blob: b354ddf5841ffd4865694ded74581ca50968e3ab [file] [log] [blame]
Bram Moolenaar03413f42016-04-12 21:07:15 +02001*options.txt* For Vim version 7.4. Last change: 2016 Apr 12
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
13For an overview of options see help.txt |option-list|.
14
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
245has its own copy of this option, thus can each have their own value. This
246allows 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
264When editing a buffer that has been edited before, the last used window
265options are used again. If this buffer has been edited in this window, the
266values from back then are used. Otherwise the values from the window where
267the buffer was edited last are used.
268
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'*
890'backspace' 'bs' string (default "")
891 global
892 {not in Vi}
893 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
894 mode. This is a list of items, separated by commas. Each item allows
895 a way to backspace over something:
896 value effect ~
897 indent allow backspacing over autoindent
898 eol allow backspacing over line breaks (join lines)
899 start allow backspacing over the start of insert; CTRL-W and CTRL-U
900 stop once at the start of insert.
901
902 When the value is empty, Vi compatible backspacing is used.
903
904 For backwards compatibility with version 5.4 and earlier:
905 value effect ~
906 0 same as ":set backspace=" (Vi compatible)
907 1 same as ":set backspace=indent,eol"
908 2 same as ":set backspace=indent,eol,start"
909
910 See |:fixdel| if your <BS> or <Del> key does not do what you want.
911 NOTE: This option is set to "" when 'compatible' is set.
912
913 *'backup'* *'bk'* *'nobackup'* *'nobk'*
914'backup' 'bk' boolean (default off)
915 global
916 {not in Vi}
917 Make a backup before overwriting a file. Leave it around after the
918 file has been successfully written. If you do not want to keep the
919 backup file, but you do want a backup while the file is being
920 written, reset this option and set the 'writebackup' option (this is
921 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 |backup-table| for more explanations.
924 When the 'backupskip' pattern matches, a backup is not made anyway.
925 When 'patchmode' is set, the backup may be renamed to become the
926 oldest version of a file.
927 NOTE: This option is reset when 'compatible' is set.
928
929 *'backupcopy'* *'bkc'*
930'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200931 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 {not in Vi}
933 When writing a file and a backup is made, this option tells how it's
934 done. This is a comma separated list of words.
935
936 The main values are:
937 "yes" make a copy of the file and overwrite the original one
938 "no" rename the file and write a new one
939 "auto" one of the previous, what works best
940
941 Extra values that can be combined with the ones above are:
942 "breaksymlink" always break symlinks when writing
943 "breakhardlink" always break hardlinks when writing
944
945 Making a copy and overwriting the original file:
946 - Takes extra time to copy the file.
947 + When the file has special attributes, is a (hard/symbolic) link or
948 has a resource fork, all this is preserved.
949 - When the file is a link the backup will have the name of the link,
950 not of the real file.
951
952 Renaming the file and writing a new one:
953 + It's fast.
954 - Sometimes not all attributes of the file can be copied to the new
955 file.
956 - When the file is a link the new file will not be a link.
957
958 The "auto" value is the middle way: When Vim sees that renaming file
959 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000960 the file is not a link) that is used. When problems are expected, a
961 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
963 The "breaksymlink" and "breakhardlink" values can be used in
964 combination with any of "yes", "no" and "auto". When included, they
965 force Vim to always break either symbolic or hard links by doing
966 exactly what the "no" option does, renaming the original file to
967 become the backup and writing a new file in its place. This can be
968 useful for example in source trees where all the files are symbolic or
969 hard links and any changes should stay in the local source tree, not
970 be propagated back to the original source.
971 *crontab*
972 One situation where "no" and "auto" will cause problems: A program
973 that opens a file, invokes Vim to edit that file, and then tests if
974 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000975 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 example.
977
978 When a copy is made, the original file is truncated and then filled
979 with the new text. This means that protection bits, owner and
980 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000981 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 group of the backup is set to the group of the original file. If this
983 fails, the protection bits for the group are made the same as for
984 others.
985
986 When the file is renamed this is the other way around: The backup has
987 the same attributes of the original file, and the newly written file
988 is owned by the current user. When the file was a (hard/symbolic)
989 link, the new file will not! That's why the "auto" value doesn't
990 rename when the file is a link. The owner and group of the newly
991 written file will be set to the same ones as the original file, but
992 the system may refuse to do this. In that case the "auto" value will
993 again not rename the file.
994
995 *'backupdir'* *'bdir'*
996'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100997 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 for Unix: ".,~/tmp,~/")
999 global
1000 {not in Vi}
1001 List of directories for the backup file, separated with commas.
1002 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001003 where this is possible. The directory must exist, Vim will not
1004 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001005 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 impossible!). Writing may fail because of this.
1007 - A directory "." means to put the backup file in the same directory
1008 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001009 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 put the backup file relative to where the edited file is. The
1011 leading "." is replaced with the path name of the edited file.
1012 ("." inside a directory name has no special meaning).
1013 - Spaces after the comma are ignored, other spaces are considered part
1014 of the directory name. To have a space at the start of a directory
1015 name, precede it with a backslash.
1016 - To include a comma in a directory name precede it with a backslash.
1017 - A directory name may end in an '/'.
1018 - Environment variables are expanded |:set_env|.
1019 - Careful with '\' characters, type one before a space, type two to
1020 get one in the option (see |option-backslash|), for example: >
1021 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1022< - For backwards compatibility with Vim version 3.0 a '>' at the start
1023 of the option is removed.
1024 See also 'backup' and 'writebackup' options.
1025 If you want to hide your backup files on Unix, consider this value: >
1026 :set backupdir=./.backup,~/.backup,.,/tmp
1027< You must create a ".backup" directory in each directory and in your
1028 home directory for this to work properly.
1029 The use of |:set+=| and |:set-=| is preferred when adding or removing
1030 directories from the list. This avoids problems when a future version
1031 uses another default.
1032 This option cannot be set from a |modeline| or in the |sandbox|, for
1033 security reasons.
1034
1035 *'backupext'* *'bex'* *E589*
1036'backupext' 'bex' string (default "~", for VMS: "_")
1037 global
1038 {not in Vi}
1039 String which is appended to a file name to make the name of the
1040 backup file. The default is quite unusual, because this avoids
1041 accidentally overwriting existing files with a backup file. You might
1042 prefer using ".bak", but make sure that you don't have files with
1043 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001044 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001046 If you like to keep a lot of backups, you could use a BufWritePre
1047 autocommand to change 'backupext' just before writing the file to
1048 include a timestamp. >
1049 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1050< Use 'backupdir' to put the backup in a different directory.
1051
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 *'backupskip'* *'bsk'*
1053'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1054 global
1055 {not in Vi}
1056 {not available when compiled without the |+wildignore|
1057 feature}
1058 A list of file patterns. When one of the patterns matches with the
1059 name of the file which is written, no backup file is created. Both
1060 the specified file name and the full path name of the file are used.
1061 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1062 Watch out for special characters, see |option-backslash|.
1063 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001064 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001065
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001066 WARNING: Not having a backup file means that when Vim fails to write
1067 your buffer correctly and then, for whatever reason, Vim exits, you
1068 lose both the original file and what you were writing. Only disable
1069 backups if you don't care about losing the file.
1070
Bram Moolenaar02467872007-05-06 13:22:01 +00001071 Note that environment variables are not expanded. If you want to use
1072 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001073 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001074
1075< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001076 backup would be made by renaming the original file crontab won't see
1077 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078
1079 *'balloondelay'* *'bdlay'*
1080'balloondelay' 'bdlay' number (default: 600)
1081 global
1082 {not in Vi}
1083 {only available when compiled with the |+balloon_eval|
1084 feature}
1085 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1086
1087 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1088'ballooneval' 'beval' boolean (default off)
1089 global
1090 {not in Vi}
1091 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001092 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 Switch on the |balloon-eval| functionality.
1094
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001095 *'balloonexpr'* *'bexpr'*
1096'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001097 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001098 {not in Vi}
1099 {only available when compiled with the |+balloon_eval|
1100 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001101 Expression for text to show in evaluation balloon. It is only used
1102 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001103
1104 v:beval_bufnr number of the buffer in which balloon is going to show
1105 v:beval_winnr number of the window
1106 v:beval_lnum line number
1107 v:beval_col column number (byte index)
1108 v:beval_text word under or after the mouse pointer
1109
1110 The evaluation of the expression must not have side effects!
1111 Example: >
1112 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001113 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001114 \', column ' . v:beval_col .
1115 \ ' of file ' . bufname(v:beval_bufnr) .
1116 \ ' on word "' . v:beval_text . '"'
1117 endfunction
1118 set bexpr=MyBalloonExpr()
1119 set ballooneval
1120<
1121 NOTE: The balloon is displayed only if the cursor is on a text
1122 character. If the result of evaluating 'balloonexpr' is not empty,
1123 Vim does not try to send a message to an external debugger (Netbeans
1124 or Sun Workshop).
1125
Bram Moolenaar30b65812012-07-12 22:01:11 +02001126 The expression will be evaluated in the |sandbox| when set from a
1127 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001128
1129 It is not allowed to change text or jump to another window while
1130 evaluating 'balloonexpr' |textlock|.
1131
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001132 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001133 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001134< When they are supported "\n" characters will start a new line. If the
1135 expression evaluates to a |List| this is equal to using each List item
1136 as a string and putting "\n" in between them.
1137
Bram Moolenaar165bc692015-07-21 17:53:25 +02001138 *'belloff'* *'bo'*
1139'belloff' 'bo' string (default "")
1140 global
1141 {not in Vi}
1142 Specifies for which events the bell will not be rung. It is a comma
1143 separated list of items. For each item that is present, the bell
1144 will be silenced. This is most useful to specify specific events in
1145 insert mode to be silenced.
1146
1147 item meaning when present ~
1148 all All events.
1149 backspace When hitting <BS> or <Del> and deleting results in an
1150 error.
1151 cursor Fail to move around using the cursor keys or
1152 <PageUp>/<PageDown> in |Insert-mode|.
1153 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1154 |i_CTRL-X_CTRL-T|.
1155 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1156 |i_CTRL-E|.
1157 ctrlg Unknown Char after <C-G> in Insert mode.
1158 error Other Error occurred (e.g. try to join last line)
1159 (mostly used in |Normal-mode| or |Cmdline-mode|).
1160 esc hitting <Esc> in |Normal-mode|.
1161 ex In |Visual-mode|, hitting |Q| results in an error.
1162 hangul Error occurred when using hangul input.
1163 insertmode Pressing <Esc> in 'insertmode'.
1164 lang Calling the beep module for Lua/Mzscheme/TCL.
1165 mess No output available for |g<|.
1166 showmatch Error occurred for 'showmatch' function.
1167 operator Empty region error |cpo-E|.
1168 register Unknown register after <C-R> in |Insert-mode|.
1169 shell Bell from shell output |:!|.
1170 spell Error happened on spell suggest.
1171 wildmode More matches in |cmdline-completion| available
1172 (depends on the 'wildmode' setting).
1173
1174 This is most useful, to fine tune when in insert mode the bell should
1175 be rung. For normal mode and ex commands, the bell is often rung to
1176 indicate that an error occurred. It can be silenced by adding the
1177 "error" keyword.
1178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1180'binary' 'bin' boolean (default off)
1181 local to buffer
1182 {not in Vi}
1183 This option should be set before editing a binary file. You can also
1184 use the |-b| Vim argument. When this option is switched on a few
1185 options will be changed (also when it already was on):
1186 'textwidth' will be set to 0
1187 'wrapmargin' will be set to 0
1188 'modeline' will be off
1189 'expandtab' will be off
1190 Also, 'fileformat' and 'fileformats' options will not be used, the
1191 file is read and written like 'fileformat' was "unix" (a single <NL>
1192 separates lines).
1193 The 'fileencoding' and 'fileencodings' options will not be used, the
1194 file is read without conversion.
1195 NOTE: When you start editing a(nother) file while the 'bin' option is
1196 on, settings from autocommands may change the settings again (e.g.,
1197 'textwidth'), causing trouble when editing. You might want to set
1198 'bin' again when the file has been loaded.
1199 The previous values of these options are remembered and restored when
1200 'bin' is switched from on to off. Each buffer has its own set of
1201 saved option values.
1202 To edit a file with 'binary' set you can use the |++bin| argument.
1203 This avoids you have to do ":set bin", which would have effect for all
1204 files you edit.
1205 When writing a file the <EOL> for the last line is only written if
1206 there was one in the original file (normally Vim appends an <EOL> to
1207 the last line if there is none; this would make the file longer). See
1208 the 'endofline' option.
1209
1210 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1211'bioskey' 'biosk' boolean (default on)
1212 global
1213 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001214 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215
1216 *'bomb'* *'nobomb'*
1217'bomb' boolean (default off)
1218 local to buffer
1219 {not in Vi}
1220 {only available when compiled with the |+multi_byte|
1221 feature}
1222 When writing a file and the following conditions are met, a BOM (Byte
1223 Order Mark) is prepended to the file:
1224 - this option is on
1225 - the 'binary' option is off
1226 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1227 endian variants.
1228 Some applications use the BOM to recognize the encoding of the file.
1229 Often used for UCS-2 files on MS-Windows. For other applications it
1230 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001231 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1233 check for the presence of the BOM is done and 'bomb' set accordingly.
1234 Unless 'binary' is set, it is removed from the first line, so that you
1235 don't see it when editing. When you don't change the options, the BOM
1236 will be restored when writing the file.
1237
1238 *'breakat'* *'brk'*
1239'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1240 global
1241 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001242 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 feature}
1244 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001245 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1246 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001248 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001249'breakindent' 'bri' boolean (default off)
1250 local to window
1251 {not in Vi}
1252 {not available when compiled without the |+linebreak|
1253 feature}
1254 Every wrapped line will continue visually indented (same amount of
1255 space as the beginning of that line), thus preserving horizontal blocks
1256 of text.
1257
1258 *'breakindentopt'* *'briopt'*
1259'breakindentopt' 'briopt' string (default empty)
1260 local to window
1261 {not in Vi}
1262 {not available when compiled without the |+linebreak|
1263 feature}
1264 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001265 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001266 min:{n} Minimum text width that will be kept after
1267 applying 'breakindent', even if the resulting
1268 text should normally be narrower. This prevents
1269 text indented almost to the right window border
1270 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001271 shift:{n} After applying 'breakindent', the wrapped line's
1272 beginning will be shifted by the given number of
1273 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001274 indentation (negative) or emphasizing the line
1275 continuation (positive).
1276 sbr Display the 'showbreak' value before applying the
1277 additional indent.
1278 The default value for min is 20 and shift is 0.
1279
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001281'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001283 {not in Vi} {only for Motif, Athena, GTK, Mac and
1284 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001286 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001287 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288 buffer Use the directory of the related buffer.
1289 current Use the current directory.
1290 {path} Use the specified directory
1291
1292 *'bufhidden'* *'bh'*
1293'bufhidden' 'bh' string (default: "")
1294 local to buffer
1295 {not in Vi}
1296 {not available when compiled without the |+quickfix|
1297 feature}
1298 This option specifies what happens when a buffer is no longer
1299 displayed in a window:
1300 <empty> follow the global 'hidden' option
1301 hide hide the buffer (don't unload it), also when 'hidden'
1302 is not set
1303 unload unload the buffer, also when 'hidden' is set or using
1304 |:hide|
1305 delete delete the buffer from the buffer list, also when
1306 'hidden' is set or using |:hide|, like using
1307 |:bdelete|
1308 wipe wipe out the buffer from the buffer list, also when
1309 'hidden' is set or using |:hide|, like using
1310 |:bwipeout|
1311
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001312 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001313 are lost without a warning. Also, these values may break autocommands
1314 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 This option is used together with 'buftype' and 'swapfile' to specify
1316 special kinds of buffers. See |special-buffers|.
1317
1318 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1319'buflisted' 'bl' boolean (default: on)
1320 local to buffer
1321 {not in Vi}
1322 When this option is set, the buffer shows up in the buffer list. If
1323 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1324 This option is reset by Vim for buffers that are only used to remember
1325 a file name or marks. Vim sets it when starting to edit a buffer.
1326 But not when moving to a buffer with ":buffer".
1327
1328 *'buftype'* *'bt'* *E382*
1329'buftype' 'bt' string (default: "")
1330 local to buffer
1331 {not in Vi}
1332 {not available when compiled without the |+quickfix|
1333 feature}
1334 The value of this option specifies the type of a buffer:
1335 <empty> normal buffer
1336 nofile buffer which is not related to a file and will not be
1337 written
1338 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001339 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001340 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001341 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001343 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 help help buffer (you are not supposed to set this
1345 manually)
1346
1347 This option is used together with 'bufhidden' and 'swapfile' to
1348 specify special kinds of buffers. See |special-buffers|.
1349
1350 Be careful with changing this option, it can have many side effects!
1351
Bram Moolenaar280f1262006-01-30 00:14:18 +00001352 A "quickfix" buffer is only used for the error list and the location
1353 list. This value is set by the |:cwindow| and |:lwindow| commands and
1354 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355
1356 "nofile" and "nowrite" buffers are similar:
1357 both: The buffer is not to be written to disk, ":w" doesn't
1358 work (":w filename" does work though).
1359 both: The buffer is never considered to be |'modified'|.
1360 There is no warning when the changes will be lost, for
1361 example when you quit Vim.
1362 both: A swap file is only created when using too much memory
1363 (when 'swapfile' has been reset there is never a swap
1364 file).
1365 nofile only: The buffer name is fixed, it is not handled like a
1366 file name. It is not modified in response to a |:cd|
1367 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001368 both: When using ":e bufname" and already editing "bufname"
1369 the buffer is made empty and autocommands are
1370 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001371 *E676*
1372 "acwrite" implies that the buffer name is not related to a file, like
1373 "nofile", but it will be written. Thus, in contrast to "nofile" and
1374 "nowrite", ":w" does work and a modified buffer can't be abandoned
1375 without saving. For writing there must be matching |BufWriteCmd|,
1376 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001377
1378 *'casemap'* *'cmp'*
1379'casemap' 'cmp' string (default: "internal,keepascii")
1380 global
1381 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001382 {only available when compiled with the |+multi_byte|
1383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 Specifies details about changing the case of letters. It may contain
1385 these words, separated by a comma:
1386 internal Use internal case mapping functions, the current
1387 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001388 matters when 'encoding' is a Unicode encoding,
1389 "latin1" or "iso-8859-15". When "internal" is
1390 omitted, the towupper() and towlower() system library
1391 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1393 case mapping, the current locale is not effective.
1394 This probably only matters for Turkish.
1395
1396 *'cdpath'* *'cd'* *E344* *E346*
1397'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1398 global
1399 {not in Vi}
1400 {not available when compiled without the
1401 |+file_in_path| feature}
1402 This is a list of directories which will be searched when using the
1403 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001404 for has a relative path, not an absolute part starting with "/", "./"
1405 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 The 'cdpath' option's value has the same form and semantics as
1407 |'path'|. Also see |file-searching|.
1408 The default value is taken from $CDPATH, with a "," prepended to look
1409 in the current directory first.
1410 If the default value taken from $CDPATH is not what you want, include
1411 a modified version of the following command in your vimrc file to
1412 override it: >
1413 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1414< This option cannot be set from a |modeline| or in the |sandbox|, for
1415 security reasons.
1416 (parts of 'cdpath' can be passed to the shell to expand file names).
1417
1418 *'cedit'*
1419'cedit' string (Vi default: "", Vim default: CTRL-F)
1420 global
1421 {not in Vi}
1422 {not available when compiled without the |+vertsplit|
1423 feature}
1424 The key used in Command-line Mode to open the command-line window.
1425 The default is CTRL-F when 'compatible' is off.
1426 Only non-printable keys are allowed.
1427 The key can be specified as a single character, but it is difficult to
1428 type. The preferred way is to use the <> notation. Examples: >
1429 :set cedit=<C-Y>
1430 :set cedit=<Esc>
1431< |Nvi| also has this option, but it only uses the first character.
1432 See |cmdwin|.
1433
1434 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1435'charconvert' 'ccv' string (default "")
1436 global
1437 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001438 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439 {not in Vi}
1440 An expression that is used for character encoding conversion. It is
1441 evaluated when a file that is to be read or has been written has a
1442 different encoding from what is desired.
1443 'charconvert' is not used when the internal iconv() function is
1444 supported and is able to do the conversion. Using iconv() is
1445 preferred, because it is much faster.
1446 'charconvert' is not used when reading stdin |--|, because there is no
1447 file to convert from. You will have to save the text in a file first.
1448 The expression must return zero or an empty string for success,
1449 non-zero for failure.
1450 The possible encoding names encountered are in 'encoding'.
1451 Additionally, names given in 'fileencodings' and 'fileencoding' are
1452 used.
1453 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1454 is done internally by Vim, 'charconvert' is not used for this.
1455 'charconvert' is also used to convert the viminfo file, if the 'c'
1456 flag is present in 'viminfo'. Also used for Unicode conversion.
1457 Example: >
1458 set charconvert=CharConvert()
1459 fun CharConvert()
1460 system("recode "
1461 \ . v:charconvert_from . ".." . v:charconvert_to
1462 \ . " <" . v:fname_in . " >" v:fname_out)
1463 return v:shell_error
1464 endfun
1465< The related Vim variables are:
1466 v:charconvert_from name of the current encoding
1467 v:charconvert_to name of the desired encoding
1468 v:fname_in name of the input file
1469 v:fname_out name of the output file
1470 Note that v:fname_in and v:fname_out will never be the same.
1471 Note that v:charconvert_from and v:charconvert_to may be different
1472 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1473 Encryption is not done by Vim when using 'charconvert'. If you want
1474 to encrypt the file after conversion, 'charconvert' should take care
1475 of this.
1476 This option cannot be set from a |modeline| or in the |sandbox|, for
1477 security reasons.
1478
1479 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1480'cindent' 'cin' boolean (default off)
1481 local to buffer
1482 {not in Vi}
1483 {not available when compiled without the |+cindent|
1484 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001485 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 that trigger reindenting in insert mode and 'cinoptions' to set your
1487 preferred indent style.
1488 If 'indentexpr' is not empty, it overrules 'cindent'.
1489 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1490 the "=" operator indents using this algorithm rather than calling an
1491 external program.
1492 See |C-indenting|.
1493 When you don't like the way 'cindent' works, try the 'smartindent'
1494 option or 'indentexpr'.
1495 This option is not used when 'paste' is set.
1496 NOTE: This option is reset when 'compatible' is set.
1497
1498 *'cinkeys'* *'cink'*
1499'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1500 local to buffer
1501 {not in Vi}
1502 {not available when compiled without the |+cindent|
1503 feature}
1504 A list of keys that, when typed in Insert mode, cause reindenting of
1505 the current line. Only used if 'cindent' is on and 'indentexpr' is
1506 empty.
1507 For the format of this option see |cinkeys-format|.
1508 See |C-indenting|.
1509
1510 *'cinoptions'* *'cino'*
1511'cinoptions' 'cino' string (default "")
1512 local to buffer
1513 {not in Vi}
1514 {not available when compiled without the |+cindent|
1515 feature}
1516 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1517 program. See |cinoptions-values| for the values of this option, and
1518 |C-indenting| for info on C indenting in general.
1519
1520
1521 *'cinwords'* *'cinw'*
1522'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1523 local to buffer
1524 {not in Vi}
1525 {not available when compiled without both the
1526 |+cindent| and the |+smartindent| features}
1527 These keywords start an extra indent in the next line when
1528 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1529 an appropriate place (inside {}).
1530 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1531 matter, include the keyword both the uppercase and lowercase:
1532 "if,If,IF".
1533
1534 *'clipboard'* *'cb'*
1535'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1536 for X-windows, "" otherwise)
1537 global
1538 {not in Vi}
1539 {only in GUI versions or when the |+xterm_clipboard|
1540 feature is included}
1541 This option is a list of comma separated names.
1542 These names are recognized:
1543
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001544 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 unnamed When included, Vim will use the clipboard register '*'
1546 for all yank, delete, change and put operations which
1547 would normally go to the unnamed register. When a
1548 register is explicitly specified, it will always be
1549 used regardless of whether "unnamed" is in 'clipboard'
1550 or not. The clipboard register can always be
1551 explicitly accessed using the "* notation. Also see
1552 |gui-clipboard|.
1553
Bram Moolenaar30b65812012-07-12 22:01:11 +02001554 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001555 unnamedplus A variant of the "unnamed" flag which uses the
1556 clipboard register '+' (|quoteplus|) instead of
1557 register '*' for all yank, delete, change and put
1558 operations which would normally go to the unnamed
1559 register. When "unnamed" is also included to the
1560 option, yank operations (but not delete, change or
1561 put) will additionally copy the text into register
1562 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001563 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001564 Availability can be checked with: >
1565 if has('unnamedplus')
1566<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001567 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 autoselect Works like the 'a' flag in 'guioptions': If present,
1569 then whenever Visual mode is started, or the Visual
1570 area extended, Vim tries to become the owner of the
1571 windowing system's global selection or put the
1572 selected text on the clipboard used by the selection
1573 register "*. See |guioptions_a| and |quotestar| for
1574 details. When the GUI is active, the 'a' flag in
1575 'guioptions' is used, when the GUI is not active, this
1576 "autoselect" flag is used.
1577 Also applies to the modeless selection.
1578
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001579 *clipboard-autoselectplus*
1580 autoselectplus Like "autoselect" but using the + register instead of
1581 the * register. Compare to the 'P' flag in
1582 'guioptions'.
1583
1584 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 autoselectml Like "autoselect", but for the modeless selection
1586 only. Compare to the 'A' flag in 'guioptions'.
1587
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001588 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001589 html When the clipboard contains HTML, use this when
1590 pasting. When putting text on the clipboard, mark it
1591 as HTML. This works to copy rendered HTML from
1592 Firefox, paste it as raw HTML in Vim, select the HTML
1593 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001594 You probably want to add this only temporarily,
1595 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001596 Only supported for GTK version 2 and later.
1597 Only available with the |+multi_byte| feature.
1598
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001599 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 exclude:{pattern}
1601 Defines a pattern that is matched against the name of
1602 the terminal 'term'. If there is a match, no
1603 connection will be made to the X server. This is
1604 useful in this situation:
1605 - Running Vim in a console.
1606 - $DISPLAY is set to start applications on another
1607 display.
1608 - You do not want to connect to the X server in the
1609 console, but do want this in a terminal emulator.
1610 To never connect to the X server use: >
1611 exclude:.*
1612< This has the same effect as using the |-X| argument.
1613 Note that when there is no connection to the X server
1614 the window title won't be restored and the clipboard
1615 cannot be accessed.
1616 The value of 'magic' is ignored, {pattern} is
1617 interpreted as if 'magic' was on.
1618 The rest of the option value will be used for
1619 {pattern}, this must be the last entry.
1620
1621 *'cmdheight'* *'ch'*
1622'cmdheight' 'ch' number (default 1)
1623 global
1624 {not in Vi}
1625 Number of screen lines to use for the command-line. Helps avoiding
1626 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001627 The value of this option is stored with the tab page, so that each tab
1628 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629
1630 *'cmdwinheight'* *'cwh'*
1631'cmdwinheight' 'cwh' number (default 7)
1632 global
1633 {not in Vi}
1634 {not available when compiled without the |+vertsplit|
1635 feature}
1636 Number of screen lines to use for the command-line window. |cmdwin|
1637
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001638 *'colorcolumn'* *'cc'*
1639'colorcolumn' 'cc' string (default "")
1640 local to window
1641 {not in Vi}
1642 {not available when compiled without the |+syntax|
1643 feature}
1644 'colorcolumn' is a comma separated list of screen columns that are
1645 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1646 text. Will make screen redrawing slower.
1647 The screen column can be an absolute number, or a number preceded with
1648 '+' or '-', which is added to or subtracted from 'textwidth'. >
1649
1650 :set cc=+1 " highlight column after 'textwidth'
1651 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1652 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1653<
1654 When 'textwidth' is zero then the items with '-' and '+' are not used.
1655 A maximum of 256 columns are highlighted.
1656
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657 *'columns'* *'co'* *E594*
1658'columns' 'co' number (default 80 or terminal width)
1659 global
1660 {not in Vi}
1661 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001662 initialization and does not have to be set by hand. Also see
1663 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001664 When Vim is running in the GUI or in a resizable window, setting this
1665 option will cause the window size to be changed. When you only want
1666 to use the size for the GUI, put the command in your |gvimrc| file.
1667 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001668 number of columns of the display, the display may be messed up. For
1669 the GUI it is always possible and Vim limits the number of columns to
1670 what fits on the screen. You can use this command to get the widest
1671 window possible: >
1672 :set columns=9999
1673< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674
1675 *'comments'* *'com'* *E524* *E525*
1676'comments' 'com' string (default
1677 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1678 local to buffer
1679 {not in Vi}
1680 {not available when compiled without the |+comments|
1681 feature}
1682 A comma separated list of strings that can start a comment line. See
1683 |format-comments|. See |option-backslash| about using backslashes to
1684 insert a space.
1685
1686 *'commentstring'* *'cms'* *E537*
1687'commentstring' 'cms' string (default "/*%s*/")
1688 local to buffer
1689 {not in Vi}
1690 {not available when compiled without the |+folding|
1691 feature}
1692 A template for a comment. The "%s" in the value is replaced with the
1693 comment text. Currently only used to add markers for folding, see
1694 |fold-marker|.
1695
1696 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001697'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1698 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 global
1700 {not in Vi}
1701 This option has the effect of making Vim either more Vi-compatible, or
1702 make Vim behave in a more useful way.
1703 This is a special kind of option, because when it's set or reset,
1704 other options are also changed as a side effect. CAREFUL: Setting or
1705 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001706 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 set this option in your vimrc file, you should probably put it at the
1708 very start.
1709 By default this option is on and the Vi defaults are used for the
1710 options. This default was chosen for those people who want to use Vim
1711 just like Vi, and don't even (want to) know about the 'compatible'
1712 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001713 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001714 this option is switched off, and all options that have not been
1715 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001716 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001717 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001718 happen for the system-wide vimrc or gvimrc file, nor for a file given
1719 with the |-u| argument). Also see |compatible-default| and
1720 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 You can also set this option with the "-C" argument, and reset it with
1722 "-N". See |-C| and |-N|.
1723 Switching this option off makes the Vim defaults be used for options
1724 that have a different Vi and Vim default value. See the options
1725 marked with a '+' below. Other options are not modified.
1726 At the moment this option is set, several other options will be set
1727 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001728 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 editing.
1730 See also 'cpoptions'.
1731
1732 option + set value effect ~
1733
1734 'allowrevins' off no CTRL-_ command
1735 'backupcopy' Unix: "yes" backup file is a copy
1736 others: "auto" copy or rename backup file
1737 'backspace' "" normal backspace
1738 'backup' off no backup file
1739 'cindent' off no C code indentation
1740 'cedit' + "" no key to open the |cmdwin|
1741 'cpoptions' + (all flags) Vi-compatible flags
1742 'cscopetag' off don't use cscope for ":tag"
1743 'cscopetagorder' 0 see |cscopetagorder|
1744 'cscopeverbose' off see |cscopeverbose|
1745 'digraph' off no digraphs
1746 'esckeys' + off no <Esc>-keys in Insert mode
1747 'expandtab' off tabs not expanded to spaces
1748 'fileformats' + "" no automatic file format detection,
1749 "dos,unix" except for DOS, Windows and OS/2
1750 'formatoptions' + "vt" Vi compatible formatting
1751 'gdefault' off no default 'g' flag for ":s"
1752 'history' + 0 no commandline history
1753 'hkmap' off no Hebrew keyboard mapping
1754 'hkmapp' off no phonetic Hebrew keyboard mapping
1755 'hlsearch' off no highlighting of search matches
1756 'incsearch' off no incremental searching
1757 'indentexpr' "" no indenting by expression
1758 'insertmode' off do not start in Insert mode
1759 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1760 characters and '_'
1761 'joinspaces' on insert 2 spaces after period
1762 'modeline' + off no modelines
1763 'more' + off no pauses in listings
1764 'revins' off no reverse insert
1765 'ruler' off no ruler
1766 'scrolljump' 1 no jump scroll
1767 'scrolloff' 0 no scroll offset
1768 'shiftround' off indent not rounded to shiftwidth
1769 'shortmess' + "" no shortening of messages
1770 'showcmd' + off command characters not shown
1771 'showmode' + off current mode not shown
1772 'smartcase' off no automatic ignore case switch
1773 'smartindent' off no smart indentation
1774 'smarttab' off no smart tab size
1775 'softtabstop' 0 tabs are always 'tabstop' positions
1776 'startofline' on goto startofline with some commands
1777 'tagrelative' + off tag file names are not relative
1778 'textauto' + off no automatic textmode detection
1779 'textwidth' 0 no automatic line wrap
1780 'tildeop' off tilde is not an operator
1781 'ttimeout' off no terminal timeout
1782 'whichwrap' + "" left-right movements don't wrap
1783 'wildchar' + CTRL-E only when the current value is <Tab>
1784 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001785 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786
1787 *'complete'* *'cpt'* *E535*
1788'complete' 'cpt' string (default: ".,w,b,u,t,i")
1789 local to buffer
1790 {not in Vi}
1791 This option specifies how keyword completion |ins-completion| works
1792 when CTRL-P or CTRL-N are used. It is also used for whole-line
1793 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1794 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001795 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 w scan buffers from other windows
1797 b scan other loaded buffers that are in the buffer list
1798 u scan the unloaded buffers that are in the buffer list
1799 U scan the buffers that are not in the buffer list
1800 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001801 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 k{dict} scan the file {dict}. Several "k" flags can be given,
1803 patterns are valid too. For example: >
1804 :set cpt=k/usr/dict/*,k~/spanish
1805< s scan the files given with the 'thesaurus' option
1806 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1807 are valid too.
1808 i scan current and included files
1809 d scan current and included files for defined name or macro
1810 |i_CTRL-X_CTRL-D|
1811 ] tag completion
1812 t same as "]"
1813
1814 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1815 not executed, this may lead to unexpected completions from some files
1816 (gzipped files for example). Unloaded buffers are not scanned for
1817 whole-line completion.
1818
1819 The default is ".,w,b,u,t,i", which means to scan:
1820 1. the current buffer
1821 2. buffers in other windows
1822 3. other loaded buffers
1823 4. unloaded buffers
1824 5. tags
1825 6. included files
1826
1827 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001828 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1829 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001831 *'completefunc'* *'cfu'*
1832'completefunc' 'cfu' string (default: empty)
1833 local to buffer
1834 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001835 {not available when compiled without the |+eval|
1836 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001837 This option specifies a function to be used for Insert mode completion
1838 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001839 See |complete-functions| for an explanation of how the function is
1840 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001841 This option cannot be set from a |modeline| or in the |sandbox|, for
1842 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001843
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001844 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001845'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001846 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001847 {not available when compiled without the
1848 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001849 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001850 A comma separated list of options for Insert mode completion
1851 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001852
1853 menu Use a popup menu to show the possible completions. The
1854 menu is only shown when there is more than one match and
1855 sufficient colors are available. |ins-completion-menu|
1856
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001857 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001858 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001859 match, e.g., what file it comes from.
1860
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001861 longest Only insert the longest common text of the matches. If
1862 the menu is displayed you can use CTRL-L to add more
1863 characters. Whether case is ignored depends on the kind
1864 of completion. For buffer text the 'ignorecase' option is
1865 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001866
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001867 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001868 completion in the preview window. Only works in
1869 combination with "menu" or "menuone".
1870
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001871 noinsert Do not insert any text for a match until the user selects
1872 a match from the menu. Only works in combination with
1873 "menu" or "menuone". No effect if "longest" is present.
1874
1875 noselect Do not select a match in the menu, force the user to
1876 select one from the menu. Only works in combination with
1877 "menu" or "menuone".
1878
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001879
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001880 *'concealcursor'* *'cocu'*
1881'concealcursor' 'cocu' string (default: "")
1882 local to window
1883 {not in Vi}
1884 {not available when compiled without the |+conceal|
1885 feature}
1886 Sets the modes in which text in the cursor line can also be concealed.
1887 When the current mode is listed then concealing happens just like in
1888 other lines.
1889 n Normal mode
1890 v Visual mode
1891 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001892 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001893
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001894 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001895 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001896 are moving around text is concealed, but when starting to insert text
1897 or selecting a Visual area the concealed text is displayed, so that
1898 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001899 Keep in mind that the cursor position is not always where it's
1900 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001901
1902
1903'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001904 number (default 0)
1905 local to window
1906 {not in Vi}
1907 {not available when compiled without the |+conceal|
1908 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001909 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1910 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001911
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001912 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001913 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001914 1 Each block of concealed text is replaced with one
1915 character. If the syntax item does not have a custom
1916 replacement character defined (see |:syn-cchar|) the
1917 character defined in 'listchars' is used (default is a
1918 space).
1919 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001920 2 Concealed text is completely hidden unless it has a
1921 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001922 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001923 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001924
Bram Moolenaara7781e02010-07-19 20:13:22 +02001925 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001926 edit and copy the text. This can be changed with the 'concealcursor'
1927 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001928
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1930'confirm' 'cf' boolean (default off)
1931 global
1932 {not in Vi}
1933 When 'confirm' is on, certain operations that would normally
1934 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1935 instead raise a |dialog| asking if you wish to save the current
1936 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1937 If 'confirm' is off you can still activate confirmation for one
1938 command only (this is most useful in mappings) with the |:confirm|
1939 command.
1940 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1941
1942 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1943'conskey' 'consk' boolean (default off)
1944 global
1945 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001946 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947
1948 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1949'copyindent' 'ci' boolean (default off)
1950 local to buffer
1951 {not in Vi}
1952 Copy the structure of the existing lines indent when autoindenting a
1953 new line. Normally the new indent is reconstructed by a series of
1954 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1955 in which case only spaces are used). Enabling this option makes the
1956 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001957 existing line. 'expandtab' has no effect on these characters, a Tab
1958 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 line, the remaining space is filled in the normal manner.
1960 NOTE: 'copyindent' is reset when 'compatible' is set.
1961 Also see 'preserveindent'.
1962
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001963 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964'cpoptions' 'cpo' string (Vim default: "aABceFs",
1965 Vi default: all flags)
1966 global
1967 {not in Vi}
1968 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001969 this indicates Vi-compatible behavior. This is used for things where
1970 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 'cpoptions' stands for "compatible-options".
1972 Commas can be added for readability.
1973 To avoid problems with flags that are added in the future, use the
1974 "+=" and "-=" feature of ":set" |add-option-flags|.
1975 NOTE: This option is set to the Vi default value when 'compatible' is
1976 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001977 NOTE: This option is set to the POSIX default value at startup when
1978 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001979 variable exists |posix|. This means Vim tries to behave like the
1980 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981
1982 contains behavior ~
1983 *cpo-a*
1984 a When included, a ":read" command with a file name
1985 argument will set the alternate file name for the
1986 current window.
1987 *cpo-A*
1988 A When included, a ":write" command with a file name
1989 argument will set the alternate file name for the
1990 current window.
1991 *cpo-b*
1992 b "\|" in a ":map" command is recognized as the end of
1993 the map command. The '\' is included in the mapping,
1994 the text after the '|' is interpreted as the next
1995 command. Use a CTRL-V instead of a backslash to
1996 include the '|' in the mapping. Applies to all
1997 mapping, abbreviation, menu and autocmd commands.
1998 See also |map_bar|.
1999 *cpo-B*
2000 B A backslash has no special meaning in mappings,
2001 abbreviations and the "to" part of the menu commands.
2002 Remove this flag to be able to use a backslash like a
2003 CTRL-V. For example, the command ":map X \<Esc>"
2004 results in X being mapped to:
2005 'B' included: "\^[" (^[ is a real <Esc>)
2006 'B' excluded: "<Esc>" (5 characters)
2007 ('<' excluded in both cases)
2008 *cpo-c*
2009 c Searching continues at the end of any match at the
2010 cursor position, but not further than the start of the
2011 next line. When not present searching continues
2012 one character from the cursor position. With 'c'
2013 "abababababab" only gets three matches when repeating
2014 "/abab", without 'c' there are five matches.
2015 *cpo-C*
2016 C Do not concatenate sourced lines that start with a
2017 backslash. See |line-continuation|.
2018 *cpo-d*
2019 d Using "./" in the 'tags' option doesn't mean to use
2020 the tags file relative to the current file, but the
2021 tags file in the current directory.
2022 *cpo-D*
2023 D Can't use CTRL-K to enter a digraph after Normal mode
2024 commands with a character argument, like |r|, |f| and
2025 |t|.
2026 *cpo-e*
2027 e When executing a register with ":@r", always add a
2028 <CR> to the last line, also when the register is not
2029 linewise. If this flag is not present, the register
2030 is not linewise and the last line does not end in a
2031 <CR>, then the last line is put on the command-line
2032 and can be edited before hitting <CR>.
2033 *cpo-E*
2034 E It is an error when using "y", "d", "c", "g~", "gu" or
2035 "gU" on an Empty region. The operators only work when
2036 at least one character is to be operate on. Example:
2037 This makes "y0" fail in the first column.
2038 *cpo-f*
2039 f When included, a ":read" command with a file name
2040 argument will set the file name for the current buffer,
2041 if the current buffer doesn't have a file name yet.
2042 *cpo-F*
2043 F When included, a ":write" command with a file name
2044 argument will set the file name for the current
2045 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002046 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 *cpo-g*
2048 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002049 *cpo-H*
2050 H When using "I" on a line with only blanks, insert
2051 before the last blank. Without this flag insert after
2052 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 *cpo-i*
2054 i When included, interrupting the reading of a file will
2055 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002056 *cpo-I*
2057 I When moving the cursor up or down just after inserting
2058 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 *cpo-j*
2060 j When joining lines, only add two spaces after a '.',
2061 not after '!' or '?'. Also see 'joinspaces'.
2062 *cpo-J*
2063 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002064 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 white space.
2066 *cpo-k*
2067 k Disable the recognition of raw key codes in
2068 mappings, abbreviations, and the "to" part of menu
2069 commands. For example, if <Key> sends ^[OA (where ^[
2070 is <Esc>), the command ":map X ^[OA" results in X
2071 being mapped to:
2072 'k' included: "^[OA" (3 characters)
2073 'k' excluded: "<Key>" (one key code)
2074 Also see the '<' flag below.
2075 *cpo-K*
2076 K Don't wait for a key code to complete when it is
2077 halfway a mapping. This breaks mapping <F1><F1> when
2078 only part of the second <F1> has been read. It
2079 enables cancelling the mapping by typing <F1><Esc>.
2080 *cpo-l*
2081 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002082 literally, only "\]", "\^", "\-" and "\\" are special.
2083 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2085 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002086 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 *cpo-L*
2088 L When the 'list' option is set, 'wrapmargin',
2089 'textwidth', 'softtabstop' and Virtual Replace mode
2090 (see |gR|) count a <Tab> as two characters, instead of
2091 the normal behavior of a <Tab>.
2092 *cpo-m*
2093 m When included, a showmatch will always wait half a
2094 second. When not included, a showmatch will wait half
2095 a second or until a character is typed. |'showmatch'|
2096 *cpo-M*
2097 M When excluded, "%" matching will take backslashes into
2098 account. Thus in "( \( )" and "\( ( \)" the outer
2099 parenthesis match. When included "%" ignores
2100 backslashes, which is Vi compatible.
2101 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002102 n When included, the column used for 'number' and
2103 'relativenumber' will also be used for text of wrapped
2104 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-o*
2106 o Line offset to search command is not remembered for
2107 next search.
2108 *cpo-O*
2109 O Don't complain if a file is being overwritten, even
2110 when it didn't exist when editing it. This is a
2111 protection against a file unexpectedly created by
2112 someone else. Vi didn't complain about this.
2113 *cpo-p*
2114 p Vi compatible Lisp indenting. When not present, a
2115 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002116 *cpo-P*
2117 P When included, a ":write" command that appends to a
2118 file will set the file name for the current buffer, if
2119 the current buffer doesn't have a file name yet and
2120 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002121 *cpo-q*
2122 q When joining multiple lines leave the cursor at the
2123 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 *cpo-r*
2125 r Redo ("." command) uses "/" to repeat a search
2126 command, instead of the actually used search string.
2127 *cpo-R*
2128 R Remove marks from filtered lines. Without this flag
2129 marks are kept like |:keepmarks| was used.
2130 *cpo-s*
2131 s Set buffer options when entering the buffer for the
2132 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002133 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 set when the buffer is created.
2135 *cpo-S*
2136 S Set buffer options always when entering a buffer
2137 (except 'readonly', 'fileformat', 'filetype' and
2138 'syntax'). This is the (most) Vi compatible setting.
2139 The options are set to the values in the current
2140 buffer. When you change an option and go to another
2141 buffer, the value is copied. Effectively makes the
2142 buffer options global to all buffers.
2143
2144 's' 'S' copy buffer options
2145 no no when buffer created
2146 yes no when buffer first entered (default)
2147 X yes each time when buffer entered (vi comp.)
2148 *cpo-t*
2149 t Search pattern for the tag command is remembered for
2150 "n" command. Otherwise Vim only puts the pattern in
2151 the history for search pattern, but doesn't change the
2152 last used search pattern.
2153 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002154 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 *cpo-v*
2156 v Backspaced characters remain visible on the screen in
2157 Insert mode. Without this flag the characters are
2158 erased from the screen right away. With this flag the
2159 screen newly typed text overwrites backspaced
2160 characters.
2161 *cpo-w*
2162 w When using "cw" on a blank character, only change one
2163 character and not all blanks until the start of the
2164 next word.
2165 *cpo-W*
2166 W Don't overwrite a readonly file. When omitted, ":w!"
2167 overwrites a readonly file, if possible.
2168 *cpo-x*
2169 x <Esc> on the command-line executes the command-line.
2170 The default in Vim is to abandon the command-line,
2171 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002172 *cpo-X*
2173 X When using a count with "R" the replaced text is
2174 deleted only once. Also when repeating "R" with "."
2175 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 *cpo-y*
2177 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002178 *cpo-Z*
2179 Z When using "w!" while the 'readonly' option is set,
2180 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 *cpo-!*
2182 ! When redoing a filter command, use the last used
2183 external command, whatever it was. Otherwise the last
2184 used -filter- command is used.
2185 *cpo-$*
2186 $ When making a change to one line, don't redisplay the
2187 line, but put a '$' at the end of the changed text.
2188 The changed text will be overwritten when you type the
2189 new text. The line is redisplayed if you type any
2190 command that moves the cursor from the insertion
2191 point.
2192 *cpo-%*
2193 % Vi-compatible matching is done for the "%" command.
2194 Does not recognize "#if", "#endif", etc.
2195 Does not recognize "/*" and "*/".
2196 Parens inside single and double quotes are also
2197 counted, causing a string that contains a paren to
2198 disturb the matching. For example, in a line like
2199 "if (strcmp("foo(", s))" the first paren does not
2200 match the last one. When this flag is not included,
2201 parens inside single and double quotes are treated
2202 specially. When matching a paren outside of quotes,
2203 everything inside quotes is ignored. When matching a
2204 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002205 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002206 This flag is also used for other features, such as
2207 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002208 *cpo--*
2209 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002210 it would go above the first line or below the last
2211 line. Without it the cursor moves to the first or
2212 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002213 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002214 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002215 *cpo-+*
2216 + When included, a ":write file" command will reset the
2217 'modified' flag of the buffer, even though the buffer
2218 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002219 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 * Use ":*" in the same way as ":@". When not included,
2221 ":*" is an alias for ":'<,'>", select the Visual area.
2222 *cpo-<*
2223 < Disable the recognition of special key codes in |<>|
2224 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002225 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 ":map X <Tab>" results in X being mapped to:
2227 '<' included: "<Tab>" (5 characters)
2228 '<' excluded: "^I" (^I is a real <Tab>)
2229 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002230 *cpo->*
2231 > When appending to a register, put a line break before
2232 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002233 *cpo-;*
2234 ; When using |,| or |;| to repeat the last |t| search
2235 and the cursor is right in front of the searched
2236 character, the cursor won't move. When not included,
2237 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002238 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002239
2240 POSIX flags. These are not included in the Vi default value, except
2241 when $VIM_POSIX was set on startup. |posix|
2242
2243 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002244 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002245 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002246 *cpo-&*
2247 & When ":preserve" was used keep the swap file when
2248 exiting normally while this buffer is still loaded.
2249 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002250 *cpo-\*
2251 \ Backslash in a [] range in a search pattern is taken
2252 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002253 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2254 '\' excluded: "/[ \-]" finds <Space> and '-'
2255 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002256 *cpo-/*
2257 / When "%" is used as the replacement string in a |:s|
2258 command, use the previous replacement string. |:s%|
2259 *cpo-{*
2260 { The |{| and |}| commands also stop at a "{" character
2261 at the start of a line.
2262 *cpo-.*
2263 . The ":chdir" and ":cd" commands fail if the current
2264 buffer is modified, unless ! is used. Vim doesn't
2265 need this, since it remembers the full path of an
2266 opened file.
2267 *cpo-bar*
2268 | The value of the $LINES and $COLUMNS environment
2269 variables overrule the terminal size values obtained
2270 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002271
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002273 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002274'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002275 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002276 {not in Vi}
2277 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002278 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002279 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002280 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002281 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002282 blowfish Blowfish method. Medium strong encryption but it has
2283 an implementation flaw. Requires Vim 7.3 or later,
2284 files can NOT be read by Vim 7.2 and older. This adds
2285 a "seed" to the file, every time you write the file
2286 the encrypted bytes will be different.
2287 *blowfish2*
2288 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002289 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002290 and older. This adds a "seed" to the file, every time
2291 you write the file the encrypted bytes will be
2292 different. The whole undo file is encrypted, not just
2293 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002294
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002295 You should use "blowfish2", also to re-encrypt older files.
2296
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002297 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002298 to the detected method of the file being read. Thus if you write it
2299 without changing 'cryptmethod' the same method will be used.
2300 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002301 explicitly write it, you don't get a warning unless there are other
2302 modifications. Also see |:X|.
2303
2304 When setting the global value to an empty string, it will end up with
2305 the value "zip". When setting the local value to an empty string the
2306 buffer will use the global value.
2307
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002308 When a new encryption method is added in a later version of Vim, and
2309 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002310 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002311
2312
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 *'cscopepathcomp'* *'cspc'*
2314'cscopepathcomp' 'cspc' number (default 0)
2315 global
2316 {not available when compiled without the |+cscope|
2317 feature}
2318 {not in Vi}
2319 Determines how many components of the path to show in a list of tags.
2320 See |cscopepathcomp|.
2321
2322 *'cscopeprg'* *'csprg'*
2323'cscopeprg' 'csprg' string (default "cscope")
2324 global
2325 {not available when compiled without the |+cscope|
2326 feature}
2327 {not in Vi}
2328 Specifies the command to execute cscope. See |cscopeprg|.
2329 This option cannot be set from a |modeline| or in the |sandbox|, for
2330 security reasons.
2331
2332 *'cscopequickfix'* *'csqf'*
2333'cscopequickfix' 'csqf' string (default "")
2334 global
2335 {not available when compiled without the |+cscope|
2336 or |+quickfix| features}
2337 {not in Vi}
2338 Specifies whether to use quickfix window to show cscope results.
2339 See |cscopequickfix|.
2340
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002341 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002342'cscoperelative' 'csre' boolean (default off)
2343 global
2344 {not available when compiled without the |+cscope|
2345 feature}
2346 {not in Vi}
2347 In the absence of a prefix (-P) for cscope. setting this option enables
2348 to use the basename of cscope.out path as the prefix.
2349 See |cscoperelative|.
2350
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2352'cscopetag' 'cst' boolean (default off)
2353 global
2354 {not available when compiled without the |+cscope|
2355 feature}
2356 {not in Vi}
2357 Use cscope for tag commands. See |cscope-options|.
2358 NOTE: This option is reset when 'compatible' is set.
2359
2360 *'cscopetagorder'* *'csto'*
2361'cscopetagorder' 'csto' number (default 0)
2362 global
2363 {not available when compiled without the |+cscope|
2364 feature}
2365 {not in Vi}
2366 Determines the order in which ":cstag" performs a search. See
2367 |cscopetagorder|.
2368 NOTE: This option is set to 0 when 'compatible' is set.
2369
2370 *'cscopeverbose'* *'csverb'*
2371 *'nocscopeverbose'* *'nocsverb'*
2372'cscopeverbose' 'csverb' boolean (default off)
2373 global
2374 {not available when compiled without the |+cscope|
2375 feature}
2376 {not in Vi}
2377 Give messages when adding a cscope database. See |cscopeverbose|.
2378 NOTE: This option is reset when 'compatible' is set.
2379
Bram Moolenaar860cae12010-06-05 23:22:07 +02002380 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2381'cursorbind' 'crb' boolean (default off)
2382 local to window
2383 {not in Vi}
2384 {not available when compiled without the |+cursorbind|
2385 feature}
2386 When this option is set, as the cursor in the current
2387 window moves other cursorbound windows (windows that also have
2388 this option set) move their cursors to the corresponding line and
2389 column. This option is useful for viewing the
2390 differences between two versions of a file (see 'diff'); in diff mode,
2391 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002392 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002393
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002394
2395 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2396'cursorcolumn' 'cuc' boolean (default off)
2397 local to window
2398 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002399 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002400 feature}
2401 Highlight the screen column of the cursor with CursorColumn
2402 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2403 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002404 If you only want the highlighting in the current window you can use
2405 these autocommands: >
2406 au WinLeave * set nocursorline nocursorcolumn
2407 au WinEnter * set cursorline cursorcolumn
2408<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002409
2410 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2411'cursorline' 'cul' boolean (default off)
2412 local to window
2413 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002414 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002415 feature}
2416 Highlight the screen line of the cursor with CursorLine
2417 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2418 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002419 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002420 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002421
2422
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 *'debug'*
2424'debug' string (default "")
2425 global
2426 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002427 These values can be used:
2428 msg Error messages that would otherwise be omitted will be given
2429 anyway.
2430 throw Error messages that would otherwise be omitted will be given
2431 anyway and also throw an exception and set |v:errmsg|.
2432 beep A message will be given when otherwise only a beep would be
2433 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002434 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002435 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2436 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437
2438 *'define'* *'def'*
2439'define' 'def' string (default "^\s*#\s*define")
2440 global or local to buffer |global-local|
2441 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002442 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 pattern, just like for the "/" command. This option is used for the
2444 commands like "[i" and "[d" |include-search|. The 'isident' option is
2445 used to recognize the defined name after the match:
2446 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2447 See |option-backslash| about inserting backslashes to include a space
2448 or backslash.
2449 The default value is for C programs. For C++ this value would be
2450 useful, to include const type declarations: >
2451 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2452< When using the ":set" command, you need to double the backslashes!
2453
2454 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2455'delcombine' 'deco' boolean (default off)
2456 global
2457 {not in Vi}
2458 {only available when compiled with the |+multi_byte|
2459 feature}
2460 If editing Unicode and this option is set, backspace and Normal mode
2461 "x" delete each combining character on its own. When it is off (the
2462 default) the character along with its combining characters are
2463 deleted.
2464 Note: When 'delcombine' is set "xx" may work different from "2x"!
2465
2466 This is useful for Arabic, Hebrew and many other languages where one
2467 may have combining characters overtop of base characters, and want
2468 to remove only the combining ones.
2469
2470 *'dictionary'* *'dict'*
2471'dictionary' 'dict' string (default "")
2472 global or local to buffer |global-local|
2473 {not in Vi}
2474 List of file names, separated by commas, that are used to lookup words
2475 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2476 contain a list of words. This can be one word per line, or several
2477 words per line, separated by non-keyword characters (white space is
2478 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002479 When this option is empty, or an entry "spell" is present, spell
2480 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002481 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 after a comma are ignored, otherwise spaces are included in the file
2483 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002484 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 Where to find a list of words?
2486 - On FreeBSD, there is the file "/usr/share/dict/words".
2487 - In the Simtel archive, look in the "msdos/linguist" directory.
2488 - In "miscfiles" of the GNU collection.
2489 The use of |:set+=| and |:set-=| is preferred when adding or removing
2490 directories from the list. This avoids problems when a future version
2491 uses another default.
2492 Backticks cannot be used in this option for security reasons.
2493
2494 *'diff'* *'nodiff'*
2495'diff' boolean (default off)
2496 local to window
2497 {not in Vi}
2498 {not available when compiled without the |+diff|
2499 feature}
2500 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002501 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502
2503 *'dex'* *'diffexpr'*
2504'diffexpr' 'dex' string (default "")
2505 global
2506 {not in Vi}
2507 {not available when compiled without the |+diff|
2508 feature}
2509 Expression which is evaluated to obtain an ed-style diff file from two
2510 versions of a file. See |diff-diffexpr|.
2511 This option cannot be set from a |modeline| or in the |sandbox|, for
2512 security reasons.
2513
2514 *'dip'* *'diffopt'*
2515'diffopt' 'dip' string (default "filler")
2516 global
2517 {not in Vi}
2518 {not available when compiled without the |+diff|
2519 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002520 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 All are optional. Items must be separated by a comma.
2522
2523 filler Show filler lines, to keep the text
2524 synchronized with a window that has inserted
2525 lines at the same position. Mostly useful
2526 when windows are side-by-side and 'scrollbind'
2527 is set.
2528
2529 context:{n} Use a context of {n} lines between a change
2530 and a fold that contains unchanged lines.
2531 When omitted a context of six lines is used.
2532 See |fold-diff|.
2533
2534 icase Ignore changes in case of text. "a" and "A"
2535 are considered the same. Adds the "-i" flag
2536 to the "diff" command if 'diffexpr' is empty.
2537
2538 iwhite Ignore changes in amount of white space. Adds
2539 the "-b" flag to the "diff" command if
2540 'diffexpr' is empty. Check the documentation
2541 of the "diff" command for what this does
2542 exactly. It should ignore adding trailing
2543 white space, but not leading white space.
2544
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002545 horizontal Start diff mode with horizontal splits (unless
2546 explicitly specified otherwise).
2547
2548 vertical Start diff mode with vertical splits (unless
2549 explicitly specified otherwise).
2550
2551 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2552 starting diff mode. Without this 2 is used.
2553
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 Examples: >
2555
2556 :set diffopt=filler,context:4
2557 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002558 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559<
2560 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2561'digraph' 'dg' boolean (default off)
2562 global
2563 {not in Vi}
2564 {not available when compiled without the |+digraphs|
2565 feature}
2566 Enable the entering of digraphs in Insert mode with {char1} <BS>
2567 {char2}. See |digraphs|.
2568 NOTE: This option is reset when 'compatible' is set.
2569
2570 *'directory'* *'dir'*
2571'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002572 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 for Unix: ".,~/tmp,/var/tmp,/tmp")
2574 global
2575 List of directory names for the swap file, separated with commas.
2576 - The swap file will be created in the first directory where this is
2577 possible.
2578 - Empty means that no swap file will be used (recovery is
2579 impossible!).
2580 - A directory "." means to put the swap file in the same directory as
2581 the edited file. On Unix, a dot is prepended to the file name, so
2582 it doesn't show in a directory listing. On MS-Windows the "hidden"
2583 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002584 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 put the swap file relative to where the edited file is. The leading
2586 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002587 - For Unix and Win32, if a directory ends in two path separators "//"
2588 or "\\", the swap file name will be built from the complete path to
2589 the file with all path separators substituted to percent '%' signs.
2590 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002591 On Win32, when a separating comma is following, you must use "//",
2592 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 - Spaces after the comma are ignored, other spaces are considered part
2594 of the directory name. To have a space at the start of a directory
2595 name, precede it with a backslash.
2596 - To include a comma in a directory name precede it with a backslash.
2597 - A directory name may end in an ':' or '/'.
2598 - Environment variables are expanded |:set_env|.
2599 - Careful with '\' characters, type one before a space, type two to
2600 get one in the option (see |option-backslash|), for example: >
2601 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2602< - For backwards compatibility with Vim version 3.0 a '>' at the start
2603 of the option is removed.
2604 Using "." first in the list is recommended. This means that editing
2605 the same file twice will result in a warning. Using "/tmp" on Unix is
2606 discouraged: When the system crashes you lose the swap file.
2607 "/var/tmp" is often not cleared when rebooting, thus is a better
2608 choice than "/tmp". But it can contain a lot of files, your swap
2609 files get lost in the crowd. That is why a "tmp" directory in your
2610 home directory is tried first.
2611 The use of |:set+=| and |:set-=| is preferred when adding or removing
2612 directories from the list. This avoids problems when a future version
2613 uses another default.
2614 This option cannot be set from a |modeline| or in the |sandbox|, for
2615 security reasons.
2616 {Vi: directory to put temp file in, defaults to "/tmp"}
2617
2618 *'display'* *'dy'*
2619'display' 'dy' string (default "")
2620 global
2621 {not in Vi}
2622 Change the way text is displayed. This is comma separated list of
2623 flags:
2624 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002625 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 last line that doesn't fit is replaced with "@" lines.
2627 uhex Show unprintable characters hexadecimal as <xx>
2628 instead of using ^C and ~C.
2629
2630 *'eadirection'* *'ead'*
2631'eadirection' 'ead' string (default "both")
2632 global
2633 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002634 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 feature}
2636 Tells when the 'equalalways' option applies:
2637 ver vertically, width of windows is not affected
2638 hor horizontally, height of windows is not affected
2639 both width and height of windows is affected
2640
2641 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2642'edcompatible' 'ed' boolean (default off)
2643 global
2644 Makes the 'g' and 'c' flags of the ":substitute" command to be
2645 toggled each time the flag is given. See |complex-change|. See
2646 also 'gdefault' option.
2647 Switching this option on is discouraged!
2648
Bram Moolenaar03413f42016-04-12 21:07:15 +02002649 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002650'emoji' 'emo' boolean (default: on)
2651 global
2652 {not in Vi}
2653 {only available when compiled with the |+multi_byte|
2654 feature}
2655 When on all Unicode emoji characters are considered to be full width.
2656
2657
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 *'encoding'* *'enc'* *E543*
2659'encoding' 'enc' string (default: "latin1" or value from $LANG)
2660 global
2661 {only available when compiled with the |+multi_byte|
2662 feature}
2663 {not in Vi}
2664 Sets the character encoding used inside Vim. It applies to text in
2665 the buffers, registers, Strings in expressions, text stored in the
2666 viminfo file, etc. It sets the kind of characters which Vim can work
2667 with. See |encoding-names| for the possible values.
2668
2669 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002670 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002672 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673
Bram Moolenaar865242e2010-07-14 21:12:05 +02002674 This option cannot be set from a |modeline|. It would most likely
2675 corrupt the text.
2676
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2678 "utf-8". Although care has been taken to allow different values of
2679 'encoding', "utf-8" is the natural choice for the environment and
2680 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002681 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 versions, and to avoid changing the encoding of newly created files
2683 without your knowledge (in case 'fileencodings' is empty).
2684
2685 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002686 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 iconv() or as specified with 'charconvert'.
2688
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002689 If you need to know whether 'encoding' is a multi-byte encoding, you
2690 can use: >
2691 if has("multi_byte_encoding")
2692<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 Normally 'encoding' will be equal to your current locale. This will
2694 be the default if Vim recognizes your environment settings. If
2695 'encoding' is not set to the current locale, 'termencoding' must be
2696 set to convert typed and displayed text. See |encoding-table|.
2697
2698 When you set this option, it fires the |EncodingChanged| autocommand
2699 event so that you can set up fonts if necessary.
2700
2701 When the option is set, the value is converted to lowercase. Thus
2702 you can set it with uppercase values too. Underscores are translated
2703 to '-' signs.
2704 When the encoding is recognized, it is changed to the standard name.
2705 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2706 "iso-8859-2" and "utf8" becomes "utf-8".
2707
2708 Note: "latin1" is also used when the encoding could not be detected.
2709 This only works when editing files in the same encoding! When the
2710 actual character set is not latin1, make sure 'fileencoding' and
2711 'fileencodings' are empty. When conversion is needed, switch to using
2712 utf-8.
2713
2714 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2715 You don't notice this while editing, but it does matter for the
2716 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2717 setting 'encoding' to one of these values instead of utf-8 only has
2718 effect for encoding used for files when 'fileencoding' is empty.
2719
Bram Moolenaar661b1822005-07-28 22:36:45 +00002720 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2721 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722
2723 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2724'endofline' 'eol' boolean (default on)
2725 local to buffer
2726 {not in Vi}
2727 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002728 is on, or 'fixeol' option is off, no <EOL> will be written for the
2729 last line in the file. This option is automatically set or reset when
2730 starting to edit a new file, depending on whether file has an <EOL>
2731 for the last line in the file. Normally you don't have to set or
2732 reset this option.
2733 When 'binary' is off and 'fixeol' is on the value is not used when
2734 writing the file. When 'binary' is on or 'fixeol' is off it is used
2735 to remember the presence of a <EOL> for the last line in the file, so
2736 that when you write the file the situation from the original file can
2737 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738
2739 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2740'equalalways' 'ea' boolean (default on)
2741 global
2742 {not in Vi}
2743 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002744 splitting or closing a window. This also happens the moment the
2745 option is switched on. When off, splitting a window will reduce the
2746 size of the current window and leave the other windows the same. When
2747 closing a window the extra lines are given to the window next to it
2748 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 When mixing vertically and horizontally split windows, a minimal size
2750 is computed and some windows may be larger if there is room. The
2751 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002752 Changing the height and width of a window can be avoided by setting
2753 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002754 If a window size is specified when creating a new window sizes are
2755 currently not equalized (it's complicated, but may be implemented in
2756 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757
2758 *'equalprg'* *'ep'*
2759'equalprg' 'ep' string (default "")
2760 global or local to buffer |global-local|
2761 {not in Vi}
2762 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002763 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002764 or 'indentexpr'. When Vim was compiled without internal formatting,
2765 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002766 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 about including spaces and backslashes.
2768 This option cannot be set from a |modeline| or in the |sandbox|, for
2769 security reasons.
2770
2771 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2772'errorbells' 'eb' boolean (default off)
2773 global
2774 Ring the bell (beep or screen flash) for error messages. This only
2775 makes a difference for error messages, the bell will be used always
2776 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002777 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002778 screen flash or do nothing. See 'belloff' to finetune when to ring the
2779 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780
2781 *'errorfile'* *'ef'*
2782'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2783 others: "errors.err")
2784 global
2785 {not in Vi}
2786 {not available when compiled without the |+quickfix|
2787 feature}
2788 Name of the errorfile for the QuickFix mode (see |:cf|).
2789 When the "-q" command-line argument is used, 'errorfile' is set to the
2790 following argument. See |-q|.
2791 NOT used for the ":make" command. See 'makeef' for that.
2792 Environment variables are expanded |:set_env|.
2793 See |option-backslash| about including spaces and backslashes.
2794 This option cannot be set from a |modeline| or in the |sandbox|, for
2795 security reasons.
2796
2797 *'errorformat'* *'efm'*
2798'errorformat' 'efm' string (default is very long)
2799 global or local to buffer |global-local|
2800 {not in Vi}
2801 {not available when compiled without the |+quickfix|
2802 feature}
2803 Scanf-like description of the format for the lines in the error file
2804 (see |errorformat|).
2805
2806 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2807'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2808 global
2809 {not in Vi}
2810 Function keys that start with an <Esc> are recognized in Insert
2811 mode. When this option is off, the cursor and function keys cannot be
2812 used in Insert mode if they start with an <Esc>. The advantage of
2813 this is that the single <Esc> is recognized immediately, instead of
2814 after one second. Instead of resetting this option, you might want to
2815 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2816 when 'esckeys' is off, you can still map anything, but the cursor keys
2817 won't work by default.
2818 NOTE: This option is set to the Vi default value when 'compatible' is
2819 set and to the Vim default value when 'compatible' is reset.
2820
2821 *'eventignore'* *'ei'*
2822'eventignore' 'ei' string (default "")
2823 global
2824 {not in Vi}
2825 {not available when compiled without the |+autocmd|
2826 feature}
2827 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002828 When set to "all" or when "all" is one of the items, all autocommand
2829 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 Otherwise this is a comma separated list of event names. Example: >
2831 :set ei=WinEnter,WinLeave
2832<
2833 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2834'expandtab' 'et' boolean (default off)
2835 local to buffer
2836 {not in Vi}
2837 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2840 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002841 This option is reset when the 'paste' option is set and restored when
2842 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 NOTE: This option is reset when 'compatible' is set.
2844
2845 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2846'exrc' 'ex' boolean (default off)
2847 global
2848 {not in Vi}
2849 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2850 directory. If you switch this option on you should also consider
2851 setting the 'secure' option (see |initialization|). Using a local
2852 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2853 also see |.vimrc| and |gui-init|.
2854 This option cannot be set from a |modeline| or in the |sandbox|, for
2855 security reasons.
2856
2857 *'fileencoding'* *'fenc'* *E213*
2858'fileencoding' 'fenc' string (default: "")
2859 local to buffer
2860 {only available when compiled with the |+multi_byte|
2861 feature}
2862 {not in Vi}
2863 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002864
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002866 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 When 'fileencoding' is empty, the same value as 'encoding' will be
2868 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002869 Conversion will also be done when 'encoding' and 'fileencoding' are
2870 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2871 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002873 'encoding' is "utf-8" or another Unicode encoding, conversion
2874 is most likely done in a way that the reverse conversion
2875 results in the same text. When 'encoding' is not "utf-8" some
2876 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002877
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 See 'encoding' for the possible values. Additionally, values may be
2879 specified that can be handled by the converter, see
2880 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002881
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 When reading a file 'fileencoding' will be set from 'fileencodings'.
2883 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002884 'fileencoding', use the |++enc| argument. One exception: when
2885 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002886 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002887
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2889 When the option is set, the value is converted to lowercase. Thus
2890 you can set it with uppercase values too. '_' characters are
2891 replaced with '-'. If a name is recognized from the list for
2892 'encoding', it is replaced by the standard name. For example
2893 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 When this option is set, after starting to edit a file, the 'modified'
2896 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002897
2898 Keep in mind that changing 'fenc' from a modeline happens
2899 AFTER the text has been read, thus it applies to when the file will be
2900 written. If you do set 'fenc' in a modeline, you might want to set
2901 'nomodified' to avoid not being able to ":q".
2902
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 This option can not be changed when 'modifiable' is off.
2904
2905 *'fe'*
2906 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 old short name was 'fe', which is no longer used.
2909
2910 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002911'fileencodings' 'fencs' string (default: "ucs-bom",
2912 "ucs-bom,utf-8,default,latin1" when
2913 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 global
2915 {only available when compiled with the |+multi_byte|
2916 feature}
2917 {not in Vi}
2918 This is a list of character encodings considered when starting to edit
2919 an existing file. When a file is read, Vim tries to use the first
2920 mentioned character encoding. If an error is detected, the next one
2921 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002922 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 an empty string, which means the value of 'encoding' is used.
2924 WARNING: Conversion can cause loss of information! When
2925 'encoding' is "utf-8" (or one of the other Unicode variants)
2926 conversion is most likely done in a way that the reverse
2927 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002928 "utf-8" some non-ASCII characters may be lost! You can use
2929 the |++bad| argument to specify what is done with characters
2930 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 For an empty file or a file with only ASCII characters most encodings
2932 will work and the first entry of 'fileencodings' will be used (except
2933 "ucs-bom", which requires the BOM to be present). If you prefer
2934 another encoding use an BufReadPost autocommand event to test if your
2935 preferred encoding is to be used. Example: >
2936 au BufReadPost * if search('\S', 'w') == 0 |
2937 \ set fenc=iso-2022-jp | endif
2938< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2939 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002940 When the |++enc| argument is used then the value of 'fileencodings' is
2941 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002942 Note that 'fileencodings' is not used for a new file, the global value
2943 of 'fileencoding' is used instead. You can set it with: >
2944 :setglobal fenc=iso-8859-2
2945< This means that a non-existing file may get a different encoding than
2946 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 The special value "ucs-bom" can be used to check for a Unicode BOM
2948 (Byte Order Mark) at the start of the file. It must not be preceded
2949 by "utf-8" or another Unicode encoding for this to work properly.
2950 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2951 because Vim cannot detect an error, thus the encoding is always
2952 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002953 The special value "default" can be used for the encoding from the
2954 environment. This is the default value for 'encoding'. It is useful
2955 when 'encoding' is set to "utf-8" and your environment uses a
2956 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002957 When 'encoding' is "utf-8" and a file contains an illegal byte
2958 sequence it won't be recognized as UTF-8. You can use the |8g8|
2959 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 WRONG VALUES: WHAT'S WRONG:
2961 latin1,utf-8 "latin1" will always be used
2962 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2963 file
2964 cp1250,latin1 "cp1250" will always be used
2965 If 'fileencodings' is empty, 'fileencoding' is not modified.
2966 See 'fileencoding' for the possible values.
2967 Setting this option does not have an effect until the next time a file
2968 is read.
2969
2970 *'fileformat'* *'ff'*
2971'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2972 Unix default: "unix",
2973 Macintosh default: "mac")
2974 local to buffer
2975 {not in Vi}
2976 This gives the <EOL> of the current buffer, which is used for
2977 reading/writing the buffer from/to a file:
2978 dos <CR> <NL>
2979 unix <NL>
2980 mac <CR>
2981 When "dos" is used, CTRL-Z at the end of a file is ignored.
2982 See |file-formats| and |file-read|.
2983 For the character encoding of the file see 'fileencoding'.
2984 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002985 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 This option is set automatically when starting to edit a file and
2987 'fileformats' is not empty and 'binary' is off.
2988 When this option is set, after starting to edit a file, the 'modified'
2989 option is set, because the file would be different when written.
2990 This option can not be changed when 'modifiable' is off.
2991 For backwards compatibility: When this option is set to "dos",
2992 'textmode' is set, otherwise 'textmode' is reset.
2993
2994 *'fileformats'* *'ffs'*
2995'fileformats' 'ffs' string (default:
2996 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2997 Vim Unix: "unix,dos",
2998 Vim Mac: "mac,unix,dos",
2999 Vi Cygwin: "unix,dos",
3000 Vi others: "")
3001 global
3002 {not in Vi}
3003 This gives the end-of-line (<EOL>) formats that will be tried when
3004 starting to edit a new buffer and when reading a file into an existing
3005 buffer:
3006 - When empty, the format defined with 'fileformat' will be used
3007 always. It is not set automatically.
3008 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003009 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 'fileformats' name will be used when a file is read into an existing
3011 buffer, no matter what 'fileformat' for that buffer is set to.
3012 - When more than one name is present, separated by commas, automatic
3013 <EOL> detection will be done when reading a file. When starting to
3014 edit a file, a check is done for the <EOL>:
3015 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3016 'fileformat' is set to "dos".
3017 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003020 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3021 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003022 This means that "mac" is only chosen when:
3023 "unix" is not present or no <NL> is found in the file, and
3024 "dos" is not present or no <CR><NL> is found in the file.
3025 Except: if "unix" was chosen, but there is a <CR> before
3026 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003027 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 4. If 'fileformat' is still not set, the first name from
3029 'fileformats' is used.
3030 When reading a file into an existing buffer, the same is done, but
3031 this happens like 'fileformat' has been set appropriately for that
3032 file only, the option is not changed.
3033 When 'binary' is set, the value of 'fileformats' is not used.
3034
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003035 When Vim starts up with an empty buffer the first item is used. You
3036 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003037
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3039 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3040 done:
3041 - When 'fileformats' is empty, there is no automatic detection. Dos
3042 format will be used.
3043 - When 'fileformats' is set to one or more names, automatic detection
3044 is done. This is based on the first <NL> in the file: If there is a
3045 <CR> in front of it, Dos format is used, otherwise Unix format is
3046 used.
3047 Also see |file-formats|.
3048 For backwards compatibility: When this option is set to an empty
3049 string or one format (no comma is included), 'textauto' is reset,
3050 otherwise 'textauto' is set.
3051 NOTE: This option is set to the Vi default value when 'compatible' is
3052 set and to the Vim default value when 'compatible' is reset.
3053
Bram Moolenaarbf884932013-04-05 22:26:15 +02003054 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3055'fileignorecase' 'fic' boolean (default on for systems where case in file
3056 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003057 global
3058 {not in Vi}
3059 When set case is ignored when using file names and directories.
3060 See 'wildignorecase' for only ignoring case when doing completion.
3061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 *'filetype'* *'ft'*
3063'filetype' 'ft' string (default: "")
3064 local to buffer
3065 {not in Vi}
3066 {not available when compiled without the |+autocmd|
3067 feature}
3068 When this option is set, the FileType autocommand event is triggered.
3069 All autocommands that match with the value of this option will be
3070 executed. Thus the value of 'filetype' is used in place of the file
3071 name.
3072 Otherwise this option does not always reflect the current file type.
3073 This option is normally set when the file type is detected. To enable
3074 this use the ":filetype on" command. |:filetype|
3075 Setting this option to a different value is most useful in a modeline,
3076 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003077 Example, for in an IDL file:
3078 /* vim: set filetype=idl : */ ~
3079 |FileType| |filetypes|
3080 When a dot appears in the value then this separates two filetype
3081 names. Example:
3082 /* vim: set filetype=c.doxygen : */ ~
3083 This will use the "c" filetype first, then the "doxygen" filetype.
3084 This works both for filetype plugins and for syntax files. More than
3085 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 This option is not copied to another buffer, independent of the 's' or
3087 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003088 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003089
3090 *'fillchars'* *'fcs'*
3091'fillchars' 'fcs' string (default "vert:|,fold:-")
3092 global
3093 {not in Vi}
3094 {not available when compiled without the |+windows|
3095 and |+folding| features}
3096 Characters to fill the statuslines and vertical separators.
3097 It is a comma separated list of items:
3098
3099 item default Used for ~
3100 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003101 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 vert:c '|' vertical separators |:vsplit|
3103 fold:c '-' filling 'foldtext'
3104 diff:c '-' deleted lines of the 'diff' option
3105
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003106 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003107 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 otherwise.
3109
3110 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003111 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112< This is similar to the default, except that these characters will also
3113 be used when there is highlighting.
3114
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003115 for "stl" and "stlnc" only single-byte values are supported.
3116
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 The highlighting used for these items:
3118 item highlight group ~
3119 stl:c StatusLine |hl-StatusLine|
3120 stlnc:c StatusLineNC |hl-StatusLineNC|
3121 vert:c VertSplit |hl-VertSplit|
3122 fold:c Folded |hl-Folded|
3123 diff:c DiffDelete |hl-DiffDelete|
3124
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003125 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3126'fixendofline' 'fixeol' boolean (default on)
3127 local to buffer
3128 {not in Vi}
3129 When writing a file and this option is on, <EOL> at the end of file
3130 will be restored if missing. Turn this option off if you want to
3131 preserve the situation from the original file.
3132 When the 'binary' option is set the value of this option doesn't
3133 matter.
3134 See the 'endofline' option.
3135
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3137'fkmap' 'fk' boolean (default off) *E198*
3138 global
3139 {not in Vi}
3140 {only available when compiled with the |+rightleft|
3141 feature}
3142 When on, the keyboard is mapped for the Farsi character set.
3143 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003144 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145
3146 *'foldclose'* *'fcl'*
3147'foldclose' 'fcl' string (default "")
3148 global
3149 {not in Vi}
3150 {not available when compiled without the |+folding|
3151 feature}
3152 When set to "all", a fold is closed when the cursor isn't in it and
3153 its level is higher than 'foldlevel'. Useful if you want folds to
3154 automatically close when moving out of them.
3155
3156 *'foldcolumn'* *'fdc'*
3157'foldcolumn' 'fdc' number (default 0)
3158 local to window
3159 {not in Vi}
3160 {not available when compiled without the |+folding|
3161 feature}
3162 When non-zero, a column with the specified width is shown at the side
3163 of the window which indicates open and closed folds. The maximum
3164 value is 12.
3165 See |folding|.
3166
3167 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3168'foldenable' 'fen' boolean (default on)
3169 local to window
3170 {not in Vi}
3171 {not available when compiled without the |+folding|
3172 feature}
3173 When off, all folds are open. This option can be used to quickly
3174 switch between showing all text unfolded and viewing the text with
3175 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003176 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 'foldenable' is off.
3178 This option is set by commands that create a new fold or close a fold.
3179 See |folding|.
3180
3181 *'foldexpr'* *'fde'*
3182'foldexpr' 'fde' string (default: "0")
3183 local to window
3184 {not in Vi}
3185 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003186 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003188 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003189
Bram Moolenaar30b65812012-07-12 22:01:11 +02003190 The expression will be evaluated in the |sandbox| if set from a
3191 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003192 This option can't be set from a |modeline| when the 'diff' option is
3193 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003194
3195 It is not allowed to change text or jump to another window while
3196 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197
3198 *'foldignore'* *'fdi'*
3199'foldignore' 'fdi' string (default: "#")
3200 local to window
3201 {not in Vi}
3202 {not available when compiled without the |+folding|
3203 feature}
3204 Used only when 'foldmethod' is "indent". Lines starting with
3205 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003206 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 The default "#" works well for C programs. See |fold-indent|.
3208
3209 *'foldlevel'* *'fdl'*
3210'foldlevel' 'fdl' number (default: 0)
3211 local to window
3212 {not in Vi}
3213 {not available when compiled without the |+folding|
3214 feature}
3215 Sets the fold level: Folds with a higher level will be closed.
3216 Setting this option to zero will close all folds. Higher numbers will
3217 close fewer folds.
3218 This option is set by commands like |zm|, |zM| and |zR|.
3219 See |fold-foldlevel|.
3220
3221 *'foldlevelstart'* *'fdls'*
3222'foldlevelstart' 'fdls' number (default: -1)
3223 global
3224 {not in Vi}
3225 {not available when compiled without the |+folding|
3226 feature}
3227 Sets 'foldlevel' when starting to edit another buffer in a window.
3228 Useful to always start editing with all folds closed (value zero),
3229 some folds closed (one) or no folds closed (99).
3230 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 ignores this option and closes all folds.
3233 It is also done before BufReadPre autocommands, to allow an autocmd to
3234 overrule the 'foldlevel' value for specific files.
3235 When the value is negative, it is not used.
3236
3237 *'foldmarker'* *'fmr'* *E536*
3238'foldmarker' 'fmr' string (default: "{{{,}}}")
3239 local to window
3240 {not in Vi}
3241 {not available when compiled without the |+folding|
3242 feature}
3243 The start and end marker used when 'foldmethod' is "marker". There
3244 must be one comma, which separates the start and end marker. The
3245 marker is a literal string (a regular expression would be too slow).
3246 See |fold-marker|.
3247
3248 *'foldmethod'* *'fdm'*
3249'foldmethod' 'fdm' string (default: "manual")
3250 local to window
3251 {not in Vi}
3252 {not available when compiled without the |+folding|
3253 feature}
3254 The kind of folding used for the current window. Possible values:
3255 |fold-manual| manual Folds are created manually.
3256 |fold-indent| indent Lines with equal indent form a fold.
3257 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3258 |fold-marker| marker Markers are used to specify folds.
3259 |fold-syntax| syntax Syntax highlighting items specify folds.
3260 |fold-diff| diff Fold text that is not changed.
3261
3262 *'foldminlines'* *'fml'*
3263'foldminlines' 'fml' number (default: 1)
3264 local to window
3265 {not in Vi}
3266 {not available when compiled without the |+folding|
3267 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003268 Sets the number of screen lines above which a fold can be displayed
3269 closed. Also for manually closed folds. With the default value of
3270 one a fold can only be closed if it takes up two or more screen lines.
3271 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003272 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 "zc" to close a fold, which is displayed open because it's smaller
3274 than 'foldminlines', a following "zc" may close a containing fold.
3275
3276 *'foldnestmax'* *'fdn'*
3277'foldnestmax' 'fdn' number (default: 20)
3278 local to window
3279 {not in Vi}
3280 {not available when compiled without the |+folding|
3281 feature}
3282 Sets the maximum nesting of folds for the "indent" and "syntax"
3283 methods. This avoids that too many folds will be created. Using more
3284 than 20 doesn't work, because the internal limit is 20.
3285
3286 *'foldopen'* *'fdo'*
3287'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3288 search,tag,undo")
3289 global
3290 {not in Vi}
3291 {not available when compiled without the |+folding|
3292 feature}
3293 Specifies for which type of commands folds will be opened, if the
3294 command moves the cursor into a closed fold. It is a comma separated
3295 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003296 NOTE: When the command is part of a mapping this option is not used.
3297 Add the |zv| command to the mapping to get the same effect.
3298 (rationale: the mapping may want to control opening folds itself)
3299
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 item commands ~
3301 all any
3302 block "(", "{", "[[", "[{", etc.
3303 hor horizontal movements: "l", "w", "fx", etc.
3304 insert any command in Insert mode
3305 jump far jumps: "G", "gg", etc.
3306 mark jumping to a mark: "'m", CTRL-O, etc.
3307 percent "%"
3308 quickfix ":cn", ":crew", ":make", etc.
3309 search search for a pattern: "/", "n", "*", "gd", etc.
3310 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003311 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 tag jumping to a tag: ":ta", CTRL-T, etc.
3313 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 When a movement command is used for an operator (e.g., "dl" or "y%")
3315 this option is not used. This means the operator will include the
3316 whole closed fold.
3317 Note that vertical movements are not here, because it would make it
3318 very difficult to move onto a closed fold.
3319 In insert mode the folds containing the cursor will always be open
3320 when text is inserted.
3321 To close folds you can re-apply 'foldlevel' with the |zx| command or
3322 set the 'foldclose' option to "all".
3323
3324 *'foldtext'* *'fdt'*
3325'foldtext' 'fdt' string (default: "foldtext()")
3326 local to window
3327 {not in Vi}
3328 {not available when compiled without the |+folding|
3329 feature}
3330 An expression which is used to specify the text displayed for a closed
3331 fold. See |fold-foldtext|.
3332
Bram Moolenaar30b65812012-07-12 22:01:11 +02003333 The expression will be evaluated in the |sandbox| if set from a
3334 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003335
3336 It is not allowed to change text or jump to another window while
3337 evaluating 'foldtext' |textlock|.
3338
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 *'formatoptions'* *'fo'*
3340'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3341 local to buffer
3342 {not in Vi}
3343 This is a sequence of letters which describes how automatic
3344 formatting is to be done. See |fo-table|. When the 'paste' option is
3345 on, no formatting is done (like 'formatoptions' is empty). Commas can
3346 be inserted for readability.
3347 To avoid problems with flags that are added in the future, use the
3348 "+=" and "-=" feature of ":set" |add-option-flags|.
3349 NOTE: This option is set to the Vi default value when 'compatible' is
3350 set and to the Vim default value when 'compatible' is reset.
3351
Bram Moolenaar86b68352004-12-27 21:59:20 +00003352 *'formatlistpat'* *'flp'*
3353'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3354 local to buffer
3355 {not in Vi}
3356 A pattern that is used to recognize a list header. This is used for
3357 the "n" flag in 'formatoptions'.
3358 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003359 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003360 while still checking more characters. There must be a character
3361 following the pattern, when it matches the whole line it is handled
3362 like there is no match.
3363 The default recognizes a number, followed by an optional punctuation
3364 character and white space.
3365
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 *'formatprg'* *'fp'*
3367'formatprg' 'fp' string (default "")
3368 global
3369 {not in Vi}
3370 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003371 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003373 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003374 If the 'formatexpr' option is not empty it will be used instead.
3375 Otherwise, if 'formatprg' option is an empty string, the internal
3376 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003377 Environment variables are expanded |:set_env|. See |option-backslash|
3378 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003379 This option cannot be set from a |modeline| or in the |sandbox|, for
3380 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003382 *'formatexpr'* *'fex'*
3383'formatexpr' 'fex' string (default "")
3384 local to buffer
3385 {not in Vi}
3386 {not available when compiled without the |+eval|
3387 feature}
3388 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003389 operator or automatic formatting (see 'formatoptions'). When this
3390 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003391
3392 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003393 The |v:count| variable holds the number of lines to be formatted.
3394 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003395 inserted if the expression is being evaluated due to
3396 automatic formatting. This can be empty. Don't insert
3397 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003398
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003399 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003400 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003401< This will invoke the mylang#Format() function in the
3402 autoload/mylang.vim file in 'runtimepath'. |autoload|
3403
3404 The expression is also evaluated when 'textwidth' is set and adding
3405 text beyond that limit. This happens under the same conditions as
3406 when internal formatting is used. Make sure the cursor is kept in the
3407 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003408 return "i" or "R" in this situation.
3409
3410 When the expression evaluates to non-zero Vim will fall back to using
3411 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003412
Bram Moolenaar30b65812012-07-12 22:01:11 +02003413 The expression will be evaluated in the |sandbox| when set from a
3414 modeline, see |sandbox-option|. That stops the option from working,
3415 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003416
Bram Moolenaard94464e2015-11-02 15:28:18 +01003417 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003418'fsync' 'fs' boolean (default on)
3419 global
3420 {not in Vi}
3421 When on, the library function fsync() will be called after writing a
3422 file. This will flush a file to disk, ensuring that it is safely
3423 written even on filesystems which do metadata-only journaling. This
3424 will force the harddrive to spin up on Linux systems running in laptop
3425 mode, so it may be undesirable in some situations. Be warned that
3426 turning this off increases the chances of data loss after a crash. On
3427 systems without an fsync() implementation, this variable is always
3428 off.
3429 Also see 'swapsync' for controlling fsync() on swap files.
3430
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3432'gdefault' 'gd' boolean (default off)
3433 global
3434 {not in Vi}
3435 When on, the ":substitute" flag 'g' is default on. This means that
3436 all matches in a line are substituted instead of one. When a 'g' flag
3437 is given to a ":substitute" command, this will toggle the substitution
3438 of all or one match. See |complex-change|.
3439
3440 command 'gdefault' on 'gdefault' off ~
3441 :s/// subst. all subst. one
3442 :s///g subst. one subst. all
3443 :s///gg subst. all subst. one
3444
3445 NOTE: This option is reset when 'compatible' is set.
3446
3447 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003448'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 global
3450 {not in Vi}
3451 Format to recognize for the ":grep" command output.
3452 This is a scanf-like string that uses the same format as the
3453 'errorformat' option: see |errorformat|.
3454
3455 *'grepprg'* *'gp'*
3456'grepprg' 'gp' string (default "grep -n ",
3457 Unix: "grep -n $* /dev/null",
3458 Win32: "findstr /n" or "grep -n",
3459 VMS: "SEARCH/NUMBERS ")
3460 global or local to buffer |global-local|
3461 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003462 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003463 and '#' characters, which are expanded like when used in a command-
3464 line. The placeholder "$*" is allowed to specify where the arguments
3465 will be included. Environment variables are expanded |:set_env|. See
3466 |option-backslash| about including spaces and backslashes.
3467 When your "grep" accepts the "-H" argument, use this to make ":grep"
3468 also work well with a single file: >
3469 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003470< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003471 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3472 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003473 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 apply equally to 'grepprg'.
3475 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3476 otherwise it's "grep -n".
3477 This option cannot be set from a |modeline| or in the |sandbox|, for
3478 security reasons.
3479
3480 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3481'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3482 ve:ver35-Cursor,
3483 o:hor50-Cursor,
3484 i-ci:ver25-Cursor/lCursor,
3485 r-cr:hor20-Cursor/lCursor,
3486 sm:block-Cursor
3487 -blinkwait175-blinkoff150-blinkon175",
3488 for MS-DOS and Win32 console:
3489 "n-v-c:block,o:hor50,i-ci:hor15,
3490 r-cr:hor30,sm:block")
3491 global
3492 {not in Vi}
3493 {only available when compiled with GUI enabled, and
3494 for MS-DOS and Win32 console}
3495 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003496 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 the height of the cursor can be changed. This can be done by
3498 specifying a block cursor, or a percentage for a vertical or
3499 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003500 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3501 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 mode-list and an argument-list:
3505 mode-list:argument-list,mode-list:argument-list,..
3506 The mode-list is a dash separated list of these modes:
3507 n Normal mode
3508 v Visual mode
3509 ve Visual mode with 'selection' "exclusive" (same as 'v',
3510 if not specified)
3511 o Operator-pending mode
3512 i Insert mode
3513 r Replace mode
3514 c Command-line Normal (append) mode
3515 ci Command-line Insert mode
3516 cr Command-line Replace mode
3517 sm showmatch in Insert mode
3518 a all modes
3519 The argument-list is a dash separated list of these arguments:
3520 hor{N} horizontal bar, {N} percent of the character height
3521 ver{N} vertical bar, {N} percent of the character width
3522 block block cursor, fills the whole character
3523 [only one of the above three should be present]
3524 blinkwait{N} *cursor-blinking*
3525 blinkon{N}
3526 blinkoff{N}
3527 blink times for cursor: blinkwait is the delay before
3528 the cursor starts blinking, blinkon is the time that
3529 the cursor is shown and blinkoff is the time that the
3530 cursor is not shown. The times are in msec. When one
3531 of the numbers is zero, there is no blinking. The
3532 default is: "blinkwait700-blinkon400-blinkoff250".
3533 These numbers are used for a missing entry. This
3534 means that blinking is enabled by default. To switch
3535 blinking off you can use "blinkon0". The cursor only
3536 blinks when Vim is waiting for input, not while
3537 executing a command.
3538 To make the cursor blink in an xterm, see
3539 |xterm-blink|.
3540 {group-name}
3541 a highlight group name, that sets the color and font
3542 for the cursor
3543 {group-name}/{group-name}
3544 Two highlight group names, the first is used when
3545 no language mappings are used, the other when they
3546 are. |language-mapping|
3547
3548 Examples of parts:
3549 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3550 block cursor with colors from the "nCursor"
3551 highlight group
3552 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3553 In Insert and Command-line Insert mode, use a
3554 30% vertical bar cursor with colors from the
3555 "iCursor" highlight group. Blink a bit
3556 faster.
3557
3558 The 'a' mode is different. It will set the given argument-list for
3559 all modes. It does not reset anything to defaults. This can be used
3560 to do a common setting for all modes. For example, to switch off
3561 blinking: "a:blinkon0"
3562
3563 Examples of cursor highlighting: >
3564 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3565 :highlight Cursor gui=NONE guifg=bg guibg=fg
3566<
3567 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003568 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569'guifont' 'gfn' string (default "")
3570 global
3571 {not in Vi}
3572 {only available when compiled with GUI enabled}
3573 This is a list of fonts which will be used for the GUI version of Vim.
3574 In its simplest form the value is just one font name. When
3575 the font cannot be found you will get an error message. To try other
3576 font names a list can be specified, font names separated with commas.
3577 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003578
Bram Moolenaar05159a02005-02-26 23:04:13 +00003579 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3580 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003581
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 Spaces after a comma are ignored. To include a comma in a font name
3583 precede it with a backslash. Setting an option requires an extra
3584 backslash before a space and a backslash. See also
3585 |option-backslash|. For example: >
3586 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003587< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003589
3590 If none of the fonts can be loaded, Vim will keep the current setting.
3591 If an empty font list is given, Vim will try using other resource
3592 settings (for X, it will use the Vim.font resource), and finally it
3593 will try some builtin default which should always be there ("7x13" in
3594 the case of X). The font names given should be "normal" fonts. Vim
3595 will try to find the related bold and italic fonts.
3596
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003597 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003598 :set guifont=*
3599< will bring up a font requester, where you can pick the font you want.
3600
3601 The font name depends on the GUI used. See |setting-guifont| for a
3602 way to set 'guifont' for various systems.
3603
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 For the GTK+ 2 GUI the font name looks like this: >
3605 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003606< That's all. XLFDs are not used. For Chinese this is reported to work
3607 well: >
3608 if has("gui_gtk2")
3609 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3610 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3611 endif
3612<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003613 For Mac OSX you can use something like this: >
3614 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003615< Also see 'macatsui', it can help fix display problems.
3616 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003618 width). An exception is GTK 2: all fonts are accepted, but
3619 mono-spaced fonts look best.
3620
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 To preview a font on X11, you might be able to use the "xfontsel"
3622 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003623
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 For the Win32 GUI *E244* *E245*
3625 - takes these options in the font name:
3626 hXX - height is XX (points, can be floating-point)
3627 wXX - width is XX (points, can be floating-point)
3628 b - bold
3629 i - italic
3630 u - underline
3631 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003632 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3634 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3635 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003636 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003637 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003638 ANTIALIASED, UNANTIALIASED, CLEARTYPE, DEFAULT.
3639 Normally you would use "qDEFAULT".
3640 Some quality values isn't supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641
3642 Use a ':' to separate the options.
3643 - A '_' can be used in the place of a space, so you don't need to use
3644 backslashes to escape the spaces.
3645 - Examples: >
3646 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3647 :set guifont=Andale_Mono:h7.5:w4.5
3648< See also |font-sizes|.
3649
3650 *'guifontset'* *'gfs'*
3651 *E250* *E252* *E234* *E597* *E598*
3652'guifontset' 'gfs' string (default "")
3653 global
3654 {not in Vi}
3655 {only available when compiled with GUI enabled and
3656 with the |+xfontset| feature}
3657 {not available in the GTK+ 2 GUI}
3658 When not empty, specifies two (or more) fonts to be used. The first
3659 one for normal English, the second one for your special language. See
3660 |xfontset|.
3661 Setting this option also means that all font names will be handled as
3662 a fontset name. Also the ones used for the "font" argument of the
3663 |:highlight| command.
3664 The fonts must match with the current locale. If fonts for the
3665 character sets that the current locale uses are not included, setting
3666 'guifontset' will fail.
3667 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3668 the comma-separated names are alternative names, one of which will be
3669 used. In 'guifontset' the whole string is one fontset name,
3670 including the commas. It is not possible to specify alternative
3671 fontset names.
3672 This example works on many X11 systems: >
3673 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3674<
3675 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3676'guifontwide' 'gfw' string (default "")
3677 global
3678 {not in Vi}
3679 {only available when compiled with GUI enabled}
3680 When not empty, specifies a comma-separated list of fonts to be used
3681 for double-width characters. The first font that can be loaded is
3682 used.
3683 Note: The size of these fonts must be exactly twice as wide as the one
3684 specified with 'guifont' and the same height.
3685
3686 All GUI versions but GTK+ 2:
3687
3688 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3689 'guifontset' is empty or invalid.
3690 When 'guifont' is set and a valid font is found in it and
3691 'guifontwide' is empty Vim will attempt to find a matching
3692 double-width font and set 'guifontwide' to it.
3693
3694 GTK+ 2 GUI only: *guifontwide_gtk2*
3695
3696 If set and valid, 'guifontwide' is always used for double width
3697 characters, even if 'encoding' is not set to "utf-8".
3698 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003699 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 font for characters not available in 'guifont'. Thus you do not need
3701 to set 'guifontwide' at all unless you want to override the choice
3702 made by Pango/Xft.
3703
Bram Moolenaar0f272122013-01-23 18:37:40 +01003704 Windows +multibyte only: *guifontwide_win_mbyte*
3705
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003706 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003707
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 *'guiheadroom'* *'ghr'*
3709'guiheadroom' 'ghr' number (default 50)
3710 global
3711 {not in Vi} {only for GTK and X11 GUI}
3712 The number of pixels subtracted from the screen height when fitting
3713 the GUI window on the screen. Set this before the GUI is started,
3714 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003715 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 lines will be left for window decorations and other items on the
3717 screen. Set it to a negative value to allow windows taller than the
3718 screen.
3719
3720 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003721'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3722 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 global
3724 {not in Vi}
3725 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003726 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 sequence of letters which describes what components and options of the
3728 GUI should be used.
3729 To avoid problems with flags that are added in the future, use the
3730 "+=" and "-=" feature of ":set" |add-option-flags|.
3731
3732 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003733 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 'a' Autoselect: If present, then whenever VISUAL mode is started,
3735 or the Visual area extended, Vim tries to become the owner of
3736 the windowing system's global selection. This means that the
3737 Visually highlighted text is available for pasting into other
3738 applications as well as into Vim itself. When the Visual mode
3739 ends, possibly due to an operation on the text, or when an
3740 application wants to paste the selection, the highlighted text
3741 is automatically yanked into the "* selection register.
3742 Thus the selection is still available for pasting into other
3743 applications after the VISUAL mode has ended.
3744 If not present, then Vim won't become the owner of the
3745 windowing system's global selection unless explicitly told to
3746 by a yank or delete operation for the "* register.
3747 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003748 *'go-P'*
3749 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003750 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003751 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 applies to the modeless selection.
3754
3755 'guioptions' autoselect Visual autoselect modeless ~
3756 "" - -
3757 "a" yes yes
3758 "A" - yes
3759 "aA" yes yes
3760
Bram Moolenaar02467872007-05-06 13:22:01 +00003761 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 'c' Use console dialogs instead of popup dialogs for simple
3763 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003764 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003765 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003766 'guitablabel' can be used to change the text in the labels.
3767 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003768 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003769 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003770 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 'f' Foreground: Don't use fork() to detach the GUI from the shell
3772 where it was started. Use this for programs that wait for the
3773 editor to finish (e.g., an e-mail program). Alternatively you
3774 can use "gvim -f" or ":gui -f" to start the GUI in the
3775 foreground. |gui-fork|
3776 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003777 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3780 corner of the window. It's black&white on non-GTK, because of
3781 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003782 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003784 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003785 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003787 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 file is sourced the system menu has already been loaded; the
3789 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003790 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 'g' Grey menu items: Make menu items that are not active grey. If
3792 'g' is not included inactive menu items are not shown at all.
3793 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003794 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 't' Include tearoff menu items. Currently only works for Win32,
3796 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003797 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003798 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003799 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003800 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003802 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'R' Right-hand scrollbar is present when there is a vertically
3804 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003807 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 'L' Left-hand scrollbar is present when there is a vertically
3809 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003810 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3812 the longest visible line, or on the cursor line if the 'h'
3813 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003814 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 'h' Limit horizontal scrollbar size to the length of the cursor
3816 line. Reduces computations. |gui-horiz-scroll|
3817
3818 And yes, you may even have scrollbars on the left AND the right if
3819 you really want to :-). See |gui-scrollbars| for more information.
3820
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003821 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'v' Use a vertical button layout for dialogs. When not included,
3823 a horizontal layout is preferred, but when it doesn't fit a
3824 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003825 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'p' Use Pointer callbacks for X11 GUI. This is required for some
3827 window managers. If the cursor is not blinking or hollow at
3828 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003829 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003831 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003832 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833
Bram Moolenaar02467872007-05-06 13:22:01 +00003834
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 *'guipty'* *'noguipty'*
3836'guipty' boolean (default on)
3837 global
3838 {not in Vi}
3839 {only available when compiled with GUI enabled}
3840 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3841 I/O to/from shell commands. See |gui-pty|.
3842
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843 *'guitablabel'* *'gtl'*
3844'guitablabel' 'gtl' string (default empty)
3845 global
3846 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003847 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003848 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003849 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003850 pages line. When empty and when the result is empty Vim will use a
3851 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003852
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003853 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003854 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003855
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003856 Only used when the GUI tab pages line is displayed. 'e' must be
3857 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3858 used.
3859
Bram Moolenaar57657d82006-04-21 22:12:41 +00003860 *'guitabtooltip'* *'gtt'*
3861'guitabtooltip' 'gtt' string (default empty)
3862 global
3863 {not in Vi}
3864 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003865 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003866 When nonempty describes the text to use in a tooltip for the GUI tab
3867 pages line. When empty Vim will use a default tooltip.
3868 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003869 You can include a line break. Simplest method is to use |:let|: >
3870 :let &guitabtooltip = "line one\nline two"
3871<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003872
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 *'helpfile'* *'hf'*
3874'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3875 (others) "$VIMRUNTIME/doc/help.txt")
3876 global
3877 {not in Vi}
3878 Name of the main help file. All distributed help files should be
3879 placed together in one directory. Additionally, all "doc" directories
3880 in 'runtimepath' will be used.
3881 Environment variables are expanded |:set_env|. For example:
3882 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003883 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 spaces and backslashes.
3885 This option cannot be set from a |modeline| or in the |sandbox|, for
3886 security reasons.
3887
3888 *'helpheight'* *'hh'*
3889'helpheight' 'hh' number (default 20)
3890 global
3891 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003892 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 feature}
3894 Minimal initial height of the help window when it is opened with the
3895 ":help" command. The initial height of the help window is half of the
3896 current window, or (when the 'ea' option is on) the same as other
3897 windows. When the height is less than 'helpheight', the height is
3898 set to 'helpheight'. Set to zero to disable.
3899
3900 *'helplang'* *'hlg'*
3901'helplang' 'hlg' string (default: messages language or empty)
3902 global
3903 {only available when compiled with the |+multi_lang|
3904 feature}
3905 {not in Vi}
3906 Comma separated list of languages. Vim will use the first language
3907 for which the desired help can be found. The English help will always
3908 be used as a last resort. You can add "en" to prefer English over
3909 another language, but that will only find tags that exist in that
3910 language and not in the English help.
3911 Example: >
3912 :set helplang=de,it
3913< This will first search German, then Italian and finally English help
3914 files.
3915 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3916 try to find the tag in the current language before using this option.
3917 See |help-translated|.
3918
3919 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3920'hidden' 'hid' boolean (default off)
3921 global
3922 {not in Vi}
3923 When off a buffer is unloaded when it is |abandon|ed. When on a
3924 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3925 displayed in another window, it does not become hidden, of course.
3926 The commands that move through the buffer list sometimes make a buffer
3927 hidden although the 'hidden' option is off: When the buffer is
3928 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003930 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 This option is set for one command with ":hide {command}" |:hide|.
3932 WARNING: It's easy to forget that you have changes in hidden buffers.
3933 Think twice when using ":q!" or ":qa!".
3934
3935 *'highlight'* *'hl'*
3936'highlight' 'hl' string (default (as a single string):
3937 "8:SpecialKey,@:NonText,d:Directory,
3938 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003939 M:ModeMsg,n:LineNr,N:CursorLineNr,
3940 r:Question,s:StatusLine,S:StatusLineNC,
3941 c:VertSplit, t:Title,v:Visual,
3942 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 f:Folded,F:FoldColumn,A:DiffAdd,
3944 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003945 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003946 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003947 +:Pmenu,=:PmenuSel,
3948 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 global
3950 {not in Vi}
3951 This option can be used to set highlighting mode for various
3952 occasions. It is a comma separated list of character pairs. The
3953 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003954 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3956 |hl-NonText| @ '~' and '@' at the end of the window and
3957 characters from 'showbreak'
3958 |hl-Directory| d directories in CTRL-D listing and other special
3959 things in listings
3960 |hl-ErrorMsg| e error messages
3961 h (obsolete, ignored)
3962 |hl-IncSearch| i 'incsearch' highlighting
3963 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3964 |hl-MoreMsg| m |more-prompt|
3965 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003966 |hl-LineNr| n line number for ":number" and ":#" commands, and
3967 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003968 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3969 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 |hl-Question| r |hit-enter| prompt and yes/no questions
3971 |hl-StatusLine| s status line of current window |status-line|
3972 |hl-StatusLineNC| S status lines of not-current windows
3973 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3974 |hl-VertSplit| c column used to separate vertically split windows
3975 |hl-Visual| v Visual mode
3976 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3977 Selection" Only X11 Gui's |gui-x11| and
3978 |xterm-clipboard|.
3979 |hl-WarningMsg| w warning messages
3980 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3981 |hl-Folded| f line used for closed folds
3982 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003983 |hl-DiffAdd| A added line in diff mode
3984 |hl-DiffChange| C changed line in diff mode
3985 |hl-DiffDelete| D deleted line in diff mode
3986 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003988 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003989 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003990 |hl-SpellRare| R rare word |spell|
3991 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003992 |hl-Conceal| - the placeholders used for concealed characters
3993 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003994 |hl-Pmenu| + popup menu normal line
3995 |hl-PmenuSel| = popup menu normal line
3996 |hl-PmenuSbar| x popup menu scrollbar
3997 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998
3999 The display modes are:
4000 r reverse (termcap entry "mr" and "me")
4001 i italic (termcap entry "ZH" and "ZR")
4002 b bold (termcap entry "md" and "me")
4003 s standout (termcap entry "so" and "se")
4004 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004005 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 n no highlighting
4007 - no highlighting
4008 : use a highlight group
4009 The default is used for occasions that are not included.
4010 If you want to change what the display modes do, see |dos-colors|
4011 for an example.
4012 When using the ':' display mode, this must be followed by the name of
4013 a highlight group. A highlight group can be used to define any type
4014 of highlighting, including using color. See |:highlight| on how to
4015 define one. The default uses a different group for each occasion.
4016 See |highlight-default| for the default highlight groups.
4017
4018 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4019'hlsearch' 'hls' boolean (default off)
4020 global
4021 {not in Vi}
4022 {not available when compiled without the
4023 |+extra_search| feature}
4024 When there is a previous search pattern, highlight all its matches.
4025 The type of highlighting used can be set with the 'l' occasion in the
4026 'highlight' option. This uses the "Search" highlight group by
4027 default. Note that only the matching text is highlighted, any offsets
4028 are not applied.
4029 See also: 'incsearch' and |:match|.
4030 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004031 off with |:nohlsearch|. This does not change the option value, as
4032 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004033 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 When the search pattern can match an end-of-line, Vim will try to
4035 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004036 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004038 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004039 You can specify whether the highlight status is restored on startup
4040 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 NOTE: This option is reset when 'compatible' is set.
4042
4043 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004044'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 global
4046 {not in Vi}
4047 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004048 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004050 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051 NOTE: This option is set to the Vi default value when 'compatible' is
4052 set and to the Vim default value when 'compatible' is reset.
4053
4054 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4055'hkmap' 'hk' boolean (default off)
4056 global
4057 {not in Vi}
4058 {only available when compiled with the |+rightleft|
4059 feature}
4060 When on, the keyboard is mapped for the Hebrew character set.
4061 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4062 toggle this option. See |rileft.txt|.
4063 NOTE: This option is reset when 'compatible' is set.
4064
4065 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4066'hkmapp' 'hkp' boolean (default off)
4067 global
4068 {not in Vi}
4069 {only available when compiled with the |+rightleft|
4070 feature}
4071 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4072 This is useful if you have a non-Hebrew keyboard.
4073 See |rileft.txt|.
4074 NOTE: This option is reset when 'compatible' is set.
4075
4076 *'icon'* *'noicon'*
4077'icon' boolean (default off, on when title can be restored)
4078 global
4079 {not in Vi}
4080 {not available when compiled without the |+title|
4081 feature}
4082 When on, the icon text of the window will be set to the value of
4083 'iconstring' (if it is not empty), or to the name of the file
4084 currently being edited. Only the last part of the name is used.
4085 Overridden by the 'iconstring' option.
4086 Only works if the terminal supports setting window icons (currently
4087 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4088 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4089 builtin termcap).
4090 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004091 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004093 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094
4095 *'iconstring'*
4096'iconstring' string (default "")
4097 global
4098 {not in Vi}
4099 {not available when compiled without the |+title|
4100 feature}
4101 When this option is not empty, it will be used for the icon text of
4102 the window. This happens only when the 'icon' option is on.
4103 Only works if the terminal supports setting window icon text
4104 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4105 Does not work for MS Windows.
4106 When Vim was compiled with HAVE_X11 defined, the original icon will be
4107 restored if possible |X11|.
4108 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004109 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 'titlestring' for example settings.
4111 {not available when compiled without the |+statusline| feature}
4112
4113 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4114'ignorecase' 'ic' boolean (default off)
4115 global
4116 Ignore case in search patterns. Also used when searching in the tags
4117 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004118 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 Can be overruled by using "\c" or "\C" in the pattern, see
4120 |/ignorecase|.
4121
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004122 *'imactivatefunc'* *'imaf'*
4123'imactivatefunc' 'imaf' string (default "")
4124 global
4125 {not in Vi}
4126 {only available when compiled with |+xim| and
4127 |+GUI_GTK|}
4128 This option specifies a function that will be called to
4129 activate/inactivate Input Method.
4130
4131 Example: >
4132 function ImActivateFunc(active)
4133 if a:active
4134 ... do something
4135 else
4136 ... do something
4137 endif
4138 " return value is not used
4139 endfunction
4140 set imactivatefunc=ImActivateFunc
4141<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 *'imactivatekey'* *'imak'*
4143'imactivatekey' 'imak' string (default "")
4144 global
4145 {not in Vi}
4146 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004147 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 Specifies the key that your Input Method in X-Windows uses for
4149 activation. When this is specified correctly, vim can fully control
4150 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4151 You can't use this option to change the activation key, the option
4152 tells Vim what the key is.
4153 Format:
4154 [MODIFIER_FLAG-]KEY_STRING
4155
4156 These characters can be used for MODIFIER_FLAG (case is ignored):
4157 S Shift key
4158 L Lock key
4159 C Control key
4160 1 Mod1 key
4161 2 Mod2 key
4162 3 Mod3 key
4163 4 Mod4 key
4164 5 Mod5 key
4165 Combinations are allowed, for example "S-C-space" or "SC-space" are
4166 both shift+ctrl+space.
4167 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4168
4169 Example: >
4170 :set imactivatekey=S-space
4171< "S-space" means shift+space. This is the activation key for kinput2 +
4172 canna (Japanese), and ami (Korean).
4173
4174 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4175'imcmdline' 'imc' boolean (default off)
4176 global
4177 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004178 {only available when compiled with the |+xim|,
4179 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 When set the Input Method is always on when starting to edit a command
4181 line, unless entering a search pattern (see 'imsearch' for that).
4182 Setting this option is useful when your input method allows entering
4183 English characters directly, e.g., when it's used to type accented
4184 characters with dead keys.
4185
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004186 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4188 global
4189 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004190 {only available when compiled with the |+xim|,
4191 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 When set the Input Method is never used. This is useful to disable
4193 the IM when it doesn't work properly.
4194 Currently this option is on by default for SGI/IRIX machines. This
4195 may change in later releases.
4196
4197 *'iminsert'* *'imi'*
4198'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4199 local to buffer
4200 {not in Vi}
4201 Specifies whether :lmap or an Input Method (IM) is to be used in
4202 Insert mode. Valid values:
4203 0 :lmap is off and IM is off
4204 1 :lmap is ON and IM is off
4205 2 :lmap is off and IM is ON
4206 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4207 or |global-ime|.
4208 To always reset the option to zero when leaving Insert mode with <Esc>
4209 this can be used: >
4210 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4211< This makes :lmap and IM turn off automatically when leaving Insert
4212 mode.
4213 Note that this option changes when using CTRL-^ in Insert mode
4214 |i_CTRL-^|.
4215 The value is set to 1 when setting 'keymap' to a valid keymap name.
4216 It is also used for the argument of commands like "r" and "f".
4217 The value 0 may not work correctly with Athena and Motif with some XIM
4218 methods. Use 'imdisable' to disable XIM then.
4219
4220 *'imsearch'* *'ims'*
4221'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4222 local to buffer
4223 {not in Vi}
4224 Specifies whether :lmap or an Input Method (IM) is to be used when
4225 entering a search pattern. Valid values:
4226 -1 the value of 'iminsert' is used, makes it look like
4227 'iminsert' is also used when typing a search pattern
4228 0 :lmap is off and IM is off
4229 1 :lmap is ON and IM is off
4230 2 :lmap is off and IM is ON
4231 Note that this option changes when using CTRL-^ in Command-line mode
4232 |c_CTRL-^|.
4233 The value is set to 1 when it is not -1 and setting the 'keymap'
4234 option to a valid keymap name.
4235 The value 0 may not work correctly with Athena and Motif with some XIM
4236 methods. Use 'imdisable' to disable XIM then.
4237
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004238 *'imstatusfunc'* *'imsf'*
4239'imstatusfunc' 'imsf' string (default "")
4240 global
4241 {not in Vi}
4242 {only available when compiled with |+xim| and
4243 |+GUI_GTK|}
4244 This option specifies a function that is called to obtain the status
4245 of Input Method. It must return a positive number when IME is active.
4246
4247 Example: >
4248 function ImStatusFunc()
4249 let is_active = ...do something
4250 return is_active ? 1 : 0
4251 endfunction
4252 set imstatusfunc=ImStatusFunc
4253<
4254 NOTE: This function is invoked very often. Keep it fast.
4255
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 *'include'* *'inc'*
4257'include' 'inc' string (default "^\s*#\s*include")
4258 global or local to buffer |global-local|
4259 {not in Vi}
4260 {not available when compiled without the
4261 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004262 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 pattern, just like for the "/" command (See |pattern|). The default
4264 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004265 "]I", "[d", etc.
4266 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004267 comes after the matched pattern. But if "\zs" appears in the pattern
4268 then the text matched from "\zs" to the end, or until "\ze" if it
4269 appears, is used as the file name. Use this to include characters
4270 that are not in 'isfname', such as a space. You can then use
4271 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004272 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273
4274 *'includeexpr'* *'inex'*
4275'includeexpr' 'inex' string (default "")
4276 local to buffer
4277 {not in Vi}
4278 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004279 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004281 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 :set includeexpr=substitute(v:fname,'\\.','/','g')
4283< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004284
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004286 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 Also used for |<cfile>|.
4288
Bram Moolenaar30b65812012-07-12 22:01:11 +02004289 The expression will be evaluated in the |sandbox| when set from a
4290 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004291
4292 It is not allowed to change text or jump to another window while
4293 evaluating 'includeexpr' |textlock|.
4294
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4296'incsearch' 'is' boolean (default off)
4297 global
4298 {not in Vi}
4299 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004300 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004301 While typing a search command, show where the pattern, as it was typed
4302 so far, matches. The matched string is highlighted. If the pattern
4303 is invalid or not found, nothing is shown. The screen will be updated
4304 often, this is only useful on fast terminals.
4305 Note that the match will be shown, but the cursor will return to its
4306 original position when no match is found and when pressing <Esc>. You
4307 still need to finish the search command with <Enter> to move the
4308 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004309 When compiled with the |+reltime| feature Vim only searches for about
4310 half a second. With a complicated pattern and/or a lot of text the
4311 match may not be found. This is to avoid that Vim hangs while you
4312 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004313 The highlighting can be set with the 'i' flag in 'highlight'.
4314 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004315 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004316 to the command line. If 'ignorecase' and 'smartcase' are set and the
4317 command line has no uppercase characters, the added character is
4318 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004319 CTRL-R CTRL-W can be used to add the word at the end of the current
4320 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 NOTE: This option is reset when 'compatible' is set.
4322
4323 *'indentexpr'* *'inde'*
4324'indentexpr' 'inde' string (default "")
4325 local to buffer
4326 {not in Vi}
4327 {not available when compiled without the |+cindent|
4328 or |+eval| features}
4329 Expression which is evaluated to obtain the proper indent for a line.
4330 It is used when a new line is created, for the |=| operator and
4331 in Insert mode as specified with the 'indentkeys' option.
4332 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004333 'smartindent' indenting. When 'lisp' is set, this option is
4334 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 When 'paste' is set this option is not used for indenting.
4336 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004337 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 when the expression is evaluated (but it may be moved around).
4339 The expression must return the number of spaces worth of indent. It
4340 can return "-1" to keep the current indent (this means 'autoindent' is
4341 used for the indent).
4342 Functions useful for computing the indent are |indent()|, |cindent()|
4343 and |lispindent()|.
4344 The evaluation of the expression must not have side effects! It must
4345 not change the text, jump to another window, etc. Afterwards the
4346 cursor position is always restored, thus the cursor may be moved.
4347 Normally this option would be set to call a function: >
4348 :set indentexpr=GetMyIndent()
4349< Error messages will be suppressed, unless the 'debug' option contains
4350 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004351 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 NOTE: This option is made empty when 'compatible' is set.
4353
Bram Moolenaar30b65812012-07-12 22:01:11 +02004354 The expression will be evaluated in the |sandbox| when set from a
4355 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004356
4357 It is not allowed to change text or jump to another window while
4358 evaluating 'indentexpr' |textlock|.
4359
4360
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 *'indentkeys'* *'indk'*
4362'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4363 local to buffer
4364 {not in Vi}
4365 {not available when compiled without the |+cindent|
4366 feature}
4367 A list of keys that, when typed in Insert mode, cause reindenting of
4368 the current line. Only happens if 'indentexpr' isn't empty.
4369 The format is identical to 'cinkeys', see |indentkeys-format|.
4370 See |C-indenting| and |indent-expression|.
4371
4372 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4373'infercase' 'inf' boolean (default off)
4374 local to buffer
4375 {not in Vi}
4376 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004377 'ignorecase' is also on, the case of the match is adjusted depending
4378 on the typed text. If the typed text contains a lowercase letter
4379 where the match has an upper case letter, the completed part is made
4380 lowercase. If the typed text has no lowercase letters and the match
4381 has a lowercase letter where the typed text has an uppercase letter,
4382 and there is a letter before it, the completed part is made uppercase.
4383 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384
4385 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4386'insertmode' 'im' boolean (default off)
4387 global
4388 {not in Vi}
4389 Makes Vim work in a way that Insert mode is the default mode. Useful
4390 if you want to use Vim as a modeless editor. Used for |evim|.
4391 These Insert mode commands will be useful:
4392 - Use the cursor keys to move around.
4393 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4394 this is a mapping, it is executed as if 'insertmode' was off.
4395 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004397 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4398 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399
4400 These items change when 'insertmode' is set:
4401 - when starting to edit of a file, Vim goes to Insert mode.
4402 - <Esc> in Insert mode is a no-op and beeps.
4403 - <Esc> in Normal mode makes Vim go to Insert mode.
4404 - CTRL-L in Insert mode is a command, it is not inserted.
4405 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4406 However, when <Esc> is used inside a mapping, it behaves like
4407 'insertmode' was not set. This was done to be able to use the same
4408 mappings with 'insertmode' set or not set.
4409 When executing commands with |:normal| 'insertmode' is not used.
4410
4411 NOTE: This option is reset when 'compatible' is set.
4412
4413 *'isfname'* *'isf'*
4414'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4415 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4416 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4417 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4418 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4419 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4420 global
4421 {not in Vi}
4422 The characters specified by this option are included in file names and
4423 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004424 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 Multi-byte characters 256 and above are always included, only the
4426 characters up to 255 are specified with this option.
4427 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004428 Think twice before adding white space to this option. Although a
4429 space may appear inside a file name, the effect will be that Vim
4430 doesn't know where a file name starts or ends when doing completion.
4431 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432
4433 Note that on systems using a backslash as path separator, Vim tries to
4434 do its best to make it work as you would expect. That is a bit
4435 tricky, since Vi originally used the backslash to escape special
4436 characters. Vim will not remove a backslash in front of a normal file
4437 name character on these systems, but it will on Unix and alikes. The
4438 '&' and '^' are not included by default, because these are special for
4439 cmd.exe.
4440
4441 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004442 Each part can be a single character number or a range. A range is two
4443 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444 decimal number between 0 and 255 or the ASCII character itself (does
4445 not work for digits). Example:
4446 "_,-,128-140,#-43" (include '_' and '-' and the range
4447 128 to 140 and '#' to 43)
4448 If a part starts with '^', the following character number or range
4449 will be excluded from the option. The option is interpreted from left
4450 to right. Put the excluded character after the range where it is
4451 included. To include '^' itself use it as the last character of the
4452 option or the end of a range. Example:
4453 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4454 If the character is '@', all characters where isalpha() returns TRUE
4455 are included. Normally these are the characters a to z and A to Z,
4456 plus accented characters. To include '@' itself use "@-@". Examples:
4457 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004458 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 "a-z,A-Z,@-@" All letters plus the '@' character.
4460 A comma can be included by using it where a character number is
4461 expected. Example:
4462 "48-57,,,_" Digits, comma and underscore.
4463 A comma can be excluded by prepending a '^'. Example:
4464 " -~,^,,9" All characters from space to '~', excluding
4465 comma, plus <Tab>.
4466 See |option-backslash| about including spaces and backslashes.
4467
4468 *'isident'* *'isi'*
4469'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4470 "@,48-57,_,128-167,224-235"
4471 otherwise: "@,48-57,_,192-255")
4472 global
4473 {not in Vi}
4474 The characters given by this option are included in identifiers.
4475 Identifiers are used in recognizing environment variables and after a
4476 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004477 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 option.
4479 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004480 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4482
4483 *'iskeyword'* *'isk'*
4484'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4485 "@,48-57,_,128-167,224-235"
4486 otherwise: "@,48-57,_,192-255"
4487 Vi default: "@,48-57,_")
4488 local to buffer
4489 {not in Vi}
4490 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004491 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 'isfname' for a description of the format of this option. For C
4493 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4494 For a help file it is set to all non-blank printable characters except
4495 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4496 command).
4497 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004498 This option also influences syntax highlighting, unless the syntax
4499 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 NOTE: This option is set to the Vi default value when 'compatible' is
4501 set and to the Vim default value when 'compatible' is reset.
4502
4503 *'isprint'* *'isp'*
4504'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4505 "@,~-255"; otherwise: "@,161-255")
4506 global
4507 {not in Vi}
4508 The characters given by this option are displayed directly on the
4509 screen. It is also used for "\p" in a |pattern|. The characters from
4510 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4511 even when they are not included in 'isprint' or excluded. See
4512 'isfname' for a description of the format of this option.
4513
4514 Non-printable characters are displayed with two characters:
4515 0 - 31 "^@" - "^_"
4516 32 - 126 always single characters
4517 127 "^?"
4518 128 - 159 "~@" - "~_"
4519 160 - 254 "| " - "|~"
4520 255 "~?"
4521 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4522 displayed as <xx>, with the hexadecimal value of the byte.
4523 When 'display' contains "uhex" all unprintable characters are
4524 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004525 The SpecialKey highlighting will be used for unprintable characters.
4526 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527
4528 Multi-byte characters 256 and above are always included, only the
4529 characters up to 255 are specified with this option. When a character
4530 is printable but it is not available in the current font, a
4531 replacement character will be shown.
4532 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4533 There is no option to specify these characters.
4534
4535 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4536'joinspaces' 'js' boolean (default on)
4537 global
4538 {not in Vi}
4539 Insert two spaces after a '.', '?' and '!' with a join command.
4540 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4541 Otherwise only one space is inserted.
4542 NOTE: This option is set when 'compatible' is set.
4543
4544 *'key'*
4545'key' string (default "")
4546 local to buffer
4547 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004548 {only available when compiled with the |+cryptv|
4549 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004551 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552 Careful: Do not set the key value by hand, someone might see the typed
4553 key. Use the |:X| command. But you can make 'key' empty: >
4554 :set key=
4555< It is not possible to get the value of this option with ":set key" or
4556 "echo &key". This is to avoid showing it to someone who shouldn't
4557 know. It also means you cannot see it yourself once you have set it,
4558 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004559 You can use "&key" in an expression to detect whether encryption is
4560 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561
4562 *'keymap'* *'kmp'* *E544*
4563'keymap' 'kmp' string (default "")
4564 local to buffer
4565 {not in Vi}
4566 {only available when compiled with the |+keymap|
4567 feature}
4568 Name of a keyboard mapping. See |mbyte-keymap|.
4569 Setting this option to a valid keymap name has the side effect of
4570 setting 'iminsert' to one, so that the keymap becomes effective.
4571 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004572 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573
4574 *'keymodel'* *'km'*
4575'keymodel' 'km' string (default "")
4576 global
4577 {not in Vi}
4578 List of comma separated words, which enable special things that keys
4579 can do. These values can be used:
4580 startsel Using a shifted special key starts selection (either
4581 Select mode or Visual mode, depending on "key" being
4582 present in 'selectmode').
4583 stopsel Using a not-shifted special key stops selection.
4584 Special keys in this context are the cursor keys, <End>, <Home>,
4585 <PageUp> and <PageDown>.
4586 The 'keymodel' option is set by the |:behave| command.
4587
4588 *'keywordprg'* *'kp'*
4589'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4590 OS/2: "view /", VMS: "help")
4591 global or local to buffer |global-local|
4592 {not in Vi}
4593 Program to use for the |K| command. Environment variables are
4594 expanded |:set_env|. ":help" may be used to access the Vim internal
4595 help. (Note that previously setting the global option to the empty
4596 value did this, which is now deprecated.)
4597 When "man" is used, Vim will automatically translate a count for the
4598 "K" command to a section number. Also for "man -s", in which case the
4599 "-s" is removed when there is no count.
4600 See |option-backslash| about including spaces and backslashes.
4601 Example: >
4602 :set keywordprg=man\ -s
4603< This option cannot be set from a |modeline| or in the |sandbox|, for
4604 security reasons.
4605
4606 *'langmap'* *'lmap'* *E357* *E358*
4607'langmap' 'lmap' string (default "")
4608 global
4609 {not in Vi}
4610 {only available when compiled with the |+langmap|
4611 feature}
4612 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004613 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004614 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 care of translating these special characters to the original meaning
4616 of the key. This means you don't have to change the keyboard mode to
4617 be able to execute Normal mode commands.
4618 This is the opposite of the 'keymap' option, where characters are
4619 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004620 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4621 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004622 This option cannot be set from a |modeline| or in the |sandbox|, for
4623 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004625 Example (for Greek, in UTF-8): *greek* >
4626 :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 +00004627< Example (exchanges meaning of z and y for commands): >
4628 :set langmap=zy,yz,ZY,YZ
4629<
4630 The 'langmap' option is a list of parts, separated with commas. Each
4631 part can be in one of two forms:
4632 1. A list of pairs. Each pair is a "from" character immediately
4633 followed by the "to" character. Examples: "aA", "aAbBcC".
4634 2. A list of "from" characters, a semi-colon and a list of "to"
4635 characters. Example: "abc;ABC"
4636 Example: "aA,fgh;FGH,cCdDeE"
4637 Special characters need to be preceded with a backslash. These are
4638 ";", ',' and backslash itself.
4639
4640 This will allow you to activate vim actions without having to switch
4641 back and forth between the languages. Your language characters will
4642 be understood as normal vim English characters (according to the
4643 langmap mappings) in the following cases:
4644 o Normal/Visual mode (commands, buffer/register names, user mappings)
4645 o Insert/Replace Mode: Register names after CTRL-R
4646 o Insert/Replace Mode: Mappings
4647 Characters entered in Command-line mode will NOT be affected by
4648 this option. Note that this option can be changed at any time
4649 allowing to switch between mappings for different languages/encodings.
4650 Use a mapping to avoid having to type it each time!
4651
4652 *'langmenu'* *'lm'*
4653'langmenu' 'lm' string (default "")
4654 global
4655 {not in Vi}
4656 {only available when compiled with the |+menu| and
4657 |+multi_lang| features}
4658 Language to use for menu translation. Tells which file is loaded
4659 from the "lang" directory in 'runtimepath': >
4660 "lang/menu_" . &langmenu . ".vim"
4661< (without the spaces). For example, to always use the Dutch menus, no
4662 matter what $LANG is set to: >
4663 :set langmenu=nl_NL.ISO_8859-1
4664< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004665 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 If your $LANG is set to a non-English language but you do want to use
4667 the English menus: >
4668 :set langmenu=none
4669< This option must be set before loading menus, switching on filetype
4670 detection or syntax highlighting. Once the menus are defined setting
4671 this option has no effect. But you could do this: >
4672 :source $VIMRUNTIME/delmenu.vim
4673 :set langmenu=de_DE.ISO_8859-1
4674 :source $VIMRUNTIME/menu.vim
4675< Warning: This deletes all menus that you defined yourself!
4676
Bram Moolenaard94464e2015-11-02 15:28:18 +01004677 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004678'langnoremap' 'lnr' boolean (default off)
4679 global
4680 {not in Vi}
4681 {only available when compiled with the |+langmap|
4682 feature}
4683 When on, setting 'langmap' does not apply to characters resulting from
4684 a mapping. This basically means, if you noticed that setting
4685 'langmap' disables some of your mappings, try setting this option.
4686 This option defaults to off for backwards compatibility. Set it on if
4687 that works for you to avoid mappings to break.
4688
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 *'laststatus'* *'ls'*
4690'laststatus' 'ls' number (default 1)
4691 global
4692 {not in Vi}
4693 The value of this option influences when the last window will have a
4694 status line:
4695 0: never
4696 1: only if there are at least two windows
4697 2: always
4698 The screen looks nicer with a status line if you have several
4699 windows, but it takes another screen line. |status-line|
4700
4701 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4702'lazyredraw' 'lz' boolean (default off)
4703 global
4704 {not in Vi}
4705 When this option is set, the screen will not be redrawn while
4706 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004707 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 update use |:redraw|.
4709
4710 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4711'linebreak' 'lbr' boolean (default off)
4712 local to window
4713 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004714 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004716 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 than at the last character that fits on the screen. Unlike
4718 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004719 it only affects the way the file is displayed, not its contents.
4720 If 'breakindent' is set, line is visually indented. Then, the value
4721 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004722 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 Note that <Tab> characters after an <EOL> are mostly not displayed
4724 with the right amount of white space.
4725
4726 *'lines'* *E593*
4727'lines' number (default 24 or terminal height)
4728 global
4729 Number of lines of the Vim window.
4730 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004731 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 When Vim is running in the GUI or in a resizable window, setting this
4733 option will cause the window size to be changed. When you only want
4734 to use the size for the GUI, put the command in your |gvimrc| file.
4735 Vim limits the number of lines to what fits on the screen. You can
4736 use this command to get the tallest window possible: >
4737 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004738< Minimum value is 2, maximum value is 1000.
4739 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004740 When you set this option and Vim is unable to change the physical
4741 number of lines of the display, the display may be messed up.
4742
4743 *'linespace'* *'lsp'*
4744'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4745 global
4746 {not in Vi}
4747 {only in the GUI}
4748 Number of pixel lines inserted between characters. Useful if the font
4749 uses the full character cell height, making lines touch each other.
4750 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004751 With some fonts there can be too much room between lines (to have
4752 space for ascents and descents). Then it makes sense to set
4753 'linespace' to a negative value. This may cause display problems
4754 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
4756 *'lisp'* *'nolisp'*
4757'lisp' boolean (default off)
4758 local to buffer
4759 {not available when compiled without the |+lispindent|
4760 feature}
4761 Lisp mode: When <Enter> is typed in insert mode set the indent for
4762 the next line to Lisp standards (well, sort of). Also happens with
4763 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4764 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4765 better. Also see 'lispwords'.
4766 The '-' character is included in keyword characters. Redefines the
4767 "=" operator to use this same indentation algorithm rather than
4768 calling an external program if 'equalprg' is empty.
4769 This option is not used when 'paste' is set.
4770 {Vi: Does it a little bit differently}
4771
4772 *'lispwords'* *'lw'*
4773'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004774 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 {not in Vi}
4776 {not available when compiled without the |+lispindent|
4777 feature}
4778 Comma separated list of words that influence the Lisp indenting.
4779 |'lisp'|
4780
4781 *'list'* *'nolist'*
4782'list' boolean (default off)
4783 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004784 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4785 line. Useful to see the difference between tabs and spaces and for
4786 trailing blanks. Further changed by the 'listchars' option.
4787
4788 The cursor is displayed at the start of the space a Tab character
4789 occupies, not at the end as usual in Normal mode. To get this cursor
4790 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004791 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004792<
4793 Note that list mode will also affect formatting (set with 'textwidth'
4794 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004795 changing the way tabs are displayed.
4796
4797 *'listchars'* *'lcs'*
4798'listchars' 'lcs' string (default "eol:$")
4799 global
4800 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004801 Strings to use in 'list' mode and for the |:list| command. It is a
4802 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004803 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 eol:c Character to show at the end of each line. When
4805 omitted, there is no extra character at the end of the
4806 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004807 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004808 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004810 fill the space that the tab normally occupies.
4811 "tab:>-" will show a tab that takes four spaces as
4812 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004813 *lcs-space*
4814 space:c Character to show for a space. When omitted, spaces
4815 are left blank.
4816 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004817 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004818 trailing spaces are blank. Overrides the "space"
4819 setting for trailing spaces.
4820 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 extends:c Character to show in the last column, when 'wrap' is
4822 off and the line continues beyond the right of the
4823 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004824 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 precedes:c Character to show in the first column, when 'wrap'
4826 is off and there is text preceding the character
4827 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004828 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004829 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004830 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004831 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004832 nbsp:c Character to show for a non-breakable space character
4833 (0xA0 (160 decimal) and U+202F). Left blank when
4834 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004836 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004838 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839
4840 Examples: >
4841 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004842 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 :set lcs=extends:>,precedes:<
4844< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004845 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004846 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
4848 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4849'loadplugins' 'lpl' boolean (default on)
4850 global
4851 {not in Vi}
4852 When on the plugin scripts are loaded when starting up |load-plugins|.
4853 This option can be reset in your |vimrc| file to disable the loading
4854 of plugins.
4855 Note that using the "-u NONE" and "--noplugin" command line arguments
4856 reset this option. |-u| |--noplugin|
4857
Bram Moolenaard94464e2015-11-02 15:28:18 +01004858 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004859'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004860 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004861 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004862 {only available when compiled with the |+lua/dyn|
4863 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004864 Specifies the name of the Lua shared library. The default is
4865 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004866 This option cannot be set from a |modeline| or in the |sandbox|, for
4867 security reasons.
4868
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004869 *'macatsui'* *'nomacatsui'*
4870'macatsui' boolean (default on)
4871 global
4872 {only available in Mac GUI version}
4873 This is a workaround for when drawing doesn't work properly. When set
4874 and compiled with multi-byte support ATSUI text drawing is used. When
4875 not set ATSUI text drawing is not used. Switch this option off when
4876 you experience drawing problems. In a future version the problems may
4877 be solved and this option becomes obsolete. Therefore use this method
4878 to unset it: >
4879 if exists('&macatsui')
4880 set nomacatsui
4881 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004882< Another option to check if you have drawing problems is
4883 'termencoding'.
4884
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 *'magic'* *'nomagic'*
4886'magic' boolean (default on)
4887 global
4888 Changes the special characters that can be used in search patterns.
4889 See |pattern|.
4890 NOTE: To avoid portability problems with using patterns, always keep
4891 this option at the default "on". Only switch it off when working with
4892 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004893 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894
4895 *'makeef'* *'mef'*
4896'makeef' 'mef' string (default: "")
4897 global
4898 {not in Vi}
4899 {not available when compiled without the |+quickfix|
4900 feature}
4901 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4902 and the |:grep| command.
4903 When it is empty, an internally generated temp file will be used.
4904 When "##" is included, it is replaced by a number to make the name
4905 unique. This makes sure that the ":make" command doesn't overwrite an
4906 existing file.
4907 NOT used for the ":cf" command. See 'errorfile' for that.
4908 Environment variables are expanded |:set_env|.
4909 See |option-backslash| about including spaces and backslashes.
4910 This option cannot be set from a |modeline| or in the |sandbox|, for
4911 security reasons.
4912
4913 *'makeprg'* *'mp'*
4914'makeprg' 'mp' string (default "make", VMS: "MMS")
4915 global or local to buffer |global-local|
4916 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004917 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004918 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4919 which are expanded to the current and alternate file name. Use |::S|
4920 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004921 Environment variables are expanded |:set_env|. See |option-backslash|
4922 about including spaces and backslashes.
4923 Note that a '|' must be escaped twice: once for ":set" and once for
4924 the interpretation of a command. When you use a filter called
4925 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 :set makeprg=gmake\ \\\|\ myfilter
4927< The placeholder "$*" can be given (even multiple times) to specify
4928 where the arguments will be included, for example: >
4929 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4930< This option cannot be set from a |modeline| or in the |sandbox|, for
4931 security reasons.
4932
4933 *'matchpairs'* *'mps'*
4934'matchpairs' 'mps' string (default "(:),{:},[:]")
4935 local to buffer
4936 {not in Vi}
4937 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004938 other.
4939 Only character pairs are allowed that are different, thus you cannot
4940 jump between two double quotes.
4941 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004942 The pairs must be separated by a comma. Example for including '<' and
4943 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 :set mps+=<:>
4945
4946< A more exotic example, to jump between the '=' and ';' in an
4947 assignment, useful for languages like C and Java: >
4948 :au FileType c,cpp,java set mps+==:;
4949
4950< For a more advanced way of using "%", see the matchit.vim plugin in
4951 the $VIMRUNTIME/macros directory. |add-local-help|
4952
4953 *'matchtime'* *'mat'*
4954'matchtime' 'mat' number (default 5)
4955 global
4956 {not in Vi}{in Nvi}
4957 Tenths of a second to show the matching paren, when 'showmatch' is
4958 set. Note that this is not in milliseconds, like other options that
4959 set a time. This is to be compatible with Nvi.
4960
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004961 *'maxcombine'* *'mco'*
4962'maxcombine' 'mco' number (default 2)
4963 global
4964 {not in Vi}
4965 {only available when compiled with the |+multi_byte|
4966 feature}
4967 The maximum number of combining characters supported for displaying.
4968 Only used when 'encoding' is "utf-8".
4969 The default is OK for most languages. Hebrew may require 4.
4970 Maximum value is 6.
4971 Even when this option is set to 2 you can still edit text with more
4972 combining characters, you just can't see them. Use |g8| or |ga|.
4973 See |mbyte-combining|.
4974
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 *'maxfuncdepth'* *'mfd'*
4976'maxfuncdepth' 'mfd' number (default 100)
4977 global
4978 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004979 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004980 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 Maximum depth of function calls for user functions. This normally
4982 catches endless recursion. When using a recursive function with
4983 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4984 more memory, there is the danger of failing when memory is exhausted.
4985 See also |:function|.
4986
4987 *'maxmapdepth'* *'mmd'* *E223*
4988'maxmapdepth' 'mmd' number (default 1000)
4989 global
4990 {not in Vi}
4991 Maximum number of times a mapping is done without resulting in a
4992 character to be used. This normally catches endless mappings, like
4993 ":map x y" with ":map y x". It still does not catch ":map g wg",
4994 because the 'w' is used before the next mapping is done. See also
4995 |key-mapping|.
4996
4997 *'maxmem'* *'mm'*
4998'maxmem' 'mm' number (default between 256 to 5120 (system
4999 dependent) or half the amount of memory
5000 available)
5001 global
5002 {not in Vi}
5003 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5004 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005005 other memory to be freed. The maximum usable value is about 2000000.
5006 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005008 *'maxmempattern'* *'mmp'*
5009'maxmempattern' 'mmp' number (default 1000)
5010 global
5011 {not in Vi}
5012 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005013 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005014 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005015 When Vim runs into the limit it gives an error message and mostly
5016 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005017 Running into the limit often means that the pattern is very
5018 inefficient or too complex. This may already happen with the pattern
5019 "\(.\)*" on a very long line. ".*" works much better.
5020 Vim may run out of memory before hitting the 'maxmempattern' limit.
5021
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 *'maxmemtot'* *'mmt'*
5023'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5024 dependent) or half the amount of memory
5025 available)
5026 global
5027 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005028 Maximum amount of memory in Kbyte to use for all buffers together.
5029 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005030 without a limit.
5031 On 64 bit machines higher values might work. But hey, do you really
5032 need more than 2 Gbyte for text editing? Keep in mind that text is
5033 stored in the swap file, one can edit files > 2 Gbyte anyay. We do
5034 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005035 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
5037 *'menuitems'* *'mis'*
5038'menuitems' 'mis' number (default 25)
5039 global
5040 {not in Vi}
5041 {not available when compiled without the |+menu|
5042 feature}
5043 Maximum number of items to use in a menu. Used for menus that are
5044 generated from a list of items, e.g., the Buffers menu. Changing this
5045 option has no direct effect, the menu must be refreshed first.
5046
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005047 *'mkspellmem'* *'msm'*
5048'mkspellmem' 'msm' string (default "460000,2000,500")
5049 global
5050 {not in Vi}
5051 {not available when compiled without the |+syntax|
5052 feature}
5053 Parameters for |:mkspell|. This tunes when to start compressing the
5054 word tree. Compression can be slow when there are many words, but
5055 it's needed to avoid running out of memory. The amount of memory used
5056 per word depends very much on how similar the words are, that's why
5057 this tuning is complicated.
5058
5059 There are three numbers, separated by commas:
5060 {start},{inc},{added}
5061
5062 For most languages the uncompressed word tree fits in memory. {start}
5063 gives the amount of memory in Kbyte that can be used before any
5064 compression is done. It should be a bit smaller than the amount of
5065 memory that is available to Vim.
5066
5067 When going over the {start} limit the {inc} number specifies the
5068 amount of memory in Kbyte that can be allocated before another
5069 compression is done. A low number means compression is done after
5070 less words are added, which is slow. A high number means more memory
5071 will be allocated.
5072
5073 After doing compression, {added} times 1024 words can be added before
5074 the {inc} limit is ignored and compression is done when any extra
5075 amount of memory is needed. A low number means there is a smaller
5076 chance of hitting the {inc} limit, less memory is used but it's
5077 slower.
5078
5079 The languages for which these numbers are important are Italian and
5080 Hungarian. The default works for when you have about 512 Mbyte. If
5081 you have 1 Gbyte you could use: >
5082 :set mkspellmem=900000,3000,800
5083< If you have less than 512 Mbyte |:mkspell| may fail for some
5084 languages, no matter what you set 'mkspellmem' to.
5085
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005087'modeline' 'ml' boolean (Vim default: on (off for root),
5088 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 local to buffer
5090 *'modelines'* *'mls'*
5091'modelines' 'mls' number (default 5)
5092 global
5093 {not in Vi}
5094 If 'modeline' is on 'modelines' gives the number of lines that is
5095 checked for set commands. If 'modeline' is off or 'modelines' is zero
5096 no lines are checked. See |modeline|.
5097 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5098 set and to the Vim default value when 'compatible' is reset.
5099
5100 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5101'modifiable' 'ma' boolean (default on)
5102 local to buffer
5103 {not in Vi} *E21*
5104 When off the buffer contents cannot be changed. The 'fileformat' and
5105 'fileencoding' options also can't be changed.
5106 Can be reset with the |-M| command line argument.
5107
5108 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5109'modified' 'mod' boolean (default off)
5110 local to buffer
5111 {not in Vi}
5112 When on, the buffer is considered to be modified. This option is set
5113 when:
5114 1. A change was made to the text since it was last written. Using the
5115 |undo| command to go back to the original text will reset the
5116 option. But undoing changes that were made before writing the
5117 buffer will set the option again, since the text is different from
5118 when it was written.
5119 2. 'fileformat' or 'fileencoding' is different from its original
5120 value. The original value is set when the buffer is read or
5121 written. A ":set nomodified" command also resets the original
5122 values to the current values and the 'modified' option will be
5123 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005124 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005125 This option is not set when a change is made to the buffer as the
5126 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5127 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5128 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5130 will be ignored.
5131
5132 *'more'* *'nomore'*
5133'more' boolean (Vim default: on, Vi default: off)
5134 global
5135 {not in Vi}
5136 When on, listings pause when the whole screen is filled. You will get
5137 the |more-prompt|. When this option is off there are no pauses, the
5138 listing continues until finished.
5139 NOTE: This option is set to the Vi default value when 'compatible' is
5140 set and to the Vim default value when 'compatible' is reset.
5141
5142 *'mouse'* *E538*
5143'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5144 global
5145 {not in Vi}
5146 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005147 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5148 sysmouse and Linux console with gpm). For using the mouse in the
5149 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 The mouse can be enabled for different modes:
5151 n Normal mode
5152 v Visual mode
5153 i Insert mode
5154 c Command-line mode
5155 h all previous modes when editing a help file
5156 a all previous modes
5157 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 Normally you would enable the mouse in all four modes with: >
5159 :set mouse=a
5160< When the mouse is not enabled, the GUI will still use the mouse for
5161 modeless selection. This doesn't move the text cursor.
5162
5163 See |mouse-using|. Also see |'clipboard'|.
5164
5165 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005166 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 the mouse buttons can still be used by keeping the shift key pressed.
5168 Also see the 'clipboard' option.
5169
5170 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5171'mousefocus' 'mousef' boolean (default off)
5172 global
5173 {not in Vi}
5174 {only works in the GUI}
5175 The window that the mouse pointer is on is automatically activated.
5176 When changing the window layout or window focus in another way, the
5177 mouse pointer is moved to the window with keyboard focus. Off is the
5178 default because it makes using the pull down menus a little goofy, as
5179 a pointer transit may activate a window unintentionally.
5180
5181 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5182'mousehide' 'mh' boolean (default on)
5183 global
5184 {not in Vi}
5185 {only works in the GUI}
5186 When on, the mouse pointer is hidden when characters are typed.
5187 The mouse pointer is restored when the mouse is moved.
5188
5189 *'mousemodel'* *'mousem'*
5190'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5191 global
5192 {not in Vi}
5193 Sets the model to use for the mouse. The name mostly specifies what
5194 the right mouse button is used for:
5195 extend Right mouse button extends a selection. This works
5196 like in an xterm.
5197 popup Right mouse button pops up a menu. The shifted left
5198 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005199 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 popup_setpos Like "popup", but the cursor will be moved to the
5201 position where the mouse was clicked, and thus the
5202 selected operation will act upon the clicked object.
5203 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005204 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 course, that right clicking outside a selection will
5206 end Visual mode.
5207 Overview of what button does what for each model:
5208 mouse extend popup(_setpos) ~
5209 left click place cursor place cursor
5210 left drag start selection start selection
5211 shift-left search word extend selection
5212 right click extend selection popup menu (place cursor)
5213 right drag extend selection -
5214 middle click paste paste
5215
5216 In the "popup" model the right mouse button produces a pop-up menu.
5217 You need to define this first, see |popup-menu|.
5218
5219 Note that you can further refine the meaning of buttons with mappings.
5220 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5221 selection (because that's handled in the GUI code directly).
5222
5223 The 'mousemodel' option is set by the |:behave| command.
5224
5225 *'mouseshape'* *'mouses'* *E547*
5226'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005227 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 global
5229 {not in Vi}
5230 {only available when compiled with the |+mouseshape|
5231 feature}
5232 This option tells Vim what the mouse pointer should look like in
5233 different modes. The option is a comma separated list of parts, much
5234 like used for 'guicursor'. Each part consist of a mode/location-list
5235 and an argument-list:
5236 mode-list:shape,mode-list:shape,..
5237 The mode-list is a dash separated list of these modes/locations:
5238 In a normal window: ~
5239 n Normal mode
5240 v Visual mode
5241 ve Visual mode with 'selection' "exclusive" (same as 'v',
5242 if not specified)
5243 o Operator-pending mode
5244 i Insert mode
5245 r Replace mode
5246
5247 Others: ~
5248 c appending to the command-line
5249 ci inserting in the command-line
5250 cr replacing in the command-line
5251 m at the 'Hit ENTER' or 'More' prompts
5252 ml idem, but cursor in the last line
5253 e any mode, pointer below last window
5254 s any mode, pointer on a status line
5255 sd any mode, while dragging a status line
5256 vs any mode, pointer on a vertical separator line
5257 vd any mode, while dragging a vertical separator line
5258 a everywhere
5259
5260 The shape is one of the following:
5261 avail name looks like ~
5262 w x arrow Normal mouse pointer
5263 w x blank no pointer at all (use with care!)
5264 w x beam I-beam
5265 w x updown up-down sizing arrows
5266 w x leftright left-right sizing arrows
5267 w x busy The system's usual busy pointer
5268 w x no The system's usual 'no input' pointer
5269 x udsizing indicates up-down resizing
5270 x lrsizing indicates left-right resizing
5271 x crosshair like a big thin +
5272 x hand1 black hand
5273 x hand2 white hand
5274 x pencil what you write with
5275 x question big ?
5276 x rightup-arrow arrow pointing right-up
5277 w x up-arrow arrow pointing up
5278 x <number> any X11 pointer number (see X11/cursorfont.h)
5279
5280 The "avail" column contains a 'w' if the shape is available for Win32,
5281 x for X11.
5282 Any modes not specified or shapes not available use the normal mouse
5283 pointer.
5284
5285 Example: >
5286 :set mouseshape=s:udsizing,m:no
5287< will make the mouse turn to a sizing arrow over the status lines and
5288 indicate no input when the hit-enter prompt is displayed (since
5289 clicking the mouse has no effect in this state.)
5290
5291 *'mousetime'* *'mouset'*
5292'mousetime' 'mouset' number (default 500)
5293 global
5294 {not in Vi}
5295 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5296 time in msec between two mouse clicks for the second click to be
5297 recognized as a multi click.
5298
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005299 *'mzquantum'* *'mzq'*
5300'mzquantum' 'mzq' number (default 100)
5301 global
5302 {not in Vi}
5303 {not available when compiled without the |+mzscheme|
5304 feature}
5305 The number of milliseconds between polls for MzScheme threads.
5306 Negative or zero value means no thread scheduling.
5307
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 *'nrformats'* *'nf'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005309'nrformats' 'nf' string (default "bin,octal,hex")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 local to buffer
5311 {not in Vi}
5312 This defines what bases Vim will consider for numbers when using the
5313 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5314 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005315 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005317 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005318 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005320 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 considered to be hexadecimal. Example: Using CTRL-X on
5322 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005323 bin If included, numbers starting with "0b" or "0B" will be
5324 considered to be binary. Example: Using CTRL-X on
5325 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 Numbers which simply begin with a digit in the range 1-9 are always
5327 considered decimal. This also happens for numbers that are not
5328 recognized as octal or hex.
5329
5330 *'number'* *'nu'* *'nonumber'* *'nonu'*
5331'number' 'nu' boolean (default off)
5332 local to window
5333 Print the line number in front of each line. When the 'n' option is
5334 excluded from 'cpoptions' a wrapped line will not use the column of
5335 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005336 The 'numberwidth' option can be used to set the room used for the line
5337 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 When a long, wrapped line doesn't start with the first character, '-'
5339 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005340 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5341 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005342 *number_relativenumber*
5343 The 'relativenumber' option changes the displayed number to be
5344 relative to the cursor. Together with 'number' there are these
5345 four combinations (cursor in line 3):
5346
Bram Moolenaar3848e002016-03-19 18:42:29 +01005347 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005348 'nornu' 'nornu' 'rnu' 'rnu'
5349
5350 |apple | 1 apple | 2 apple | 2 apple
5351 |pear | 2 pear | 1 pear | 1 pear
5352 |nobody | 3 nobody | 0 nobody |3 nobody
5353 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005355 *'numberwidth'* *'nuw'*
5356'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5357 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005358 {not in Vi}
5359 {only available when compiled with the |+linebreak|
5360 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005361 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005362 when the 'number' or 'relativenumber' option is set or printing lines
5363 with a line number. Since one space is always between the number and
5364 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005365 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005366 fit the highest line number in the buffer respectively the number of
5367 rows in the window, depending on whether 'number' or 'relativenumber'
5368 is set. Thus with the Vim default of 4 there is room for a line number
5369 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005370 The minimum value is 1, the maximum value is 10.
5371 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5372
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005373 *'omnifunc'* *'ofu'*
5374'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005375 local to buffer
5376 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005377 {not available when compiled without the |+eval|
5378 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005379 This option specifies a function to be used for Insert mode omni
5380 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005381 See |complete-functions| for an explanation of how the function is
5382 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005383 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005384 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005385 This option cannot be set from a |modeline| or in the |sandbox|, for
5386 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005387
5388
Bram Moolenaar02467872007-05-06 13:22:01 +00005389 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005390'opendevice' 'odev' boolean (default off)
5391 global
5392 {not in Vi}
5393 {only for MS-DOS, MS-Windows and OS/2}
5394 Enable reading and writing from devices. This may get Vim stuck on a
5395 device that can be opened but doesn't actually do the I/O. Therefore
5396 it is off by default.
5397 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5398 result in editing a device.
5399
5400
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005401 *'operatorfunc'* *'opfunc'*
5402'operatorfunc' 'opfunc' string (default: empty)
5403 global
5404 {not in Vi}
5405 This option specifies a function to be called by the |g@| operator.
5406 See |:map-operator| for more info and an example.
5407
5408 This option cannot be set from a |modeline| or in the |sandbox|, for
5409 security reasons.
5410
5411
Bram Moolenaar251e1912011-06-19 05:09:16 +02005412 *'osfiletype'* *'oft'*
5413'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 local to buffer
5415 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005416 This option was supported on RISC OS, which has been removed.
5417
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005419 *'packpath'* *'pp'*
5420'packpath' 'pp' string (default: see 'runtimepath')
5421 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005422 Directories used to find packages. See |packages|.
5423
5424
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005426'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 global
5428 Specifies the nroff macros that separate paragraphs. These are pairs
5429 of two letters (see |object-motions|).
5430
5431 *'paste'* *'nopaste'*
5432'paste' boolean (default off)
5433 global
5434 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005435 Put Vim in Paste mode. This is useful if you want to cut or copy
5436 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437 unexpected effects.
5438 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005439 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 knows about pasting and will mostly do the right thing without 'paste'
5441 being set. The same is true for a terminal where Vim handles the
5442 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005443 This option is reset when starting the GUI. Thus if you set it in
5444 your .vimrc it will work in a terminal, but not in the GUI. Setting
5445 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5446 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 When the 'paste' option is switched on (also when it was already on):
5448 - mapping in Insert mode and Command-line mode is disabled
5449 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005451 - 'expandtab' is reset
5452 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 - 'revins' is reset
5454 - 'ruler' is reset
5455 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005456 - 'smartindent' is reset
5457 - 'smarttab' is reset
5458 - 'softtabstop' is set to 0
5459 - 'textwidth' is set to 0
5460 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005463 - 'indentexpr'
5464 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 NOTE: When you start editing another file while the 'paste' option is
5466 on, settings from the modelines or autocommands may change the
5467 settings again, causing trouble when pasting text. You might want to
5468 set the 'paste' option again.
5469 When the 'paste' option is reset the mentioned options are restored to
5470 the value before the moment 'paste' was switched from off to on.
5471 Resetting 'paste' before ever setting it does not have any effect.
5472 Since mapping doesn't work while 'paste' is active, you need to use
5473 the 'pastetoggle' option to toggle the 'paste' option with some key.
5474
5475 *'pastetoggle'* *'pt'*
5476'pastetoggle' 'pt' string (default "")
5477 global
5478 {not in Vi}
5479 When non-empty, specifies the key sequence that toggles the 'paste'
5480 option. This is like specifying a mapping: >
5481 :map {keys} :set invpaste<CR>
5482< Where {keys} is the value of 'pastetoggle'.
5483 The difference is that it will work even when 'paste' is set.
5484 'pastetoggle' works in Insert mode and Normal mode, but not in
5485 Command-line mode.
5486 Mappings are checked first, thus overrule 'pastetoggle'. However,
5487 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5488 this: >
5489 :map <F10> :set paste<CR>
5490 :map <F11> :set nopaste<CR>
5491 :imap <F10> <C-O>:set paste<CR>
5492 :imap <F11> <nop>
5493 :set pastetoggle=<F11>
5494< This will make <F10> start paste mode and <F11> stop paste mode.
5495 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5496 mode everything is inserted literally, except the 'pastetoggle' key
5497 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005498 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499
5500 *'pex'* *'patchexpr'*
5501'patchexpr' 'pex' string (default "")
5502 global
5503 {not in Vi}
5504 {not available when compiled without the |+diff|
5505 feature}
5506 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005507 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508
Bram Moolenaardbc28022014-07-26 13:40:44 +02005509 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510'patchmode' 'pm' string (default "")
5511 global
5512 {not in Vi}
5513 When non-empty the oldest version of a file is kept. This can be used
5514 to keep the original version of a file if you are changing files in a
5515 source distribution. Only the first time that a file is written a
5516 copy of the original file will be kept. The name of the copy is the
5517 name of the original file with the string in the 'patchmode' option
5518 appended. This option should start with a dot. Use a string like
5519 ".org". 'backupdir' must not be empty for this to work (Detail: The
5520 backup file is renamed to the patchmode file after the new file has
5521 been successfully written, that's why it must be possible to write a
5522 backup file). If there was no file to be backed up, an empty file is
5523 created.
5524 When the 'backupskip' pattern matches, a patchmode file is not made.
5525 Using 'patchmode' for compressed files appends the extension at the
5526 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5527 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005528 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005530 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531'path' 'pa' string (default on Unix: ".,/usr/include,,"
5532 on OS/2: ".,/emx/include,,"
5533 other systems: ".,,")
5534 global or local to buffer |global-local|
5535 {not in Vi}
5536 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005537 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5538 provided that the file being searched for has a relative path (not
5539 starting with "/", "./" or "../"). The directories in the 'path'
5540 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 - Use commas to separate directory names: >
5542 :set path=.,/usr/local/include,/usr/include
5543< - Spaces can also be used to separate directory names (for backwards
5544 compatibility with version 3.0). To have a space in a directory
5545 name, precede it with an extra backslash, and escape the space: >
5546 :set path=.,/dir/with\\\ space
5547< - To include a comma in a directory name precede it with an extra
5548 backslash: >
5549 :set path=.,/dir/with\\,comma
5550< - To search relative to the directory of the current file, use: >
5551 :set path=.
5552< - To search in the current directory use an empty string between two
5553 commas: >
5554 :set path=,,
5555< - A directory name may end in a ':' or '/'.
5556 - Environment variables are expanded |:set_env|.
5557 - When using |netrw.vim| URLs can be used. For example, adding
5558 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005559 - Search upwards and downwards in a directory tree using "*", "**" and
5560 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 {not available when compiled without the |+path_extra| feature}
5562 - Careful with '\' characters, type two to get one in the option: >
5563 :set path=.,c:\\include
5564< Or just use '/' instead: >
5565 :set path=.,c:/include
5566< Don't forget "." or files won't even be found in the same directory as
5567 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005568 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569 it is something like 256 or 1024 characters.
5570 You can check if all the include files are found, using the value of
5571 'path', see |:checkpath|.
5572 The use of |:set+=| and |:set-=| is preferred when adding or removing
5573 directories from the list. This avoids problems when a future version
5574 uses another default. To remove the current directory use: >
5575 :set path-=
5576< To add the current directory use: >
5577 :set path+=
5578< To use an environment variable, you probably need to replace the
5579 separator. Here is an example to append $INCL, in which directory
5580 names are separated with a semi-colon: >
5581 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5582< Replace the ';' with a ':' or whatever separator is used. Note that
5583 this doesn't work when $INCL contains a comma or white space.
5584
Bram Moolenaard94464e2015-11-02 15:28:18 +01005585 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005586'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005587 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005588 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005589 {only available when compiled with the |+perl/dyn|
5590 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005591 Specifies the name of the Perl shared library. The default is
5592 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005593 This option cannot be set from a |modeline| or in the |sandbox|, for
5594 security reasons.
5595
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5597'preserveindent' 'pi' boolean (default off)
5598 local to buffer
5599 {not in Vi}
5600 When changing the indent of the current line, preserve as much of the
5601 indent structure as possible. Normally the indent is replaced by a
5602 series of tabs followed by spaces as required (unless |'expandtab'| is
5603 enabled, in which case only spaces are used). Enabling this option
5604 means the indent will preserve as many existing characters as possible
5605 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005606 'expandtab' does not apply to the preserved white space, a Tab remains
5607 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 NOTE: When using ">>" multiple times the resulting indent is a mix of
5609 tabs and spaces. You might not like this.
5610 NOTE: 'preserveindent' is reset when 'compatible' is set.
5611 Also see 'copyindent'.
5612 Use |:retab| to clean up white space.
5613
5614 *'previewheight'* *'pvh'*
5615'previewheight' 'pvh' number (default 12)
5616 global
5617 {not in Vi}
5618 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005619 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 Default height for a preview window. Used for |:ptag| and associated
5621 commands. Used for |CTRL-W_}| when no count is given.
5622
5623 *'previewwindow'* *'nopreviewwindow'*
5624 *'pvw'* *'nopvw'* *E590*
5625'previewwindow' 'pvw' boolean (default off)
5626 local to window
5627 {not in Vi}
5628 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005629 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005630 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 set. It's normally not set directly, but by using one of the commands
5632 |:ptag|, |:pedit|, etc.
5633
5634 *'printdevice'* *'pdev'*
5635'printdevice' 'pdev' string (default empty)
5636 global
5637 {not in Vi}
5638 {only available when compiled with the |+printer|
5639 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005640 The name of the printer to be used for |:hardcopy|.
5641 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005642 This option cannot be set from a |modeline| or in the |sandbox|, for
5643 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644
Bram Moolenaar8299df92004-07-10 09:47:34 +00005645 *'printencoding'* *'penc'*
5646'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 global
5648 {not in Vi}
5649 {only available when compiled with the |+printer|
5650 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005651 Sets the character encoding used when printing.
5652 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653
5654 *'printexpr'* *'pexpr'*
5655'printexpr' 'pexpr' String (default: see below)
5656 global
5657 {not in Vi}
5658 {only available when compiled with the |+printer|
5659 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005660 Expression used to print the PostScript produced with |:hardcopy|.
5661 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662
Bram Moolenaar8299df92004-07-10 09:47:34 +00005663 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664'printfont' 'pfn' string (default "courier")
5665 global
5666 {not in Vi}
5667 {only available when compiled with the |+printer|
5668 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005669 The name of the font that will be used for |:hardcopy|.
5670 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671
5672 *'printheader'* *'pheader'*
5673'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5674 global
5675 {not in Vi}
5676 {only available when compiled with the |+printer|
5677 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005678 The format of the header produced in |:hardcopy| output.
5679 See |pheader-option|.
5680
5681 *'printmbcharset'* *'pmbcs'*
5682'printmbcharset' 'pmbcs' string (default "")
5683 global
5684 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005685 {only available when compiled with the |+printer|,
5686 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005687 The CJK character set to be used for CJK output from |:hardcopy|.
5688 See |pmbcs-option|.
5689
5690 *'printmbfont'* *'pmbfn'*
5691'printmbfont' 'pmbfn' string (default "")
5692 global
5693 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005694 {only available when compiled with the |+printer|,
5695 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005696 List of font names to be used for CJK output from |:hardcopy|.
5697 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698
5699 *'printoptions'* *'popt'*
5700'printoptions' 'popt' string (default "")
5701 global
5702 {not in Vi}
5703 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005704 List of items that control the format of the output of |:hardcopy|.
5705 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005707 *'prompt'* *'noprompt'*
5708'prompt' boolean (default on)
5709 global
5710 When on a ":" prompt is used in Ex mode.
5711
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005712 *'pumheight'* *'ph'*
5713'pumheight' 'ph' number (default 0)
5714 global
5715 {not available when compiled without the
5716 |+insert_expand| feature}
5717 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005718 Determines the maximum number of items to show in the popup menu for
5719 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005720 |ins-completion-menu|.
5721
Bram Moolenaard94464e2015-11-02 15:28:18 +01005722 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005723'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005724 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005725 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005726 {only available when compiled with the |+python/dyn|
5727 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005728 Specifies the name of the Python 2.x shared library. The default is
5729 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005730 This option cannot be set from a |modeline| or in the |sandbox|, for
5731 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005732
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005733 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005734'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005735 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005736 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005737 {only available when compiled with the |+python3/dyn|
5738 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005739 Specifies the name of the Python 3 shared library. The default is
5740 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005741 This option cannot be set from a |modeline| or in the |sandbox|, for
5742 security reasons.
5743
Bram Moolenaar677ee682005-01-27 14:41:15 +00005744 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005745'quoteescape' 'qe' string (default "\")
5746 local to buffer
5747 {not in Vi}
5748 The characters that are used to escape quotes in a string. Used for
5749 objects like a', a" and a` |a'|.
5750 When one of the characters in this option is found inside a string,
5751 the following character will be skipped. The default value makes the
5752 text "foo\"bar\\" considered to be one string.
5753
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5755'readonly' 'ro' boolean (default off)
5756 local to buffer
5757 If on, writes fail unless you use a '!'. Protects you from
5758 accidentally overwriting a file. Default on when Vim is started
5759 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005760 When using ":w!" the 'readonly' option is reset for the current
5761 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005762 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005763 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005765 *'redrawtime'* *'rdt'*
5766'redrawtime' 'rdt' number (default 2000)
5767 global
5768 {not in Vi}
5769 {only available when compiled with the |+reltime|
5770 feature}
5771 The time in milliseconds for redrawing the display. This applies to
5772 searching for patterns for 'hlsearch' and |:match| highlighting.
5773 When redrawing takes more than this many milliseconds no further
5774 matches will be highlighted. This is used to avoid that Vim hangs
5775 when using a very complicated pattern.
5776
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005777 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005778'regexpengine' 're' number (default 0)
5779 global
5780 {not in Vi}
5781 This selects the default regexp engine. |two-engines|
5782 The possible values are:
5783 0 automatic selection
5784 1 old engine
5785 2 NFA engine
5786 Note that when using the NFA engine and the pattern contains something
5787 that is not supported the pattern will not match. This is only useful
5788 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005789 Using automatic selection enables Vim to switch the engine, if the
5790 default engine becomes too costly. E.g., when the NFA engine uses too
5791 many states. This should prevent Vim from hanging on a combination of
5792 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005793
Bram Moolenaar64486672010-05-16 15:46:46 +02005794 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5795'relativenumber' 'rnu' boolean (default off)
5796 local to window
5797 {not in Vi}
5798 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005799 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005800 precede some vertical motion commands (e.g. j k + -) with, without
5801 having to calculate it yourself. Especially useful in combination with
5802 other commands (e.g. y d c < > gq gw =).
5803 When the 'n' option is excluded from 'cpoptions' a wrapped
5804 line will not use the column of line numbers (this is the default when
5805 'compatible' isn't set).
5806 The 'numberwidth' option can be used to set the room used for the line
5807 number.
5808 When a long, wrapped line doesn't start with the first character, '-'
5809 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005810 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5811 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005812
5813 The number in front of the cursor line also depends on the value of
5814 'number', see |number_relativenumber| for all combinations of the two
5815 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005816
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 *'remap'* *'noremap'*
5818'remap' boolean (default on)
5819 global
5820 Allows for mappings to work recursively. If you do not want this for
5821 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005822 NOTE: To avoid portability problems with Vim scripts, always keep
5823 this option at the default "on". Only switch it off when working with
5824 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005826 *'renderoptions'* *'rop'*
5827'renderoptions' 'rop' string (default: empty)
5828 global
5829 {not in Vi}
5830 {only available when compiled with GUI and DIRECTX on
5831 MS-Windows}
5832 Select a text renderer and set its options. The options depend on the
5833 renderer.
5834
5835 Syntax: >
5836 set rop=type:{renderer}(,{name}:{value})*
5837<
5838 Currently, only one optional renderer is available.
5839
5840 render behavior ~
5841 directx Vim will draw text using DirectX (DirectWrite). It makes
5842 drawn glyphs more beautiful than default GDI.
5843 It requires 'encoding' is "utf-8", and only works on
5844 MS-Windows Vista or newer version.
5845
5846 Options:
5847 name meaning type value ~
5848 gamma gamma float 1.0 - 2.2 (maybe)
5849 contrast enhancedContrast float (unknown)
5850 level clearTypeLevel float (unknown)
5851 geom pixelGeometry int 0 - 2 (see below)
5852 renmode renderingMode int 0 - 6 (see below)
5853 taamode textAntialiasMode int 0 - 3 (see below)
5854
5855 See this URL for detail:
5856 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5857
5858 For geom: structure of a device pixel.
5859 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5860 1 - DWRITE_PIXEL_GEOMETRY_RGB
5861 2 - DWRITE_PIXEL_GEOMETRY_BGR
5862
5863 See this URL for detail:
5864 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5865
5866 For renmode: method of rendering glyphs.
5867 0 - DWRITE_RENDERING_MODE_DEFAULT
5868 1 - DWRITE_RENDERING_MODE_ALIASED
5869 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5870 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5871 4 - DWRITE_RENDERING_MODE_NATURAL
5872 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5873 6 - DWRITE_RENDERING_MODE_OUTLINE
5874
5875 See this URL for detail:
5876 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5877
5878 For taamode: antialiasing mode used for drawing text.
5879 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5880 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5881 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5882 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5883
5884 See this URL for detail:
5885 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5886
5887 Example: >
5888 set encoding=utf-8
5889 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5890 set rop=type:directx
5891<
5892 If select a raster font (Courier, Terminal or FixedSys) to
5893 'guifont', it fallbacks to be drawn by GDI automatically.
5894
5895 Other render types are currently not supported.
5896
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 *'report'*
5898'report' number (default 2)
5899 global
5900 Threshold for reporting number of lines changed. When the number of
5901 changed lines is more than 'report' a message will be given for most
5902 ":" commands. If you want it always, set 'report' to 0.
5903 For the ":substitute" command the number of substitutions is used
5904 instead of the number of lines.
5905
5906 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5907'restorescreen' 'rs' boolean (default on)
5908 global
5909 {not in Vi} {only in Windows 95/NT console version}
5910 When set, the screen contents is restored when exiting Vim. This also
5911 happens when executing external commands.
5912
5913 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5914 options in your .vimrc. To disable restoring:
5915 set t_ti= t_te=
5916 To enable restoring (for an xterm):
5917 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5918 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5919
5920 *'revins'* *'ri'* *'norevins'* *'nori'*
5921'revins' 'ri' boolean (default off)
5922 global
5923 {not in Vi}
5924 {only available when compiled with the |+rightleft|
5925 feature}
5926 Inserting characters in Insert mode will work backwards. See "typing
5927 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5928 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005929 NOTE: This option is reset when 'compatible' is set.
5930 This option is reset when 'paste' is set and restored when 'paste' is
5931 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932
5933 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5934'rightleft' 'rl' boolean (default off)
5935 local to window
5936 {not in Vi}
5937 {only available when compiled with the |+rightleft|
5938 feature}
5939 When on, display orientation becomes right-to-left, i.e., characters
5940 that are stored in the file appear from the right to the left.
5941 Using this option, it is possible to edit files for languages that
5942 are written from the right to the left such as Hebrew and Arabic.
5943 This option is per window, so it is possible to edit mixed files
5944 simultaneously, or to view the same file in both ways (this is
5945 useful whenever you have a mixed text file with both right-to-left
5946 and left-to-right strings so that both sets are displayed properly
5947 in different windows). Also see |rileft.txt|.
5948
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005949 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950'rightleftcmd' 'rlc' string (default "search")
5951 local to window
5952 {not in Vi}
5953 {only available when compiled with the |+rightleft|
5954 feature}
5955 Each word in this option enables the command line editing to work in
5956 right-to-left mode for a group of commands:
5957
5958 search "/" and "?" commands
5959
5960 This is useful for languages such as Hebrew, Arabic and Farsi.
5961 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5962
Bram Moolenaard94464e2015-11-02 15:28:18 +01005963 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005964'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005965 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005966 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005967 {only available when compiled with the |+ruby/dyn|
5968 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005969 Specifies the name of the Ruby shared library. The default is
5970 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005971 This option cannot be set from a |modeline| or in the |sandbox|, for
5972 security reasons.
5973
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 *'ruler'* *'ru'* *'noruler'* *'noru'*
5975'ruler' 'ru' boolean (default off)
5976 global
5977 {not in Vi}
5978 {not available when compiled without the
5979 |+cmdline_info| feature}
5980 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005981 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 text in the file is shown on the far right:
5983 Top first line is visible
5984 Bot last line is visible
5985 All first and last line are visible
5986 45% relative position in the file
5987 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005988 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005990 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 this option takes precedence over 'ruler' and 'rulerformat'
5992 If the number of characters displayed is different from the number of
5993 bytes in the text (e.g., for a TAB or a multi-byte character), both
5994 the text column (byte number) and the screen column are shown,
5995 separated with a dash.
5996 For an empty line "0-1" is shown.
5997 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02005998 This option is reset when 'paste' is set and restored when 'paste' is
5999 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 If you don't want to see the ruler all the time but want to know where
6001 you are, use "g CTRL-G" |g_CTRL-G|.
6002 NOTE: This option is reset when 'compatible' is set.
6003
6004 *'rulerformat'* *'ruf'*
6005'rulerformat' 'ruf' string (default empty)
6006 global
6007 {not in Vi}
6008 {not available when compiled without the |+statusline|
6009 feature}
6010 When this option is not empty, it determines the content of the ruler
6011 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006012 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 The default ruler width is 17 characters. To make the ruler 15
6014 characters wide, put "%15(" at the start and "%)" at the end.
6015 Example: >
6016 :set rulerformat=%15(%c%V\ %p%%%)
6017<
6018 *'runtimepath'* *'rtp'* *vimfiles*
6019'runtimepath' 'rtp' string (default:
6020 Unix: "$HOME/.vim,
6021 $VIM/vimfiles,
6022 $VIMRUNTIME,
6023 $VIM/vimfiles/after,
6024 $HOME/.vim/after"
6025 Amiga: "home:vimfiles,
6026 $VIM/vimfiles,
6027 $VIMRUNTIME,
6028 $VIM/vimfiles/after,
6029 home:vimfiles/after"
6030 PC, OS/2: "$HOME/vimfiles,
6031 $VIM/vimfiles,
6032 $VIMRUNTIME,
6033 $VIM/vimfiles/after,
6034 $HOME/vimfiles/after"
6035 Macintosh: "$VIM:vimfiles,
6036 $VIMRUNTIME,
6037 $VIM:vimfiles:after"
6038 RISC-OS: "Choices:vimfiles,
6039 $VIMRUNTIME,
6040 Choices:vimfiles/after"
6041 VMS: "sys$login:vimfiles,
6042 $VIM/vimfiles,
6043 $VIMRUNTIME,
6044 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006045 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 global
6047 {not in Vi}
6048 This is a list of directories which will be searched for runtime
6049 files:
6050 filetype.vim filetypes by file name |new-filetype|
6051 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006052 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 colors/ color scheme files |:colorscheme|
6054 compiler/ compiler files |:compiler|
6055 doc/ documentation |write-local-help|
6056 ftplugin/ filetype plugins |write-filetype-plugin|
6057 indent/ indent scripts |indent-expression|
6058 keymap/ key mapping files |mbyte-keymap|
6059 lang/ menu translations |:menutrans|
6060 menu.vim GUI menus |menu.vim|
6061 plugin/ plugin scripts |write-plugin|
6062 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006063 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 syntax/ syntax files |mysyntaxfile|
6065 tutor/ files for vimtutor |tutor|
6066
6067 And any other file searched for with the |:runtime| command.
6068
6069 The defaults for most systems are setup to search five locations:
6070 1. In your home directory, for your personal preferences.
6071 2. In a system-wide Vim directory, for preferences from the system
6072 administrator.
6073 3. In $VIMRUNTIME, for files distributed with Vim.
6074 *after-directory*
6075 4. In the "after" directory in the system-wide Vim directory. This is
6076 for the system administrator to overrule or add to the distributed
6077 defaults (rarely needed)
6078 5. In the "after" directory in your home directory. This is for
6079 personal preferences to overrule or add to the distributed defaults
6080 or system-wide settings (rarely needed).
6081
6082 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6083 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006084 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 wildcards.
6086 See |:runtime|.
6087 Example: >
6088 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6089< This will use the directory "~/vimruntime" first (containing your
6090 personal Vim runtime files), then "/mygroup/vim" (shared between a
6091 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6092 files).
6093 You probably should always include $VIMRUNTIME somewhere, to use the
6094 distributed runtime files. You can put a directory before $VIMRUNTIME
6095 to find files which replace a distributed runtime files. You can put
6096 a directory after $VIMRUNTIME to find files which add to distributed
6097 runtime files.
6098 This option cannot be set from a |modeline| or in the |sandbox|, for
6099 security reasons.
6100
6101 *'scroll'* *'scr'*
6102'scroll' 'scr' number (default: half the window height)
6103 local to window
6104 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6105 set to half the number of lines in the window when the window size
6106 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006107 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6109 the number of screen lines instead of file lines, makes a difference
6110 when lines wrap}
6111
6112 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6113'scrollbind' 'scb' boolean (default off)
6114 local to window
6115 {not in Vi}
6116 {not available when compiled without the |+scrollbind|
6117 feature}
6118 See also |scroll-binding|. When this option is set, the current
6119 window scrolls as other scrollbind windows (windows that also have
6120 this option set) scroll. This option is useful for viewing the
6121 differences between two versions of a file, see 'diff'.
6122 See |'scrollopt'| for options that determine how this option should be
6123 interpreted.
6124 This option is mostly reset when splitting a window to edit another
6125 file. This means that ":split | edit file" results in two windows
6126 with scroll-binding, but ":split file" does not.
6127
6128 *'scrolljump'* *'sj'*
6129'scrolljump' 'sj' number (default 1)
6130 global
6131 {not in Vi}
6132 Minimal number of lines to scroll when the cursor gets off the
6133 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6134 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006135 When set to a negative number from -1 to -100 this is used as the
6136 percentage of the window height. Thus -50 scrolls half the window
6137 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 NOTE: This option is set to 1 when 'compatible' is set.
6139
6140 *'scrolloff'* *'so'*
6141'scrolloff' 'so' number (default 0)
6142 global
6143 {not in Vi}
6144 Minimal number of screen lines to keep above and below the cursor.
6145 This will make some context visible around where you are working. If
6146 you set it to a very large value (999) the cursor line will always be
6147 in the middle of the window (except at the start or end of the file or
6148 when long lines wrap).
6149 For scrolling horizontally see 'sidescrolloff'.
6150 NOTE: This option is set to 0 when 'compatible' is set.
6151
6152 *'scrollopt'* *'sbo'*
6153'scrollopt' 'sbo' string (default "ver,jump")
6154 global
6155 {not available when compiled without the |+scrollbind|
6156 feature}
6157 {not in Vi}
6158 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006159 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6160 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 The following words are available:
6162 ver Bind vertical scrolling for 'scrollbind' windows
6163 hor Bind horizontal scrolling for 'scrollbind' windows
6164 jump Applies to the offset between two windows for vertical
6165 scrolling. This offset is the difference in the first
6166 displayed line of the bound windows. When moving
6167 around in a window, another 'scrollbind' window may
6168 reach a position before the start or after the end of
6169 the buffer. The offset is not changed though, when
6170 moving back the 'scrollbind' window will try to scroll
6171 to the desired position when possible.
6172 When now making that window the current one, two
6173 things can be done with the relative offset:
6174 1. When "jump" is not included, the relative offset is
6175 adjusted for the scroll position in the new current
6176 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006177 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 2. When "jump" is included, the other windows are
6179 scrolled to keep the same relative offset. When
6180 going back to the other window, it still uses the
6181 same relative offset.
6182 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006183 When 'diff' mode is active there always is vertical scroll binding,
6184 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185
6186 *'sections'* *'sect'*
6187'sections' 'sect' string (default "SHNHH HUnhsh")
6188 global
6189 Specifies the nroff macros that separate sections. These are pairs of
6190 two letters (See |object-motions|). The default makes a section start
6191 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6192
6193 *'secure'* *'nosecure'* *E523*
6194'secure' boolean (default off)
6195 global
6196 {not in Vi}
6197 When on, ":autocmd", shell and write commands are not allowed in
6198 ".vimrc" and ".exrc" in the current directory and map commands are
6199 displayed. Switch it off only if you know that you will not run into
6200 problems, or when the 'exrc' option is off. On Unix this option is
6201 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006202 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 'secure' at the end of your ~/.vimrc then.
6204 This option cannot be set from a |modeline| or in the |sandbox|, for
6205 security reasons.
6206
6207 *'selection'* *'sel'*
6208'selection' 'sel' string (default "inclusive")
6209 global
6210 {not in Vi}
6211 This option defines the behavior of the selection. It is only used
6212 in Visual and Select mode.
6213 Possible values:
6214 value past line inclusive ~
6215 old no yes
6216 inclusive yes yes
6217 exclusive yes no
6218 "past line" means that the cursor is allowed to be positioned one
6219 character past the line.
6220 "inclusive" means that the last character of the selection is included
6221 in an operation. For example, when "x" is used to delete the
6222 selection.
6223 Note that when "exclusive" is used and selecting from the end
6224 backwards, you cannot include the last character of a line, when
6225 starting in Normal mode and 'virtualedit' empty.
6226
6227 The 'selection' option is set by the |:behave| command.
6228
6229 *'selectmode'* *'slm'*
6230'selectmode' 'slm' string (default "")
6231 global
6232 {not in Vi}
6233 This is a comma separated list of words, which specifies when to start
6234 Select mode instead of Visual mode, when a selection is started.
6235 Possible values:
6236 mouse when using the mouse
6237 key when using shifted special keys
6238 cmd when using "v", "V" or CTRL-V
6239 See |Select-mode|.
6240 The 'selectmode' option is set by the |:behave| command.
6241
6242 *'sessionoptions'* *'ssop'*
6243'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006244 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 global
6246 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006247 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 feature}
6249 Changes the effect of the |:mksession| command. It is a comma
6250 separated list of words. Each word enables saving and restoring
6251 something:
6252 word save and restore ~
6253 blank empty windows
6254 buffers hidden and unloaded buffers, not just those in windows
6255 curdir the current directory
6256 folds manually created folds, opened/closed folds and local
6257 fold options
6258 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006259 and contain at least one lowercase letter. Only
6260 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 help the help window
6262 localoptions options and mappings local to a window or buffer (not
6263 global values for local options)
6264 options all options and mappings (also global values for local
6265 options)
6266 resize size of the Vim window: 'lines' and 'columns'
6267 sesdir the directory in which the session file is located
6268 will become the current directory (useful with
6269 projects accessed over a network from different
6270 systems)
6271 slash backslashes in file names replaced with forward
6272 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006273 tabpages all tab pages; without this only the current tab page
6274 is restored, so that you can make a session for each
6275 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 unix with Unix end-of-line format (single <NL>), even when
6277 on Windows or DOS
6278 winpos position of the whole Vim window
6279 winsize window sizes
6280
6281 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006282 When neither "curdir" nor "sesdir" is included, file names are stored
6283 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 "slash" and "unix" are useful on Windows when sharing session files
6285 with Unix. The Unix version of Vim cannot source dos format scripts,
6286 but the Windows version of Vim can source unix format scripts.
6287
6288 *'shell'* *'sh'* *E91*
6289'shell' 'sh' string (default $SHELL or "sh",
6290 MS-DOS and Win32: "command.com" or
6291 "cmd.exe", OS/2: "cmd")
6292 global
6293 Name of the shell to use for ! and :! commands. When changing the
6294 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6295 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006296 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 See |option-backslash| about including spaces and backslashes.
6298 Environment variables are expanded |:set_env|.
6299 If the name of the shell contains a space, you might need to enclose
6300 it in quotes. Example: >
6301 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6302< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 "-f" is not inside the quotes, because it is not part of the command
6305 name. And Vim automagically recognizes the backslashes that are path
6306 separators.
6307 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6308 variable to change the way external commands are executed. See the
6309 libc.inf file of DJGPP.
6310 Under MS-Windows, when the executable ends in ".com" it must be
6311 included. Thus setting the shell to "command.com" or "4dos.com"
6312 works, but "command" and "4dos" do not work for all commands (e.g.,
6313 filtering).
6314 For unknown reasons, when using "4dos.com" the current directory is
6315 changed to "C:\". To avoid this set 'shell' like this: >
6316 :set shell=command.com\ /c\ 4dos
6317< This option cannot be set from a |modeline| or in the |sandbox|, for
6318 security reasons.
6319
6320 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006321'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006322 MS-DOS and Win32, when 'shell' does not
6323 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 global
6325 {not in Vi}
6326 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6327 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6328 systems, the default is set according to the value of 'shell', to
6329 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006330 OS/2 (EMX figures this out itself).
6331 On Unix it can have more than one flag. Each white space separated
6332 part is passed as an argument to the shell command.
6333 See |option-backslash| about including spaces and backslashes.
6334 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 This option cannot be set from a |modeline| or in the |sandbox|, for
6336 security reasons.
6337
6338 *'shellpipe'* *'sp'*
6339'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6340 global
6341 {not in Vi}
6342 {not available when compiled without the |+quickfix|
6343 feature}
6344 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006345 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 including spaces and backslashes.
6347 The name of the temporary file can be represented by "%s" if necessary
6348 (the file name is appended automatically if no %s appears in the value
6349 of this option).
6350 For the Amiga and MS-DOS the default is ">". The output is directly
6351 saved in a file and not echoed to the screen.
6352 For Unix the default it "| tee". The stdout of the compiler is saved
6353 in a file and echoed to the screen. If the 'shell' option is "csh" or
6354 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006355 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6356 default becomes "2>&1| tee". This means that stderr is also included.
6357 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6358 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 The initialization of this option is done after reading the ".vimrc"
6360 and the other initializations, so that when the 'shell' option is set
6361 there, the 'shellpipe' option changes automatically, unless it was
6362 explicitly set before.
6363 When 'shellpipe' is set to an empty string, no redirection of the
6364 ":make" output will be done. This is useful if you use a 'makeprg'
6365 that writes to 'makeef' by itself. If you want no piping, but do
6366 want to include the 'makeef', set 'shellpipe' to a single space.
6367 Don't forget to precede the space with a backslash: ":set sp=\ ".
6368 In the future pipes may be used for filtering and this option will
6369 become obsolete (at least for Unix).
6370 This option cannot be set from a |modeline| or in the |sandbox|, for
6371 security reasons.
6372
6373 *'shellquote'* *'shq'*
6374'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6375 contains "sh" somewhere: "\"")
6376 global
6377 {not in Vi}
6378 Quoting character(s), put around the command passed to the shell, for
6379 the "!" and ":!" commands. The redirection is kept outside of the
6380 quoting. See 'shellxquote' to include the redirection. It's
6381 probably not useful to set both options.
6382 This is an empty string by default. Only known to be useful for
6383 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6384 or bash, where it should be "\"". The default is adjusted according
6385 the value of 'shell', to reduce the need to set this option by the
6386 user. See |dos-shell|.
6387 This option cannot be set from a |modeline| or in the |sandbox|, for
6388 security reasons.
6389
6390 *'shellredir'* *'srr'*
6391'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6392 global
6393 {not in Vi}
6394 String to be used to put the output of a filter command in a temporary
6395 file. See also |:!|. See |option-backslash| about including spaces
6396 and backslashes.
6397 The name of the temporary file can be represented by "%s" if necessary
6398 (the file name is appended automatically if no %s appears in the value
6399 of this option).
6400 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6401 or "zsh" during initializations, the default becomes ">&". If the
6402 'shell' option is "sh", "ksh" or "bash" the default becomes
6403 ">%s 2>&1". This means that stderr is also included.
6404 For Win32, the Unix checks are done and additionally "cmd" is checked
6405 for, which makes the default ">%s 2>&1". Also, the same names with
6406 ".exe" appended are checked for.
6407 The initialization of this option is done after reading the ".vimrc"
6408 and the other initializations, so that when the 'shell' option is set
6409 there, the 'shellredir' option changes automatically unless it was
6410 explicitly set before.
6411 In the future pipes may be used for filtering and this option will
6412 become obsolete (at least for Unix).
6413 This option cannot be set from a |modeline| or in the |sandbox|, for
6414 security reasons.
6415
6416 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6417'shellslash' 'ssl' boolean (default off)
6418 global
6419 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6420 When set, a forward slash is used when expanding file names. This is
6421 useful when a Unix-like shell is used instead of command.com or
6422 cmd.exe. Backward slashes can still be typed, but they are changed to
6423 forward slashes by Vim.
6424 Note that setting or resetting this option has no effect for some
6425 existing file names, thus this option needs to be set before opening
6426 any file for best results. This might change in the future.
6427 'shellslash' only works when a backslash can be used as a path
6428 separator. To test if this is so use: >
6429 if exists('+shellslash')
6430<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006431 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6432'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6433 global
6434 {not in Vi}
6435 When on, use temp files for shell commands. When off use a pipe.
6436 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006437 Currently a pipe is only supported on Unix and MS-Windows 2K and
6438 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006439 :if has("filterpipe")
6440< The advantage of using a pipe is that nobody can read the temp file
6441 and the 'shell' command does not need to support redirection.
6442 The advantage of using a temp file is that the file type and encoding
6443 can be detected.
6444 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6445 |FilterWritePost| autocommands event are not triggered when
6446 'shelltemp' is off.
6447
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 *'shelltype'* *'st'*
6449'shelltype' 'st' number (default 0)
6450 global
6451 {not in Vi} {only for the Amiga}
6452 On the Amiga this option influences the way how the commands work
6453 which use a shell.
6454 0 and 1: always use the shell
6455 2 and 3: use the shell only to filter lines
6456 4 and 5: use shell only for ':sh' command
6457 When not using the shell, the command is executed directly.
6458
6459 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6460 1 and 3: use "shell cmd" to start external commands
6461
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006462 *'shellxescape'* *'sxe'*
6463'shellxescape' 'sxe' string (default: "";
6464 for MS-DOS and MS-Windows: "\"&|<>()@^")
6465 global
6466 {not in Vi}
6467 When 'shellxquote' is set to "(" then the characters listed in this
6468 option will be escaped with a '^' character. This makes it possible
6469 to execute most external commands with cmd.exe.
6470
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 *'shellxquote'* *'sxq'*
6472'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006473 for Win32, when 'shell' is cmd.exe: "("
6474 for Win32, when 'shell' contains "sh"
6475 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 for Unix, when using system(): "\"")
6477 global
6478 {not in Vi}
6479 Quoting character(s), put around the command passed to the shell, for
6480 the "!" and ":!" commands. Includes the redirection. See
6481 'shellquote' to exclude the redirection. It's probably not useful
6482 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006483 When the value is '(' then ')' is appended. When the value is '"('
6484 then ')"' is appended.
6485 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006486 This is an empty string by default on most systems, but is known to be
6487 useful for on Win32 version, either for cmd.exe which automatically
6488 strips off the first and last quote on a command, or 3rd-party shells
6489 such as the MKS Korn Shell or bash, where it should be "\"". The
6490 default is adjusted according the value of 'shell', to reduce the need
6491 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492 This option cannot be set from a |modeline| or in the |sandbox|, for
6493 security reasons.
6494
6495 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6496'shiftround' 'sr' boolean (default off)
6497 global
6498 {not in Vi}
6499 Round indent to multiple of 'shiftwidth'. Applies to > and <
6500 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6501 a multiple of 'shiftwidth' (this is Vi compatible).
6502 NOTE: This option is reset when 'compatible' is set.
6503
6504 *'shiftwidth'* *'sw'*
6505'shiftwidth' 'sw' number (default 8)
6506 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006507 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006509 When zero the 'ts' value will be used. Use the |shiftwidth()|
6510 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511
6512 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006513'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6514 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 global
6516 {not in Vi}
6517 This option helps to avoid all the |hit-enter| prompts caused by file
6518 messages, for example with CTRL-G, and to avoid some other messages.
6519 It is a list of flags:
6520 flag meaning when present ~
6521 f use "(3 of 5)" instead of "(file 3 of 5)"
6522 i use "[noeol]" instead of "[Incomplete last line]"
6523 l use "999L, 888C" instead of "999 lines, 888 characters"
6524 m use "[+]" instead of "[Modified]"
6525 n use "[New]" instead of "[New File]"
6526 r use "[RO]" instead of "[readonly]"
6527 w use "[w]" instead of "written" for file write message
6528 and "[a]" instead of "appended" for ':w >> file' command
6529 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6530 "[unix format]" and "[mac]" instead of "[mac format]".
6531 a all of the above abbreviations
6532
6533 o overwrite message for writing a file with subsequent message
6534 for reading a file (useful for ":wn" or when 'autowrite' on)
6535 O message for reading a file overwrites any previous message.
6536 Also for quickfix message (e.g., ":cn").
6537 s don't give "search hit BOTTOM, continuing at TOP" or "search
6538 hit TOP, continuing at BOTTOM" messages
6539 t truncate file message at the start if it is too long to fit
6540 on the command-line, "<" will appear in the left most column.
6541 Ignored in Ex mode.
6542 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006543 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 Ignored in Ex mode.
6545 W don't give "written" or "[w]" when writing a file
6546 A don't give the "ATTENTION" message when an existing swap file
6547 is found.
6548 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006549 c don't give |ins-completion-menu| messages. For example,
6550 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6551 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006552 q use "recording" instead of "recording @a"
6553 F don't give the file info when editing a file, like `:silent`
6554 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555
6556 This gives you the opportunity to avoid that a change between buffers
6557 requires you to hit <Enter>, but still gives as useful a message as
6558 possible for the space available. To get the whole message that you
6559 would have got with 'shm' empty, use ":file!"
6560 Useful values:
6561 shm= No abbreviation of message.
6562 shm=a Abbreviation, but no loss of information.
6563 shm=at Abbreviation, and truncate message when necessary.
6564
6565 NOTE: This option is set to the Vi default value when 'compatible' is
6566 set and to the Vim default value when 'compatible' is reset.
6567
6568 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6569'shortname' 'sn' boolean (default off)
6570 local to buffer
6571 {not in Vi, not in MS-DOS versions}
6572 Filenames are assumed to be 8 characters plus one extension of 3
6573 characters. Multiple dots in file names are not allowed. When this
6574 option is on, dots in file names are replaced with underscores when
6575 adding an extension (".~" or ".swp"). This option is not available
6576 for MS-DOS, because then it would always be on. This option is useful
6577 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6578 or crossdos. When running the Win32 GUI version under Win32s, this
6579 option is always on by default.
6580
6581 *'showbreak'* *'sbr'* *E595*
6582'showbreak' 'sbr' string (default "")
6583 global
6584 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006585 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 feature}
6587 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006588 values are "> " or "+++ ": >
6589 :set showbreak=>\
6590< Note the backslash to escape the trailing space. It's easier like
6591 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006592 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006593< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 comma (in a future version the comma might be used to separate the
6595 part that is shown at the end and at the start of a line).
6596 The characters are highlighted according to the '@' flag in
6597 'highlight'.
6598 Note that tabs after the showbreak will be displayed differently.
6599 If you want the 'showbreak' to appear in between line numbers, add the
6600 "n" flag to 'cpoptions'.
6601
6602 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6603'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6604 off)
6605 global
6606 {not in Vi}
6607 {not available when compiled without the
6608 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006609 Show (partial) command in the last line of the screen. Set this
6610 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 In Visual mode the size of the selected area is shown:
6612 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006613 If the number of bytes is different it is also displayed: "2-6"
6614 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006616 - When selecting a block, the size in screen characters:
6617 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 NOTE: This option is set to the Vi default value when 'compatible' is
6619 set and to the Vim default value when 'compatible' is reset.
6620
6621 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6622'showfulltag' 'sft' boolean (default off)
6623 global
6624 {not in Vi}
6625 When completing a word in insert mode (see |ins-completion|) from the
6626 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006627 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 matched a C function, you can see a template for what arguments are
6629 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006630 Note that this doesn't work well together with having "longest" in
6631 'completeopt', because the completion from the search pattern may not
6632 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633
6634 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6635'showmatch' 'sm' boolean (default off)
6636 global
6637 When a bracket is inserted, briefly jump to the matching one. The
6638 jump is only done if the match can be seen on the screen. The time to
6639 show the match can be set with 'matchtime'.
6640 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006641 seen or not).
6642 This option is reset when 'paste' is set and restored when 'paste' is
6643 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 When the 'm' flag is not included in 'cpoptions', typing a character
6645 will immediately move the cursor back to where it belongs.
6646 See the "sm" field in 'guicursor' for setting the cursor shape and
6647 blinking when showing the match.
6648 The 'matchpairs' option can be used to specify the characters to show
6649 matches for. 'rightleft' and 'revins' are used to look for opposite
6650 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006651 Also see the matchparen plugin for highlighting the match when moving
6652 around |pi_paren.txt|.
6653 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006654
6655 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6656'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6657 global
6658 If in Insert, Replace or Visual mode put a message on the last line.
6659 Use the 'M' flag in 'highlight' to set the type of highlighting for
6660 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006661 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 doesn't mean XIM is really active, especially when 'imactivatekey' is
6663 not set.
6664 NOTE: This option is set to the Vi default value when 'compatible' is
6665 set and to the Vim default value when 'compatible' is reset.
6666
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006667 *'showtabline'* *'stal'*
6668'showtabline' 'stal' number (default 1)
6669 global
6670 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006671 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006672 feature}
6673 The value of this option specifies when the line with tab page labels
6674 will be displayed:
6675 0: never
6676 1: only if there are at least two tab pages
6677 2: always
6678 This is both for the GUI and non-GUI implementation of the tab pages
6679 line.
6680 See |tab-page| for more information about tab pages.
6681
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 *'sidescroll'* *'ss'*
6683'sidescroll' 'ss' number (default 0)
6684 global
6685 {not in Vi}
6686 The minimal number of columns to scroll horizontally. Used only when
6687 the 'wrap' option is off and the cursor is moved off of the screen.
6688 When it is zero the cursor will be put in the middle of the screen.
6689 When using a slow terminal set it to a large number or 0. When using
6690 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6691 commands.
6692
6693 *'sidescrolloff'* *'siso'*
6694'sidescrolloff' 'siso' number (default 0)
6695 global
6696 {not in Vi}
6697 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006698 right of the cursor if 'nowrap' is set. Setting this option to a
6699 value greater than 0 while having |'sidescroll'| also at a non-zero
6700 value makes some context visible in the line you are scrolling in
6701 horizontally (except at beginning of the line). Setting this option
6702 to a large value (like 999) has the effect of keeping the cursor
6703 horizontally centered in the window, as long as one does not come too
6704 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705 NOTE: This option is set to 0 when 'compatible' is set.
6706
6707 Example: Try this together with 'sidescroll' and 'listchars' as
6708 in the following example to never allow the cursor to move
6709 onto the "extends" character:
6710
6711 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6712 :set sidescrolloff=1
6713
6714
6715 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6716'smartcase' 'scs' boolean (default off)
6717 global
6718 {not in Vi}
6719 Override the 'ignorecase' option if the search pattern contains upper
6720 case characters. Only used when the search pattern is typed and
6721 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006722 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6724 recalling the search pattern from history and hitting <Enter>.
6725 NOTE: This option is reset when 'compatible' is set.
6726
6727 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6728'smartindent' 'si' boolean (default off)
6729 local to buffer
6730 {not in Vi}
6731 {not available when compiled without the
6732 |+smartindent| feature}
6733 Do smart autoindenting when starting a new line. Works for C-like
6734 programs, but can also be used for other languages. 'cindent' does
6735 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006736 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006737 setting 'si' has no effect. 'indentexpr' is a more advanced
6738 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 Normally 'autoindent' should also be on when using 'smartindent'.
6740 An indent is automatically inserted:
6741 - After a line ending in '{'.
6742 - After a line starting with a keyword from 'cinwords'.
6743 - Before a line starting with '}' (only with the "O" command).
6744 When typing '}' as the first character in a new line, that line is
6745 given the same indent as the matching '{'.
6746 When typing '#' as the first character in a new line, the indent for
6747 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006748 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6750 When using the ">>" command, lines starting with '#' are not shifted
6751 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006752 NOTE: 'smartindent' is reset when 'compatible' is set.
6753 This option is reset when 'paste' is set and restored when 'paste' is
6754 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755
6756 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6757'smarttab' 'sta' boolean (default off)
6758 global
6759 {not in Vi}
6760 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006761 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6762 <BS> will delete a 'shiftwidth' worth of space at the start of the
6763 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006764 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006765 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6766 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006767 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006769 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006770 This option is reset when 'paste' is set and restored when 'paste' is
6771 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 NOTE: This option is reset when 'compatible' is set.
6773
6774 *'softtabstop'* *'sts'*
6775'softtabstop' 'sts' number (default 0)
6776 local to buffer
6777 {not in Vi}
6778 Number of spaces that a <Tab> counts for while performing editing
6779 operations, like inserting a <Tab> or using <BS>. It "feels" like
6780 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6781 used. This is useful to keep the 'ts' setting at its standard value
6782 of 8, while being able to edit like it is set to 'sts'. However,
6783 commands like "x" still work on the actual characters.
6784 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006785 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006786 'softtabstop' is set to 0 when the 'paste' option is set and restored
6787 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006788 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6789 spaces is minimized by using <Tab>s.
6790 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6791 set.
6792 NOTE: This option is set to 0 when 'compatible' is set.
6793
Bram Moolenaar217ad922005-03-20 22:37:15 +00006794 *'spell'* *'nospell'*
6795'spell' boolean (default off)
6796 local to window
6797 {not in Vi}
6798 {not available when compiled without the |+syntax|
6799 feature}
6800 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006801 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006802
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006803 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006804'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006805 local to buffer
6806 {not in Vi}
6807 {not available when compiled without the |+syntax|
6808 feature}
6809 Pattern to locate the end of a sentence. The following word will be
6810 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006811 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006812 When this check is not wanted make this option empty.
6813 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006814 Be careful with special characters, see |option-backslash| about
6815 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006816 To set this option automatically depending on the language, see
6817 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006818
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006819 *'spellfile'* *'spf'*
6820'spellfile' 'spf' string (default empty)
6821 local to buffer
6822 {not in Vi}
6823 {not available when compiled without the |+syntax|
6824 feature}
6825 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006826 commands. It must end in ".{encoding}.add". You need to include the
6827 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006828 *E765*
6829 It may also be a comma separated list of names. A count before the
6830 |zg| and |zw| commands can be used to access each. This allows using
6831 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006832 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006833 you: Using the first directory in 'runtimepath' that is writable. If
6834 there is no "spell" directory yet it will be created. For the file
6835 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006836 ignoring the region.
6837 The resulting ".spl" file will be used for spell checking, it does not
6838 have to appear in 'spelllang'.
6839 Normally one file is used for all regions, but you can add the region
6840 name if you want to. However, it will then only be used when
6841 'spellfile' is set to it, for entries in 'spelllang' only files
6842 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006843 This option cannot be set from a |modeline| or in the |sandbox|, for
6844 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006845
Bram Moolenaar217ad922005-03-20 22:37:15 +00006846 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006847'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006848 local to buffer
6849 {not in Vi}
6850 {not available when compiled without the |+syntax|
6851 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006852 A comma separated list of word list names. When the 'spell' option is
6853 on spellchecking will be done for these languages. Example: >
6854 set spelllang=en_us,nl,medical
6855< This means US English, Dutch and medical words are recognized. Words
6856 that are not recognized will be highlighted.
6857 The word list name must not include a comma or dot. Using a dash is
6858 recommended to separate the two letter language name from a
6859 specification. Thus "en-rare" is used for rare English words.
6860 A region name must come last and have the form "_xx", where "xx" is
6861 the two-letter, lower case region name. You can use more than one
6862 region by listing them: "en_us,en_ca" supports both US and Canadian
6863 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006864 Britain. (Note: currently en_au and en_nz dictionaries are older than
6865 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006866 If the name "cjk" is included East Asian characters are excluded from
6867 spell checking. This is useful when editing text that also has Asian
6868 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006869 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006870 As a special case the name of a .spl file can be given as-is. The
6871 first "_xx" in the name is removed and used as the region name
6872 (_xx is an underscore, two letters and followed by a non-letter).
6873 This is mainly for testing purposes. You must make sure the correct
6874 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006875 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006876 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6877 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006878 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006879
Bram Moolenaar98692072006-02-04 00:57:42 +00006880 If the |spellfile.vim| plugin is active and you use a language name
6881 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6882 will ask you if you want to download the file.
6883
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006884 After this option has been set successfully, Vim will source the files
6885 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006886 up to the first comma, dot or underscore.
6887 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006888
6889
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006890 *'spellsuggest'* *'sps'*
6891'spellsuggest' 'sps' string (default "best")
6892 global
6893 {not in Vi}
6894 {not available when compiled without the |+syntax|
6895 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006896 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006897 the |spellsuggest()| function. This is a comma-separated list of
6898 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006899
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006900 best Internal method that works best for English. Finds
6901 changes like "fast" and uses a bit of sound-a-like
6902 scoring to improve the ordering.
6903
6904 double Internal method that uses two methods and mixes the
6905 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006906 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006907 word. That only works when the language specifies
6908 sound folding. Can be slow and doesn't always give
6909 better results.
6910
6911 fast Internal method that only checks for simple changes:
6912 character inserts/deletes/swaps. Works well for
6913 simple typing mistakes.
6914
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006915 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006916 Not used for |spellsuggest()|. The number of
6917 suggestions is never more than the value of 'lines'
6918 minus two.
6919
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006920 file:{filename} Read file {filename}, which must have two columns,
6921 separated by a slash. The first column contains the
6922 bad word, the second column the suggested good word.
6923 Example:
6924 theribal/terrible ~
6925 Use this for common mistakes that do not appear at the
6926 top of the suggestion list with the internal methods.
6927 Lines without a slash are ignored, use this for
6928 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006929 The word in the second column must be correct,
6930 otherwise it will not be used. Add the word to an
6931 ".add" file if it is currently flagged as a spelling
6932 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006933 The file is used for all languages.
6934
6935 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6936 trouble with spaces. |v:val| holds the badly spelled
6937 word. The expression must evaluate to a List of
6938 Lists, each with a suggestion and a score.
6939 Example:
6940 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006941 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006942 internal methods use. A lower score is better.
6943 This may invoke |spellsuggest()| if you temporarily
6944 set 'spellsuggest' to exclude the "expr:" part.
6945 Errors are silently ignored, unless you set the
6946 'verbose' option to a non-zero value.
6947
6948 Only one of "best", "double" or "fast" may be used. The others may
6949 appear several times in any order. Example: >
6950 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6951<
6952 This option cannot be set from a |modeline| or in the |sandbox|, for
6953 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006954
6955
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6957'splitbelow' 'sb' boolean (default off)
6958 global
6959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006960 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 feature}
6962 When on, splitting a window will put the new window below the current
6963 one. |:split|
6964
6965 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6966'splitright' 'spr' boolean (default off)
6967 global
6968 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006969 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 feature}
6971 When on, splitting a window will put the new window right of the
6972 current one. |:vsplit|
6973
6974 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6975'startofline' 'sol' boolean (default on)
6976 global
6977 {not in Vi}
6978 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006979 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006980 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006981 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 with a linewise operator, with "%" with a count and to buffer changing
6983 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6984 only has a line number, e.g., ":25" or ":+".
6985 In case of buffer changing commands the cursor is placed at the column
6986 where it was the last time the buffer was edited.
6987 NOTE: This option is set when 'compatible' is set.
6988
Bram Moolenaar00654022011-02-25 14:42:19 +01006989 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006991 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 {not in Vi}
6993 {not available when compiled without the |+statusline|
6994 feature}
6995 When nonempty, this option determines the content of the status line.
6996 Also see |status-line|.
6997
6998 The option consists of printf style '%' items interspersed with
6999 normal text. Each status line item is of the form:
7000 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007001 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007002 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003
Bram Moolenaar238a5642006-02-21 22:12:05 +00007004 When the option starts with "%!" then it is used as an expression,
7005 evaluated and the result is used as the option value. Example: >
7006 :set statusline=%!MyStatusLine()
7007< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007008 Note that the "%!" expression is evaluated in the context of the
7009 current window and buffer, while %{} items are evaluated in the
7010 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007011
7012 When there is error while evaluating the option then it will be made
7013 empty to avoid further errors. Otherwise screen updating would loop.
7014
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 Note that the only effect of 'ruler' when this option is set (and
7016 'laststatus' is 2) is controlling the output of |CTRL-G|.
7017
7018 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007019 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007021 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 minwid Minimum width of the item, padding as set by '-' & '0'.
7023 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007024 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007025 on the left for text items. Numeric items will be
7026 shifted down to maxwid-2 digits followed by '>'number
7027 where number is the amount of missing digits, much like
7028 an exponential notation.
7029 item A one letter code as described below.
7030
7031 Following is a description of the possible statusline items. The
7032 second character in "item" is the type:
7033 N for number
7034 S for string
7035 F for flags as described below
7036 - not applicable
7037
7038 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007039 f S Path to the file in the buffer, as typed or relative to current
7040 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041 F S Full path to the file in the buffer.
7042 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007043 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007045 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007047 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007049 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007051 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7053 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007054 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7056 being used: "<keymap>"
7057 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007058 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 B N As above, in hexadecimal.
7060 o N Byte number in file of byte under cursor, first byte is 1.
7061 Mnemonic: Offset from start of file (with one added)
7062 {not available when compiled without |+byte_offset| feature}
7063 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007064 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065 l N Line number.
7066 L N Number of lines in buffer.
7067 c N Column number.
7068 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007069 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 p N Percentage through file in lines as in |CTRL-G|.
7071 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007072 percentage described for 'ruler'. Always 3 in length, unless
7073 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007074 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007076 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007077 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 ( - Start of item group. Can be used for setting the width and
7079 alignment of a section. Must be followed by %) somewhere.
7080 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007081 T N For 'tabline': start of tab page N label. Use %T after the last
7082 label. This information is used for mouse clicks.
7083 X N For 'tabline': start of close tab N label. Use %X after the
7084 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7085 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 < - Where to truncate line if too long. Default is at the start.
7087 No width fields allowed.
7088 = - Separation point between left and right aligned items.
7089 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007090 # - Set highlight group. The name must follow and then a # again.
7091 Thus use %#HLname# for highlight group HLname. The same
7092 highlighting is used, also for the statusline of non-current
7093 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007095 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 The difference between User{N} and StatusLine will be applied
7097 to StatusLineNC for the statusline of non-current windows.
7098 The number N must be between 1 and 9. See |hl-User1..9|
7099
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007100 When displaying a flag, Vim removes the leading comma, if any, when
7101 that flag comes right after plaintext. This will make a nice display
7102 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103
Bram Moolenaar582fd852005-03-28 20:58:01 +00007104 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 not set) and a minwid is not set for the group, the whole group will
7106 become empty. This will make a group like the following disappear
7107 completely from the statusline when none of the flags are set. >
7108 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007109< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 Beware that an expression is evaluated each and every time the status
7111 line is displayed. The current buffer and current window will be set
7112 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007113 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007115 real current buffer.
7116
Bram Moolenaar30b65812012-07-12 22:01:11 +02007117 The 'statusline' option will be evaluated in the |sandbox| if set from
7118 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007119
7120 It is not allowed to change text or jump to another window while
7121 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007122
7123 If the statusline is not updated when you want it (e.g., after setting
7124 a variable that's used in an expression), you can force an update by
7125 setting an option without changing its value. Example: >
7126 :let &ro = &ro
7127
7128< A result of all digits is regarded a number for display purposes.
7129 Otherwise the result is taken as flag text and applied to the rules
7130 described above.
7131
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007132 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7134 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7135
7136 Examples:
7137 Emulate standard status line with 'ruler' set >
7138 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7139< Similar, but add ASCII value of char under the cursor (like "ga") >
7140 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7141< Display byte count and byte value, modified flag in red. >
7142 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7143 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7144< Display a ,GZ flag if a compressed file is loaded >
7145 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7146< In the |:autocmd|'s: >
7147 :let b:gzflag = 1
7148< And: >
7149 :unlet b:gzflag
7150< And define this function: >
7151 :function VarExists(var, val)
7152 : if exists(a:var) | return a:val | else | return '' | endif
7153 :endfunction
7154<
7155 *'suffixes'* *'su'*
7156'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7157 global
7158 {not in Vi}
7159 Files with these suffixes get a lower priority when multiple files
7160 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007161 suffixes. Spaces after the comma are ignored. A dot is also seen as
7162 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 separator, precede it with a backslash (see |option-backslash| about
7164 including spaces and backslashes).
7165 See 'wildignore' for completely ignoring files.
7166 The use of |:set+=| and |:set-=| is preferred when adding or removing
7167 suffixes from the list. This avoids problems when a future version
7168 uses another default.
7169
7170 *'suffixesadd'* *'sua'*
7171'suffixesadd' 'sua' string (default "")
7172 local to buffer
7173 {not in Vi}
7174 {not available when compiled without the
7175 |+file_in_path| feature}
7176 Comma separated list of suffixes, which are used when searching for a
7177 file for the "gf", "[I", etc. commands. Example: >
7178 :set suffixesadd=.java
7179<
7180 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7181'swapfile' 'swf' boolean (default on)
7182 local to buffer
7183 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007184 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 swapfile is not wanted for a specific buffer. For example, with
7186 confidential information that even root must not be able to access.
7187 Careful: All text will be in memory:
7188 - Don't use this for big files.
7189 - Recovery will be impossible!
7190 A swapfile will only be present when |'updatecount'| is non-zero and
7191 'swapfile' is set.
7192 When 'swapfile' is reset, the swap file for the current buffer is
7193 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7194 non-zero, a swap file is immediately created.
7195 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007196 If you want to open a new buffer without creating a swap file for it,
7197 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198
7199 This option is used together with 'bufhidden' and 'buftype' to
7200 specify special kinds of buffers. See |special-buffers|.
7201
7202 *'swapsync'* *'sws'*
7203'swapsync' 'sws' string (default "fsync")
7204 global
7205 {not in Vi}
7206 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007207 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 When this option is empty parts of the swap file may be in memory and
7209 not written to disk. When the system crashes you may lose more work.
7210 On Unix the system does a sync now and then without Vim asking for it,
7211 so the disadvantage of setting this option off is small. On some
7212 systems the swap file will not be written at all. For a unix system
7213 setting it to "sync" will use the sync() call instead of the default
7214 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007215 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216
7217 *'switchbuf'* *'swb'*
7218'switchbuf' 'swb' string (default "")
7219 global
7220 {not in Vi}
7221 This option controls the behavior when switching between buffers.
7222 Possible values (comma separated list):
7223 useopen If included, jump to the first open window that
7224 contains the specified buffer (if there is one).
7225 Otherwise: Do not examine other windows.
7226 This setting is checked with |quickfix| commands, when
7227 jumping to errors (":cc", ":cn", "cp", etc.). It is
7228 also used in all buffer related split commands, for
7229 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007230 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007231 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007233 a buffer for a |quickfix| command that display errors.
7234 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007235 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007236 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007237 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007239 *'synmaxcol'* *'smc'*
7240'synmaxcol' 'smc' number (default 3000)
7241 local to buffer
7242 {not in Vi}
7243 {not available when compiled without the |+syntax|
7244 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007245 Maximum column in which to search for syntax items. In long lines the
7246 text after this column is not highlighted and following lines may not
7247 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007248 This helps to avoid very slow redrawing for an XML file that is one
7249 long line.
7250 Set to zero to remove the limit.
7251
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 *'syntax'* *'syn'*
7253'syntax' 'syn' string (default empty)
7254 local to buffer
7255 {not in Vi}
7256 {not available when compiled without the |+syntax|
7257 feature}
7258 When this option is set, the syntax with this name is loaded, unless
7259 syntax highlighting has been switched off with ":syntax off".
7260 Otherwise this option does not always reflect the current syntax (the
7261 b:current_syntax variable does).
7262 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007263 not automatically recognized. Example, in an IDL file:
7264 /* vim: set syntax=idl : */ ~
7265 When a dot appears in the value then this separates two filetype
7266 names. Example:
7267 /* vim: set syntax=c.doxygen : */ ~
7268 This will use the "c" syntax first, then the "doxygen" syntax.
7269 Note that the second one must be prepared to be loaded as an addition,
7270 otherwise it will be skipped. More than one dot may appear.
7271 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007272 :set syntax=OFF
7273< To switch syntax highlighting on according to the current value of the
7274 'filetype' option: >
7275 :set syntax=ON
7276< What actually happens when setting the 'syntax' option is that the
7277 Syntax autocommand event is triggered with the value as argument.
7278 This option is not copied to another buffer, independent of the 's' or
7279 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007280 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007282 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007283'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007284 global
7285 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007286 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007287 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007288 When nonempty, this option determines the content of the tab pages
7289 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007290 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007291
7292 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007293 option and only when there is no GUI tab line. When 'e' is in
7294 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007295 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007296
7297 The value is evaluated like with 'statusline'. You can use
7298 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007299 the text to be displayed. Use "%1T" for the first label, "%2T" for
7300 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007301
7302 Keep in mind that only one of the tab pages is the current one, others
7303 are invisible and you can't jump to their windows.
7304
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007305
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007306 *'tabpagemax'* *'tpm'*
7307'tabpagemax' 'tpm' number (default 10)
7308 global
7309 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007310 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007311 feature}
7312 Maximum number of tab pages to be opened by the |-p| command line
7313 argument or the ":tab all" command. |tabpage|
7314
7315
7316 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317'tabstop' 'ts' number (default 8)
7318 local to buffer
7319 Number of spaces that a <Tab> in the file counts for. Also see
7320 |:retab| command, and 'softtabstop' option.
7321
7322 Note: Setting 'tabstop' to any other value than 8 can make your file
7323 appear wrong in many places (e.g., when printing it).
7324
7325 There are four main ways to use tabs in Vim:
7326 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7327 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007328 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 behave like a tab appears every 4 (or 3) characters.
7330 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7331 'expandtab'. This way you will always insert spaces. The
7332 formatting will never be messed up when 'tabstop' is changed.
7333 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007334 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 works when using Vim to edit the file.
7336 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7337 'noexpandtab'. This should then work (for initial indents only)
7338 for any tabstop setting that people use. It might be nice to have
7339 tabs after the first non-blank inserted as spaces if you do this
7340 though. Otherwise aligned comments will be wrong when 'tabstop' is
7341 changed.
7342
7343 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7344'tagbsearch' 'tbs' boolean (default on)
7345 global
7346 {not in Vi}
7347 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007348 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 searching makes searching for a tag a LOT faster, but a linear search
7350 will find more tags if the tags file wasn't properly sorted.
7351 Vim normally assumes that your tags files are sorted, or indicate that
7352 they are not sorted. Only when this is not the case does the
7353 'tagbsearch' option need to be switched off.
7354
7355 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007356 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 certain files, or retry all files with a linear search. When
7358 'tagbsearch' is off, only a linear search is done.
7359
7360 Linear searching is done anyway, for one file, when Vim finds a line
7361 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007362 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007363< [The whitespace before and after the '0' must be a single <Tab>]
7364
7365 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007366 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 instead of a normal tag name, a retry is done with a linear search.
7368 Tags in unsorted tags files, and matches with different case will only
7369 be found in the retry.
7370
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007371 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007372 linear search can be avoided when case is ignored. Use a value of '2'
7373 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7374 sorted with the -f switch to "sort" in most unices, as in the command:
7375 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7376 (at least 5.5) the --sort=foldcase switch can be used for this as
7377 well. Note that case must be folded to uppercase for this to work.
7378
7379 By default, tag searches are case-sensitive. Case is ignored when
7380 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7381 "ignore".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382
7383 When 'tagbsearch' is off, tags searching is slower when a full match
7384 exists, but faster when no full match exists. Tags in unsorted tags
7385 files may only be found with 'tagbsearch' off.
7386 When the tags file is not sorted, or sorted in a wrong way (not on
7387 ASCII byte value), 'tagbsearch' should be off, or the line given above
7388 must be included in the tags file.
7389 This option doesn't affect commands that find all matching tags (e.g.,
7390 command-line completion and ":help").
7391 {Vi: always uses binary search in some versions}
7392
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007393 *'tagcase'* *'tc'*
7394'tagcase' 'tc' string (default "followic")
7395 global or local to buffer |global-local|
7396 {not in Vi}
7397 This option specifies how case is handled when searching the tags
7398 file:
7399 followic Follow the 'ignorecase' option
7400 ignore Ignore case
7401 match Match case
7402
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 *'taglength'* *'tl'*
7404'taglength' 'tl' number (default 0)
7405 global
7406 If non-zero, tags are significant up to this number of characters.
7407
7408 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7409'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7410 global
7411 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007412 If on and using a tags file in another directory, file names in that
7413 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 NOTE: This option is set to the Vi default value when 'compatible' is
7415 set and to the Vim default value when 'compatible' is reset.
7416
7417 *'tags'* *'tag'* *E433*
7418'tags' 'tag' string (default "./tags,tags", when compiled with
7419 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7420 global or local to buffer |global-local|
7421 Filenames for the tag command, separated by spaces or commas. To
7422 include a space or comma in a file name, precede it with a backslash
7423 (see |option-backslash| about including spaces and backslashes).
7424 When a file name starts with "./", the '.' is replaced with the path
7425 of the current file. But only when the 'd' flag is not included in
7426 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7427 |tags-option|.
7428 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007429 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7430 find all files named "tags" below "/lib". The filename itself cannot
7431 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7432 files called "tags?". {not available when compiled without the
7433 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007434 The |tagfiles()| function can be used to get a list of the file names
7435 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7437 files are also supported. They are automatically recognized. The
7438 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7439 differences are ignored (MS-Windows). |emacs-tags|
7440 The use of |:set+=| and |:set-=| is preferred when adding or removing
7441 file names from the list. This avoids problems when a future version
7442 uses another default.
7443 {Vi: default is "tags /usr/lib/tags"}
7444
7445 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7446'tagstack' 'tgst' boolean (default on)
7447 global
7448 {not in all versions of Vi}
7449 When on, the |tagstack| is used normally. When off, a ":tag" or
7450 ":tselect" command with an argument will not push the tag onto the
7451 tagstack. A following ":tag" without an argument, a ":pop" command or
7452 any other command that uses the tagstack will use the unmodified
7453 tagstack, but does change the pointer to the active entry.
7454 Resetting this option is useful when using a ":tag" command in a
7455 mapping which should not change the tagstack.
7456
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007457 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007458'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007459 global
7460 {not in Vi}
7461 {only available when compiled with the |+tcl/dyn|
7462 feature}
7463 Specifies the name of the Tcl shared library. The default is
7464 DYNAMIC_TCL_DLL, which was specified at compile time.
7465 This option cannot be set from a |modeline| or in the |sandbox|, for
7466 security reasons.
7467
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 *'term'* *E529* *E530* *E531*
7469'term' string (default is $TERM, if that fails:
7470 in the GUI: "builtin_gui"
7471 on Amiga: "amiga"
7472 on BeOS: "beos-ansi"
7473 on Mac: "mac-ansi"
7474 on MiNT: "vt52"
7475 on MS-DOS: "pcterm"
7476 on OS/2: "os2ansi"
7477 on Unix: "ansi"
7478 on VMS: "ansi"
7479 on Win 32: "win32")
7480 global
7481 Name of the terminal. Used for choosing the terminal control
7482 characters. Environment variables are expanded |:set_env|.
7483 For example: >
7484 :set term=$TERM
7485< See |termcap|.
7486
7487 *'termbidi'* *'tbidi'*
7488 *'notermbidi'* *'notbidi'*
7489'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7490 global
7491 {not in Vi}
7492 {only available when compiled with the |+arabic|
7493 feature}
7494 The terminal is in charge of Bi-directionality of text (as specified
7495 by Unicode). The terminal is also expected to do the required shaping
7496 that some languages (such as Arabic) require.
7497 Setting this option implies that 'rightleft' will not be set when
7498 'arabic' is set and the value of 'arabicshape' will be ignored.
7499 Note that setting 'termbidi' has the immediate effect that
7500 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7501 This option is reset when the GUI is started.
7502 For further details see |arabic.txt|.
7503
7504 *'termencoding'* *'tenc'*
7505'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7506 Macintosh GUI: "macroman")
7507 global
7508 {only available when compiled with the |+multi_byte|
7509 feature}
7510 {not in Vi}
7511 Encoding used for the terminal. This specifies what character
7512 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007513 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007514 display). Except for the Mac when 'macatsui' is off, then
7515 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007516 *E617*
7517 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7518 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7519 Any attempts to set a different value will be rejected, and an error
7520 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007521 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 because the Win32 system always passes Unicode characters.
7523 When empty, the same encoding is used as for the 'encoding' option.
7524 This is the normal value.
7525 Not all combinations for 'termencoding' and 'encoding' are valid. See
7526 |encoding-table|.
7527 The value for this option must be supported by internal conversions or
7528 iconv(). When this is not possible no conversion will be done and you
7529 will probably experience problems with non-ASCII characters.
7530 Example: You are working with the locale set to euc-jp (Japanese) and
7531 want to edit a UTF-8 file: >
7532 :let &termencoding = &encoding
7533 :set encoding=utf-8
7534< You need to do this when your system has no locale support for UTF-8.
7535
7536 *'terse'* *'noterse'*
7537'terse' boolean (default off)
7538 global
7539 When set: Add 's' flag to 'shortmess' option (this makes the message
7540 for a search that hits the start or end of the file not being
7541 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7542 shortens a lot of messages}
7543
7544 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7545'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7546 global
7547 {not in Vi}
7548 This option is obsolete. Use 'fileformats'.
7549 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7550 set to the default value for the current system. When 'textauto' is
7551 reset, 'fileformats' is made empty.
7552 NOTE: This option is set to the Vi default value when 'compatible' is
7553 set and to the Vim default value when 'compatible' is reset.
7554
7555 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7556'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7557 others: default off)
7558 local to buffer
7559 {not in Vi}
7560 This option is obsolete. Use 'fileformat'.
7561 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7562 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7563 "unix".
7564
7565 *'textwidth'* *'tw'*
7566'textwidth' 'tw' number (default 0)
7567 local to buffer
7568 {not in Vi}
7569 Maximum width of text that is being inserted. A longer line will be
7570 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007571 this.
7572 'textwidth' is set to 0 when the 'paste' option is set and restored
7573 when 'paste' is reset.
7574 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007576 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 NOTE: This option is set to 0 when 'compatible' is set.
7578
7579 *'thesaurus'* *'tsr'*
7580'thesaurus' 'tsr' string (default "")
7581 global or local to buffer |global-local|
7582 {not in Vi}
7583 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007584 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 the file should contain words with similar meaning, separated by
7586 non-keyword characters (white space is preferred). Maximum line
7587 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007588 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007589 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007590 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007591 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 after a comma are ignored, otherwise spaces are included in the file
7593 name. See |option-backslash| about using backslashes.
7594 The use of |:set+=| and |:set-=| is preferred when adding or removing
7595 directories from the list. This avoids problems when a future version
7596 uses another default.
7597 Backticks cannot be used in this option for security reasons.
7598
7599 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7600'tildeop' 'top' boolean (default off)
7601 global
7602 {not in Vi}
7603 When on: The tilde command "~" behaves like an operator.
7604 NOTE: This option is reset when 'compatible' is set.
7605
7606 *'timeout'* *'to'* *'notimeout'* *'noto'*
7607'timeout' 'to' boolean (default on)
7608 global
7609 *'ttimeout'* *'nottimeout'*
7610'ttimeout' boolean (default off)
7611 global
7612 {not in Vi}
7613 These two options together determine the behavior when part of a
7614 mapped key sequence or keyboard code has been received:
7615
7616 'timeout' 'ttimeout' action ~
7617 off off do not time out
7618 on on or off time out on :mappings and key codes
7619 off on time out on key codes
7620
7621 If both options are off, Vim will wait until either the complete
7622 mapping or key sequence has been received, or it is clear that there
7623 is no mapping or key sequence for the received characters. For
7624 example: if you have mapped "vl" and Vim has received 'v', the next
7625 character is needed to see if the 'v' is followed by an 'l'.
7626 When one of the options is on, Vim will wait for about 1 second for
7627 the next character to arrive. After that the already received
7628 characters are interpreted as single characters. The waiting time can
7629 be changed with the 'timeoutlen' option.
7630 On slow terminals or very busy systems timing out may cause
7631 malfunctioning cursor keys. If both options are off, Vim waits
7632 forever after an entered <Esc> if there are key codes that start
7633 with <Esc>. You will have to type <Esc> twice. If you do not have
7634 problems with key codes, but would like to have :mapped key
7635 sequences not timing out in 1 second, set the 'ttimeout' option and
7636 reset the 'timeout' option.
7637
7638 NOTE: 'ttimeout' is reset when 'compatible' is set.
7639
7640 *'timeoutlen'* *'tm'*
7641'timeoutlen' 'tm' number (default 1000)
7642 global
7643 {not in all versions of Vi}
7644 *'ttimeoutlen'* *'ttm'*
7645'ttimeoutlen' 'ttm' number (default -1)
7646 global
7647 {not in Vi}
7648 The time in milliseconds that is waited for a key code or mapped key
7649 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7650 when part of a command has been typed.
7651 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7652 different timeout value for key codes is desired set 'ttimeoutlen' to
7653 a non-negative number.
7654
7655 ttimeoutlen mapping delay key code delay ~
7656 < 0 'timeoutlen' 'timeoutlen'
7657 >= 0 'timeoutlen' 'ttimeoutlen'
7658
7659 The timeout only happens when the 'timeout' and 'ttimeout' options
7660 tell so. A useful setting would be >
7661 :set timeout timeoutlen=3000 ttimeoutlen=100
7662< (time out on mapping after three seconds, time out on key codes after
7663 a tenth of a second).
7664
7665 *'title'* *'notitle'*
7666'title' boolean (default off, on when title can be restored)
7667 global
7668 {not in Vi}
7669 {not available when compiled without the |+title|
7670 feature}
7671 When on, the title of the window will be set to the value of
7672 'titlestring' (if it is not empty), or to:
7673 filename [+=-] (path) - VIM
7674 Where:
7675 filename the name of the file being edited
7676 - indicates the file cannot be modified, 'ma' off
7677 + indicates the file was modified
7678 = indicates the file is read-only
7679 =+ indicates the file is read-only and modified
7680 (path) is the path of the file being edited
7681 - VIM the server name |v:servername| or "VIM"
7682 Only works if the terminal supports setting window titles
7683 (currently Amiga console, Win32 console, all GUI versions and
7684 terminals with a non- empty 't_ts' option - these are Unix xterm and
7685 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7686 *X11*
7687 When Vim was compiled with HAVE_X11 defined, the original title will
7688 be restored if possible. The output of ":version" will include "+X11"
7689 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7690 works for the icon name |'icon'|.
7691 But: When Vim was started with the |-X| argument, restoring the title
7692 will not work (except in the GUI).
7693 If the title cannot be restored, it is set to the value of 'titleold'.
7694 You might want to restore the title outside of Vim then.
7695 When using an xterm from a remote machine you can use this command:
7696 rsh machine_name xterm -display $DISPLAY &
7697 then the WINDOWID environment variable should be inherited and the
7698 title of the window should change back to what it should be after
7699 exiting Vim.
7700
7701 *'titlelen'*
7702'titlelen' number (default 85)
7703 global
7704 {not in Vi}
7705 {not available when compiled without the |+title|
7706 feature}
7707 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007708 title. When the title is longer, only the end of the path name is
7709 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 Using a percentage makes this adapt to the width of the window. But
7711 it won't work perfectly, because the actual number of characters
7712 available also depends on the font used and other things in the title
7713 bar. When 'titlelen' is zero the full path is used. Otherwise,
7714 values from 1 to 30000 percent can be used.
7715 'titlelen' is also used for the 'titlestring' option.
7716
7717 *'titleold'*
7718'titleold' string (default "Thanks for flying Vim")
7719 global
7720 {not in Vi}
7721 {only available when compiled with the |+title|
7722 feature}
7723 This option will be used for the window title when exiting Vim if the
7724 original title cannot be restored. Only happens if 'title' is on or
7725 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007726 This option cannot be set from a |modeline| or in the |sandbox|, for
7727 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 *'titlestring'*
7729'titlestring' string (default "")
7730 global
7731 {not in Vi}
7732 {not available when compiled without the |+title|
7733 feature}
7734 When this option is not empty, it will be used for the title of the
7735 window. This happens only when the 'title' option is on.
7736 Only works if the terminal supports setting window titles (currently
7737 Amiga console, Win32 console, all GUI versions and terminals with a
7738 non-empty 't_ts' option).
7739 When Vim was compiled with HAVE_X11 defined, the original title will
7740 be restored if possible |X11|.
7741 When this option contains printf-style '%' items, they will be
7742 expanded according to the rules used for 'statusline'.
7743 Example: >
7744 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7745 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7746< The value of 'titlelen' is used to align items in the middle or right
7747 of the available space.
7748 Some people prefer to have the file name first: >
7749 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7750< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007751 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 separating space only when needed.
7753 NOTE: Use of special characters in 'titlestring' may cause the display
7754 to be garbled (e.g., when it contains a CR or NL character).
7755 {not available when compiled without the |+statusline| feature}
7756
7757 *'toolbar'* *'tb'*
7758'toolbar' 'tb' string (default "icons,tooltips")
7759 global
7760 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7761 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007762 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 possible values are:
7764 icons Toolbar buttons are shown with icons.
7765 text Toolbar buttons shown with text.
7766 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007767 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 tooltips Tooltips are active for toolbar buttons.
7769 Tooltips refer to the popup help text which appears after the mouse
7770 cursor is placed over a toolbar button for a brief moment.
7771
7772 If you want the toolbar to be shown with icons as well as text, do the
7773 following: >
7774 :set tb=icons,text
7775< Motif and Athena cannot display icons and text at the same time. They
7776 will show icons if both are requested.
7777
7778 If none of the strings specified in 'toolbar' are valid or if
7779 'toolbar' is empty, this option is ignored. If you want to disable
7780 the toolbar, you need to set the 'guioptions' option. For example: >
7781 :set guioptions-=T
7782< Also see |gui-toolbar|.
7783
7784 *'toolbariconsize'* *'tbis'*
7785'toolbariconsize' 'tbis' string (default "small")
7786 global
7787 {not in Vi}
7788 {only in the GTK+ 2 GUI}
7789 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007790 tiny Use tiny icons.
7791 small Use small icons (default).
7792 medium Use medium-sized icons.
7793 large Use large icons.
7794 huge Use even larger icons.
7795 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007796 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007797 the current theme. Common dimensions are giant=48x48, huge=32x32,
7798 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799
7800 If 'toolbariconsize' is empty, the global default size as determined
7801 by user preferences or the current theme is used.
7802
7803 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7804'ttybuiltin' 'tbi' boolean (default on)
7805 global
7806 {not in Vi}
7807 When on, the builtin termcaps are searched before the external ones.
7808 When off the builtin termcaps are searched after the external ones.
7809 When this option is changed, you should set the 'term' option next for
7810 the change to take effect, for example: >
7811 :set notbi term=$TERM
7812< See also |termcap|.
7813 Rationale: The default for this option is "on", because the builtin
7814 termcap entries are generally better (many systems contain faulty
7815 xterm entries...).
7816
7817 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7818'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7819 sun-cmd, screen, rxvt, dtterm or
7820 iris-ansi; also on when running Vim in
7821 a DOS console)
7822 global
7823 {not in Vi}
7824 Indicates a fast terminal connection. More characters will be sent to
7825 the screen for redrawing, instead of using insert/delete line
7826 commands. Improves smoothness of redrawing when there are multiple
7827 windows and the terminal does not support a scrolling region.
7828 Also enables the extra writing of characters at the end of each screen
7829 line for lines that wrap. This helps when using copy/paste with the
7830 mouse in an xterm and other terminals.
7831
7832 *'ttymouse'* *'ttym'*
7833'ttymouse' 'ttym' string (default depends on 'term')
7834 global
7835 {not in Vi}
7836 {only in Unix and VMS, doesn't work in the GUI; not
7837 available when compiled without |+mouse|}
7838 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007839 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 *xterm-mouse*
7841 xterm xterm-like mouse handling. The mouse generates
7842 "<Esc>[Mscr", where "scr" is three bytes:
7843 "s" = button state
7844 "c" = column plus 33
7845 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007846 This only works up to 223 columns! See "dec",
7847 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 xterm2 Works like "xterm", but with the xterm reporting the
7849 mouse position while the mouse is dragged. This works
7850 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007851 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 work. See below for how Vim detects this
7853 automatically.
7854 *netterm-mouse*
7855 netterm NetTerm mouse handling. The mouse generates
7856 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7857 for the row and column.
7858 *dec-mouse*
7859 dec DEC terminal mouse handling. The mouse generates a
7860 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007861 This is also available for an Xterm, if it was
7862 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007863 *jsbterm-mouse*
7864 jsbterm JSB term mouse handling.
7865 *pterm-mouse*
7866 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007867 *urxvt-mouse*
7868 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007869 The mouse works only if the terminal supports this
7870 encoding style, but it does not have 223 columns limit
7871 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007872 *sgr-mouse*
7873 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007874 mouse reporting. The mouse works even in columns
7875 beyond 223. This option is backward compatible with
7876 "xterm2" because it can also decode "xterm2" style
7877 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878
7879 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007880 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7881 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7883 recognized, if enabled at compile time. DEC terminal mouse codes
7884 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007885 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7886 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007888 set to a name that starts with "xterm", "mlterm", or "screen", and
7889 'ttymouse' is not set already.
7890 Additionally, if vim is compiled with the |+termresponse| feature and
7891 |t_RV| is set to the escape sequence to request the xterm version
7892 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007894 from 95 to 276. The "sgr" value will be set if the xterm version is
7895 277 or highter.
7896 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7897 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 :set t_RV=
7899<
7900 *'ttyscroll'* *'tsl'*
7901'ttyscroll' 'tsl' number (default 999)
7902 global
7903 Maximum number of lines to scroll the screen. If there are more lines
7904 to scroll the window is redrawn. For terminals where scrolling is
7905 very slow and redrawing is not slow this can be set to a small number,
7906 e.g., 3, to speed up displaying.
7907
7908 *'ttytype'* *'tty'*
7909'ttytype' 'tty' string (default from $TERM)
7910 global
7911 Alias for 'term', see above.
7912
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007913 *'undodir'* *'udir'*
7914'undodir' 'udir' string (default ".")
7915 global
7916 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007917 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007918 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007919 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007920 "." means using the directory of the file. The undo file name for
7921 "file.txt" is ".file.txt.un~".
7922 For other directories the file name is the full path of the edited
7923 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007924 When writing: The first directory that exists is used. "." always
7925 works, no directories after "." will be used for writing.
7926 When reading all entries are tried to find an undo file. The first
7927 undo file that exists is used. When it cannot be read an error is
7928 given, no further entry is used.
7929 See |undo-persistence|.
7930
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007931 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007932'undofile' 'udf' boolean (default off)
7933 local to buffer
7934 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007935 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007936 When on, Vim automatically saves undo history to an undo file when
7937 writing a buffer to a file, and restores undo history from the same
7938 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007939 The directory where the undo file is stored is specified by 'undodir'.
7940 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007941 The undo file is not read when 'undoreload' causes the buffer from
7942 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007943 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007944
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 *'undolevels'* *'ul'*
7946'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7947 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007948 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 {not in Vi}
7950 Maximum number of changes that can be undone. Since undo information
7951 is kept in memory, higher numbers will cause more memory to be used
7952 (nevertheless, a single change can use an unlimited amount of memory).
7953 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7954 itself: >
7955 set ul=0
7956< But you can also get Vi compatibility by including the 'u' flag in
7957 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007958 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007959 Set to -1 for no undo at all. You might want to do this only for the
7960 current buffer: >
7961 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007963
7964 The local value is set to -123456 when the global value is to be used.
7965
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007966 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007968 *'undoreload'* *'ur'*
7969'undoreload' 'ur' number (default 10000)
7970 global
7971 {not in Vi}
7972 Save the whole buffer for undo when reloading it. This applies to the
7973 ":e!" command and reloading for when the buffer changed outside of
7974 Vim. |FileChangedShell|
7975 The save only happens when this options is negative or when the number
7976 of lines is smaller than the value of this option.
7977 Set this option to zero to disable undo for a reload.
7978
7979 When saving undo for a reload, any undo file is not read.
7980
7981 Note that this causes the whole buffer to be stored in memory. Set
7982 this option to a lower value if you run out of memory.
7983
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 *'updatecount'* *'uc'*
7985'updatecount' 'uc' number (default: 200)
7986 global
7987 {not in Vi}
7988 After typing this many characters the swap file will be written to
7989 disk. When zero, no swap file will be created at all (see chapter on
7990 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7991 Vim with the "-n" option, see |startup|. When editing in readonly
7992 mode this option will be initialized to 10000.
7993 The swapfile can be disabled per buffer with |'swapfile'|.
7994 When 'updatecount' is set from zero to non-zero, swap files are
7995 created for all buffers that have 'swapfile' set. When 'updatecount'
7996 is set to zero, existing swap files are not deleted.
7997 Also see |'swapsync'|.
7998 This option has no meaning in buffers where |'buftype'| is "nofile"
7999 or "nowrite".
8000
8001 *'updatetime'* *'ut'*
8002'updatetime' 'ut' number (default 4000)
8003 global
8004 {not in Vi}
8005 If this many milliseconds nothing is typed the swap file will be
8006 written to disk (see |crash-recovery|). Also used for the
8007 |CursorHold| autocommand event.
8008
8009 *'verbose'* *'vbs'*
8010'verbose' 'vbs' number (default 0)
8011 global
8012 {not in Vi, although some versions have a boolean
8013 verbose option}
8014 When bigger than zero, Vim will give messages about what it is doing.
8015 Currently, these messages are given:
8016 >= 1 When the viminfo file is read or written.
8017 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008018 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 >= 8 Files for which a group of autocommands is executed.
8020 >= 9 Every executed autocommand.
8021 >= 12 Every executed function.
8022 >= 13 When an exception is thrown, caught, finished, or discarded.
8023 >= 14 Anything pending in a ":finally" clause.
8024 >= 15 Every executed Ex command (truncated at 200 characters).
8025
8026 This option can also be set with the "-V" argument. See |-V|.
8027 This option is also set by the |:verbose| command.
8028
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008029 When the 'verbosefile' option is set then the verbose messages are not
8030 displayed.
8031
8032 *'verbosefile'* *'vfile'*
8033'verbosefile' 'vfile' string (default empty)
8034 global
8035 {not in Vi}
8036 When not empty all messages are written in a file with this name.
8037 When the file exists messages are appended.
8038 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008039 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008040 Setting 'verbosefile' to a new value is like making it empty first.
8041 The difference with |:redir| is that verbose messages are not
8042 displayed when 'verbosefile' is set.
8043
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 *'viewdir'* *'vdir'*
8045'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8046 "$VIM/vimfiles/view",
8047 for Unix: "~/.vim/view",
8048 for Macintosh: "$VIM:vimfiles:view"
8049 for VMS: "sys$login:vimfiles/view"
8050 for RiscOS: "Choices:vimfiles/view")
8051 global
8052 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008053 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 feature}
8055 Name of the directory where to store files for |:mkview|.
8056 This option cannot be set from a |modeline| or in the |sandbox|, for
8057 security reasons.
8058
8059 *'viewoptions'* *'vop'*
8060'viewoptions' 'vop' string (default: "folds,options,cursor")
8061 global
8062 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008063 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 feature}
8065 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008066 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 word save and restore ~
8068 cursor cursor position in file and in window
8069 folds manually created folds, opened/closed folds and local
8070 fold options
8071 options options and mappings local to a window or buffer (not
8072 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008073 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 slash backslashes in file names replaced with forward
8075 slashes
8076 unix with Unix end-of-line format (single <NL>), even when
8077 on Windows or DOS
8078
8079 "slash" and "unix" are useful on Windows when sharing view files
8080 with Unix. The Unix version of Vim cannot source dos format scripts,
8081 but the Windows version of Vim can source unix format scripts.
8082
8083 *'viminfo'* *'vi'* *E526* *E527* *E528*
8084'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008085 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8086 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8087 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 global
8089 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008090 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 feature}
8092 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008093 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 separated list of parameters, each consisting of a single character
8095 identifying the particular parameter, followed by a number or string
8096 which specifies the value of that parameter. If a particular
8097 character is left out, then the default value is used for that
8098 parameter. The following is a list of the identifying characters and
8099 the effect of their value.
8100 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008101 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 ! When included, save and restore global variables that start
8103 with an uppercase letter, and don't contain a lowercase
8104 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008105 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008106 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008107 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 " Maximum number of lines saved for each register. Old name of
8109 the '<' item, with the disadvantage that you need to put a
8110 backslash before the ", otherwise it will be recognized as the
8111 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008112 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 % When included, save and restore the buffer list. If Vim is
8114 started with a file name argument, the buffer list is not
8115 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008116 buffer list is restored from the viminfo file. Quickfix
8117 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8118 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008119 When followed by a number, the number specifies the maximum
8120 number of buffers that are stored. Without a number all
8121 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008122 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 ' Maximum number of previously edited files for which the marks
8124 are remembered. This parameter must always be included when
8125 'viminfo' is non-empty.
8126 Including this item also means that the |jumplist| and the
8127 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008128 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008130 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 patterns are also saved. When not included, the value of
8132 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008133 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008135 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008136 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 < Maximum number of lines saved for each register. If zero then
8138 registers are not saved. When not included, all lines are
8139 saved. '"' is the old name for this item.
8140 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008141 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008142 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008143 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008144 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 c When included, convert the text in the viminfo file from the
8146 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008147 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008148 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008149 f Whether file marks need to be stored. If zero, file marks ('0
8150 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008151 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008153 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008154 h Disable the effect of 'hlsearch' when loading the viminfo
8155 file. When not included, it depends on whether ":nohlsearch"
8156 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008157 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 n Name of the viminfo file. The name must immediately follow
8159 the 'n'. Must be the last one! If the "-i" argument was
8160 given when starting Vim, that file name overrides the one
8161 given here with 'viminfo'. Environment variables are expanded
8162 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008163 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 r Removable media. The argument is a string (up to the next
8165 ','). This parameter can be given several times. Each
8166 specifies the start of a path for which no marks will be
8167 stored. This is to avoid removable media. For MS-DOS you
8168 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8169 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8170 ignored. Maximum length of each 'r' argument is 50
8171 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008172 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 s Maximum size of an item in Kbyte. If zero then registers are
8174 not saved. Currently only applies to registers. The default
8175 "s10" will exclude registers with more than 10 Kbyte of text.
8176 Also see the '<' item above: line count limit.
8177
8178 Example: >
8179 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8180<
8181 '50 Marks will be remembered for the last 50 files you
8182 edited.
8183 <1000 Contents of registers (up to 1000 lines each) will be
8184 remembered.
8185 s100 Registers with more than 100 Kbyte text are skipped.
8186 :0 Command-line history will not be saved.
8187 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8188 no / Since '/' is not specified, the default will be used,
8189 that is, save all of the search history, and also the
8190 previous search and substitute patterns.
8191 no % The buffer list will not be saved nor read back.
8192 no h 'hlsearch' highlighting will be restored.
8193
8194 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8195 load the contents of the file, this is not done automatically.
8196
8197 This option cannot be set from a |modeline| or in the |sandbox|, for
8198 security reasons.
8199
8200 *'virtualedit'* *'ve'*
8201'virtualedit' 've' string (default "")
8202 global
8203 {not in Vi}
8204 {not available when compiled without the
8205 |+virtualedit| feature}
8206 A comma separated list of these words:
8207 block Allow virtual editing in Visual block mode.
8208 insert Allow virtual editing in Insert mode.
8209 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008210 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008211
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008213 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 of the line. Useful for selecting a rectangle in Visual mode and
8215 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008216 "onemore" is not the same, it will only allow moving the cursor just
8217 after the last character of the line. This makes some commands more
8218 consistent. Previously the cursor was always past the end of the line
8219 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008220 break some plugins or Vim scripts. For example because |l| can move
8221 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008222 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008223 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008224 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008225 It doesn't make sense to combine "all" with "onemore", but you will
8226 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227
8228 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8229'visualbell' 'vb' boolean (default off)
8230 global
8231 {not in Vi}
8232 Use visual bell instead of beeping. The terminal code to display the
8233 visual bell is given with 't_vb'. When no beep or flash is wanted,
8234 use ":set vb t_vb=".
8235 Note: When the GUI starts, 't_vb' is reset to its default value. You
8236 might want to set it again in your |gvimrc|.
8237 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8238 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8239 where 40 is the time in msec.
8240 Does not work on the Amiga, you always get a screen flash.
8241 Also see 'errorbells'.
8242
8243 *'warn'* *'nowarn'*
8244'warn' boolean (default on)
8245 global
8246 Give a warning message when a shell command is used while the buffer
8247 has been changed.
8248
8249 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8250'weirdinvert' 'wiv' boolean (default off)
8251 global
8252 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008253 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 It is provided for backwards compatibility with version 4.x.
8255 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8256 vice versa. Has no effect when the GUI is running.
8257
8258 *'whichwrap'* *'ww'*
8259'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8260 global
8261 {not in Vi}
8262 Allow specified keys that move the cursor left/right to move to the
8263 previous/next line when the cursor is on the first/last character in
8264 the line. Concatenate characters to allow this for these keys:
8265 char key mode ~
8266 b <BS> Normal and Visual
8267 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008268 h "h" Normal and Visual (not recommended)
8269 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 < <Left> Normal and Visual
8271 > <Right> Normal and Visual
8272 ~ "~" Normal
8273 [ <Left> Insert and Replace
8274 ] <Right> Insert and Replace
8275 For example: >
8276 :set ww=<,>,[,]
8277< allows wrap only when cursor keys are used.
8278 When the movement keys are used in combination with a delete or change
8279 operator, the <EOL> also counts for a character. This makes "3h"
8280 different from "3dh" when the cursor crosses the end of a line. This
8281 is also true for "x" and "X", because they do the same as "dl" and
8282 "dh". If you use this, you may also want to use the mapping
8283 ":map <BS> X" to make backspace delete the character in front of the
8284 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008285 When 'l' is included and it is used after an operator at the end of a
8286 line then it will not move to the next line. This makes "dl", "cl",
8287 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008288 NOTE: This option is set to the Vi default value when 'compatible' is
8289 set and to the Vim default value when 'compatible' is reset.
8290
8291 *'wildchar'* *'wc'*
8292'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8293 global
8294 {not in Vi}
8295 Character you have to type to start wildcard expansion in the
8296 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008297 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 The character is not recognized when used inside a macro. See
8299 'wildcharm' for that.
8300 Although 'wc' is a number option, you can set it to a special key: >
8301 :set wc=<Esc>
8302< NOTE: This option is set to the Vi default value when 'compatible' is
8303 set and to the Vim default value when 'compatible' is reset.
8304
8305 *'wildcharm'* *'wcm'*
8306'wildcharm' 'wcm' number (default: none (0))
8307 global
8308 {not in Vi}
8309 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008310 recognized when used inside a macro. You can find "spare" command-line
8311 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 you'll never actually type 'wildcharm', just use it in mappings that
8313 automatically invoke completion mode, e.g.: >
8314 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008315 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316< Then after typing :ss you can use CTRL-P & CTRL-N.
8317
8318 *'wildignore'* *'wig'*
8319'wildignore' 'wig' string (default "")
8320 global
8321 {not in Vi}
8322 {not available when compiled without the |+wildignore|
8323 feature}
8324 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008325 patterns is ignored when expanding |wildcards|, completing file or
8326 directory names, and influences the result of |expand()|, |glob()| and
8327 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8329 Also see 'suffixes'.
8330 Example: >
8331 :set wildignore=*.o,*.obj
8332< The use of |:set+=| and |:set-=| is preferred when adding or removing
8333 a pattern from the list. This avoids problems when a future version
8334 uses another default.
8335
Bram Moolenaar94950a92010-12-02 16:01:29 +01008336
Bram Moolenaar81af9252010-12-10 20:35:50 +01008337 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008338'wildignorecase' 'wic' boolean (default off)
8339 global
8340 {not in Vi}
8341 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008342 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008343 Does not apply when the shell is used to expand wildcards, which
8344 happens when there are special characters.
8345
8346
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8348'wildmenu' 'wmnu' boolean (default off)
8349 global
8350 {not in Vi}
8351 {not available if compiled without the |+wildmenu|
8352 feature}
8353 When 'wildmenu' is on, command-line completion operates in an enhanced
8354 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8355 the possible matches are shown just above the command line, with the
8356 first match highlighted (overwriting the status line, if there is
8357 one). Keys that show the previous/next match, such as <Tab> or
8358 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8359 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8360 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008361 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 If there are more matches than can fit in the line, a ">" is shown on
8363 the right and/or a "<" is shown on the left. The status line scrolls
8364 as needed.
8365 The "wildmenu" mode is abandoned when a key is hit that is not used
8366 for selecting a completion.
8367 While the "wildmenu" is active the following keys have special
8368 meanings:
8369
8370 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8371 <Down> - in filename/menu name completion: move into a
8372 subdirectory or submenu.
8373 <CR> - in menu completion, when the cursor is just after a
8374 dot: move into a submenu.
8375 <Up> - in filename/menu name completion: move up into
8376 parent directory or parent menu.
8377
8378 This makes the menus accessible from the console |console-menus|.
8379
8380 If you prefer the <Left> and <Right> keys to move the cursor instead
8381 of selecting a different match, use this: >
8382 :cnoremap <Left> <Space><BS><Left>
8383 :cnoremap <Right> <Space><BS><Right>
8384<
8385 The "WildMenu" highlighting is used for displaying the current match
8386 |hl-WildMenu|.
8387
8388 *'wildmode'* *'wim'*
8389'wildmode' 'wim' string (Vim default: "full")
8390 global
8391 {not in Vi}
8392 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008393 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008394 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 first part specifies the behavior for the first use of 'wildchar',
8396 The second part for the second use, etc.
8397 These are the possible values for each part:
8398 "" Complete only the first match.
8399 "full" Complete the next full match. After the last match,
8400 the original string is used and then the first match
8401 again.
8402 "longest" Complete till longest common string. If this doesn't
8403 result in a longer string, use the next part.
8404 "longest:full" Like "longest", but also start 'wildmenu' if it is
8405 enabled.
8406 "list" When more than one match, list all matches.
8407 "list:full" When more than one match, list all matches and
8408 complete first match.
8409 "list:longest" When more than one match, list all matches and
8410 complete till longest common string.
8411 When there is only a single match, it is fully completed in all cases.
8412
8413 Examples: >
8414 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008415< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 :set wildmode=longest,full
8417< Complete longest common string, then each full match >
8418 :set wildmode=list:full
8419< List all matches and complete each full match >
8420 :set wildmode=list,full
8421< List all matches without completing, then each full match >
8422 :set wildmode=longest,list
8423< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008424 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008426 *'wildoptions'* *'wop'*
8427'wildoptions' 'wop' string (default "")
8428 global
8429 {not in Vi}
8430 {not available when compiled without the |+wildignore|
8431 feature}
8432 A list of words that change how command line completion is done.
8433 Currently only one word is allowed:
8434 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008435 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008436 is displayed per line. Often used tag kinds are:
8437 d #define
8438 f function
8439 Also see |cmdline-completion|.
8440
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441 *'winaltkeys'* *'wak'*
8442'winaltkeys' 'wak' string (default "menu")
8443 global
8444 {not in Vi}
8445 {only used in Win32, Motif, GTK and Photon GUI}
8446 Some GUI versions allow the access to menu entries by using the ALT
8447 key in combination with a character that appears underlined in the
8448 menu. This conflicts with the use of the ALT key for mappings and
8449 entering special characters. This option tells what to do:
8450 no Don't use ALT keys for menus. ALT key combinations can be
8451 mapped, but there is no automatic handling. This can then be
8452 done with the |:simalt| command.
8453 yes ALT key handling is done by the windowing system. ALT key
8454 combinations cannot be mapped.
8455 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008456 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008457 keys can be mapped.
8458 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8459 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008460 This option is not used for <F10>; on Win32 and with GTK <F10> will
8461 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008462
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008463 *'window'* *'wi'*
8464'window' 'wi' number (default screen height - 1)
8465 global
8466 Window height. Do not confuse this with the height of the Vim window,
8467 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008468 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8469 value is smaller than 'lines' minus one. The screen will scroll
8470 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008471 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8472 in a much smarter way, taking care of wrapping lines.
8473 When resizing the Vim window, the value is smaller than 1 or more than
8474 or equal to 'lines' it will be set to 'lines' minus 1.
8475 {Vi also uses the option to specify the number of displayed lines}
8476
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477 *'winheight'* *'wh'* *E591*
8478'winheight' 'wh' number (default 1)
8479 global
8480 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008481 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008482 feature}
8483 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008484 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008485 focus goes to a window that is smaller, its size is increased, at the
8486 cost of the height of other windows.
8487 Set 'winheight' to a small number for normal editing.
8488 Set it to 999 to make the current window fill most of the screen.
8489 Other windows will be only 'winminheight' high. This has the drawback
8490 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8491 to create only two windows, set the option after startup is done,
8492 using the |VimEnter| event: >
8493 au VimEnter * set winheight=999
8494< Minimum value is 1.
8495 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496 height of the current window.
8497 'winheight' applies to the current window. Use 'winminheight' to set
8498 the minimal height for other windows.
8499
8500 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8501'winfixheight' 'wfh' boolean (default off)
8502 local to window
8503 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008504 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 feature}
8506 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008507 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8508 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008509 The height may be changed anyway when running out of room.
8510
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008511 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8512'winfixwidth' 'wfw' boolean (default off)
8513 local to window
8514 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008515 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008516 feature}
8517 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008518 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008519 The width may be changed anyway when running out of room.
8520
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 *'winminheight'* *'wmh'*
8522'winminheight' 'wmh' number (default 1)
8523 global
8524 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008525 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008526 feature}
8527 The minimal height of a window, when it's not the current window.
8528 This is a hard minimum, windows will never become smaller.
8529 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8530 status bar) if necessary. They will return to at least one line when
8531 they become active (since the cursor has to have somewhere to go.)
8532 Use 'winheight' to set the minimal height of the current window.
8533 This option is only checked when making a window smaller. Don't use a
8534 large number, it will cause errors when opening more than a few
8535 windows. A value of 0 to 3 is reasonable.
8536
8537 *'winminwidth'* *'wmw'*
8538'winminwidth' 'wmw' number (default 1)
8539 global
8540 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008541 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542 feature}
8543 The minimal width of a window, when it's not the current window.
8544 This is a hard minimum, windows will never become smaller.
8545 When set to zero, windows may be "squashed" to zero columns (i.e. just
8546 a vertical separator) if necessary. They will return to at least one
8547 line when they become active (since the cursor has to have somewhere
8548 to go.)
8549 Use 'winwidth' to set the minimal width of the current window.
8550 This option is only checked when making a window smaller. Don't use a
8551 large number, it will cause errors when opening more than a few
8552 windows. A value of 0 to 12 is reasonable.
8553
8554 *'winwidth'* *'wiw'* *E592*
8555'winwidth' 'wiw' number (default 20)
8556 global
8557 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008558 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 feature}
8560 Minimal number of columns for the current window. This is not a hard
8561 minimum, Vim will use fewer columns if there is not enough room. If
8562 the current window is smaller, its size is increased, at the cost of
8563 the width of other windows. Set it to 999 to make the current window
8564 always fill the screen. Set it to a small number for normal editing.
8565 The width is not adjusted after one of the commands to change the
8566 width of the current window.
8567 'winwidth' applies to the current window. Use 'winminwidth' to set
8568 the minimal width for other windows.
8569
8570 *'wrap'* *'nowrap'*
8571'wrap' boolean (default on)
8572 local to window
8573 {not in Vi}
8574 This option changes how text is displayed. It doesn't change the text
8575 in the buffer, see 'textwidth' for that.
8576 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008577 displaying continues on the next line. When off lines will not wrap
8578 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 moved to a part that is not shown, the screen will scroll
8580 horizontally.
8581 The line will be broken in the middle of a word if necessary. See
8582 'linebreak' to get the break at a word boundary.
8583 To make scrolling horizontally a bit more useful, try this: >
8584 :set sidescroll=5
8585 :set listchars+=precedes:<,extends:>
8586< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008587 This option can't be set from a |modeline| when the 'diff' option is
8588 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589
8590 *'wrapmargin'* *'wm'*
8591'wrapmargin' 'wm' number (default 0)
8592 local to buffer
8593 Number of characters from the right window border where wrapping
8594 starts. When typing text beyond this limit, an <EOL> will be inserted
8595 and inserting continues on the next line.
8596 Options that add a margin, such as 'number' and 'foldcolumn', cause
8597 the text width to be further reduced. This is Vi compatible.
8598 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008599 This option is set to 0 when 'paste' is set and restored when 'paste'
8600 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8602 and less usefully}
8603
8604 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8605'wrapscan' 'ws' boolean (default on) *E384* *E385*
8606 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008607 Searches wrap around the end of the file. Also applies to |]s| and
8608 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008609
8610 *'write'* *'nowrite'*
8611'write' boolean (default on)
8612 global
8613 {not in Vi}
8614 Allows writing files. When not set, writing a file is not allowed.
8615 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008616 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 argument. Filtering text is still possible, even though this requires
8618 writing a temporary file.
8619
8620 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8621'writeany' 'wa' boolean (default off)
8622 global
8623 Allows writing to any file with no need for "!" override.
8624
8625 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8626'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8627 otherwise)
8628 global
8629 {not in Vi}
8630 Make a backup before overwriting a file. The backup is removed after
8631 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008632 also on.
8633 WARNING: Switching this option off means that when Vim fails to write
8634 your buffer correctly and then, for whatever reason, Vim exits, you
8635 lose both the original file and what you were writing. Only reset
8636 this option if your file system is almost full and it makes the write
8637 fail (and make sure not to exit Vim until the write was successful).
8638 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 When the 'backupskip' pattern matches, a backup is not made anyway.
8640 NOTE: This option is set to the default value when 'compatible' is
8641 set.
8642
8643 *'writedelay'* *'wd'*
8644'writedelay' 'wd' number (default 0)
8645 global
8646 {not in Vi}
8647 The number of microseconds to wait for each character sent to the
8648 screen. When non-zero, characters are sent to the terminal one by
8649 one. For MS-DOS pcterm this does not work. For debugging purposes.
8650
8651 vim:tw=78:ts=8:ft=help:norl: