blob: 87123d31fa394b286b4e3817e9670d007aa02d67 [file] [log] [blame]
Bram Moolenaar802a0d92016-06-26 16:17:58 +02001*options.txt* For Vim version 7.4. Last change: 2016 Jun 19
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
Bram Moolenaar82af8712016-06-04 20:20:29 +02001106 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 v:beval_lnum line number
1108 v:beval_col column number (byte index)
1109 v:beval_text word under or after the mouse pointer
1110
1111 The evaluation of the expression must not have side effects!
1112 Example: >
1113 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001114 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001115 \', column ' . v:beval_col .
1116 \ ' of file ' . bufname(v:beval_bufnr) .
1117 \ ' on word "' . v:beval_text . '"'
1118 endfunction
1119 set bexpr=MyBalloonExpr()
1120 set ballooneval
1121<
1122 NOTE: The balloon is displayed only if the cursor is on a text
1123 character. If the result of evaluating 'balloonexpr' is not empty,
1124 Vim does not try to send a message to an external debugger (Netbeans
1125 or Sun Workshop).
1126
Bram Moolenaar30b65812012-07-12 22:01:11 +02001127 The expression will be evaluated in the |sandbox| when set from a
1128 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001129
1130 It is not allowed to change text or jump to another window while
1131 evaluating 'balloonexpr' |textlock|.
1132
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001133 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001134 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001135< When they are supported "\n" characters will start a new line. If the
1136 expression evaluates to a |List| this is equal to using each List item
1137 as a string and putting "\n" in between them.
1138
Bram Moolenaar165bc692015-07-21 17:53:25 +02001139 *'belloff'* *'bo'*
1140'belloff' 'bo' string (default "")
1141 global
1142 {not in Vi}
1143 Specifies for which events the bell will not be rung. It is a comma
1144 separated list of items. For each item that is present, the bell
1145 will be silenced. This is most useful to specify specific events in
1146 insert mode to be silenced.
1147
1148 item meaning when present ~
1149 all All events.
1150 backspace When hitting <BS> or <Del> and deleting results in an
1151 error.
1152 cursor Fail to move around using the cursor keys or
1153 <PageUp>/<PageDown> in |Insert-mode|.
1154 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1155 |i_CTRL-X_CTRL-T|.
1156 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1157 |i_CTRL-E|.
1158 ctrlg Unknown Char after <C-G> in Insert mode.
1159 error Other Error occurred (e.g. try to join last line)
1160 (mostly used in |Normal-mode| or |Cmdline-mode|).
1161 esc hitting <Esc> in |Normal-mode|.
1162 ex In |Visual-mode|, hitting |Q| results in an error.
1163 hangul Error occurred when using hangul input.
1164 insertmode Pressing <Esc> in 'insertmode'.
1165 lang Calling the beep module for Lua/Mzscheme/TCL.
1166 mess No output available for |g<|.
1167 showmatch Error occurred for 'showmatch' function.
1168 operator Empty region error |cpo-E|.
1169 register Unknown register after <C-R> in |Insert-mode|.
1170 shell Bell from shell output |:!|.
1171 spell Error happened on spell suggest.
1172 wildmode More matches in |cmdline-completion| available
1173 (depends on the 'wildmode' setting).
1174
1175 This is most useful, to fine tune when in insert mode the bell should
1176 be rung. For normal mode and ex commands, the bell is often rung to
1177 indicate that an error occurred. It can be silenced by adding the
1178 "error" keyword.
1179
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1181'binary' 'bin' boolean (default off)
1182 local to buffer
1183 {not in Vi}
1184 This option should be set before editing a binary file. You can also
1185 use the |-b| Vim argument. When this option is switched on a few
1186 options will be changed (also when it already was on):
1187 'textwidth' will be set to 0
1188 'wrapmargin' will be set to 0
1189 'modeline' will be off
1190 'expandtab' will be off
1191 Also, 'fileformat' and 'fileformats' options will not be used, the
1192 file is read and written like 'fileformat' was "unix" (a single <NL>
1193 separates lines).
1194 The 'fileencoding' and 'fileencodings' options will not be used, the
1195 file is read without conversion.
1196 NOTE: When you start editing a(nother) file while the 'bin' option is
1197 on, settings from autocommands may change the settings again (e.g.,
1198 'textwidth'), causing trouble when editing. You might want to set
1199 'bin' again when the file has been loaded.
1200 The previous values of these options are remembered and restored when
1201 'bin' is switched from on to off. Each buffer has its own set of
1202 saved option values.
1203 To edit a file with 'binary' set you can use the |++bin| argument.
1204 This avoids you have to do ":set bin", which would have effect for all
1205 files you edit.
1206 When writing a file the <EOL> for the last line is only written if
1207 there was one in the original file (normally Vim appends an <EOL> to
1208 the last line if there is none; this would make the file longer). See
1209 the 'endofline' option.
1210
1211 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1212'bioskey' 'biosk' boolean (default on)
1213 global
1214 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001215 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216
1217 *'bomb'* *'nobomb'*
1218'bomb' boolean (default off)
1219 local to buffer
1220 {not in Vi}
1221 {only available when compiled with the |+multi_byte|
1222 feature}
1223 When writing a file and the following conditions are met, a BOM (Byte
1224 Order Mark) is prepended to the file:
1225 - this option is on
1226 - the 'binary' option is off
1227 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1228 endian variants.
1229 Some applications use the BOM to recognize the encoding of the file.
1230 Often used for UCS-2 files on MS-Windows. For other applications it
1231 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001232 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1234 check for the presence of the BOM is done and 'bomb' set accordingly.
1235 Unless 'binary' is set, it is removed from the first line, so that you
1236 don't see it when editing. When you don't change the options, the BOM
1237 will be restored when writing the file.
1238
1239 *'breakat'* *'brk'*
1240'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1241 global
1242 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001243 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244 feature}
1245 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001246 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1247 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001249 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001250'breakindent' 'bri' boolean (default off)
1251 local to window
1252 {not in Vi}
1253 {not available when compiled without the |+linebreak|
1254 feature}
1255 Every wrapped line will continue visually indented (same amount of
1256 space as the beginning of that line), thus preserving horizontal blocks
1257 of text.
1258
1259 *'breakindentopt'* *'briopt'*
1260'breakindentopt' 'briopt' string (default empty)
1261 local to window
1262 {not in Vi}
1263 {not available when compiled without the |+linebreak|
1264 feature}
1265 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001266 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001267 min:{n} Minimum text width that will be kept after
1268 applying 'breakindent', even if the resulting
1269 text should normally be narrower. This prevents
1270 text indented almost to the right window border
1271 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001272 shift:{n} After applying 'breakindent', the wrapped line's
1273 beginning will be shifted by the given number of
1274 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001275 indentation (negative) or emphasizing the line
1276 continuation (positive).
1277 sbr Display the 'showbreak' value before applying the
1278 additional indent.
1279 The default value for min is 20 and shift is 0.
1280
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001282'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001284 {not in Vi} {only for Motif, Athena, GTK, Mac and
1285 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001287 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001288 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 buffer Use the directory of the related buffer.
1290 current Use the current directory.
1291 {path} Use the specified directory
1292
1293 *'bufhidden'* *'bh'*
1294'bufhidden' 'bh' string (default: "")
1295 local to buffer
1296 {not in Vi}
1297 {not available when compiled without the |+quickfix|
1298 feature}
1299 This option specifies what happens when a buffer is no longer
1300 displayed in a window:
1301 <empty> follow the global 'hidden' option
1302 hide hide the buffer (don't unload it), also when 'hidden'
1303 is not set
1304 unload unload the buffer, also when 'hidden' is set or using
1305 |:hide|
1306 delete delete the buffer from the buffer list, also when
1307 'hidden' is set or using |:hide|, like using
1308 |:bdelete|
1309 wipe wipe out the buffer from the buffer list, also when
1310 'hidden' is set or using |:hide|, like using
1311 |:bwipeout|
1312
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001313 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001314 are lost without a warning. Also, these values may break autocommands
1315 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 This option is used together with 'buftype' and 'swapfile' to specify
1317 special kinds of buffers. See |special-buffers|.
1318
1319 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1320'buflisted' 'bl' boolean (default: on)
1321 local to buffer
1322 {not in Vi}
1323 When this option is set, the buffer shows up in the buffer list. If
1324 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1325 This option is reset by Vim for buffers that are only used to remember
1326 a file name or marks. Vim sets it when starting to edit a buffer.
1327 But not when moving to a buffer with ":buffer".
1328
1329 *'buftype'* *'bt'* *E382*
1330'buftype' 'bt' string (default: "")
1331 local to buffer
1332 {not in Vi}
1333 {not available when compiled without the |+quickfix|
1334 feature}
1335 The value of this option specifies the type of a buffer:
1336 <empty> normal buffer
1337 nofile buffer which is not related to a file and will not be
1338 written
1339 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001340 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001341 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001342 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001344 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 help help buffer (you are not supposed to set this
1346 manually)
1347
1348 This option is used together with 'bufhidden' and 'swapfile' to
1349 specify special kinds of buffers. See |special-buffers|.
1350
1351 Be careful with changing this option, it can have many side effects!
1352
Bram Moolenaar280f1262006-01-30 00:14:18 +00001353 A "quickfix" buffer is only used for the error list and the location
1354 list. This value is set by the |:cwindow| and |:lwindow| commands and
1355 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356
1357 "nofile" and "nowrite" buffers are similar:
1358 both: The buffer is not to be written to disk, ":w" doesn't
1359 work (":w filename" does work though).
1360 both: The buffer is never considered to be |'modified'|.
1361 There is no warning when the changes will be lost, for
1362 example when you quit Vim.
1363 both: A swap file is only created when using too much memory
1364 (when 'swapfile' has been reset there is never a swap
1365 file).
1366 nofile only: The buffer name is fixed, it is not handled like a
1367 file name. It is not modified in response to a |:cd|
1368 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001369 both: When using ":e bufname" and already editing "bufname"
1370 the buffer is made empty and autocommands are
1371 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001372 *E676*
1373 "acwrite" implies that the buffer name is not related to a file, like
1374 "nofile", but it will be written. Thus, in contrast to "nofile" and
1375 "nowrite", ":w" does work and a modified buffer can't be abandoned
1376 without saving. For writing there must be matching |BufWriteCmd|,
1377 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378
1379 *'casemap'* *'cmp'*
1380'casemap' 'cmp' string (default: "internal,keepascii")
1381 global
1382 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001383 {only available when compiled with the |+multi_byte|
1384 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385 Specifies details about changing the case of letters. It may contain
1386 these words, separated by a comma:
1387 internal Use internal case mapping functions, the current
1388 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001389 matters when 'encoding' is a Unicode encoding,
1390 "latin1" or "iso-8859-15". When "internal" is
1391 omitted, the towupper() and towlower() system library
1392 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1394 case mapping, the current locale is not effective.
1395 This probably only matters for Turkish.
1396
1397 *'cdpath'* *'cd'* *E344* *E346*
1398'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1399 global
1400 {not in Vi}
1401 {not available when compiled without the
1402 |+file_in_path| feature}
1403 This is a list of directories which will be searched when using the
1404 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001405 for has a relative path, not an absolute part starting with "/", "./"
1406 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 The 'cdpath' option's value has the same form and semantics as
1408 |'path'|. Also see |file-searching|.
1409 The default value is taken from $CDPATH, with a "," prepended to look
1410 in the current directory first.
1411 If the default value taken from $CDPATH is not what you want, include
1412 a modified version of the following command in your vimrc file to
1413 override it: >
1414 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1415< This option cannot be set from a |modeline| or in the |sandbox|, for
1416 security reasons.
1417 (parts of 'cdpath' can be passed to the shell to expand file names).
1418
1419 *'cedit'*
1420'cedit' string (Vi default: "", Vim default: CTRL-F)
1421 global
1422 {not in Vi}
1423 {not available when compiled without the |+vertsplit|
1424 feature}
1425 The key used in Command-line Mode to open the command-line window.
1426 The default is CTRL-F when 'compatible' is off.
1427 Only non-printable keys are allowed.
1428 The key can be specified as a single character, but it is difficult to
1429 type. The preferred way is to use the <> notation. Examples: >
1430 :set cedit=<C-Y>
1431 :set cedit=<Esc>
1432< |Nvi| also has this option, but it only uses the first character.
1433 See |cmdwin|.
1434
1435 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1436'charconvert' 'ccv' string (default "")
1437 global
1438 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001439 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 {not in Vi}
1441 An expression that is used for character encoding conversion. It is
1442 evaluated when a file that is to be read or has been written has a
1443 different encoding from what is desired.
1444 'charconvert' is not used when the internal iconv() function is
1445 supported and is able to do the conversion. Using iconv() is
1446 preferred, because it is much faster.
1447 'charconvert' is not used when reading stdin |--|, because there is no
1448 file to convert from. You will have to save the text in a file first.
1449 The expression must return zero or an empty string for success,
1450 non-zero for failure.
1451 The possible encoding names encountered are in 'encoding'.
1452 Additionally, names given in 'fileencodings' and 'fileencoding' are
1453 used.
1454 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1455 is done internally by Vim, 'charconvert' is not used for this.
1456 'charconvert' is also used to convert the viminfo file, if the 'c'
1457 flag is present in 'viminfo'. Also used for Unicode conversion.
1458 Example: >
1459 set charconvert=CharConvert()
1460 fun CharConvert()
1461 system("recode "
1462 \ . v:charconvert_from . ".." . v:charconvert_to
1463 \ . " <" . v:fname_in . " >" v:fname_out)
1464 return v:shell_error
1465 endfun
1466< The related Vim variables are:
1467 v:charconvert_from name of the current encoding
1468 v:charconvert_to name of the desired encoding
1469 v:fname_in name of the input file
1470 v:fname_out name of the output file
1471 Note that v:fname_in and v:fname_out will never be the same.
1472 Note that v:charconvert_from and v:charconvert_to may be different
1473 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1474 Encryption is not done by Vim when using 'charconvert'. If you want
1475 to encrypt the file after conversion, 'charconvert' should take care
1476 of this.
1477 This option cannot be set from a |modeline| or in the |sandbox|, for
1478 security reasons.
1479
1480 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1481'cindent' 'cin' boolean (default off)
1482 local to buffer
1483 {not in Vi}
1484 {not available when compiled without the |+cindent|
1485 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001486 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487 that trigger reindenting in insert mode and 'cinoptions' to set your
1488 preferred indent style.
1489 If 'indentexpr' is not empty, it overrules 'cindent'.
1490 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1491 the "=" operator indents using this algorithm rather than calling an
1492 external program.
1493 See |C-indenting|.
1494 When you don't like the way 'cindent' works, try the 'smartindent'
1495 option or 'indentexpr'.
1496 This option is not used when 'paste' is set.
1497 NOTE: This option is reset when 'compatible' is set.
1498
1499 *'cinkeys'* *'cink'*
1500'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1501 local to buffer
1502 {not in Vi}
1503 {not available when compiled without the |+cindent|
1504 feature}
1505 A list of keys that, when typed in Insert mode, cause reindenting of
1506 the current line. Only used if 'cindent' is on and 'indentexpr' is
1507 empty.
1508 For the format of this option see |cinkeys-format|.
1509 See |C-indenting|.
1510
1511 *'cinoptions'* *'cino'*
1512'cinoptions' 'cino' string (default "")
1513 local to buffer
1514 {not in Vi}
1515 {not available when compiled without the |+cindent|
1516 feature}
1517 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1518 program. See |cinoptions-values| for the values of this option, and
1519 |C-indenting| for info on C indenting in general.
1520
1521
1522 *'cinwords'* *'cinw'*
1523'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1524 local to buffer
1525 {not in Vi}
1526 {not available when compiled without both the
1527 |+cindent| and the |+smartindent| features}
1528 These keywords start an extra indent in the next line when
1529 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1530 an appropriate place (inside {}).
1531 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1532 matter, include the keyword both the uppercase and lowercase:
1533 "if,If,IF".
1534
1535 *'clipboard'* *'cb'*
1536'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1537 for X-windows, "" otherwise)
1538 global
1539 {not in Vi}
1540 {only in GUI versions or when the |+xterm_clipboard|
1541 feature is included}
1542 This option is a list of comma separated names.
1543 These names are recognized:
1544
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001545 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 unnamed When included, Vim will use the clipboard register '*'
1547 for all yank, delete, change and put operations which
1548 would normally go to the unnamed register. When a
1549 register is explicitly specified, it will always be
1550 used regardless of whether "unnamed" is in 'clipboard'
1551 or not. The clipboard register can always be
1552 explicitly accessed using the "* notation. Also see
1553 |gui-clipboard|.
1554
Bram Moolenaar30b65812012-07-12 22:01:11 +02001555 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001556 unnamedplus A variant of the "unnamed" flag which uses the
1557 clipboard register '+' (|quoteplus|) instead of
1558 register '*' for all yank, delete, change and put
1559 operations which would normally go to the unnamed
1560 register. When "unnamed" is also included to the
1561 option, yank operations (but not delete, change or
1562 put) will additionally copy the text into register
1563 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001564 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001565 Availability can be checked with: >
1566 if has('unnamedplus')
1567<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001568 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 autoselect Works like the 'a' flag in 'guioptions': If present,
1570 then whenever Visual mode is started, or the Visual
1571 area extended, Vim tries to become the owner of the
1572 windowing system's global selection or put the
1573 selected text on the clipboard used by the selection
1574 register "*. See |guioptions_a| and |quotestar| for
1575 details. When the GUI is active, the 'a' flag in
1576 'guioptions' is used, when the GUI is not active, this
1577 "autoselect" flag is used.
1578 Also applies to the modeless selection.
1579
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001580 *clipboard-autoselectplus*
1581 autoselectplus Like "autoselect" but using the + register instead of
1582 the * register. Compare to the 'P' flag in
1583 'guioptions'.
1584
1585 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 autoselectml Like "autoselect", but for the modeless selection
1587 only. Compare to the 'A' flag in 'guioptions'.
1588
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001589 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001590 html When the clipboard contains HTML, use this when
1591 pasting. When putting text on the clipboard, mark it
1592 as HTML. This works to copy rendered HTML from
1593 Firefox, paste it as raw HTML in Vim, select the HTML
1594 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001595 You probably want to add this only temporarily,
1596 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001597 Only supported for GTK version 2 and later.
1598 Only available with the |+multi_byte| feature.
1599
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001600 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 exclude:{pattern}
1602 Defines a pattern that is matched against the name of
1603 the terminal 'term'. If there is a match, no
1604 connection will be made to the X server. This is
1605 useful in this situation:
1606 - Running Vim in a console.
1607 - $DISPLAY is set to start applications on another
1608 display.
1609 - You do not want to connect to the X server in the
1610 console, but do want this in a terminal emulator.
1611 To never connect to the X server use: >
1612 exclude:.*
1613< This has the same effect as using the |-X| argument.
1614 Note that when there is no connection to the X server
1615 the window title won't be restored and the clipboard
1616 cannot be accessed.
1617 The value of 'magic' is ignored, {pattern} is
1618 interpreted as if 'magic' was on.
1619 The rest of the option value will be used for
1620 {pattern}, this must be the last entry.
1621
1622 *'cmdheight'* *'ch'*
1623'cmdheight' 'ch' number (default 1)
1624 global
1625 {not in Vi}
1626 Number of screen lines to use for the command-line. Helps avoiding
1627 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001628 The value of this option is stored with the tab page, so that each tab
1629 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001630
1631 *'cmdwinheight'* *'cwh'*
1632'cmdwinheight' 'cwh' number (default 7)
1633 global
1634 {not in Vi}
1635 {not available when compiled without the |+vertsplit|
1636 feature}
1637 Number of screen lines to use for the command-line window. |cmdwin|
1638
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001639 *'colorcolumn'* *'cc'*
1640'colorcolumn' 'cc' string (default "")
1641 local to window
1642 {not in Vi}
1643 {not available when compiled without the |+syntax|
1644 feature}
1645 'colorcolumn' is a comma separated list of screen columns that are
1646 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1647 text. Will make screen redrawing slower.
1648 The screen column can be an absolute number, or a number preceded with
1649 '+' or '-', which is added to or subtracted from 'textwidth'. >
1650
1651 :set cc=+1 " highlight column after 'textwidth'
1652 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1653 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1654<
1655 When 'textwidth' is zero then the items with '-' and '+' are not used.
1656 A maximum of 256 columns are highlighted.
1657
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 *'columns'* *'co'* *E594*
1659'columns' 'co' number (default 80 or terminal width)
1660 global
1661 {not in Vi}
1662 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001663 initialization and does not have to be set by hand. Also see
1664 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 When Vim is running in the GUI or in a resizable window, setting this
1666 option will cause the window size to be changed. When you only want
1667 to use the size for the GUI, put the command in your |gvimrc| file.
1668 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001669 number of columns of the display, the display may be messed up. For
1670 the GUI it is always possible and Vim limits the number of columns to
1671 what fits on the screen. You can use this command to get the widest
1672 window possible: >
1673 :set columns=9999
1674< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675
1676 *'comments'* *'com'* *E524* *E525*
1677'comments' 'com' string (default
1678 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1679 local to buffer
1680 {not in Vi}
1681 {not available when compiled without the |+comments|
1682 feature}
1683 A comma separated list of strings that can start a comment line. See
1684 |format-comments|. See |option-backslash| about using backslashes to
1685 insert a space.
1686
1687 *'commentstring'* *'cms'* *E537*
1688'commentstring' 'cms' string (default "/*%s*/")
1689 local to buffer
1690 {not in Vi}
1691 {not available when compiled without the |+folding|
1692 feature}
1693 A template for a comment. The "%s" in the value is replaced with the
1694 comment text. Currently only used to add markers for folding, see
1695 |fold-marker|.
1696
1697 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001698'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1699 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 global
1701 {not in Vi}
1702 This option has the effect of making Vim either more Vi-compatible, or
1703 make Vim behave in a more useful way.
1704 This is a special kind of option, because when it's set or reset,
1705 other options are also changed as a side effect. CAREFUL: Setting or
1706 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001707 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 set this option in your vimrc file, you should probably put it at the
1709 very start.
1710 By default this option is on and the Vi defaults are used for the
1711 options. This default was chosen for those people who want to use Vim
1712 just like Vi, and don't even (want to) know about the 'compatible'
1713 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001714 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001715 this option is switched off, and all options that have not been
1716 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001717 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001718 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001719 happen for the system-wide vimrc or gvimrc file, nor for a file given
1720 with the |-u| argument). Also see |compatible-default| and
1721 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 You can also set this option with the "-C" argument, and reset it with
1723 "-N". See |-C| and |-N|.
1724 Switching this option off makes the Vim defaults be used for options
1725 that have a different Vi and Vim default value. See the options
1726 marked with a '+' below. Other options are not modified.
1727 At the moment this option is set, several other options will be set
1728 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001729 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 editing.
1731 See also 'cpoptions'.
1732
1733 option + set value effect ~
1734
1735 'allowrevins' off no CTRL-_ command
1736 'backupcopy' Unix: "yes" backup file is a copy
1737 others: "auto" copy or rename backup file
1738 'backspace' "" normal backspace
1739 'backup' off no backup file
1740 'cindent' off no C code indentation
1741 'cedit' + "" no key to open the |cmdwin|
1742 'cpoptions' + (all flags) Vi-compatible flags
1743 'cscopetag' off don't use cscope for ":tag"
1744 'cscopetagorder' 0 see |cscopetagorder|
1745 'cscopeverbose' off see |cscopeverbose|
1746 'digraph' off no digraphs
1747 'esckeys' + off no <Esc>-keys in Insert mode
1748 'expandtab' off tabs not expanded to spaces
1749 'fileformats' + "" no automatic file format detection,
1750 "dos,unix" except for DOS, Windows and OS/2
1751 'formatoptions' + "vt" Vi compatible formatting
1752 'gdefault' off no default 'g' flag for ":s"
1753 'history' + 0 no commandline history
1754 'hkmap' off no Hebrew keyboard mapping
1755 'hkmapp' off no phonetic Hebrew keyboard mapping
1756 'hlsearch' off no highlighting of search matches
1757 'incsearch' off no incremental searching
1758 'indentexpr' "" no indenting by expression
1759 'insertmode' off do not start in Insert mode
1760 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1761 characters and '_'
1762 'joinspaces' on insert 2 spaces after period
1763 'modeline' + off no modelines
1764 'more' + off no pauses in listings
1765 'revins' off no reverse insert
1766 'ruler' off no ruler
1767 'scrolljump' 1 no jump scroll
1768 'scrolloff' 0 no scroll offset
1769 'shiftround' off indent not rounded to shiftwidth
1770 'shortmess' + "" no shortening of messages
1771 'showcmd' + off command characters not shown
1772 'showmode' + off current mode not shown
1773 'smartcase' off no automatic ignore case switch
1774 'smartindent' off no smart indentation
1775 'smarttab' off no smart tab size
1776 'softtabstop' 0 tabs are always 'tabstop' positions
1777 'startofline' on goto startofline with some commands
1778 'tagrelative' + off tag file names are not relative
1779 'textauto' + off no automatic textmode detection
1780 'textwidth' 0 no automatic line wrap
1781 'tildeop' off tilde is not an operator
1782 'ttimeout' off no terminal timeout
1783 'whichwrap' + "" left-right movements don't wrap
1784 'wildchar' + CTRL-E only when the current value is <Tab>
1785 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001786 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787
1788 *'complete'* *'cpt'* *E535*
1789'complete' 'cpt' string (default: ".,w,b,u,t,i")
1790 local to buffer
1791 {not in Vi}
1792 This option specifies how keyword completion |ins-completion| works
1793 when CTRL-P or CTRL-N are used. It is also used for whole-line
1794 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1795 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001796 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 w scan buffers from other windows
1798 b scan other loaded buffers that are in the buffer list
1799 u scan the unloaded buffers that are in the buffer list
1800 U scan the buffers that are not in the buffer list
1801 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001802 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 k{dict} scan the file {dict}. Several "k" flags can be given,
1804 patterns are valid too. For example: >
1805 :set cpt=k/usr/dict/*,k~/spanish
1806< s scan the files given with the 'thesaurus' option
1807 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1808 are valid too.
1809 i scan current and included files
1810 d scan current and included files for defined name or macro
1811 |i_CTRL-X_CTRL-D|
1812 ] tag completion
1813 t same as "]"
1814
1815 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1816 not executed, this may lead to unexpected completions from some files
1817 (gzipped files for example). Unloaded buffers are not scanned for
1818 whole-line completion.
1819
1820 The default is ".,w,b,u,t,i", which means to scan:
1821 1. the current buffer
1822 2. buffers in other windows
1823 3. other loaded buffers
1824 4. unloaded buffers
1825 5. tags
1826 6. included files
1827
1828 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001829 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1830 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001832 *'completefunc'* *'cfu'*
1833'completefunc' 'cfu' string (default: empty)
1834 local to buffer
1835 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001836 {not available when compiled without the |+eval|
1837 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001838 This option specifies a function to be used for Insert mode completion
1839 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001840 See |complete-functions| for an explanation of how the function is
1841 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001842 This option cannot be set from a |modeline| or in the |sandbox|, for
1843 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001844
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001845 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001846'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001847 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001848 {not available when compiled without the
1849 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001850 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001851 A comma separated list of options for Insert mode completion
1852 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001853
1854 menu Use a popup menu to show the possible completions. The
1855 menu is only shown when there is more than one match and
1856 sufficient colors are available. |ins-completion-menu|
1857
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001858 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001859 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001860 match, e.g., what file it comes from.
1861
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001862 longest Only insert the longest common text of the matches. If
1863 the menu is displayed you can use CTRL-L to add more
1864 characters. Whether case is ignored depends on the kind
1865 of completion. For buffer text the 'ignorecase' option is
1866 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001867
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001868 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001869 completion in the preview window. Only works in
1870 combination with "menu" or "menuone".
1871
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001872 noinsert Do not insert any text for a match until the user selects
1873 a match from the menu. Only works in combination with
1874 "menu" or "menuone". No effect if "longest" is present.
1875
1876 noselect Do not select a match in the menu, force the user to
1877 select one from the menu. Only works in combination with
1878 "menu" or "menuone".
1879
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001880
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001881 *'concealcursor'* *'cocu'*
1882'concealcursor' 'cocu' string (default: "")
1883 local to window
1884 {not in Vi}
1885 {not available when compiled without the |+conceal|
1886 feature}
1887 Sets the modes in which text in the cursor line can also be concealed.
1888 When the current mode is listed then concealing happens just like in
1889 other lines.
1890 n Normal mode
1891 v Visual mode
1892 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001893 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001894
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001895 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001896 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001897 are moving around text is concealed, but when starting to insert text
1898 or selecting a Visual area the concealed text is displayed, so that
1899 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001900 Keep in mind that the cursor position is not always where it's
1901 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001902
1903
1904'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001905 number (default 0)
1906 local to window
1907 {not in Vi}
1908 {not available when compiled without the |+conceal|
1909 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001910 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1911 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001912
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001913 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001914 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001915 1 Each block of concealed text is replaced with one
1916 character. If the syntax item does not have a custom
1917 replacement character defined (see |:syn-cchar|) the
1918 character defined in 'listchars' is used (default is a
1919 space).
1920 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001921 2 Concealed text is completely hidden unless it has a
1922 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001923 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001924 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001925
Bram Moolenaara7781e02010-07-19 20:13:22 +02001926 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001927 edit and copy the text. This can be changed with the 'concealcursor'
1928 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001929
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1931'confirm' 'cf' boolean (default off)
1932 global
1933 {not in Vi}
1934 When 'confirm' is on, certain operations that would normally
1935 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1936 instead raise a |dialog| asking if you wish to save the current
1937 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1938 If 'confirm' is off you can still activate confirmation for one
1939 command only (this is most useful in mappings) with the |:confirm|
1940 command.
1941 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1942
1943 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1944'conskey' 'consk' boolean (default off)
1945 global
1946 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001947 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948
1949 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1950'copyindent' 'ci' boolean (default off)
1951 local to buffer
1952 {not in Vi}
1953 Copy the structure of the existing lines indent when autoindenting a
1954 new line. Normally the new indent is reconstructed by a series of
1955 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1956 in which case only spaces are used). Enabling this option makes the
1957 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001958 existing line. 'expandtab' has no effect on these characters, a Tab
1959 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 line, the remaining space is filled in the normal manner.
1961 NOTE: 'copyindent' is reset when 'compatible' is set.
1962 Also see 'preserveindent'.
1963
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001964 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965'cpoptions' 'cpo' string (Vim default: "aABceFs",
1966 Vi default: all flags)
1967 global
1968 {not in Vi}
1969 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001970 this indicates Vi-compatible behavior. This is used for things where
1971 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 'cpoptions' stands for "compatible-options".
1973 Commas can be added for readability.
1974 To avoid problems with flags that are added in the future, use the
1975 "+=" and "-=" feature of ":set" |add-option-flags|.
1976 NOTE: This option is set to the Vi default value when 'compatible' is
1977 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001978 NOTE: This option is set to the POSIX default value at startup when
1979 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001980 variable exists |posix|. This means Vim tries to behave like the
1981 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
1983 contains behavior ~
1984 *cpo-a*
1985 a When included, a ":read" command with a file name
1986 argument will set the alternate file name for the
1987 current window.
1988 *cpo-A*
1989 A When included, a ":write" command with a file name
1990 argument will set the alternate file name for the
1991 current window.
1992 *cpo-b*
1993 b "\|" in a ":map" command is recognized as the end of
1994 the map command. The '\' is included in the mapping,
1995 the text after the '|' is interpreted as the next
1996 command. Use a CTRL-V instead of a backslash to
1997 include the '|' in the mapping. Applies to all
1998 mapping, abbreviation, menu and autocmd commands.
1999 See also |map_bar|.
2000 *cpo-B*
2001 B A backslash has no special meaning in mappings,
2002 abbreviations and the "to" part of the menu commands.
2003 Remove this flag to be able to use a backslash like a
2004 CTRL-V. For example, the command ":map X \<Esc>"
2005 results in X being mapped to:
2006 'B' included: "\^[" (^[ is a real <Esc>)
2007 'B' excluded: "<Esc>" (5 characters)
2008 ('<' excluded in both cases)
2009 *cpo-c*
2010 c Searching continues at the end of any match at the
2011 cursor position, but not further than the start of the
2012 next line. When not present searching continues
2013 one character from the cursor position. With 'c'
2014 "abababababab" only gets three matches when repeating
2015 "/abab", without 'c' there are five matches.
2016 *cpo-C*
2017 C Do not concatenate sourced lines that start with a
2018 backslash. See |line-continuation|.
2019 *cpo-d*
2020 d Using "./" in the 'tags' option doesn't mean to use
2021 the tags file relative to the current file, but the
2022 tags file in the current directory.
2023 *cpo-D*
2024 D Can't use CTRL-K to enter a digraph after Normal mode
2025 commands with a character argument, like |r|, |f| and
2026 |t|.
2027 *cpo-e*
2028 e When executing a register with ":@r", always add a
2029 <CR> to the last line, also when the register is not
2030 linewise. If this flag is not present, the register
2031 is not linewise and the last line does not end in a
2032 <CR>, then the last line is put on the command-line
2033 and can be edited before hitting <CR>.
2034 *cpo-E*
2035 E It is an error when using "y", "d", "c", "g~", "gu" or
2036 "gU" on an Empty region. The operators only work when
2037 at least one character is to be operate on. Example:
2038 This makes "y0" fail in the first column.
2039 *cpo-f*
2040 f When included, a ":read" command with a file name
2041 argument will set the file name for the current buffer,
2042 if the current buffer doesn't have a file name yet.
2043 *cpo-F*
2044 F When included, a ":write" command with a file name
2045 argument will set the file name for the current
2046 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002047 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048 *cpo-g*
2049 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002050 *cpo-H*
2051 H When using "I" on a line with only blanks, insert
2052 before the last blank. Without this flag insert after
2053 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 *cpo-i*
2055 i When included, interrupting the reading of a file will
2056 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002057 *cpo-I*
2058 I When moving the cursor up or down just after inserting
2059 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 *cpo-j*
2061 j When joining lines, only add two spaces after a '.',
2062 not after '!' or '?'. Also see 'joinspaces'.
2063 *cpo-J*
2064 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002065 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 white space.
2067 *cpo-k*
2068 k Disable the recognition of raw key codes in
2069 mappings, abbreviations, and the "to" part of menu
2070 commands. For example, if <Key> sends ^[OA (where ^[
2071 is <Esc>), the command ":map X ^[OA" results in X
2072 being mapped to:
2073 'k' included: "^[OA" (3 characters)
2074 'k' excluded: "<Key>" (one key code)
2075 Also see the '<' flag below.
2076 *cpo-K*
2077 K Don't wait for a key code to complete when it is
2078 halfway a mapping. This breaks mapping <F1><F1> when
2079 only part of the second <F1> has been read. It
2080 enables cancelling the mapping by typing <F1><Esc>.
2081 *cpo-l*
2082 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002083 literally, only "\]", "\^", "\-" and "\\" are special.
2084 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2086 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002087 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 *cpo-L*
2089 L When the 'list' option is set, 'wrapmargin',
2090 'textwidth', 'softtabstop' and Virtual Replace mode
2091 (see |gR|) count a <Tab> as two characters, instead of
2092 the normal behavior of a <Tab>.
2093 *cpo-m*
2094 m When included, a showmatch will always wait half a
2095 second. When not included, a showmatch will wait half
2096 a second or until a character is typed. |'showmatch'|
2097 *cpo-M*
2098 M When excluded, "%" matching will take backslashes into
2099 account. Thus in "( \( )" and "\( ( \)" the outer
2100 parenthesis match. When included "%" ignores
2101 backslashes, which is Vi compatible.
2102 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002103 n When included, the column used for 'number' and
2104 'relativenumber' will also be used for text of wrapped
2105 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002106 *cpo-o*
2107 o Line offset to search command is not remembered for
2108 next search.
2109 *cpo-O*
2110 O Don't complain if a file is being overwritten, even
2111 when it didn't exist when editing it. This is a
2112 protection against a file unexpectedly created by
2113 someone else. Vi didn't complain about this.
2114 *cpo-p*
2115 p Vi compatible Lisp indenting. When not present, a
2116 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002117 *cpo-P*
2118 P When included, a ":write" command that appends to a
2119 file will set the file name for the current buffer, if
2120 the current buffer doesn't have a file name yet and
2121 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002122 *cpo-q*
2123 q When joining multiple lines leave the cursor at the
2124 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 *cpo-r*
2126 r Redo ("." command) uses "/" to repeat a search
2127 command, instead of the actually used search string.
2128 *cpo-R*
2129 R Remove marks from filtered lines. Without this flag
2130 marks are kept like |:keepmarks| was used.
2131 *cpo-s*
2132 s Set buffer options when entering the buffer for the
2133 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002134 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 set when the buffer is created.
2136 *cpo-S*
2137 S Set buffer options always when entering a buffer
2138 (except 'readonly', 'fileformat', 'filetype' and
2139 'syntax'). This is the (most) Vi compatible setting.
2140 The options are set to the values in the current
2141 buffer. When you change an option and go to another
2142 buffer, the value is copied. Effectively makes the
2143 buffer options global to all buffers.
2144
2145 's' 'S' copy buffer options
2146 no no when buffer created
2147 yes no when buffer first entered (default)
2148 X yes each time when buffer entered (vi comp.)
2149 *cpo-t*
2150 t Search pattern for the tag command is remembered for
2151 "n" command. Otherwise Vim only puts the pattern in
2152 the history for search pattern, but doesn't change the
2153 last used search pattern.
2154 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 *cpo-v*
2157 v Backspaced characters remain visible on the screen in
2158 Insert mode. Without this flag the characters are
2159 erased from the screen right away. With this flag the
2160 screen newly typed text overwrites backspaced
2161 characters.
2162 *cpo-w*
2163 w When using "cw" on a blank character, only change one
2164 character and not all blanks until the start of the
2165 next word.
2166 *cpo-W*
2167 W Don't overwrite a readonly file. When omitted, ":w!"
2168 overwrites a readonly file, if possible.
2169 *cpo-x*
2170 x <Esc> on the command-line executes the command-line.
2171 The default in Vim is to abandon the command-line,
2172 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002173 *cpo-X*
2174 X When using a count with "R" the replaced text is
2175 deleted only once. Also when repeating "R" with "."
2176 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 *cpo-y*
2178 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002179 *cpo-Z*
2180 Z When using "w!" while the 'readonly' option is set,
2181 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 *cpo-!*
2183 ! When redoing a filter command, use the last used
2184 external command, whatever it was. Otherwise the last
2185 used -filter- command is used.
2186 *cpo-$*
2187 $ When making a change to one line, don't redisplay the
2188 line, but put a '$' at the end of the changed text.
2189 The changed text will be overwritten when you type the
2190 new text. The line is redisplayed if you type any
2191 command that moves the cursor from the insertion
2192 point.
2193 *cpo-%*
2194 % Vi-compatible matching is done for the "%" command.
2195 Does not recognize "#if", "#endif", etc.
2196 Does not recognize "/*" and "*/".
2197 Parens inside single and double quotes are also
2198 counted, causing a string that contains a paren to
2199 disturb the matching. For example, in a line like
2200 "if (strcmp("foo(", s))" the first paren does not
2201 match the last one. When this flag is not included,
2202 parens inside single and double quotes are treated
2203 specially. When matching a paren outside of quotes,
2204 everything inside quotes is ignored. When matching a
2205 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002206 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002207 This flag is also used for other features, such as
2208 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002209 *cpo--*
2210 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002211 it would go above the first line or below the last
2212 line. Without it the cursor moves to the first or
2213 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002214 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002215 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002216 *cpo-+*
2217 + When included, a ":write file" command will reset the
2218 'modified' flag of the buffer, even though the buffer
2219 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002220 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 * Use ":*" in the same way as ":@". When not included,
2222 ":*" is an alias for ":'<,'>", select the Visual area.
2223 *cpo-<*
2224 < Disable the recognition of special key codes in |<>|
2225 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002226 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 ":map X <Tab>" results in X being mapped to:
2228 '<' included: "<Tab>" (5 characters)
2229 '<' excluded: "^I" (^I is a real <Tab>)
2230 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002231 *cpo->*
2232 > When appending to a register, put a line break before
2233 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002234 *cpo-;*
2235 ; When using |,| or |;| to repeat the last |t| search
2236 and the cursor is right in front of the searched
2237 character, the cursor won't move. When not included,
2238 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002239 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002240
2241 POSIX flags. These are not included in the Vi default value, except
2242 when $VIM_POSIX was set on startup. |posix|
2243
2244 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002245 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002246 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247 *cpo-&*
2248 & When ":preserve" was used keep the swap file when
2249 exiting normally while this buffer is still loaded.
2250 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002251 *cpo-\*
2252 \ Backslash in a [] range in a search pattern is taken
2253 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002254 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2255 '\' excluded: "/[ \-]" finds <Space> and '-'
2256 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002257 *cpo-/*
2258 / When "%" is used as the replacement string in a |:s|
2259 command, use the previous replacement string. |:s%|
2260 *cpo-{*
2261 { The |{| and |}| commands also stop at a "{" character
2262 at the start of a line.
2263 *cpo-.*
2264 . The ":chdir" and ":cd" commands fail if the current
2265 buffer is modified, unless ! is used. Vim doesn't
2266 need this, since it remembers the full path of an
2267 opened file.
2268 *cpo-bar*
2269 | The value of the $LINES and $COLUMNS environment
2270 variables overrule the terminal size values obtained
2271 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002272
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002274 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002275'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002276 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002277 {not in Vi}
2278 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002279 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002280 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002281 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002282 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002283 blowfish Blowfish method. Medium strong encryption but it has
2284 an implementation flaw. Requires Vim 7.3 or later,
2285 files can NOT be read by Vim 7.2 and older. This adds
2286 a "seed" to the file, every time you write the file
2287 the encrypted bytes will be different.
2288 *blowfish2*
2289 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002290 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002291 and older. This adds a "seed" to the file, every time
2292 you write the file the encrypted bytes will be
2293 different. The whole undo file is encrypted, not just
2294 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002295
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002296 You should use "blowfish2", also to re-encrypt older files.
2297
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002298 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002299 to the detected method of the file being read. Thus if you write it
2300 without changing 'cryptmethod' the same method will be used.
2301 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002302 explicitly write it, you don't get a warning unless there are other
2303 modifications. Also see |:X|.
2304
2305 When setting the global value to an empty string, it will end up with
2306 the value "zip". When setting the local value to an empty string the
2307 buffer will use the global value.
2308
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002309 When a new encryption method is added in a later version of Vim, and
2310 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002311 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002312
2313
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 *'cscopepathcomp'* *'cspc'*
2315'cscopepathcomp' 'cspc' number (default 0)
2316 global
2317 {not available when compiled without the |+cscope|
2318 feature}
2319 {not in Vi}
2320 Determines how many components of the path to show in a list of tags.
2321 See |cscopepathcomp|.
2322
2323 *'cscopeprg'* *'csprg'*
2324'cscopeprg' 'csprg' string (default "cscope")
2325 global
2326 {not available when compiled without the |+cscope|
2327 feature}
2328 {not in Vi}
2329 Specifies the command to execute cscope. See |cscopeprg|.
2330 This option cannot be set from a |modeline| or in the |sandbox|, for
2331 security reasons.
2332
2333 *'cscopequickfix'* *'csqf'*
2334'cscopequickfix' 'csqf' string (default "")
2335 global
2336 {not available when compiled without the |+cscope|
2337 or |+quickfix| features}
2338 {not in Vi}
2339 Specifies whether to use quickfix window to show cscope results.
2340 See |cscopequickfix|.
2341
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002342 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002343'cscoperelative' 'csre' boolean (default off)
2344 global
2345 {not available when compiled without the |+cscope|
2346 feature}
2347 {not in Vi}
2348 In the absence of a prefix (-P) for cscope. setting this option enables
2349 to use the basename of cscope.out path as the prefix.
2350 See |cscoperelative|.
2351
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2353'cscopetag' 'cst' boolean (default off)
2354 global
2355 {not available when compiled without the |+cscope|
2356 feature}
2357 {not in Vi}
2358 Use cscope for tag commands. See |cscope-options|.
2359 NOTE: This option is reset when 'compatible' is set.
2360
2361 *'cscopetagorder'* *'csto'*
2362'cscopetagorder' 'csto' number (default 0)
2363 global
2364 {not available when compiled without the |+cscope|
2365 feature}
2366 {not in Vi}
2367 Determines the order in which ":cstag" performs a search. See
2368 |cscopetagorder|.
2369 NOTE: This option is set to 0 when 'compatible' is set.
2370
2371 *'cscopeverbose'* *'csverb'*
2372 *'nocscopeverbose'* *'nocsverb'*
2373'cscopeverbose' 'csverb' boolean (default off)
2374 global
2375 {not available when compiled without the |+cscope|
2376 feature}
2377 {not in Vi}
2378 Give messages when adding a cscope database. See |cscopeverbose|.
2379 NOTE: This option is reset when 'compatible' is set.
2380
Bram Moolenaar860cae12010-06-05 23:22:07 +02002381 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2382'cursorbind' 'crb' boolean (default off)
2383 local to window
2384 {not in Vi}
2385 {not available when compiled without the |+cursorbind|
2386 feature}
2387 When this option is set, as the cursor in the current
2388 window moves other cursorbound windows (windows that also have
2389 this option set) move their cursors to the corresponding line and
2390 column. This option is useful for viewing the
2391 differences between two versions of a file (see 'diff'); in diff mode,
2392 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002393 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002394
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002395
2396 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2397'cursorcolumn' 'cuc' boolean (default off)
2398 local to window
2399 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002400 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002401 feature}
2402 Highlight the screen column of the cursor with CursorColumn
2403 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2404 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002405 If you only want the highlighting in the current window you can use
2406 these autocommands: >
2407 au WinLeave * set nocursorline nocursorcolumn
2408 au WinEnter * set cursorline cursorcolumn
2409<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002410
2411 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2412'cursorline' 'cul' boolean (default off)
2413 local to window
2414 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002415 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002416 feature}
2417 Highlight the screen line of the cursor with CursorLine
2418 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2419 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002420 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002421 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002422
2423
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 *'debug'*
2425'debug' string (default "")
2426 global
2427 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002428 These values can be used:
2429 msg Error messages that would otherwise be omitted will be given
2430 anyway.
2431 throw Error messages that would otherwise be omitted will be given
2432 anyway and also throw an exception and set |v:errmsg|.
2433 beep A message will be given when otherwise only a beep would be
2434 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002435 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002436 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2437 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438
2439 *'define'* *'def'*
2440'define' 'def' string (default "^\s*#\s*define")
2441 global or local to buffer |global-local|
2442 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002443 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 pattern, just like for the "/" command. This option is used for the
2445 commands like "[i" and "[d" |include-search|. The 'isident' option is
2446 used to recognize the defined name after the match:
2447 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2448 See |option-backslash| about inserting backslashes to include a space
2449 or backslash.
2450 The default value is for C programs. For C++ this value would be
2451 useful, to include const type declarations: >
2452 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2453< When using the ":set" command, you need to double the backslashes!
2454
2455 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2456'delcombine' 'deco' boolean (default off)
2457 global
2458 {not in Vi}
2459 {only available when compiled with the |+multi_byte|
2460 feature}
2461 If editing Unicode and this option is set, backspace and Normal mode
2462 "x" delete each combining character on its own. When it is off (the
2463 default) the character along with its combining characters are
2464 deleted.
2465 Note: When 'delcombine' is set "xx" may work different from "2x"!
2466
2467 This is useful for Arabic, Hebrew and many other languages where one
2468 may have combining characters overtop of base characters, and want
2469 to remove only the combining ones.
2470
2471 *'dictionary'* *'dict'*
2472'dictionary' 'dict' string (default "")
2473 global or local to buffer |global-local|
2474 {not in Vi}
2475 List of file names, separated by commas, that are used to lookup words
2476 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2477 contain a list of words. This can be one word per line, or several
2478 words per line, separated by non-keyword characters (white space is
2479 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002480 When this option is empty, or an entry "spell" is present, spell
2481 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002482 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 after a comma are ignored, otherwise spaces are included in the file
2484 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002485 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 Where to find a list of words?
2487 - On FreeBSD, there is the file "/usr/share/dict/words".
2488 - In the Simtel archive, look in the "msdos/linguist" directory.
2489 - In "miscfiles" of the GNU collection.
2490 The use of |:set+=| and |:set-=| is preferred when adding or removing
2491 directories from the list. This avoids problems when a future version
2492 uses another default.
2493 Backticks cannot be used in this option for security reasons.
2494
2495 *'diff'* *'nodiff'*
2496'diff' boolean (default off)
2497 local to window
2498 {not in Vi}
2499 {not available when compiled without the |+diff|
2500 feature}
2501 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002502 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503
2504 *'dex'* *'diffexpr'*
2505'diffexpr' 'dex' string (default "")
2506 global
2507 {not in Vi}
2508 {not available when compiled without the |+diff|
2509 feature}
2510 Expression which is evaluated to obtain an ed-style diff file from two
2511 versions of a file. See |diff-diffexpr|.
2512 This option cannot be set from a |modeline| or in the |sandbox|, for
2513 security reasons.
2514
2515 *'dip'* *'diffopt'*
2516'diffopt' 'dip' string (default "filler")
2517 global
2518 {not in Vi}
2519 {not available when compiled without the |+diff|
2520 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002521 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 All are optional. Items must be separated by a comma.
2523
2524 filler Show filler lines, to keep the text
2525 synchronized with a window that has inserted
2526 lines at the same position. Mostly useful
2527 when windows are side-by-side and 'scrollbind'
2528 is set.
2529
2530 context:{n} Use a context of {n} lines between a change
2531 and a fold that contains unchanged lines.
2532 When omitted a context of six lines is used.
2533 See |fold-diff|.
2534
2535 icase Ignore changes in case of text. "a" and "A"
2536 are considered the same. Adds the "-i" flag
2537 to the "diff" command if 'diffexpr' is empty.
2538
2539 iwhite Ignore changes in amount of white space. Adds
2540 the "-b" flag to the "diff" command if
2541 'diffexpr' is empty. Check the documentation
2542 of the "diff" command for what this does
2543 exactly. It should ignore adding trailing
2544 white space, but not leading white space.
2545
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002546 horizontal Start diff mode with horizontal splits (unless
2547 explicitly specified otherwise).
2548
2549 vertical Start diff mode with vertical splits (unless
2550 explicitly specified otherwise).
2551
2552 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2553 starting diff mode. Without this 2 is used.
2554
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 Examples: >
2556
2557 :set diffopt=filler,context:4
2558 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002559 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560<
2561 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2562'digraph' 'dg' boolean (default off)
2563 global
2564 {not in Vi}
2565 {not available when compiled without the |+digraphs|
2566 feature}
2567 Enable the entering of digraphs in Insert mode with {char1} <BS>
2568 {char2}. See |digraphs|.
2569 NOTE: This option is reset when 'compatible' is set.
2570
2571 *'directory'* *'dir'*
2572'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002573 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 for Unix: ".,~/tmp,/var/tmp,/tmp")
2575 global
2576 List of directory names for the swap file, separated with commas.
2577 - The swap file will be created in the first directory where this is
2578 possible.
2579 - Empty means that no swap file will be used (recovery is
2580 impossible!).
2581 - A directory "." means to put the swap file in the same directory as
2582 the edited file. On Unix, a dot is prepended to the file name, so
2583 it doesn't show in a directory listing. On MS-Windows the "hidden"
2584 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002585 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 put the swap file relative to where the edited file is. The leading
2587 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002588 - For Unix and Win32, if a directory ends in two path separators "//"
2589 or "\\", the swap file name will be built from the complete path to
2590 the file with all path separators substituted to percent '%' signs.
2591 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002592 On Win32, when a separating comma is following, you must use "//",
2593 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 - Spaces after the comma are ignored, other spaces are considered part
2595 of the directory name. To have a space at the start of a directory
2596 name, precede it with a backslash.
2597 - To include a comma in a directory name precede it with a backslash.
2598 - A directory name may end in an ':' or '/'.
2599 - Environment variables are expanded |:set_env|.
2600 - Careful with '\' characters, type one before a space, type two to
2601 get one in the option (see |option-backslash|), for example: >
2602 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2603< - For backwards compatibility with Vim version 3.0 a '>' at the start
2604 of the option is removed.
2605 Using "." first in the list is recommended. This means that editing
2606 the same file twice will result in a warning. Using "/tmp" on Unix is
2607 discouraged: When the system crashes you lose the swap file.
2608 "/var/tmp" is often not cleared when rebooting, thus is a better
2609 choice than "/tmp". But it can contain a lot of files, your swap
2610 files get lost in the crowd. That is why a "tmp" directory in your
2611 home directory is tried first.
2612 The use of |:set+=| and |:set-=| is preferred when adding or removing
2613 directories from the list. This avoids problems when a future version
2614 uses another default.
2615 This option cannot be set from a |modeline| or in the |sandbox|, for
2616 security reasons.
2617 {Vi: directory to put temp file in, defaults to "/tmp"}
2618
2619 *'display'* *'dy'*
2620'display' 'dy' string (default "")
2621 global
2622 {not in Vi}
2623 Change the way text is displayed. This is comma separated list of
2624 flags:
2625 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 last line that doesn't fit is replaced with "@" lines.
2628 uhex Show unprintable characters hexadecimal as <xx>
2629 instead of using ^C and ~C.
2630
2631 *'eadirection'* *'ead'*
2632'eadirection' 'ead' string (default "both")
2633 global
2634 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002635 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 feature}
2637 Tells when the 'equalalways' option applies:
2638 ver vertically, width of windows is not affected
2639 hor horizontally, height of windows is not affected
2640 both width and height of windows is affected
2641
2642 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2643'edcompatible' 'ed' boolean (default off)
2644 global
2645 Makes the 'g' and 'c' flags of the ":substitute" command to be
2646 toggled each time the flag is given. See |complex-change|. See
2647 also 'gdefault' option.
2648 Switching this option on is discouraged!
2649
Bram Moolenaar03413f42016-04-12 21:07:15 +02002650 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002651'emoji' 'emo' boolean (default: on)
2652 global
2653 {not in Vi}
2654 {only available when compiled with the |+multi_byte|
2655 feature}
2656 When on all Unicode emoji characters are considered to be full width.
2657
2658
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 *'encoding'* *'enc'* *E543*
2660'encoding' 'enc' string (default: "latin1" or value from $LANG)
2661 global
2662 {only available when compiled with the |+multi_byte|
2663 feature}
2664 {not in Vi}
2665 Sets the character encoding used inside Vim. It applies to text in
2666 the buffers, registers, Strings in expressions, text stored in the
2667 viminfo file, etc. It sets the kind of characters which Vim can work
2668 with. See |encoding-names| for the possible values.
2669
2670 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002671 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002673 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674
Bram Moolenaar865242e2010-07-14 21:12:05 +02002675 This option cannot be set from a |modeline|. It would most likely
2676 corrupt the text.
2677
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2679 "utf-8". Although care has been taken to allow different values of
2680 'encoding', "utf-8" is the natural choice for the environment and
2681 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002682 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 versions, and to avoid changing the encoding of newly created files
2684 without your knowledge (in case 'fileencodings' is empty).
2685
2686 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002687 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 iconv() or as specified with 'charconvert'.
2689
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002690 If you need to know whether 'encoding' is a multi-byte encoding, you
2691 can use: >
2692 if has("multi_byte_encoding")
2693<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 Normally 'encoding' will be equal to your current locale. This will
2695 be the default if Vim recognizes your environment settings. If
2696 'encoding' is not set to the current locale, 'termencoding' must be
2697 set to convert typed and displayed text. See |encoding-table|.
2698
2699 When you set this option, it fires the |EncodingChanged| autocommand
2700 event so that you can set up fonts if necessary.
2701
2702 When the option is set, the value is converted to lowercase. Thus
2703 you can set it with uppercase values too. Underscores are translated
2704 to '-' signs.
2705 When the encoding is recognized, it is changed to the standard name.
2706 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2707 "iso-8859-2" and "utf8" becomes "utf-8".
2708
2709 Note: "latin1" is also used when the encoding could not be detected.
2710 This only works when editing files in the same encoding! When the
2711 actual character set is not latin1, make sure 'fileencoding' and
2712 'fileencodings' are empty. When conversion is needed, switch to using
2713 utf-8.
2714
2715 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2716 You don't notice this while editing, but it does matter for the
2717 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2718 setting 'encoding' to one of these values instead of utf-8 only has
2719 effect for encoding used for files when 'fileencoding' is empty.
2720
Bram Moolenaar661b1822005-07-28 22:36:45 +00002721 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2722 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723
2724 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2725'endofline' 'eol' boolean (default on)
2726 local to buffer
2727 {not in Vi}
2728 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002729 is on, or 'fixeol' option is off, no <EOL> will be written for the
2730 last line in the file. This option is automatically set or reset when
2731 starting to edit a new file, depending on whether file has an <EOL>
2732 for the last line in the file. Normally you don't have to set or
2733 reset this option.
2734 When 'binary' is off and 'fixeol' is on the value is not used when
2735 writing the file. When 'binary' is on or 'fixeol' is off it is used
2736 to remember the presence of a <EOL> for the last line in the file, so
2737 that when you write the file the situation from the original file can
2738 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739
2740 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2741'equalalways' 'ea' boolean (default on)
2742 global
2743 {not in Vi}
2744 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002745 splitting or closing a window. This also happens the moment the
2746 option is switched on. When off, splitting a window will reduce the
2747 size of the current window and leave the other windows the same. When
2748 closing a window the extra lines are given to the window next to it
2749 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 When mixing vertically and horizontally split windows, a minimal size
2751 is computed and some windows may be larger if there is room. The
2752 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002753 Changing the height and width of a window can be avoided by setting
2754 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002755 If a window size is specified when creating a new window sizes are
2756 currently not equalized (it's complicated, but may be implemented in
2757 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758
2759 *'equalprg'* *'ep'*
2760'equalprg' 'ep' string (default "")
2761 global or local to buffer |global-local|
2762 {not in Vi}
2763 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002764 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002765 or 'indentexpr'. When Vim was compiled without internal formatting,
2766 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 about including spaces and backslashes.
2769 This option cannot be set from a |modeline| or in the |sandbox|, for
2770 security reasons.
2771
2772 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2773'errorbells' 'eb' boolean (default off)
2774 global
2775 Ring the bell (beep or screen flash) for error messages. This only
2776 makes a difference for error messages, the bell will be used always
2777 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002778 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002779 screen flash or do nothing. See 'belloff' to finetune when to ring the
2780 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781
2782 *'errorfile'* *'ef'*
2783'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2784 others: "errors.err")
2785 global
2786 {not in Vi}
2787 {not available when compiled without the |+quickfix|
2788 feature}
2789 Name of the errorfile for the QuickFix mode (see |:cf|).
2790 When the "-q" command-line argument is used, 'errorfile' is set to the
2791 following argument. See |-q|.
2792 NOT used for the ":make" command. See 'makeef' for that.
2793 Environment variables are expanded |:set_env|.
2794 See |option-backslash| about including spaces and backslashes.
2795 This option cannot be set from a |modeline| or in the |sandbox|, for
2796 security reasons.
2797
2798 *'errorformat'* *'efm'*
2799'errorformat' 'efm' string (default is very long)
2800 global or local to buffer |global-local|
2801 {not in Vi}
2802 {not available when compiled without the |+quickfix|
2803 feature}
2804 Scanf-like description of the format for the lines in the error file
2805 (see |errorformat|).
2806
2807 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2808'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2809 global
2810 {not in Vi}
2811 Function keys that start with an <Esc> are recognized in Insert
2812 mode. When this option is off, the cursor and function keys cannot be
2813 used in Insert mode if they start with an <Esc>. The advantage of
2814 this is that the single <Esc> is recognized immediately, instead of
2815 after one second. Instead of resetting this option, you might want to
2816 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2817 when 'esckeys' is off, you can still map anything, but the cursor keys
2818 won't work by default.
2819 NOTE: This option is set to the Vi default value when 'compatible' is
2820 set and to the Vim default value when 'compatible' is reset.
2821
2822 *'eventignore'* *'ei'*
2823'eventignore' 'ei' string (default "")
2824 global
2825 {not in Vi}
2826 {not available when compiled without the |+autocmd|
2827 feature}
2828 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002829 When set to "all" or when "all" is one of the items, all autocommand
2830 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 Otherwise this is a comma separated list of event names. Example: >
2832 :set ei=WinEnter,WinLeave
2833<
2834 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2835'expandtab' 'et' boolean (default off)
2836 local to buffer
2837 {not in Vi}
2838 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002839 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2841 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002842 This option is reset when the 'paste' option is set and restored when
2843 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 NOTE: This option is reset when 'compatible' is set.
2845
2846 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2847'exrc' 'ex' boolean (default off)
2848 global
2849 {not in Vi}
2850 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2851 directory. If you switch this option on you should also consider
2852 setting the 'secure' option (see |initialization|). Using a local
2853 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2854 also see |.vimrc| and |gui-init|.
2855 This option cannot be set from a |modeline| or in the |sandbox|, for
2856 security reasons.
2857
2858 *'fileencoding'* *'fenc'* *E213*
2859'fileencoding' 'fenc' string (default: "")
2860 local to buffer
2861 {only available when compiled with the |+multi_byte|
2862 feature}
2863 {not in Vi}
2864 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002865
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002867 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 When 'fileencoding' is empty, the same value as 'encoding' will be
2869 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002870 Conversion will also be done when 'encoding' and 'fileencoding' are
2871 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2872 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002874 'encoding' is "utf-8" or another Unicode encoding, conversion
2875 is most likely done in a way that the reverse conversion
2876 results in the same text. When 'encoding' is not "utf-8" some
2877 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002878
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 See 'encoding' for the possible values. Additionally, values may be
2880 specified that can be handled by the converter, see
2881 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002882
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 When reading a file 'fileencoding' will be set from 'fileencodings'.
2884 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002885 'fileencoding', use the |++enc| argument. One exception: when
2886 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002887 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002888
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2890 When the option is set, the value is converted to lowercase. Thus
2891 you can set it with uppercase values too. '_' characters are
2892 replaced with '-'. If a name is recognized from the list for
2893 'encoding', it is replaced by the standard name. For example
2894 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002895
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 When this option is set, after starting to edit a file, the 'modified'
2897 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002898
2899 Keep in mind that changing 'fenc' from a modeline happens
2900 AFTER the text has been read, thus it applies to when the file will be
2901 written. If you do set 'fenc' in a modeline, you might want to set
2902 'nomodified' to avoid not being able to ":q".
2903
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 This option can not be changed when 'modifiable' is off.
2905
2906 *'fe'*
2907 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002908 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 old short name was 'fe', which is no longer used.
2910
2911 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002912'fileencodings' 'fencs' string (default: "ucs-bom",
2913 "ucs-bom,utf-8,default,latin1" when
2914 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 global
2916 {only available when compiled with the |+multi_byte|
2917 feature}
2918 {not in Vi}
2919 This is a list of character encodings considered when starting to edit
2920 an existing file. When a file is read, Vim tries to use the first
2921 mentioned character encoding. If an error is detected, the next one
2922 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002923 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 an empty string, which means the value of 'encoding' is used.
2925 WARNING: Conversion can cause loss of information! When
2926 'encoding' is "utf-8" (or one of the other Unicode variants)
2927 conversion is most likely done in a way that the reverse
2928 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002929 "utf-8" some non-ASCII characters may be lost! You can use
2930 the |++bad| argument to specify what is done with characters
2931 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 For an empty file or a file with only ASCII characters most encodings
2933 will work and the first entry of 'fileencodings' will be used (except
2934 "ucs-bom", which requires the BOM to be present). If you prefer
2935 another encoding use an BufReadPost autocommand event to test if your
2936 preferred encoding is to be used. Example: >
2937 au BufReadPost * if search('\S', 'w') == 0 |
2938 \ set fenc=iso-2022-jp | endif
2939< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2940 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002941 When the |++enc| argument is used then the value of 'fileencodings' is
2942 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002943 Note that 'fileencodings' is not used for a new file, the global value
2944 of 'fileencoding' is used instead. You can set it with: >
2945 :setglobal fenc=iso-8859-2
2946< This means that a non-existing file may get a different encoding than
2947 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 The special value "ucs-bom" can be used to check for a Unicode BOM
2949 (Byte Order Mark) at the start of the file. It must not be preceded
2950 by "utf-8" or another Unicode encoding for this to work properly.
2951 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2952 because Vim cannot detect an error, thus the encoding is always
2953 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002954 The special value "default" can be used for the encoding from the
2955 environment. This is the default value for 'encoding'. It is useful
2956 when 'encoding' is set to "utf-8" and your environment uses a
2957 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002958 When 'encoding' is "utf-8" and a file contains an illegal byte
2959 sequence it won't be recognized as UTF-8. You can use the |8g8|
2960 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 WRONG VALUES: WHAT'S WRONG:
2962 latin1,utf-8 "latin1" will always be used
2963 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2964 file
2965 cp1250,latin1 "cp1250" will always be used
2966 If 'fileencodings' is empty, 'fileencoding' is not modified.
2967 See 'fileencoding' for the possible values.
2968 Setting this option does not have an effect until the next time a file
2969 is read.
2970
2971 *'fileformat'* *'ff'*
2972'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2973 Unix default: "unix",
2974 Macintosh default: "mac")
2975 local to buffer
2976 {not in Vi}
2977 This gives the <EOL> of the current buffer, which is used for
2978 reading/writing the buffer from/to a file:
2979 dos <CR> <NL>
2980 unix <NL>
2981 mac <CR>
2982 When "dos" is used, CTRL-Z at the end of a file is ignored.
2983 See |file-formats| and |file-read|.
2984 For the character encoding of the file see 'fileencoding'.
2985 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002986 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 This option is set automatically when starting to edit a file and
2988 'fileformats' is not empty and 'binary' is off.
2989 When this option is set, after starting to edit a file, the 'modified'
2990 option is set, because the file would be different when written.
2991 This option can not be changed when 'modifiable' is off.
2992 For backwards compatibility: When this option is set to "dos",
2993 'textmode' is set, otherwise 'textmode' is reset.
2994
2995 *'fileformats'* *'ffs'*
2996'fileformats' 'ffs' string (default:
2997 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2998 Vim Unix: "unix,dos",
2999 Vim Mac: "mac,unix,dos",
3000 Vi Cygwin: "unix,dos",
3001 Vi others: "")
3002 global
3003 {not in Vi}
3004 This gives the end-of-line (<EOL>) formats that will be tried when
3005 starting to edit a new buffer and when reading a file into an existing
3006 buffer:
3007 - When empty, the format defined with 'fileformat' will be used
3008 always. It is not set automatically.
3009 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003010 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003011 'fileformats' name will be used when a file is read into an existing
3012 buffer, no matter what 'fileformat' for that buffer is set to.
3013 - When more than one name is present, separated by commas, automatic
3014 <EOL> detection will be done when reading a file. When starting to
3015 edit a file, a check is done for the <EOL>:
3016 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3017 'fileformat' is set to "dos".
3018 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003019 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003021 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3022 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003023 This means that "mac" is only chosen when:
3024 "unix" is not present or no <NL> is found in the file, and
3025 "dos" is not present or no <CR><NL> is found in the file.
3026 Except: if "unix" was chosen, but there is a <CR> before
3027 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003028 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 4. If 'fileformat' is still not set, the first name from
3030 'fileformats' is used.
3031 When reading a file into an existing buffer, the same is done, but
3032 this happens like 'fileformat' has been set appropriately for that
3033 file only, the option is not changed.
3034 When 'binary' is set, the value of 'fileformats' is not used.
3035
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003036 When Vim starts up with an empty buffer the first item is used. You
3037 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003038
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3040 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3041 done:
3042 - When 'fileformats' is empty, there is no automatic detection. Dos
3043 format will be used.
3044 - When 'fileformats' is set to one or more names, automatic detection
3045 is done. This is based on the first <NL> in the file: If there is a
3046 <CR> in front of it, Dos format is used, otherwise Unix format is
3047 used.
3048 Also see |file-formats|.
3049 For backwards compatibility: When this option is set to an empty
3050 string or one format (no comma is included), 'textauto' is reset,
3051 otherwise 'textauto' is set.
3052 NOTE: This option is set to the Vi default value when 'compatible' is
3053 set and to the Vim default value when 'compatible' is reset.
3054
Bram Moolenaarbf884932013-04-05 22:26:15 +02003055 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3056'fileignorecase' 'fic' boolean (default on for systems where case in file
3057 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003058 global
3059 {not in Vi}
3060 When set case is ignored when using file names and directories.
3061 See 'wildignorecase' for only ignoring case when doing completion.
3062
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 *'filetype'* *'ft'*
3064'filetype' 'ft' string (default: "")
3065 local to buffer
3066 {not in Vi}
3067 {not available when compiled without the |+autocmd|
3068 feature}
3069 When this option is set, the FileType autocommand event is triggered.
3070 All autocommands that match with the value of this option will be
3071 executed. Thus the value of 'filetype' is used in place of the file
3072 name.
3073 Otherwise this option does not always reflect the current file type.
3074 This option is normally set when the file type is detected. To enable
3075 this use the ":filetype on" command. |:filetype|
3076 Setting this option to a different value is most useful in a modeline,
3077 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003078 Example, for in an IDL file:
3079 /* vim: set filetype=idl : */ ~
3080 |FileType| |filetypes|
3081 When a dot appears in the value then this separates two filetype
3082 names. Example:
3083 /* vim: set filetype=c.doxygen : */ ~
3084 This will use the "c" filetype first, then the "doxygen" filetype.
3085 This works both for filetype plugins and for syntax files. More than
3086 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 This option is not copied to another buffer, independent of the 's' or
3088 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003089 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090
3091 *'fillchars'* *'fcs'*
3092'fillchars' 'fcs' string (default "vert:|,fold:-")
3093 global
3094 {not in Vi}
3095 {not available when compiled without the |+windows|
3096 and |+folding| features}
3097 Characters to fill the statuslines and vertical separators.
3098 It is a comma separated list of items:
3099
3100 item default Used for ~
3101 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003102 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 vert:c '|' vertical separators |:vsplit|
3104 fold:c '-' filling 'foldtext'
3105 diff:c '-' deleted lines of the 'diff' option
3106
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003108 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 otherwise.
3110
3111 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003112 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113< This is similar to the default, except that these characters will also
3114 be used when there is highlighting.
3115
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003116 for "stl" and "stlnc" only single-byte values are supported.
3117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 The highlighting used for these items:
3119 item highlight group ~
3120 stl:c StatusLine |hl-StatusLine|
3121 stlnc:c StatusLineNC |hl-StatusLineNC|
3122 vert:c VertSplit |hl-VertSplit|
3123 fold:c Folded |hl-Folded|
3124 diff:c DiffDelete |hl-DiffDelete|
3125
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003126 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3127'fixendofline' 'fixeol' boolean (default on)
3128 local to buffer
3129 {not in Vi}
3130 When writing a file and this option is on, <EOL> at the end of file
3131 will be restored if missing. Turn this option off if you want to
3132 preserve the situation from the original file.
3133 When the 'binary' option is set the value of this option doesn't
3134 matter.
3135 See the 'endofline' option.
3136
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3138'fkmap' 'fk' boolean (default off) *E198*
3139 global
3140 {not in Vi}
3141 {only available when compiled with the |+rightleft|
3142 feature}
3143 When on, the keyboard is mapped for the Farsi character set.
3144 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003145 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146
3147 *'foldclose'* *'fcl'*
3148'foldclose' 'fcl' string (default "")
3149 global
3150 {not in Vi}
3151 {not available when compiled without the |+folding|
3152 feature}
3153 When set to "all", a fold is closed when the cursor isn't in it and
3154 its level is higher than 'foldlevel'. Useful if you want folds to
3155 automatically close when moving out of them.
3156
3157 *'foldcolumn'* *'fdc'*
3158'foldcolumn' 'fdc' number (default 0)
3159 local to window
3160 {not in Vi}
3161 {not available when compiled without the |+folding|
3162 feature}
3163 When non-zero, a column with the specified width is shown at the side
3164 of the window which indicates open and closed folds. The maximum
3165 value is 12.
3166 See |folding|.
3167
3168 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3169'foldenable' 'fen' boolean (default on)
3170 local to window
3171 {not in Vi}
3172 {not available when compiled without the |+folding|
3173 feature}
3174 When off, all folds are open. This option can be used to quickly
3175 switch between showing all text unfolded and viewing the text with
3176 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003177 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 'foldenable' is off.
3179 This option is set by commands that create a new fold or close a fold.
3180 See |folding|.
3181
3182 *'foldexpr'* *'fde'*
3183'foldexpr' 'fde' string (default: "0")
3184 local to window
3185 {not in Vi}
3186 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003187 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003189 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003190
Bram Moolenaar30b65812012-07-12 22:01:11 +02003191 The expression will be evaluated in the |sandbox| if set from a
3192 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003193 This option can't be set from a |modeline| when the 'diff' option is
3194 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003195
3196 It is not allowed to change text or jump to another window while
3197 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198
3199 *'foldignore'* *'fdi'*
3200'foldignore' 'fdi' string (default: "#")
3201 local to window
3202 {not in Vi}
3203 {not available when compiled without the |+folding|
3204 feature}
3205 Used only when 'foldmethod' is "indent". Lines starting with
3206 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 The default "#" works well for C programs. See |fold-indent|.
3209
3210 *'foldlevel'* *'fdl'*
3211'foldlevel' 'fdl' number (default: 0)
3212 local to window
3213 {not in Vi}
3214 {not available when compiled without the |+folding|
3215 feature}
3216 Sets the fold level: Folds with a higher level will be closed.
3217 Setting this option to zero will close all folds. Higher numbers will
3218 close fewer folds.
3219 This option is set by commands like |zm|, |zM| and |zR|.
3220 See |fold-foldlevel|.
3221
3222 *'foldlevelstart'* *'fdls'*
3223'foldlevelstart' 'fdls' number (default: -1)
3224 global
3225 {not in Vi}
3226 {not available when compiled without the |+folding|
3227 feature}
3228 Sets 'foldlevel' when starting to edit another buffer in a window.
3229 Useful to always start editing with all folds closed (value zero),
3230 some folds closed (one) or no folds closed (99).
3231 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003232 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 ignores this option and closes all folds.
3234 It is also done before BufReadPre autocommands, to allow an autocmd to
3235 overrule the 'foldlevel' value for specific files.
3236 When the value is negative, it is not used.
3237
3238 *'foldmarker'* *'fmr'* *E536*
3239'foldmarker' 'fmr' string (default: "{{{,}}}")
3240 local to window
3241 {not in Vi}
3242 {not available when compiled without the |+folding|
3243 feature}
3244 The start and end marker used when 'foldmethod' is "marker". There
3245 must be one comma, which separates the start and end marker. The
3246 marker is a literal string (a regular expression would be too slow).
3247 See |fold-marker|.
3248
3249 *'foldmethod'* *'fdm'*
3250'foldmethod' 'fdm' string (default: "manual")
3251 local to window
3252 {not in Vi}
3253 {not available when compiled without the |+folding|
3254 feature}
3255 The kind of folding used for the current window. Possible values:
3256 |fold-manual| manual Folds are created manually.
3257 |fold-indent| indent Lines with equal indent form a fold.
3258 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3259 |fold-marker| marker Markers are used to specify folds.
3260 |fold-syntax| syntax Syntax highlighting items specify folds.
3261 |fold-diff| diff Fold text that is not changed.
3262
3263 *'foldminlines'* *'fml'*
3264'foldminlines' 'fml' number (default: 1)
3265 local to window
3266 {not in Vi}
3267 {not available when compiled without the |+folding|
3268 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003269 Sets the number of screen lines above which a fold can be displayed
3270 closed. Also for manually closed folds. With the default value of
3271 one a fold can only be closed if it takes up two or more screen lines.
3272 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003273 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 "zc" to close a fold, which is displayed open because it's smaller
3275 than 'foldminlines', a following "zc" may close a containing fold.
3276
3277 *'foldnestmax'* *'fdn'*
3278'foldnestmax' 'fdn' number (default: 20)
3279 local to window
3280 {not in Vi}
3281 {not available when compiled without the |+folding|
3282 feature}
3283 Sets the maximum nesting of folds for the "indent" and "syntax"
3284 methods. This avoids that too many folds will be created. Using more
3285 than 20 doesn't work, because the internal limit is 20.
3286
3287 *'foldopen'* *'fdo'*
3288'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3289 search,tag,undo")
3290 global
3291 {not in Vi}
3292 {not available when compiled without the |+folding|
3293 feature}
3294 Specifies for which type of commands folds will be opened, if the
3295 command moves the cursor into a closed fold. It is a comma separated
3296 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003297 NOTE: When the command is part of a mapping this option is not used.
3298 Add the |zv| command to the mapping to get the same effect.
3299 (rationale: the mapping may want to control opening folds itself)
3300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 item commands ~
3302 all any
3303 block "(", "{", "[[", "[{", etc.
3304 hor horizontal movements: "l", "w", "fx", etc.
3305 insert any command in Insert mode
3306 jump far jumps: "G", "gg", etc.
3307 mark jumping to a mark: "'m", CTRL-O, etc.
3308 percent "%"
3309 quickfix ":cn", ":crew", ":make", etc.
3310 search search for a pattern: "/", "n", "*", "gd", etc.
3311 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003312 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 tag jumping to a tag: ":ta", CTRL-T, etc.
3314 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 When a movement command is used for an operator (e.g., "dl" or "y%")
3316 this option is not used. This means the operator will include the
3317 whole closed fold.
3318 Note that vertical movements are not here, because it would make it
3319 very difficult to move onto a closed fold.
3320 In insert mode the folds containing the cursor will always be open
3321 when text is inserted.
3322 To close folds you can re-apply 'foldlevel' with the |zx| command or
3323 set the 'foldclose' option to "all".
3324
3325 *'foldtext'* *'fdt'*
3326'foldtext' 'fdt' string (default: "foldtext()")
3327 local to window
3328 {not in Vi}
3329 {not available when compiled without the |+folding|
3330 feature}
3331 An expression which is used to specify the text displayed for a closed
3332 fold. See |fold-foldtext|.
3333
Bram Moolenaar30b65812012-07-12 22:01:11 +02003334 The expression will be evaluated in the |sandbox| if set from a
3335 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003336
3337 It is not allowed to change text or jump to another window while
3338 evaluating 'foldtext' |textlock|.
3339
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003340 *'formatexpr'* *'fex'*
3341'formatexpr' 'fex' string (default "")
3342 local to buffer
3343 {not in Vi}
3344 {not available when compiled without the |+eval|
3345 feature}
3346 Expression which is evaluated to format a range of lines for the |gq|
3347 operator or automatic formatting (see 'formatoptions'). When this
3348 option is empty 'formatprg' is used.
3349
3350 The |v:lnum| variable holds the first line to be formatted.
3351 The |v:count| variable holds the number of lines to be formatted.
3352 The |v:char| variable holds the character that is going to be
3353 inserted if the expression is being evaluated due to
3354 automatic formatting. This can be empty. Don't insert
3355 it yet!
3356
3357 Example: >
3358 :set formatexpr=mylang#Format()
3359< This will invoke the mylang#Format() function in the
3360 autoload/mylang.vim file in 'runtimepath'. |autoload|
3361
3362 The expression is also evaluated when 'textwidth' is set and adding
3363 text beyond that limit. This happens under the same conditions as
3364 when internal formatting is used. Make sure the cursor is kept in the
3365 same spot relative to the text then! The |mode()| function will
3366 return "i" or "R" in this situation.
3367
3368 When the expression evaluates to non-zero Vim will fall back to using
3369 the internal format mechanism.
3370
3371 The expression will be evaluated in the |sandbox| when set from a
3372 modeline, see |sandbox-option|. That stops the option from working,
3373 since changing the buffer text is not allowed.
3374
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 *'formatoptions'* *'fo'*
3376'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3377 local to buffer
3378 {not in Vi}
3379 This is a sequence of letters which describes how automatic
3380 formatting is to be done. See |fo-table|. When the 'paste' option is
3381 on, no formatting is done (like 'formatoptions' is empty). Commas can
3382 be inserted for readability.
3383 To avoid problems with flags that are added in the future, use the
3384 "+=" and "-=" feature of ":set" |add-option-flags|.
3385 NOTE: This option is set to the Vi default value when 'compatible' is
3386 set and to the Vim default value when 'compatible' is reset.
3387
Bram Moolenaar86b68352004-12-27 21:59:20 +00003388 *'formatlistpat'* *'flp'*
3389'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3390 local to buffer
3391 {not in Vi}
3392 A pattern that is used to recognize a list header. This is used for
3393 the "n" flag in 'formatoptions'.
3394 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003395 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003396 while still checking more characters. There must be a character
3397 following the pattern, when it matches the whole line it is handled
3398 like there is no match.
3399 The default recognizes a number, followed by an optional punctuation
3400 character and white space.
3401
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 *'formatprg'* *'fp'*
3403'formatprg' 'fp' string (default "")
3404 global
3405 {not in Vi}
3406 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003407 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003409 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003410 If the 'formatexpr' option is not empty it will be used instead.
3411 Otherwise, if 'formatprg' option is an empty string, the internal
3412 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003413 Environment variables are expanded |:set_env|. See |option-backslash|
3414 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003415 This option cannot be set from a |modeline| or in the |sandbox|, for
3416 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417
Bram Moolenaard94464e2015-11-02 15:28:18 +01003418 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003419'fsync' 'fs' boolean (default on)
3420 global
3421 {not in Vi}
3422 When on, the library function fsync() will be called after writing a
3423 file. This will flush a file to disk, ensuring that it is safely
3424 written even on filesystems which do metadata-only journaling. This
3425 will force the harddrive to spin up on Linux systems running in laptop
3426 mode, so it may be undesirable in some situations. Be warned that
3427 turning this off increases the chances of data loss after a crash. On
3428 systems without an fsync() implementation, this variable is always
3429 off.
3430 Also see 'swapsync' for controlling fsync() on swap files.
3431
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3433'gdefault' 'gd' boolean (default off)
3434 global
3435 {not in Vi}
3436 When on, the ":substitute" flag 'g' is default on. This means that
3437 all matches in a line are substituted instead of one. When a 'g' flag
3438 is given to a ":substitute" command, this will toggle the substitution
3439 of all or one match. See |complex-change|.
3440
3441 command 'gdefault' on 'gdefault' off ~
3442 :s/// subst. all subst. one
3443 :s///g subst. one subst. all
3444 :s///gg subst. all subst. one
3445
3446 NOTE: This option is reset when 'compatible' is set.
3447
3448 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003449'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 global
3451 {not in Vi}
3452 Format to recognize for the ":grep" command output.
3453 This is a scanf-like string that uses the same format as the
3454 'errorformat' option: see |errorformat|.
3455
3456 *'grepprg'* *'gp'*
3457'grepprg' 'gp' string (default "grep -n ",
3458 Unix: "grep -n $* /dev/null",
3459 Win32: "findstr /n" or "grep -n",
3460 VMS: "SEARCH/NUMBERS ")
3461 global or local to buffer |global-local|
3462 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003463 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 and '#' characters, which are expanded like when used in a command-
3465 line. The placeholder "$*" is allowed to specify where the arguments
3466 will be included. Environment variables are expanded |:set_env|. See
3467 |option-backslash| about including spaces and backslashes.
3468 When your "grep" accepts the "-H" argument, use this to make ":grep"
3469 also work well with a single file: >
3470 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003471< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003472 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3473 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003474 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 apply equally to 'grepprg'.
3476 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3477 otherwise it's "grep -n".
3478 This option cannot be set from a |modeline| or in the |sandbox|, for
3479 security reasons.
3480
3481 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3482'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3483 ve:ver35-Cursor,
3484 o:hor50-Cursor,
3485 i-ci:ver25-Cursor/lCursor,
3486 r-cr:hor20-Cursor/lCursor,
3487 sm:block-Cursor
3488 -blinkwait175-blinkoff150-blinkon175",
3489 for MS-DOS and Win32 console:
3490 "n-v-c:block,o:hor50,i-ci:hor15,
3491 r-cr:hor30,sm:block")
3492 global
3493 {not in Vi}
3494 {only available when compiled with GUI enabled, and
3495 for MS-DOS and Win32 console}
3496 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003497 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 the height of the cursor can be changed. This can be done by
3499 specifying a block cursor, or a percentage for a vertical or
3500 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003501 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3502 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003504 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 mode-list and an argument-list:
3506 mode-list:argument-list,mode-list:argument-list,..
3507 The mode-list is a dash separated list of these modes:
3508 n Normal mode
3509 v Visual mode
3510 ve Visual mode with 'selection' "exclusive" (same as 'v',
3511 if not specified)
3512 o Operator-pending mode
3513 i Insert mode
3514 r Replace mode
3515 c Command-line Normal (append) mode
3516 ci Command-line Insert mode
3517 cr Command-line Replace mode
3518 sm showmatch in Insert mode
3519 a all modes
3520 The argument-list is a dash separated list of these arguments:
3521 hor{N} horizontal bar, {N} percent of the character height
3522 ver{N} vertical bar, {N} percent of the character width
3523 block block cursor, fills the whole character
3524 [only one of the above three should be present]
3525 blinkwait{N} *cursor-blinking*
3526 blinkon{N}
3527 blinkoff{N}
3528 blink times for cursor: blinkwait is the delay before
3529 the cursor starts blinking, blinkon is the time that
3530 the cursor is shown and blinkoff is the time that the
3531 cursor is not shown. The times are in msec. When one
3532 of the numbers is zero, there is no blinking. The
3533 default is: "blinkwait700-blinkon400-blinkoff250".
3534 These numbers are used for a missing entry. This
3535 means that blinking is enabled by default. To switch
3536 blinking off you can use "blinkon0". The cursor only
3537 blinks when Vim is waiting for input, not while
3538 executing a command.
3539 To make the cursor blink in an xterm, see
3540 |xterm-blink|.
3541 {group-name}
3542 a highlight group name, that sets the color and font
3543 for the cursor
3544 {group-name}/{group-name}
3545 Two highlight group names, the first is used when
3546 no language mappings are used, the other when they
3547 are. |language-mapping|
3548
3549 Examples of parts:
3550 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3551 block cursor with colors from the "nCursor"
3552 highlight group
3553 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3554 In Insert and Command-line Insert mode, use a
3555 30% vertical bar cursor with colors from the
3556 "iCursor" highlight group. Blink a bit
3557 faster.
3558
3559 The 'a' mode is different. It will set the given argument-list for
3560 all modes. It does not reset anything to defaults. This can be used
3561 to do a common setting for all modes. For example, to switch off
3562 blinking: "a:blinkon0"
3563
3564 Examples of cursor highlighting: >
3565 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3566 :highlight Cursor gui=NONE guifg=bg guibg=fg
3567<
3568 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003569 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570'guifont' 'gfn' string (default "")
3571 global
3572 {not in Vi}
3573 {only available when compiled with GUI enabled}
3574 This is a list of fonts which will be used for the GUI version of Vim.
3575 In its simplest form the value is just one font name. When
3576 the font cannot be found you will get an error message. To try other
3577 font names a list can be specified, font names separated with commas.
3578 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003579
Bram Moolenaar05159a02005-02-26 23:04:13 +00003580 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3581 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003582
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 Spaces after a comma are ignored. To include a comma in a font name
3584 precede it with a backslash. Setting an option requires an extra
3585 backslash before a space and a backslash. See also
3586 |option-backslash|. For example: >
3587 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003588< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003590
3591 If none of the fonts can be loaded, Vim will keep the current setting.
3592 If an empty font list is given, Vim will try using other resource
3593 settings (for X, it will use the Vim.font resource), and finally it
3594 will try some builtin default which should always be there ("7x13" in
3595 the case of X). The font names given should be "normal" fonts. Vim
3596 will try to find the related bold and italic fonts.
3597
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003598 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003599 :set guifont=*
3600< will bring up a font requester, where you can pick the font you want.
3601
3602 The font name depends on the GUI used. See |setting-guifont| for a
3603 way to set 'guifont' for various systems.
3604
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 For the GTK+ 2 GUI the font name looks like this: >
3606 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003607< That's all. XLFDs are not used. For Chinese this is reported to work
3608 well: >
3609 if has("gui_gtk2")
3610 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3611 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3612 endif
3613<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003614 For Mac OSX you can use something like this: >
3615 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003616< Also see 'macatsui', it can help fix display problems.
3617 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003619 width). An exception is GTK 2: all fonts are accepted, but
3620 mono-spaced fonts look best.
3621
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 To preview a font on X11, you might be able to use the "xfontsel"
3623 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003624
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 For the Win32 GUI *E244* *E245*
3626 - takes these options in the font name:
3627 hXX - height is XX (points, can be floating-point)
3628 wXX - width is XX (points, can be floating-point)
3629 b - bold
3630 i - italic
3631 u - underline
3632 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003633 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3635 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3636 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003637 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003638 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003639 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003640 Normally you would use "qDEFAULT".
3641 Some quality values isn't supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642
3643 Use a ':' to separate the options.
3644 - A '_' can be used in the place of a space, so you don't need to use
3645 backslashes to escape the spaces.
3646 - Examples: >
3647 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3648 :set guifont=Andale_Mono:h7.5:w4.5
3649< See also |font-sizes|.
3650
3651 *'guifontset'* *'gfs'*
3652 *E250* *E252* *E234* *E597* *E598*
3653'guifontset' 'gfs' string (default "")
3654 global
3655 {not in Vi}
3656 {only available when compiled with GUI enabled and
3657 with the |+xfontset| feature}
3658 {not available in the GTK+ 2 GUI}
3659 When not empty, specifies two (or more) fonts to be used. The first
3660 one for normal English, the second one for your special language. See
3661 |xfontset|.
3662 Setting this option also means that all font names will be handled as
3663 a fontset name. Also the ones used for the "font" argument of the
3664 |:highlight| command.
3665 The fonts must match with the current locale. If fonts for the
3666 character sets that the current locale uses are not included, setting
3667 'guifontset' will fail.
3668 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3669 the comma-separated names are alternative names, one of which will be
3670 used. In 'guifontset' the whole string is one fontset name,
3671 including the commas. It is not possible to specify alternative
3672 fontset names.
3673 This example works on many X11 systems: >
3674 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3675<
3676 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3677'guifontwide' 'gfw' string (default "")
3678 global
3679 {not in Vi}
3680 {only available when compiled with GUI enabled}
3681 When not empty, specifies a comma-separated list of fonts to be used
3682 for double-width characters. The first font that can be loaded is
3683 used.
3684 Note: The size of these fonts must be exactly twice as wide as the one
3685 specified with 'guifont' and the same height.
3686
3687 All GUI versions but GTK+ 2:
3688
3689 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3690 'guifontset' is empty or invalid.
3691 When 'guifont' is set and a valid font is found in it and
3692 'guifontwide' is empty Vim will attempt to find a matching
3693 double-width font and set 'guifontwide' to it.
3694
3695 GTK+ 2 GUI only: *guifontwide_gtk2*
3696
3697 If set and valid, 'guifontwide' is always used for double width
3698 characters, even if 'encoding' is not set to "utf-8".
3699 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003700 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 font for characters not available in 'guifont'. Thus you do not need
3702 to set 'guifontwide' at all unless you want to override the choice
3703 made by Pango/Xft.
3704
Bram Moolenaar0f272122013-01-23 18:37:40 +01003705 Windows +multibyte only: *guifontwide_win_mbyte*
3706
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003707 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003708
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 *'guiheadroom'* *'ghr'*
3710'guiheadroom' 'ghr' number (default 50)
3711 global
3712 {not in Vi} {only for GTK and X11 GUI}
3713 The number of pixels subtracted from the screen height when fitting
3714 the GUI window on the screen. Set this before the GUI is started,
3715 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003716 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 lines will be left for window decorations and other items on the
3718 screen. Set it to a negative value to allow windows taller than the
3719 screen.
3720
3721 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003722'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3723 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 global
3725 {not in Vi}
3726 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003727 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 sequence of letters which describes what components and options of the
3729 GUI should be used.
3730 To avoid problems with flags that are added in the future, use the
3731 "+=" and "-=" feature of ":set" |add-option-flags|.
3732
3733 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003734 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 'a' Autoselect: If present, then whenever VISUAL mode is started,
3736 or the Visual area extended, Vim tries to become the owner of
3737 the windowing system's global selection. This means that the
3738 Visually highlighted text is available for pasting into other
3739 applications as well as into Vim itself. When the Visual mode
3740 ends, possibly due to an operation on the text, or when an
3741 application wants to paste the selection, the highlighted text
3742 is automatically yanked into the "* selection register.
3743 Thus the selection is still available for pasting into other
3744 applications after the VISUAL mode has ended.
3745 If not present, then Vim won't become the owner of the
3746 windowing system's global selection unless explicitly told to
3747 by a yank or delete operation for the "* register.
3748 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003749 *'go-P'*
3750 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003751 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003752 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003753 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 applies to the modeless selection.
3755
3756 'guioptions' autoselect Visual autoselect modeless ~
3757 "" - -
3758 "a" yes yes
3759 "A" - yes
3760 "aA" yes yes
3761
Bram Moolenaar02467872007-05-06 13:22:01 +00003762 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 'c' Use console dialogs instead of popup dialogs for simple
3764 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003765 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003766 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767 'guitablabel' can be used to change the text in the labels.
3768 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003769 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003770 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003771 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'f' Foreground: Don't use fork() to detach the GUI from the shell
3773 where it was started. Use this for programs that wait for the
3774 editor to finish (e.g., an e-mail program). Alternatively you
3775 can use "gvim -f" or ":gui -f" to start the GUI in the
3776 foreground. |gui-fork|
3777 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003778 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003779 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3781 corner of the window. It's black&white on non-GTK, because of
3782 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003783 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003785 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003786 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003788 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 file is sourced the system menu has already been loaded; the
3790 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003791 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'g' Grey menu items: Make menu items that are not active grey. If
3793 'g' is not included inactive menu items are not shown at all.
3794 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003795 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 't' Include tearoff menu items. Currently only works for Win32,
3797 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003798 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003799 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003800 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003801 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003803 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 'R' Right-hand scrollbar is present when there is a vertically
3805 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003806 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003808 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'L' Left-hand scrollbar is present when there is a vertically
3810 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3813 the longest visible line, or on the cursor line if the 'h'
3814 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003815 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 'h' Limit horizontal scrollbar size to the length of the cursor
3817 line. Reduces computations. |gui-horiz-scroll|
3818
3819 And yes, you may even have scrollbars on the left AND the right if
3820 you really want to :-). See |gui-scrollbars| for more information.
3821
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003822 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'v' Use a vertical button layout for dialogs. When not included,
3824 a horizontal layout is preferred, but when it doesn't fit a
3825 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003826 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'p' Use Pointer callbacks for X11 GUI. This is required for some
3828 window managers. If the cursor is not blinking or hollow at
3829 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003830 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003832 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834
Bram Moolenaar02467872007-05-06 13:22:01 +00003835
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836 *'guipty'* *'noguipty'*
3837'guipty' boolean (default on)
3838 global
3839 {not in Vi}
3840 {only available when compiled with GUI enabled}
3841 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3842 I/O to/from shell commands. See |gui-pty|.
3843
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003844 *'guitablabel'* *'gtl'*
3845'guitablabel' 'gtl' string (default empty)
3846 global
3847 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003848 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003849 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003851 pages line. When empty and when the result is empty Vim will use a
3852 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003853
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003854 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003855 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003856
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003857 Only used when the GUI tab pages line is displayed. 'e' must be
3858 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3859 used.
3860
Bram Moolenaar57657d82006-04-21 22:12:41 +00003861 *'guitabtooltip'* *'gtt'*
3862'guitabtooltip' 'gtt' string (default empty)
3863 global
3864 {not in Vi}
3865 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003866 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003867 When nonempty describes the text to use in a tooltip for the GUI tab
3868 pages line. When empty Vim will use a default tooltip.
3869 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003870 You can include a line break. Simplest method is to use |:let|: >
3871 :let &guitabtooltip = "line one\nline two"
3872<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003873
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 *'helpfile'* *'hf'*
3875'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3876 (others) "$VIMRUNTIME/doc/help.txt")
3877 global
3878 {not in Vi}
3879 Name of the main help file. All distributed help files should be
3880 placed together in one directory. Additionally, all "doc" directories
3881 in 'runtimepath' will be used.
3882 Environment variables are expanded |:set_env|. For example:
3883 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003884 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 spaces and backslashes.
3886 This option cannot be set from a |modeline| or in the |sandbox|, for
3887 security reasons.
3888
3889 *'helpheight'* *'hh'*
3890'helpheight' 'hh' number (default 20)
3891 global
3892 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003893 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 feature}
3895 Minimal initial height of the help window when it is opened with the
3896 ":help" command. The initial height of the help window is half of the
3897 current window, or (when the 'ea' option is on) the same as other
3898 windows. When the height is less than 'helpheight', the height is
3899 set to 'helpheight'. Set to zero to disable.
3900
3901 *'helplang'* *'hlg'*
3902'helplang' 'hlg' string (default: messages language or empty)
3903 global
3904 {only available when compiled with the |+multi_lang|
3905 feature}
3906 {not in Vi}
3907 Comma separated list of languages. Vim will use the first language
3908 for which the desired help can be found. The English help will always
3909 be used as a last resort. You can add "en" to prefer English over
3910 another language, but that will only find tags that exist in that
3911 language and not in the English help.
3912 Example: >
3913 :set helplang=de,it
3914< This will first search German, then Italian and finally English help
3915 files.
3916 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3917 try to find the tag in the current language before using this option.
3918 See |help-translated|.
3919
3920 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3921'hidden' 'hid' boolean (default off)
3922 global
3923 {not in Vi}
3924 When off a buffer is unloaded when it is |abandon|ed. When on a
3925 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3926 displayed in another window, it does not become hidden, of course.
3927 The commands that move through the buffer list sometimes make a buffer
3928 hidden although the 'hidden' option is off: When the buffer is
3929 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003930 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003931 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 This option is set for one command with ":hide {command}" |:hide|.
3933 WARNING: It's easy to forget that you have changes in hidden buffers.
3934 Think twice when using ":q!" or ":qa!".
3935
3936 *'highlight'* *'hl'*
3937'highlight' 'hl' string (default (as a single string):
3938 "8:SpecialKey,@:NonText,d:Directory,
3939 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003940 M:ModeMsg,n:LineNr,N:CursorLineNr,
3941 r:Question,s:StatusLine,S:StatusLineNC,
3942 c:VertSplit, t:Title,v:Visual,
3943 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 f:Folded,F:FoldColumn,A:DiffAdd,
3945 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003946 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003947 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003948 +:Pmenu,=:PmenuSel,
3949 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 global
3951 {not in Vi}
3952 This option can be used to set highlighting mode for various
3953 occasions. It is a comma separated list of character pairs. The
3954 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003955 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3957 |hl-NonText| @ '~' and '@' at the end of the window and
3958 characters from 'showbreak'
3959 |hl-Directory| d directories in CTRL-D listing and other special
3960 things in listings
3961 |hl-ErrorMsg| e error messages
3962 h (obsolete, ignored)
3963 |hl-IncSearch| i 'incsearch' highlighting
3964 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3965 |hl-MoreMsg| m |more-prompt|
3966 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003967 |hl-LineNr| n line number for ":number" and ":#" commands, and
3968 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003969 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3970 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 |hl-Question| r |hit-enter| prompt and yes/no questions
3972 |hl-StatusLine| s status line of current window |status-line|
3973 |hl-StatusLineNC| S status lines of not-current windows
3974 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3975 |hl-VertSplit| c column used to separate vertically split windows
3976 |hl-Visual| v Visual mode
3977 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3978 Selection" Only X11 Gui's |gui-x11| and
3979 |xterm-clipboard|.
3980 |hl-WarningMsg| w warning messages
3981 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3982 |hl-Folded| f line used for closed folds
3983 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003984 |hl-DiffAdd| A added line in diff mode
3985 |hl-DiffChange| C changed line in diff mode
3986 |hl-DiffDelete| D deleted line in diff mode
3987 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003989 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003990 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003991 |hl-SpellRare| R rare word |spell|
3992 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003993 |hl-Conceal| - the placeholders used for concealed characters
3994 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003995 |hl-Pmenu| + popup menu normal line
3996 |hl-PmenuSel| = popup menu normal line
3997 |hl-PmenuSbar| x popup menu scrollbar
3998 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999
4000 The display modes are:
4001 r reverse (termcap entry "mr" and "me")
4002 i italic (termcap entry "ZH" and "ZR")
4003 b bold (termcap entry "md" and "me")
4004 s standout (termcap entry "so" and "se")
4005 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004006 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 n no highlighting
4008 - no highlighting
4009 : use a highlight group
4010 The default is used for occasions that are not included.
4011 If you want to change what the display modes do, see |dos-colors|
4012 for an example.
4013 When using the ':' display mode, this must be followed by the name of
4014 a highlight group. A highlight group can be used to define any type
4015 of highlighting, including using color. See |:highlight| on how to
4016 define one. The default uses a different group for each occasion.
4017 See |highlight-default| for the default highlight groups.
4018
4019 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4020'hlsearch' 'hls' boolean (default off)
4021 global
4022 {not in Vi}
4023 {not available when compiled without the
4024 |+extra_search| feature}
4025 When there is a previous search pattern, highlight all its matches.
4026 The type of highlighting used can be set with the 'l' occasion in the
4027 'highlight' option. This uses the "Search" highlight group by
4028 default. Note that only the matching text is highlighted, any offsets
4029 are not applied.
4030 See also: 'incsearch' and |:match|.
4031 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004032 off with |:nohlsearch|. This does not change the option value, as
4033 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004034 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 When the search pattern can match an end-of-line, Vim will try to
4036 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004037 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004039 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004040 You can specify whether the highlight status is restored on startup
4041 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 NOTE: This option is reset when 'compatible' is set.
4043
4044 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004045'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 global
4047 {not in Vi}
4048 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004049 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004051 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 NOTE: This option is set to the Vi default value when 'compatible' is
4053 set and to the Vim default value when 'compatible' is reset.
4054
4055 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4056'hkmap' 'hk' boolean (default off)
4057 global
4058 {not in Vi}
4059 {only available when compiled with the |+rightleft|
4060 feature}
4061 When on, the keyboard is mapped for the Hebrew character set.
4062 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4063 toggle this option. See |rileft.txt|.
4064 NOTE: This option is reset when 'compatible' is set.
4065
4066 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4067'hkmapp' 'hkp' boolean (default off)
4068 global
4069 {not in Vi}
4070 {only available when compiled with the |+rightleft|
4071 feature}
4072 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4073 This is useful if you have a non-Hebrew keyboard.
4074 See |rileft.txt|.
4075 NOTE: This option is reset when 'compatible' is set.
4076
4077 *'icon'* *'noicon'*
4078'icon' boolean (default off, on when title can be restored)
4079 global
4080 {not in Vi}
4081 {not available when compiled without the |+title|
4082 feature}
4083 When on, the icon text of the window will be set to the value of
4084 'iconstring' (if it is not empty), or to the name of the file
4085 currently being edited. Only the last part of the name is used.
4086 Overridden by the 'iconstring' option.
4087 Only works if the terminal supports setting window icons (currently
4088 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4089 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4090 builtin termcap).
4091 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004092 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004094 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095
4096 *'iconstring'*
4097'iconstring' string (default "")
4098 global
4099 {not in Vi}
4100 {not available when compiled without the |+title|
4101 feature}
4102 When this option is not empty, it will be used for the icon text of
4103 the window. This happens only when the 'icon' option is on.
4104 Only works if the terminal supports setting window icon text
4105 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4106 Does not work for MS Windows.
4107 When Vim was compiled with HAVE_X11 defined, the original icon will be
4108 restored if possible |X11|.
4109 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004110 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 'titlestring' for example settings.
4112 {not available when compiled without the |+statusline| feature}
4113
4114 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4115'ignorecase' 'ic' boolean (default off)
4116 global
4117 Ignore case in search patterns. Also used when searching in the tags
4118 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004119 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 Can be overruled by using "\c" or "\C" in the pattern, see
4121 |/ignorecase|.
4122
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004123 *'imactivatefunc'* *'imaf'*
4124'imactivatefunc' 'imaf' string (default "")
4125 global
4126 {not in Vi}
4127 {only available when compiled with |+xim| and
4128 |+GUI_GTK|}
4129 This option specifies a function that will be called to
4130 activate/inactivate Input Method.
4131
4132 Example: >
4133 function ImActivateFunc(active)
4134 if a:active
4135 ... do something
4136 else
4137 ... do something
4138 endif
4139 " return value is not used
4140 endfunction
4141 set imactivatefunc=ImActivateFunc
4142<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'imactivatekey'* *'imak'*
4144'imactivatekey' 'imak' string (default "")
4145 global
4146 {not in Vi}
4147 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004148 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 Specifies the key that your Input Method in X-Windows uses for
4150 activation. When this is specified correctly, vim can fully control
4151 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4152 You can't use this option to change the activation key, the option
4153 tells Vim what the key is.
4154 Format:
4155 [MODIFIER_FLAG-]KEY_STRING
4156
4157 These characters can be used for MODIFIER_FLAG (case is ignored):
4158 S Shift key
4159 L Lock key
4160 C Control key
4161 1 Mod1 key
4162 2 Mod2 key
4163 3 Mod3 key
4164 4 Mod4 key
4165 5 Mod5 key
4166 Combinations are allowed, for example "S-C-space" or "SC-space" are
4167 both shift+ctrl+space.
4168 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4169
4170 Example: >
4171 :set imactivatekey=S-space
4172< "S-space" means shift+space. This is the activation key for kinput2 +
4173 canna (Japanese), and ami (Korean).
4174
4175 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4176'imcmdline' 'imc' boolean (default off)
4177 global
4178 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004179 {only available when compiled with the |+xim|,
4180 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 When set the Input Method is always on when starting to edit a command
4182 line, unless entering a search pattern (see 'imsearch' for that).
4183 Setting this option is useful when your input method allows entering
4184 English characters directly, e.g., when it's used to type accented
4185 characters with dead keys.
4186
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004187 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4189 global
4190 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004191 {only available when compiled with the |+xim|,
4192 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 When set the Input Method is never used. This is useful to disable
4194 the IM when it doesn't work properly.
4195 Currently this option is on by default for SGI/IRIX machines. This
4196 may change in later releases.
4197
4198 *'iminsert'* *'imi'*
4199'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4200 local to buffer
4201 {not in Vi}
4202 Specifies whether :lmap or an Input Method (IM) is to be used in
4203 Insert mode. Valid values:
4204 0 :lmap is off and IM is off
4205 1 :lmap is ON and IM is off
4206 2 :lmap is off and IM is ON
4207 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4208 or |global-ime|.
4209 To always reset the option to zero when leaving Insert mode with <Esc>
4210 this can be used: >
4211 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4212< This makes :lmap and IM turn off automatically when leaving Insert
4213 mode.
4214 Note that this option changes when using CTRL-^ in Insert mode
4215 |i_CTRL-^|.
4216 The value is set to 1 when setting 'keymap' to a valid keymap name.
4217 It is also used for the argument of commands like "r" and "f".
4218 The value 0 may not work correctly with Athena and Motif with some XIM
4219 methods. Use 'imdisable' to disable XIM then.
4220
4221 *'imsearch'* *'ims'*
4222'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4223 local to buffer
4224 {not in Vi}
4225 Specifies whether :lmap or an Input Method (IM) is to be used when
4226 entering a search pattern. Valid values:
4227 -1 the value of 'iminsert' is used, makes it look like
4228 'iminsert' is also used when typing a search pattern
4229 0 :lmap is off and IM is off
4230 1 :lmap is ON and IM is off
4231 2 :lmap is off and IM is ON
4232 Note that this option changes when using CTRL-^ in Command-line mode
4233 |c_CTRL-^|.
4234 The value is set to 1 when it is not -1 and setting the 'keymap'
4235 option to a valid keymap name.
4236 The value 0 may not work correctly with Athena and Motif with some XIM
4237 methods. Use 'imdisable' to disable XIM then.
4238
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004239 *'imstatusfunc'* *'imsf'*
4240'imstatusfunc' 'imsf' string (default "")
4241 global
4242 {not in Vi}
4243 {only available when compiled with |+xim| and
4244 |+GUI_GTK|}
4245 This option specifies a function that is called to obtain the status
4246 of Input Method. It must return a positive number when IME is active.
4247
4248 Example: >
4249 function ImStatusFunc()
4250 let is_active = ...do something
4251 return is_active ? 1 : 0
4252 endfunction
4253 set imstatusfunc=ImStatusFunc
4254<
4255 NOTE: This function is invoked very often. Keep it fast.
4256
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 *'include'* *'inc'*
4258'include' 'inc' string (default "^\s*#\s*include")
4259 global or local to buffer |global-local|
4260 {not in Vi}
4261 {not available when compiled without the
4262 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004263 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 pattern, just like for the "/" command (See |pattern|). The default
4265 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004266 "]I", "[d", etc.
4267 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004268 comes after the matched pattern. But if "\zs" appears in the pattern
4269 then the text matched from "\zs" to the end, or until "\ze" if it
4270 appears, is used as the file name. Use this to include characters
4271 that are not in 'isfname', such as a space. You can then use
4272 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004273 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274
4275 *'includeexpr'* *'inex'*
4276'includeexpr' 'inex' string (default "")
4277 local to buffer
4278 {not in Vi}
4279 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004280 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004282 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 :set includeexpr=substitute(v:fname,'\\.','/','g')
4284< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004285
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004287 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 Also used for |<cfile>|.
4289
Bram Moolenaar30b65812012-07-12 22:01:11 +02004290 The expression will be evaluated in the |sandbox| when set from a
4291 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004292
4293 It is not allowed to change text or jump to another window while
4294 evaluating 'includeexpr' |textlock|.
4295
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4297'incsearch' 'is' boolean (default off)
4298 global
4299 {not in Vi}
4300 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004301 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004302 While typing a search command, show where the pattern, as it was typed
4303 so far, matches. The matched string is highlighted. If the pattern
4304 is invalid or not found, nothing is shown. The screen will be updated
4305 often, this is only useful on fast terminals.
4306 Note that the match will be shown, but the cursor will return to its
4307 original position when no match is found and when pressing <Esc>. You
4308 still need to finish the search command with <Enter> to move the
4309 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004310 When compiled with the |+reltime| feature Vim only searches for about
4311 half a second. With a complicated pattern and/or a lot of text the
4312 match may not be found. This is to avoid that Vim hangs while you
4313 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004314 The highlighting can be set with the 'i' flag in 'highlight'.
4315 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004316 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004317 to the command line. If 'ignorecase' and 'smartcase' are set and the
4318 command line has no uppercase characters, the added character is
4319 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004320 CTRL-R CTRL-W can be used to add the word at the end of the current
4321 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 NOTE: This option is reset when 'compatible' is set.
4323
4324 *'indentexpr'* *'inde'*
4325'indentexpr' 'inde' string (default "")
4326 local to buffer
4327 {not in Vi}
4328 {not available when compiled without the |+cindent|
4329 or |+eval| features}
4330 Expression which is evaluated to obtain the proper indent for a line.
4331 It is used when a new line is created, for the |=| operator and
4332 in Insert mode as specified with the 'indentkeys' option.
4333 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004334 'smartindent' indenting. When 'lisp' is set, this option is
4335 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 When 'paste' is set this option is not used for indenting.
4337 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004338 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339 when the expression is evaluated (but it may be moved around).
4340 The expression must return the number of spaces worth of indent. It
4341 can return "-1" to keep the current indent (this means 'autoindent' is
4342 used for the indent).
4343 Functions useful for computing the indent are |indent()|, |cindent()|
4344 and |lispindent()|.
4345 The evaluation of the expression must not have side effects! It must
4346 not change the text, jump to another window, etc. Afterwards the
4347 cursor position is always restored, thus the cursor may be moved.
4348 Normally this option would be set to call a function: >
4349 :set indentexpr=GetMyIndent()
4350< Error messages will be suppressed, unless the 'debug' option contains
4351 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004352 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 NOTE: This option is made empty when 'compatible' is set.
4354
Bram Moolenaar30b65812012-07-12 22:01:11 +02004355 The expression will be evaluated in the |sandbox| when set from a
4356 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004357
4358 It is not allowed to change text or jump to another window while
4359 evaluating 'indentexpr' |textlock|.
4360
4361
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 *'indentkeys'* *'indk'*
4363'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4364 local to buffer
4365 {not in Vi}
4366 {not available when compiled without the |+cindent|
4367 feature}
4368 A list of keys that, when typed in Insert mode, cause reindenting of
4369 the current line. Only happens if 'indentexpr' isn't empty.
4370 The format is identical to 'cinkeys', see |indentkeys-format|.
4371 See |C-indenting| and |indent-expression|.
4372
4373 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4374'infercase' 'inf' boolean (default off)
4375 local to buffer
4376 {not in Vi}
4377 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004378 'ignorecase' is also on, the case of the match is adjusted depending
4379 on the typed text. If the typed text contains a lowercase letter
4380 where the match has an upper case letter, the completed part is made
4381 lowercase. If the typed text has no lowercase letters and the match
4382 has a lowercase letter where the typed text has an uppercase letter,
4383 and there is a letter before it, the completed part is made uppercase.
4384 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
4386 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4387'insertmode' 'im' boolean (default off)
4388 global
4389 {not in Vi}
4390 Makes Vim work in a way that Insert mode is the default mode. Useful
4391 if you want to use Vim as a modeless editor. Used for |evim|.
4392 These Insert mode commands will be useful:
4393 - Use the cursor keys to move around.
4394 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4395 this is a mapping, it is executed as if 'insertmode' was off.
4396 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004398 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4399 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
4401 These items change when 'insertmode' is set:
4402 - when starting to edit of a file, Vim goes to Insert mode.
4403 - <Esc> in Insert mode is a no-op and beeps.
4404 - <Esc> in Normal mode makes Vim go to Insert mode.
4405 - CTRL-L in Insert mode is a command, it is not inserted.
4406 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4407 However, when <Esc> is used inside a mapping, it behaves like
4408 'insertmode' was not set. This was done to be able to use the same
4409 mappings with 'insertmode' set or not set.
4410 When executing commands with |:normal| 'insertmode' is not used.
4411
4412 NOTE: This option is reset when 'compatible' is set.
4413
4414 *'isfname'* *'isf'*
4415'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4416 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4417 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4418 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4419 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4420 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4421 global
4422 {not in Vi}
4423 The characters specified by this option are included in file names and
4424 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004425 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 Multi-byte characters 256 and above are always included, only the
4427 characters up to 255 are specified with this option.
4428 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004429 Think twice before adding white space to this option. Although a
4430 space may appear inside a file name, the effect will be that Vim
4431 doesn't know where a file name starts or ends when doing completion.
4432 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433
4434 Note that on systems using a backslash as path separator, Vim tries to
4435 do its best to make it work as you would expect. That is a bit
4436 tricky, since Vi originally used the backslash to escape special
4437 characters. Vim will not remove a backslash in front of a normal file
4438 name character on these systems, but it will on Unix and alikes. The
4439 '&' and '^' are not included by default, because these are special for
4440 cmd.exe.
4441
4442 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004443 Each part can be a single character number or a range. A range is two
4444 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445 decimal number between 0 and 255 or the ASCII character itself (does
4446 not work for digits). Example:
4447 "_,-,128-140,#-43" (include '_' and '-' and the range
4448 128 to 140 and '#' to 43)
4449 If a part starts with '^', the following character number or range
4450 will be excluded from the option. The option is interpreted from left
4451 to right. Put the excluded character after the range where it is
4452 included. To include '^' itself use it as the last character of the
4453 option or the end of a range. Example:
4454 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4455 If the character is '@', all characters where isalpha() returns TRUE
4456 are included. Normally these are the characters a to z and A to Z,
4457 plus accented characters. To include '@' itself use "@-@". Examples:
4458 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004459 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 "a-z,A-Z,@-@" All letters plus the '@' character.
4461 A comma can be included by using it where a character number is
4462 expected. Example:
4463 "48-57,,,_" Digits, comma and underscore.
4464 A comma can be excluded by prepending a '^'. Example:
4465 " -~,^,,9" All characters from space to '~', excluding
4466 comma, plus <Tab>.
4467 See |option-backslash| about including spaces and backslashes.
4468
4469 *'isident'* *'isi'*
4470'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4471 "@,48-57,_,128-167,224-235"
4472 otherwise: "@,48-57,_,192-255")
4473 global
4474 {not in Vi}
4475 The characters given by this option are included in identifiers.
4476 Identifiers are used in recognizing environment variables and after a
4477 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004478 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 option.
4480 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004481 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4483
4484 *'iskeyword'* *'isk'*
4485'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4486 "@,48-57,_,128-167,224-235"
4487 otherwise: "@,48-57,_,192-255"
4488 Vi default: "@,48-57,_")
4489 local to buffer
4490 {not in Vi}
4491 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004492 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 'isfname' for a description of the format of this option. For C
4494 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4495 For a help file it is set to all non-blank printable characters except
4496 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4497 command).
4498 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004499 This option also influences syntax highlighting, unless the syntax
4500 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 NOTE: This option is set to the Vi default value when 'compatible' is
4502 set and to the Vim default value when 'compatible' is reset.
4503
4504 *'isprint'* *'isp'*
4505'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4506 "@,~-255"; otherwise: "@,161-255")
4507 global
4508 {not in Vi}
4509 The characters given by this option are displayed directly on the
4510 screen. It is also used for "\p" in a |pattern|. The characters from
4511 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4512 even when they are not included in 'isprint' or excluded. See
4513 'isfname' for a description of the format of this option.
4514
4515 Non-printable characters are displayed with two characters:
4516 0 - 31 "^@" - "^_"
4517 32 - 126 always single characters
4518 127 "^?"
4519 128 - 159 "~@" - "~_"
4520 160 - 254 "| " - "|~"
4521 255 "~?"
4522 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4523 displayed as <xx>, with the hexadecimal value of the byte.
4524 When 'display' contains "uhex" all unprintable characters are
4525 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004526 The SpecialKey highlighting will be used for unprintable characters.
4527 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528
4529 Multi-byte characters 256 and above are always included, only the
4530 characters up to 255 are specified with this option. When a character
4531 is printable but it is not available in the current font, a
4532 replacement character will be shown.
4533 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4534 There is no option to specify these characters.
4535
4536 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4537'joinspaces' 'js' boolean (default on)
4538 global
4539 {not in Vi}
4540 Insert two spaces after a '.', '?' and '!' with a join command.
4541 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4542 Otherwise only one space is inserted.
4543 NOTE: This option is set when 'compatible' is set.
4544
4545 *'key'*
4546'key' string (default "")
4547 local to buffer
4548 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004549 {only available when compiled with the |+cryptv|
4550 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004552 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 Careful: Do not set the key value by hand, someone might see the typed
4554 key. Use the |:X| command. But you can make 'key' empty: >
4555 :set key=
4556< It is not possible to get the value of this option with ":set key" or
4557 "echo &key". This is to avoid showing it to someone who shouldn't
4558 know. It also means you cannot see it yourself once you have set it,
4559 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004560 You can use "&key" in an expression to detect whether encryption is
4561 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
4563 *'keymap'* *'kmp'* *E544*
4564'keymap' 'kmp' string (default "")
4565 local to buffer
4566 {not in Vi}
4567 {only available when compiled with the |+keymap|
4568 feature}
4569 Name of a keyboard mapping. See |mbyte-keymap|.
4570 Setting this option to a valid keymap name has the side effect of
4571 setting 'iminsert' to one, so that the keymap becomes effective.
4572 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004573 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574
4575 *'keymodel'* *'km'*
4576'keymodel' 'km' string (default "")
4577 global
4578 {not in Vi}
4579 List of comma separated words, which enable special things that keys
4580 can do. These values can be used:
4581 startsel Using a shifted special key starts selection (either
4582 Select mode or Visual mode, depending on "key" being
4583 present in 'selectmode').
4584 stopsel Using a not-shifted special key stops selection.
4585 Special keys in this context are the cursor keys, <End>, <Home>,
4586 <PageUp> and <PageDown>.
4587 The 'keymodel' option is set by the |:behave| command.
4588
4589 *'keywordprg'* *'kp'*
4590'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004591 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 global or local to buffer |global-local|
4593 {not in Vi}
4594 Program to use for the |K| command. Environment variables are
4595 expanded |:set_env|. ":help" may be used to access the Vim internal
4596 help. (Note that previously setting the global option to the empty
4597 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004598 When the first character is ":", the command is invoked as a Vim
4599 Ex command prefixed with [count].
4600 When "man", "man -s" or an Ex command is used, Vim will automatically
4601 translate a count for the "K" command and pass it as the first
4602 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 See |option-backslash| about including spaces and backslashes.
4604 Example: >
4605 :set keywordprg=man\ -s
4606< This option cannot be set from a |modeline| or in the |sandbox|, for
4607 security reasons.
4608
4609 *'langmap'* *'lmap'* *E357* *E358*
4610'langmap' 'lmap' string (default "")
4611 global
4612 {not in Vi}
4613 {only available when compiled with the |+langmap|
4614 feature}
4615 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004616 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004617 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 care of translating these special characters to the original meaning
4619 of the key. This means you don't have to change the keyboard mode to
4620 be able to execute Normal mode commands.
4621 This is the opposite of the 'keymap' option, where characters are
4622 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004623 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4624 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004625 This option cannot be set from a |modeline| or in the |sandbox|, for
4626 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004628 Example (for Greek, in UTF-8): *greek* >
4629 :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 +00004630< Example (exchanges meaning of z and y for commands): >
4631 :set langmap=zy,yz,ZY,YZ
4632<
4633 The 'langmap' option is a list of parts, separated with commas. Each
4634 part can be in one of two forms:
4635 1. A list of pairs. Each pair is a "from" character immediately
4636 followed by the "to" character. Examples: "aA", "aAbBcC".
4637 2. A list of "from" characters, a semi-colon and a list of "to"
4638 characters. Example: "abc;ABC"
4639 Example: "aA,fgh;FGH,cCdDeE"
4640 Special characters need to be preceded with a backslash. These are
4641 ";", ',' and backslash itself.
4642
4643 This will allow you to activate vim actions without having to switch
4644 back and forth between the languages. Your language characters will
4645 be understood as normal vim English characters (according to the
4646 langmap mappings) in the following cases:
4647 o Normal/Visual mode (commands, buffer/register names, user mappings)
4648 o Insert/Replace Mode: Register names after CTRL-R
4649 o Insert/Replace Mode: Mappings
4650 Characters entered in Command-line mode will NOT be affected by
4651 this option. Note that this option can be changed at any time
4652 allowing to switch between mappings for different languages/encodings.
4653 Use a mapping to avoid having to type it each time!
4654
4655 *'langmenu'* *'lm'*
4656'langmenu' 'lm' string (default "")
4657 global
4658 {not in Vi}
4659 {only available when compiled with the |+menu| and
4660 |+multi_lang| features}
4661 Language to use for menu translation. Tells which file is loaded
4662 from the "lang" directory in 'runtimepath': >
4663 "lang/menu_" . &langmenu . ".vim"
4664< (without the spaces). For example, to always use the Dutch menus, no
4665 matter what $LANG is set to: >
4666 :set langmenu=nl_NL.ISO_8859-1
4667< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004668 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 If your $LANG is set to a non-English language but you do want to use
4670 the English menus: >
4671 :set langmenu=none
4672< This option must be set before loading menus, switching on filetype
4673 detection or syntax highlighting. Once the menus are defined setting
4674 this option has no effect. But you could do this: >
4675 :source $VIMRUNTIME/delmenu.vim
4676 :set langmenu=de_DE.ISO_8859-1
4677 :source $VIMRUNTIME/menu.vim
4678< Warning: This deletes all menus that you defined yourself!
4679
Bram Moolenaard94464e2015-11-02 15:28:18 +01004680 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004681'langnoremap' 'lnr' boolean (default off)
4682 global
4683 {not in Vi}
4684 {only available when compiled with the |+langmap|
4685 feature}
4686 When on, setting 'langmap' does not apply to characters resulting from
4687 a mapping. This basically means, if you noticed that setting
4688 'langmap' disables some of your mappings, try setting this option.
4689 This option defaults to off for backwards compatibility. Set it on if
4690 that works for you to avoid mappings to break.
4691
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 *'laststatus'* *'ls'*
4693'laststatus' 'ls' number (default 1)
4694 global
4695 {not in Vi}
4696 The value of this option influences when the last window will have a
4697 status line:
4698 0: never
4699 1: only if there are at least two windows
4700 2: always
4701 The screen looks nicer with a status line if you have several
4702 windows, but it takes another screen line. |status-line|
4703
4704 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4705'lazyredraw' 'lz' boolean (default off)
4706 global
4707 {not in Vi}
4708 When this option is set, the screen will not be redrawn while
4709 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004710 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 update use |:redraw|.
4712
4713 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4714'linebreak' 'lbr' boolean (default off)
4715 local to window
4716 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004717 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004719 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 than at the last character that fits on the screen. Unlike
4721 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004722 it only affects the way the file is displayed, not its contents.
4723 If 'breakindent' is set, line is visually indented. Then, the value
4724 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004725 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 Note that <Tab> characters after an <EOL> are mostly not displayed
4727 with the right amount of white space.
4728
4729 *'lines'* *E593*
4730'lines' number (default 24 or terminal height)
4731 global
4732 Number of lines of the Vim window.
4733 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004734 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 When Vim is running in the GUI or in a resizable window, setting this
4736 option will cause the window size to be changed. When you only want
4737 to use the size for the GUI, put the command in your |gvimrc| file.
4738 Vim limits the number of lines to what fits on the screen. You can
4739 use this command to get the tallest window possible: >
4740 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004741< Minimum value is 2, maximum value is 1000.
4742 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 When you set this option and Vim is unable to change the physical
4744 number of lines of the display, the display may be messed up.
4745
4746 *'linespace'* *'lsp'*
4747'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4748 global
4749 {not in Vi}
4750 {only in the GUI}
4751 Number of pixel lines inserted between characters. Useful if the font
4752 uses the full character cell height, making lines touch each other.
4753 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004754 With some fonts there can be too much room between lines (to have
4755 space for ascents and descents). Then it makes sense to set
4756 'linespace' to a negative value. This may cause display problems
4757 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758
4759 *'lisp'* *'nolisp'*
4760'lisp' boolean (default off)
4761 local to buffer
4762 {not available when compiled without the |+lispindent|
4763 feature}
4764 Lisp mode: When <Enter> is typed in insert mode set the indent for
4765 the next line to Lisp standards (well, sort of). Also happens with
4766 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4767 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4768 better. Also see 'lispwords'.
4769 The '-' character is included in keyword characters. Redefines the
4770 "=" operator to use this same indentation algorithm rather than
4771 calling an external program if 'equalprg' is empty.
4772 This option is not used when 'paste' is set.
4773 {Vi: Does it a little bit differently}
4774
4775 *'lispwords'* *'lw'*
4776'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004777 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 {not in Vi}
4779 {not available when compiled without the |+lispindent|
4780 feature}
4781 Comma separated list of words that influence the Lisp indenting.
4782 |'lisp'|
4783
4784 *'list'* *'nolist'*
4785'list' boolean (default off)
4786 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004787 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4788 line. Useful to see the difference between tabs and spaces and for
4789 trailing blanks. Further changed by the 'listchars' option.
4790
4791 The cursor is displayed at the start of the space a Tab character
4792 occupies, not at the end as usual in Normal mode. To get this cursor
4793 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004794 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004795<
4796 Note that list mode will also affect formatting (set with 'textwidth'
4797 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 changing the way tabs are displayed.
4799
4800 *'listchars'* *'lcs'*
4801'listchars' 'lcs' string (default "eol:$")
4802 global
4803 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004804 Strings to use in 'list' mode and for the |:list| command. It is a
4805 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004806 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807 eol:c Character to show at the end of each line. When
4808 omitted, there is no extra character at the end of the
4809 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004810 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004811 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004813 fill the space that the tab normally occupies.
4814 "tab:>-" will show a tab that takes four spaces as
4815 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004816 *lcs-space*
4817 space:c Character to show for a space. When omitted, spaces
4818 are left blank.
4819 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004820 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004821 trailing spaces are blank. Overrides the "space"
4822 setting for trailing spaces.
4823 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 extends:c Character to show in the last column, when 'wrap' is
4825 off and the line continues beyond the right of the
4826 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004827 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 precedes:c Character to show in the first column, when 'wrap'
4829 is off and there is text preceding the character
4830 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004831 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004832 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004833 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004834 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004835 nbsp:c Character to show for a non-breakable space character
4836 (0xA0 (160 decimal) and U+202F). Left blank when
4837 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004839 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004841 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842
4843 Examples: >
4844 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004845 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 :set lcs=extends:>,precedes:<
4847< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004848 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004849 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850
4851 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4852'loadplugins' 'lpl' boolean (default on)
4853 global
4854 {not in Vi}
4855 When on the plugin scripts are loaded when starting up |load-plugins|.
4856 This option can be reset in your |vimrc| file to disable the loading
4857 of plugins.
4858 Note that using the "-u NONE" and "--noplugin" command line arguments
4859 reset this option. |-u| |--noplugin|
4860
Bram Moolenaard94464e2015-11-02 15:28:18 +01004861 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004862'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004863 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004864 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004865 {only available when compiled with the |+lua/dyn|
4866 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004867 Specifies the name of the Lua shared library. The default is
4868 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004869 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004870 This option cannot be set from a |modeline| or in the |sandbox|, for
4871 security reasons.
4872
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004873 *'macatsui'* *'nomacatsui'*
4874'macatsui' boolean (default on)
4875 global
4876 {only available in Mac GUI version}
4877 This is a workaround for when drawing doesn't work properly. When set
4878 and compiled with multi-byte support ATSUI text drawing is used. When
4879 not set ATSUI text drawing is not used. Switch this option off when
4880 you experience drawing problems. In a future version the problems may
4881 be solved and this option becomes obsolete. Therefore use this method
4882 to unset it: >
4883 if exists('&macatsui')
4884 set nomacatsui
4885 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004886< Another option to check if you have drawing problems is
4887 'termencoding'.
4888
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 *'magic'* *'nomagic'*
4890'magic' boolean (default on)
4891 global
4892 Changes the special characters that can be used in search patterns.
4893 See |pattern|.
4894 NOTE: To avoid portability problems with using patterns, always keep
4895 this option at the default "on". Only switch it off when working with
4896 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004897 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898
4899 *'makeef'* *'mef'*
4900'makeef' 'mef' string (default: "")
4901 global
4902 {not in Vi}
4903 {not available when compiled without the |+quickfix|
4904 feature}
4905 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4906 and the |:grep| command.
4907 When it is empty, an internally generated temp file will be used.
4908 When "##" is included, it is replaced by a number to make the name
4909 unique. This makes sure that the ":make" command doesn't overwrite an
4910 existing file.
4911 NOT used for the ":cf" command. See 'errorfile' for that.
4912 Environment variables are expanded |:set_env|.
4913 See |option-backslash| about including spaces and backslashes.
4914 This option cannot be set from a |modeline| or in the |sandbox|, for
4915 security reasons.
4916
4917 *'makeprg'* *'mp'*
4918'makeprg' 'mp' string (default "make", VMS: "MMS")
4919 global or local to buffer |global-local|
4920 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004921 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004922 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4923 which are expanded to the current and alternate file name. Use |::S|
4924 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004925 Environment variables are expanded |:set_env|. See |option-backslash|
4926 about including spaces and backslashes.
4927 Note that a '|' must be escaped twice: once for ":set" and once for
4928 the interpretation of a command. When you use a filter called
4929 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 :set makeprg=gmake\ \\\|\ myfilter
4931< The placeholder "$*" can be given (even multiple times) to specify
4932 where the arguments will be included, for example: >
4933 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4934< This option cannot be set from a |modeline| or in the |sandbox|, for
4935 security reasons.
4936
4937 *'matchpairs'* *'mps'*
4938'matchpairs' 'mps' string (default "(:),{:},[:]")
4939 local to buffer
4940 {not in Vi}
4941 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004942 other.
4943 Only character pairs are allowed that are different, thus you cannot
4944 jump between two double quotes.
4945 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004946 The pairs must be separated by a comma. Example for including '<' and
4947 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 :set mps+=<:>
4949
4950< A more exotic example, to jump between the '=' and ';' in an
4951 assignment, useful for languages like C and Java: >
4952 :au FileType c,cpp,java set mps+==:;
4953
4954< For a more advanced way of using "%", see the matchit.vim plugin in
4955 the $VIMRUNTIME/macros directory. |add-local-help|
4956
4957 *'matchtime'* *'mat'*
4958'matchtime' 'mat' number (default 5)
4959 global
4960 {not in Vi}{in Nvi}
4961 Tenths of a second to show the matching paren, when 'showmatch' is
4962 set. Note that this is not in milliseconds, like other options that
4963 set a time. This is to be compatible with Nvi.
4964
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004965 *'maxcombine'* *'mco'*
4966'maxcombine' 'mco' number (default 2)
4967 global
4968 {not in Vi}
4969 {only available when compiled with the |+multi_byte|
4970 feature}
4971 The maximum number of combining characters supported for displaying.
4972 Only used when 'encoding' is "utf-8".
4973 The default is OK for most languages. Hebrew may require 4.
4974 Maximum value is 6.
4975 Even when this option is set to 2 you can still edit text with more
4976 combining characters, you just can't see them. Use |g8| or |ga|.
4977 See |mbyte-combining|.
4978
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 *'maxfuncdepth'* *'mfd'*
4980'maxfuncdepth' 'mfd' number (default 100)
4981 global
4982 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004983 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004984 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985 Maximum depth of function calls for user functions. This normally
4986 catches endless recursion. When using a recursive function with
4987 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4988 more memory, there is the danger of failing when memory is exhausted.
4989 See also |:function|.
4990
4991 *'maxmapdepth'* *'mmd'* *E223*
4992'maxmapdepth' 'mmd' number (default 1000)
4993 global
4994 {not in Vi}
4995 Maximum number of times a mapping is done without resulting in a
4996 character to be used. This normally catches endless mappings, like
4997 ":map x y" with ":map y x". It still does not catch ":map g wg",
4998 because the 'w' is used before the next mapping is done. See also
4999 |key-mapping|.
5000
5001 *'maxmem'* *'mm'*
5002'maxmem' 'mm' number (default between 256 to 5120 (system
5003 dependent) or half the amount of memory
5004 available)
5005 global
5006 {not in Vi}
5007 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5008 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005009 other memory to be freed. The maximum usable value is about 2000000.
5010 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005012 *'maxmempattern'* *'mmp'*
5013'maxmempattern' 'mmp' number (default 1000)
5014 global
5015 {not in Vi}
5016 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005017 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005018 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005019 When Vim runs into the limit it gives an error message and mostly
5020 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005021 Running into the limit often means that the pattern is very
5022 inefficient or too complex. This may already happen with the pattern
5023 "\(.\)*" on a very long line. ".*" works much better.
5024 Vim may run out of memory before hitting the 'maxmempattern' limit.
5025
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 *'maxmemtot'* *'mmt'*
5027'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5028 dependent) or half the amount of memory
5029 available)
5030 global
5031 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005032 Maximum amount of memory in Kbyte to use for all buffers together.
5033 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005034 without a limit.
5035 On 64 bit machines higher values might work. But hey, do you really
5036 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005037 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005038 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005039 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040
5041 *'menuitems'* *'mis'*
5042'menuitems' 'mis' number (default 25)
5043 global
5044 {not in Vi}
5045 {not available when compiled without the |+menu|
5046 feature}
5047 Maximum number of items to use in a menu. Used for menus that are
5048 generated from a list of items, e.g., the Buffers menu. Changing this
5049 option has no direct effect, the menu must be refreshed first.
5050
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005051 *'mkspellmem'* *'msm'*
5052'mkspellmem' 'msm' string (default "460000,2000,500")
5053 global
5054 {not in Vi}
5055 {not available when compiled without the |+syntax|
5056 feature}
5057 Parameters for |:mkspell|. This tunes when to start compressing the
5058 word tree. Compression can be slow when there are many words, but
5059 it's needed to avoid running out of memory. The amount of memory used
5060 per word depends very much on how similar the words are, that's why
5061 this tuning is complicated.
5062
5063 There are three numbers, separated by commas:
5064 {start},{inc},{added}
5065
5066 For most languages the uncompressed word tree fits in memory. {start}
5067 gives the amount of memory in Kbyte that can be used before any
5068 compression is done. It should be a bit smaller than the amount of
5069 memory that is available to Vim.
5070
5071 When going over the {start} limit the {inc} number specifies the
5072 amount of memory in Kbyte that can be allocated before another
5073 compression is done. A low number means compression is done after
5074 less words are added, which is slow. A high number means more memory
5075 will be allocated.
5076
5077 After doing compression, {added} times 1024 words can be added before
5078 the {inc} limit is ignored and compression is done when any extra
5079 amount of memory is needed. A low number means there is a smaller
5080 chance of hitting the {inc} limit, less memory is used but it's
5081 slower.
5082
5083 The languages for which these numbers are important are Italian and
5084 Hungarian. The default works for when you have about 512 Mbyte. If
5085 you have 1 Gbyte you could use: >
5086 :set mkspellmem=900000,3000,800
5087< If you have less than 512 Mbyte |:mkspell| may fail for some
5088 languages, no matter what you set 'mkspellmem' to.
5089
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005091'modeline' 'ml' boolean (Vim default: on (off for root),
5092 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 local to buffer
5094 *'modelines'* *'mls'*
5095'modelines' 'mls' number (default 5)
5096 global
5097 {not in Vi}
5098 If 'modeline' is on 'modelines' gives the number of lines that is
5099 checked for set commands. If 'modeline' is off or 'modelines' is zero
5100 no lines are checked. See |modeline|.
5101 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5102 set and to the Vim default value when 'compatible' is reset.
5103
5104 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5105'modifiable' 'ma' boolean (default on)
5106 local to buffer
5107 {not in Vi} *E21*
5108 When off the buffer contents cannot be changed. The 'fileformat' and
5109 'fileencoding' options also can't be changed.
5110 Can be reset with the |-M| command line argument.
5111
5112 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5113'modified' 'mod' boolean (default off)
5114 local to buffer
5115 {not in Vi}
5116 When on, the buffer is considered to be modified. This option is set
5117 when:
5118 1. A change was made to the text since it was last written. Using the
5119 |undo| command to go back to the original text will reset the
5120 option. But undoing changes that were made before writing the
5121 buffer will set the option again, since the text is different from
5122 when it was written.
5123 2. 'fileformat' or 'fileencoding' is different from its original
5124 value. The original value is set when the buffer is read or
5125 written. A ":set nomodified" command also resets the original
5126 values to the current values and the 'modified' option will be
5127 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005128 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005129 This option is not set when a change is made to the buffer as the
5130 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5131 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5132 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5134 will be ignored.
5135
5136 *'more'* *'nomore'*
5137'more' boolean (Vim default: on, Vi default: off)
5138 global
5139 {not in Vi}
5140 When on, listings pause when the whole screen is filled. You will get
5141 the |more-prompt|. When this option is off there are no pauses, the
5142 listing continues until finished.
5143 NOTE: This option is set to the Vi default value when 'compatible' is
5144 set and to the Vim default value when 'compatible' is reset.
5145
5146 *'mouse'* *E538*
5147'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5148 global
5149 {not in Vi}
5150 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005151 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5152 sysmouse and Linux console with gpm). For using the mouse in the
5153 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 The mouse can be enabled for different modes:
5155 n Normal mode
5156 v Visual mode
5157 i Insert mode
5158 c Command-line mode
5159 h all previous modes when editing a help file
5160 a all previous modes
5161 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 Normally you would enable the mouse in all four modes with: >
5163 :set mouse=a
5164< When the mouse is not enabled, the GUI will still use the mouse for
5165 modeless selection. This doesn't move the text cursor.
5166
5167 See |mouse-using|. Also see |'clipboard'|.
5168
5169 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005170 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 the mouse buttons can still be used by keeping the shift key pressed.
5172 Also see the 'clipboard' option.
5173
5174 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5175'mousefocus' 'mousef' boolean (default off)
5176 global
5177 {not in Vi}
5178 {only works in the GUI}
5179 The window that the mouse pointer is on is automatically activated.
5180 When changing the window layout or window focus in another way, the
5181 mouse pointer is moved to the window with keyboard focus. Off is the
5182 default because it makes using the pull down menus a little goofy, as
5183 a pointer transit may activate a window unintentionally.
5184
5185 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5186'mousehide' 'mh' boolean (default on)
5187 global
5188 {not in Vi}
5189 {only works in the GUI}
5190 When on, the mouse pointer is hidden when characters are typed.
5191 The mouse pointer is restored when the mouse is moved.
5192
5193 *'mousemodel'* *'mousem'*
5194'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5195 global
5196 {not in Vi}
5197 Sets the model to use for the mouse. The name mostly specifies what
5198 the right mouse button is used for:
5199 extend Right mouse button extends a selection. This works
5200 like in an xterm.
5201 popup Right mouse button pops up a menu. The shifted left
5202 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005203 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 popup_setpos Like "popup", but the cursor will be moved to the
5205 position where the mouse was clicked, and thus the
5206 selected operation will act upon the clicked object.
5207 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005208 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 course, that right clicking outside a selection will
5210 end Visual mode.
5211 Overview of what button does what for each model:
5212 mouse extend popup(_setpos) ~
5213 left click place cursor place cursor
5214 left drag start selection start selection
5215 shift-left search word extend selection
5216 right click extend selection popup menu (place cursor)
5217 right drag extend selection -
5218 middle click paste paste
5219
5220 In the "popup" model the right mouse button produces a pop-up menu.
5221 You need to define this first, see |popup-menu|.
5222
5223 Note that you can further refine the meaning of buttons with mappings.
5224 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5225 selection (because that's handled in the GUI code directly).
5226
5227 The 'mousemodel' option is set by the |:behave| command.
5228
5229 *'mouseshape'* *'mouses'* *E547*
5230'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005231 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 global
5233 {not in Vi}
5234 {only available when compiled with the |+mouseshape|
5235 feature}
5236 This option tells Vim what the mouse pointer should look like in
5237 different modes. The option is a comma separated list of parts, much
5238 like used for 'guicursor'. Each part consist of a mode/location-list
5239 and an argument-list:
5240 mode-list:shape,mode-list:shape,..
5241 The mode-list is a dash separated list of these modes/locations:
5242 In a normal window: ~
5243 n Normal mode
5244 v Visual mode
5245 ve Visual mode with 'selection' "exclusive" (same as 'v',
5246 if not specified)
5247 o Operator-pending mode
5248 i Insert mode
5249 r Replace mode
5250
5251 Others: ~
5252 c appending to the command-line
5253 ci inserting in the command-line
5254 cr replacing in the command-line
5255 m at the 'Hit ENTER' or 'More' prompts
5256 ml idem, but cursor in the last line
5257 e any mode, pointer below last window
5258 s any mode, pointer on a status line
5259 sd any mode, while dragging a status line
5260 vs any mode, pointer on a vertical separator line
5261 vd any mode, while dragging a vertical separator line
5262 a everywhere
5263
5264 The shape is one of the following:
5265 avail name looks like ~
5266 w x arrow Normal mouse pointer
5267 w x blank no pointer at all (use with care!)
5268 w x beam I-beam
5269 w x updown up-down sizing arrows
5270 w x leftright left-right sizing arrows
5271 w x busy The system's usual busy pointer
5272 w x no The system's usual 'no input' pointer
5273 x udsizing indicates up-down resizing
5274 x lrsizing indicates left-right resizing
5275 x crosshair like a big thin +
5276 x hand1 black hand
5277 x hand2 white hand
5278 x pencil what you write with
5279 x question big ?
5280 x rightup-arrow arrow pointing right-up
5281 w x up-arrow arrow pointing up
5282 x <number> any X11 pointer number (see X11/cursorfont.h)
5283
5284 The "avail" column contains a 'w' if the shape is available for Win32,
5285 x for X11.
5286 Any modes not specified or shapes not available use the normal mouse
5287 pointer.
5288
5289 Example: >
5290 :set mouseshape=s:udsizing,m:no
5291< will make the mouse turn to a sizing arrow over the status lines and
5292 indicate no input when the hit-enter prompt is displayed (since
5293 clicking the mouse has no effect in this state.)
5294
5295 *'mousetime'* *'mouset'*
5296'mousetime' 'mouset' number (default 500)
5297 global
5298 {not in Vi}
5299 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5300 time in msec between two mouse clicks for the second click to be
5301 recognized as a multi click.
5302
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005303 *'mzquantum'* *'mzq'*
5304'mzquantum' 'mzq' number (default 100)
5305 global
5306 {not in Vi}
5307 {not available when compiled without the |+mzscheme|
5308 feature}
5309 The number of milliseconds between polls for MzScheme threads.
5310 Negative or zero value means no thread scheduling.
5311
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 *'nrformats'* *'nf'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005313'nrformats' 'nf' string (default "bin,octal,hex")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 local to buffer
5315 {not in Vi}
5316 This defines what bases Vim will consider for numbers when using the
5317 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5318 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005319 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005321 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005322 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005323 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005324 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 considered to be hexadecimal. Example: Using CTRL-X on
5326 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005327 bin If included, numbers starting with "0b" or "0B" will be
5328 considered to be binary. Example: Using CTRL-X on
5329 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005330 Numbers which simply begin with a digit in the range 1-9 are always
5331 considered decimal. This also happens for numbers that are not
5332 recognized as octal or hex.
5333
5334 *'number'* *'nu'* *'nonumber'* *'nonu'*
5335'number' 'nu' boolean (default off)
5336 local to window
5337 Print the line number in front of each line. When the 'n' option is
5338 excluded from 'cpoptions' a wrapped line will not use the column of
5339 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005340 The 'numberwidth' option can be used to set the room used for the line
5341 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 When a long, wrapped line doesn't start with the first character, '-'
5343 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005344 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5345 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005346 *number_relativenumber*
5347 The 'relativenumber' option changes the displayed number to be
5348 relative to the cursor. Together with 'number' there are these
5349 four combinations (cursor in line 3):
5350
Bram Moolenaar3848e002016-03-19 18:42:29 +01005351 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005352 'nornu' 'nornu' 'rnu' 'rnu'
5353
5354 |apple | 1 apple | 2 apple | 2 apple
5355 |pear | 2 pear | 1 pear | 1 pear
5356 |nobody | 3 nobody | 0 nobody |3 nobody
5357 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005359 *'numberwidth'* *'nuw'*
5360'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5361 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005362 {not in Vi}
5363 {only available when compiled with the |+linebreak|
5364 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005365 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005366 when the 'number' or 'relativenumber' option is set or printing lines
5367 with a line number. Since one space is always between the number and
5368 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005369 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005370 fit the highest line number in the buffer respectively the number of
5371 rows in the window, depending on whether 'number' or 'relativenumber'
5372 is set. Thus with the Vim default of 4 there is room for a line number
5373 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005374 The minimum value is 1, the maximum value is 10.
5375 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5376
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005377 *'omnifunc'* *'ofu'*
5378'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005379 local to buffer
5380 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005381 {not available when compiled without the |+eval|
5382 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005383 This option specifies a function to be used for Insert mode omni
5384 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005385 See |complete-functions| for an explanation of how the function is
5386 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005387 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005388 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005389 This option cannot be set from a |modeline| or in the |sandbox|, for
5390 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005391
5392
Bram Moolenaar02467872007-05-06 13:22:01 +00005393 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005394'opendevice' 'odev' boolean (default off)
5395 global
5396 {not in Vi}
5397 {only for MS-DOS, MS-Windows and OS/2}
5398 Enable reading and writing from devices. This may get Vim stuck on a
5399 device that can be opened but doesn't actually do the I/O. Therefore
5400 it is off by default.
5401 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5402 result in editing a device.
5403
5404
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005405 *'operatorfunc'* *'opfunc'*
5406'operatorfunc' 'opfunc' string (default: empty)
5407 global
5408 {not in Vi}
5409 This option specifies a function to be called by the |g@| operator.
5410 See |:map-operator| for more info and an example.
5411
5412 This option cannot be set from a |modeline| or in the |sandbox|, for
5413 security reasons.
5414
5415
Bram Moolenaar251e1912011-06-19 05:09:16 +02005416 *'osfiletype'* *'oft'*
5417'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 local to buffer
5419 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005420 This option was supported on RISC OS, which has been removed.
5421
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005423 *'packpath'* *'pp'*
5424'packpath' 'pp' string (default: see 'runtimepath')
5425 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005426 Directories used to find packages. See |packages|.
5427
5428
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005430'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 global
5432 Specifies the nroff macros that separate paragraphs. These are pairs
5433 of two letters (see |object-motions|).
5434
5435 *'paste'* *'nopaste'*
5436'paste' boolean (default off)
5437 global
5438 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005439 Put Vim in Paste mode. This is useful if you want to cut or copy
5440 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 unexpected effects.
5442 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005443 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 knows about pasting and will mostly do the right thing without 'paste'
5445 being set. The same is true for a terminal where Vim handles the
5446 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005447 This option is reset when starting the GUI. Thus if you set it in
5448 your .vimrc it will work in a terminal, but not in the GUI. Setting
5449 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5450 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 When the 'paste' option is switched on (also when it was already on):
5452 - mapping in Insert mode and Command-line mode is disabled
5453 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005455 - 'expandtab' is reset
5456 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 - 'revins' is reset
5458 - 'ruler' is reset
5459 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005460 - 'smartindent' is reset
5461 - 'smarttab' is reset
5462 - 'softtabstop' is set to 0
5463 - 'textwidth' is set to 0
5464 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005466 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005467 - 'indentexpr'
5468 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 NOTE: When you start editing another file while the 'paste' option is
5470 on, settings from the modelines or autocommands may change the
5471 settings again, causing trouble when pasting text. You might want to
5472 set the 'paste' option again.
5473 When the 'paste' option is reset the mentioned options are restored to
5474 the value before the moment 'paste' was switched from off to on.
5475 Resetting 'paste' before ever setting it does not have any effect.
5476 Since mapping doesn't work while 'paste' is active, you need to use
5477 the 'pastetoggle' option to toggle the 'paste' option with some key.
5478
5479 *'pastetoggle'* *'pt'*
5480'pastetoggle' 'pt' string (default "")
5481 global
5482 {not in Vi}
5483 When non-empty, specifies the key sequence that toggles the 'paste'
5484 option. This is like specifying a mapping: >
5485 :map {keys} :set invpaste<CR>
5486< Where {keys} is the value of 'pastetoggle'.
5487 The difference is that it will work even when 'paste' is set.
5488 'pastetoggle' works in Insert mode and Normal mode, but not in
5489 Command-line mode.
5490 Mappings are checked first, thus overrule 'pastetoggle'. However,
5491 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5492 this: >
5493 :map <F10> :set paste<CR>
5494 :map <F11> :set nopaste<CR>
5495 :imap <F10> <C-O>:set paste<CR>
5496 :imap <F11> <nop>
5497 :set pastetoggle=<F11>
5498< This will make <F10> start paste mode and <F11> stop paste mode.
5499 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5500 mode everything is inserted literally, except the 'pastetoggle' key
5501 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005502 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503
5504 *'pex'* *'patchexpr'*
5505'patchexpr' 'pex' string (default "")
5506 global
5507 {not in Vi}
5508 {not available when compiled without the |+diff|
5509 feature}
5510 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005511 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512
Bram Moolenaardbc28022014-07-26 13:40:44 +02005513 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514'patchmode' 'pm' string (default "")
5515 global
5516 {not in Vi}
5517 When non-empty the oldest version of a file is kept. This can be used
5518 to keep the original version of a file if you are changing files in a
5519 source distribution. Only the first time that a file is written a
5520 copy of the original file will be kept. The name of the copy is the
5521 name of the original file with the string in the 'patchmode' option
5522 appended. This option should start with a dot. Use a string like
5523 ".org". 'backupdir' must not be empty for this to work (Detail: The
5524 backup file is renamed to the patchmode file after the new file has
5525 been successfully written, that's why it must be possible to write a
5526 backup file). If there was no file to be backed up, an empty file is
5527 created.
5528 When the 'backupskip' pattern matches, a patchmode file is not made.
5529 Using 'patchmode' for compressed files appends the extension at the
5530 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5531 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005532 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005534 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535'path' 'pa' string (default on Unix: ".,/usr/include,,"
5536 on OS/2: ".,/emx/include,,"
5537 other systems: ".,,")
5538 global or local to buffer |global-local|
5539 {not in Vi}
5540 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005541 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5542 provided that the file being searched for has a relative path (not
5543 starting with "/", "./" or "../"). The directories in the 'path'
5544 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 - Use commas to separate directory names: >
5546 :set path=.,/usr/local/include,/usr/include
5547< - Spaces can also be used to separate directory names (for backwards
5548 compatibility with version 3.0). To have a space in a directory
5549 name, precede it with an extra backslash, and escape the space: >
5550 :set path=.,/dir/with\\\ space
5551< - To include a comma in a directory name precede it with an extra
5552 backslash: >
5553 :set path=.,/dir/with\\,comma
5554< - To search relative to the directory of the current file, use: >
5555 :set path=.
5556< - To search in the current directory use an empty string between two
5557 commas: >
5558 :set path=,,
5559< - A directory name may end in a ':' or '/'.
5560 - Environment variables are expanded |:set_env|.
5561 - When using |netrw.vim| URLs can be used. For example, adding
5562 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005563 - Search upwards and downwards in a directory tree using "*", "**" and
5564 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 {not available when compiled without the |+path_extra| feature}
5566 - Careful with '\' characters, type two to get one in the option: >
5567 :set path=.,c:\\include
5568< Or just use '/' instead: >
5569 :set path=.,c:/include
5570< Don't forget "." or files won't even be found in the same directory as
5571 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005572 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 it is something like 256 or 1024 characters.
5574 You can check if all the include files are found, using the value of
5575 'path', see |:checkpath|.
5576 The use of |:set+=| and |:set-=| is preferred when adding or removing
5577 directories from the list. This avoids problems when a future version
5578 uses another default. To remove the current directory use: >
5579 :set path-=
5580< To add the current directory use: >
5581 :set path+=
5582< To use an environment variable, you probably need to replace the
5583 separator. Here is an example to append $INCL, in which directory
5584 names are separated with a semi-colon: >
5585 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5586< Replace the ';' with a ':' or whatever separator is used. Note that
5587 this doesn't work when $INCL contains a comma or white space.
5588
Bram Moolenaard94464e2015-11-02 15:28:18 +01005589 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005590'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005591 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005592 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005593 {only available when compiled with the |+perl/dyn|
5594 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005595 Specifies the name of the Perl shared library. The default is
5596 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005597 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005598 This option cannot be set from a |modeline| or in the |sandbox|, for
5599 security reasons.
5600
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5602'preserveindent' 'pi' boolean (default off)
5603 local to buffer
5604 {not in Vi}
5605 When changing the indent of the current line, preserve as much of the
5606 indent structure as possible. Normally the indent is replaced by a
5607 series of tabs followed by spaces as required (unless |'expandtab'| is
5608 enabled, in which case only spaces are used). Enabling this option
5609 means the indent will preserve as many existing characters as possible
5610 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005611 'expandtab' does not apply to the preserved white space, a Tab remains
5612 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 NOTE: When using ">>" multiple times the resulting indent is a mix of
5614 tabs and spaces. You might not like this.
5615 NOTE: 'preserveindent' is reset when 'compatible' is set.
5616 Also see 'copyindent'.
5617 Use |:retab| to clean up white space.
5618
5619 *'previewheight'* *'pvh'*
5620'previewheight' 'pvh' number (default 12)
5621 global
5622 {not in Vi}
5623 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005624 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 Default height for a preview window. Used for |:ptag| and associated
5626 commands. Used for |CTRL-W_}| when no count is given.
5627
5628 *'previewwindow'* *'nopreviewwindow'*
5629 *'pvw'* *'nopvw'* *E590*
5630'previewwindow' 'pvw' boolean (default off)
5631 local to window
5632 {not in Vi}
5633 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005634 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005635 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 set. It's normally not set directly, but by using one of the commands
5637 |:ptag|, |:pedit|, etc.
5638
5639 *'printdevice'* *'pdev'*
5640'printdevice' 'pdev' string (default empty)
5641 global
5642 {not in Vi}
5643 {only available when compiled with the |+printer|
5644 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005645 The name of the printer to be used for |:hardcopy|.
5646 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005647 This option cannot be set from a |modeline| or in the |sandbox|, for
5648 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649
Bram Moolenaar8299df92004-07-10 09:47:34 +00005650 *'printencoding'* *'penc'*
5651'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 global
5653 {not in Vi}
5654 {only available when compiled with the |+printer|
5655 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005656 Sets the character encoding used when printing.
5657 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658
5659 *'printexpr'* *'pexpr'*
5660'printexpr' 'pexpr' String (default: see below)
5661 global
5662 {not in Vi}
5663 {only available when compiled with the |+printer|
5664 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005665 Expression used to print the PostScript produced with |:hardcopy|.
5666 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667
Bram Moolenaar8299df92004-07-10 09:47:34 +00005668 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669'printfont' 'pfn' string (default "courier")
5670 global
5671 {not in Vi}
5672 {only available when compiled with the |+printer|
5673 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005674 The name of the font that will be used for |:hardcopy|.
5675 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676
5677 *'printheader'* *'pheader'*
5678'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5679 global
5680 {not in Vi}
5681 {only available when compiled with the |+printer|
5682 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005683 The format of the header produced in |:hardcopy| output.
5684 See |pheader-option|.
5685
5686 *'printmbcharset'* *'pmbcs'*
5687'printmbcharset' 'pmbcs' string (default "")
5688 global
5689 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005690 {only available when compiled with the |+printer|,
5691 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005692 The CJK character set to be used for CJK output from |:hardcopy|.
5693 See |pmbcs-option|.
5694
5695 *'printmbfont'* *'pmbfn'*
5696'printmbfont' 'pmbfn' string (default "")
5697 global
5698 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005699 {only available when compiled with the |+printer|,
5700 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005701 List of font names to be used for CJK output from |:hardcopy|.
5702 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703
5704 *'printoptions'* *'popt'*
5705'printoptions' 'popt' string (default "")
5706 global
5707 {not in Vi}
5708 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005709 List of items that control the format of the output of |:hardcopy|.
5710 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005712 *'prompt'* *'noprompt'*
5713'prompt' boolean (default on)
5714 global
5715 When on a ":" prompt is used in Ex mode.
5716
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005717 *'pumheight'* *'ph'*
5718'pumheight' 'ph' number (default 0)
5719 global
5720 {not available when compiled without the
5721 |+insert_expand| feature}
5722 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005723 Determines the maximum number of items to show in the popup menu for
5724 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005725 |ins-completion-menu|.
5726
Bram Moolenaard94464e2015-11-02 15:28:18 +01005727 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005728'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005729 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005730 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005731 {only available when compiled with the |+python/dyn|
5732 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005733 Specifies the name of the Python 2.x shared library. The default is
5734 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005735 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005736 This option cannot be set from a |modeline| or in the |sandbox|, for
5737 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005738
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005739 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005740'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005741 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005742 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005743 {only available when compiled with the |+python3/dyn|
5744 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005745 Specifies the name of the Python 3 shared library. The default is
5746 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005747 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005748 This option cannot be set from a |modeline| or in the |sandbox|, for
5749 security reasons.
5750
Bram Moolenaar677ee682005-01-27 14:41:15 +00005751 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005752'quoteescape' 'qe' string (default "\")
5753 local to buffer
5754 {not in Vi}
5755 The characters that are used to escape quotes in a string. Used for
5756 objects like a', a" and a` |a'|.
5757 When one of the characters in this option is found inside a string,
5758 the following character will be skipped. The default value makes the
5759 text "foo\"bar\\" considered to be one string.
5760
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5762'readonly' 'ro' boolean (default off)
5763 local to buffer
5764 If on, writes fail unless you use a '!'. Protects you from
5765 accidentally overwriting a file. Default on when Vim is started
5766 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005767 When using ":w!" the 'readonly' option is reset for the current
5768 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005770 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005772 *'redrawtime'* *'rdt'*
5773'redrawtime' 'rdt' number (default 2000)
5774 global
5775 {not in Vi}
5776 {only available when compiled with the |+reltime|
5777 feature}
5778 The time in milliseconds for redrawing the display. This applies to
5779 searching for patterns for 'hlsearch' and |:match| highlighting.
5780 When redrawing takes more than this many milliseconds no further
5781 matches will be highlighted. This is used to avoid that Vim hangs
5782 when using a very complicated pattern.
5783
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005784 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005785'regexpengine' 're' number (default 0)
5786 global
5787 {not in Vi}
5788 This selects the default regexp engine. |two-engines|
5789 The possible values are:
5790 0 automatic selection
5791 1 old engine
5792 2 NFA engine
5793 Note that when using the NFA engine and the pattern contains something
5794 that is not supported the pattern will not match. This is only useful
5795 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005796 Using automatic selection enables Vim to switch the engine, if the
5797 default engine becomes too costly. E.g., when the NFA engine uses too
5798 many states. This should prevent Vim from hanging on a combination of
5799 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005800
Bram Moolenaar64486672010-05-16 15:46:46 +02005801 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5802'relativenumber' 'rnu' boolean (default off)
5803 local to window
5804 {not in Vi}
5805 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005806 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005807 precede some vertical motion commands (e.g. j k + -) with, without
5808 having to calculate it yourself. Especially useful in combination with
5809 other commands (e.g. y d c < > gq gw =).
5810 When the 'n' option is excluded from 'cpoptions' a wrapped
5811 line will not use the column of line numbers (this is the default when
5812 'compatible' isn't set).
5813 The 'numberwidth' option can be used to set the room used for the line
5814 number.
5815 When a long, wrapped line doesn't start with the first character, '-'
5816 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005817 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5818 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005819
5820 The number in front of the cursor line also depends on the value of
5821 'number', see |number_relativenumber| for all combinations of the two
5822 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005823
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 *'remap'* *'noremap'*
5825'remap' boolean (default on)
5826 global
5827 Allows for mappings to work recursively. If you do not want this for
5828 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005829 NOTE: To avoid portability problems with Vim scripts, always keep
5830 this option at the default "on". Only switch it off when working with
5831 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005833 *'renderoptions'* *'rop'*
5834'renderoptions' 'rop' string (default: empty)
5835 global
5836 {not in Vi}
5837 {only available when compiled with GUI and DIRECTX on
5838 MS-Windows}
5839 Select a text renderer and set its options. The options depend on the
5840 renderer.
5841
5842 Syntax: >
5843 set rop=type:{renderer}(,{name}:{value})*
5844<
5845 Currently, only one optional renderer is available.
5846
5847 render behavior ~
5848 directx Vim will draw text using DirectX (DirectWrite). It makes
5849 drawn glyphs more beautiful than default GDI.
5850 It requires 'encoding' is "utf-8", and only works on
5851 MS-Windows Vista or newer version.
5852
5853 Options:
5854 name meaning type value ~
5855 gamma gamma float 1.0 - 2.2 (maybe)
5856 contrast enhancedContrast float (unknown)
5857 level clearTypeLevel float (unknown)
5858 geom pixelGeometry int 0 - 2 (see below)
5859 renmode renderingMode int 0 - 6 (see below)
5860 taamode textAntialiasMode int 0 - 3 (see below)
5861
5862 See this URL for detail:
5863 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5864
5865 For geom: structure of a device pixel.
5866 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5867 1 - DWRITE_PIXEL_GEOMETRY_RGB
5868 2 - DWRITE_PIXEL_GEOMETRY_BGR
5869
5870 See this URL for detail:
5871 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5872
5873 For renmode: method of rendering glyphs.
5874 0 - DWRITE_RENDERING_MODE_DEFAULT
5875 1 - DWRITE_RENDERING_MODE_ALIASED
5876 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5877 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5878 4 - DWRITE_RENDERING_MODE_NATURAL
5879 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5880 6 - DWRITE_RENDERING_MODE_OUTLINE
5881
5882 See this URL for detail:
5883 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5884
5885 For taamode: antialiasing mode used for drawing text.
5886 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5887 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5888 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5889 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5890
5891 See this URL for detail:
5892 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5893
5894 Example: >
5895 set encoding=utf-8
5896 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5897 set rop=type:directx
5898<
5899 If select a raster font (Courier, Terminal or FixedSys) to
5900 'guifont', it fallbacks to be drawn by GDI automatically.
5901
5902 Other render types are currently not supported.
5903
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 *'report'*
5905'report' number (default 2)
5906 global
5907 Threshold for reporting number of lines changed. When the number of
5908 changed lines is more than 'report' a message will be given for most
5909 ":" commands. If you want it always, set 'report' to 0.
5910 For the ":substitute" command the number of substitutions is used
5911 instead of the number of lines.
5912
5913 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5914'restorescreen' 'rs' boolean (default on)
5915 global
5916 {not in Vi} {only in Windows 95/NT console version}
5917 When set, the screen contents is restored when exiting Vim. This also
5918 happens when executing external commands.
5919
5920 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5921 options in your .vimrc. To disable restoring:
5922 set t_ti= t_te=
5923 To enable restoring (for an xterm):
5924 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5925 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5926
5927 *'revins'* *'ri'* *'norevins'* *'nori'*
5928'revins' 'ri' boolean (default off)
5929 global
5930 {not in Vi}
5931 {only available when compiled with the |+rightleft|
5932 feature}
5933 Inserting characters in Insert mode will work backwards. See "typing
5934 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5935 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005936 NOTE: This option is reset when 'compatible' is set.
5937 This option is reset when 'paste' is set and restored when 'paste' is
5938 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939
5940 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5941'rightleft' 'rl' boolean (default off)
5942 local to window
5943 {not in Vi}
5944 {only available when compiled with the |+rightleft|
5945 feature}
5946 When on, display orientation becomes right-to-left, i.e., characters
5947 that are stored in the file appear from the right to the left.
5948 Using this option, it is possible to edit files for languages that
5949 are written from the right to the left such as Hebrew and Arabic.
5950 This option is per window, so it is possible to edit mixed files
5951 simultaneously, or to view the same file in both ways (this is
5952 useful whenever you have a mixed text file with both right-to-left
5953 and left-to-right strings so that both sets are displayed properly
5954 in different windows). Also see |rileft.txt|.
5955
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005956 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957'rightleftcmd' 'rlc' string (default "search")
5958 local to window
5959 {not in Vi}
5960 {only available when compiled with the |+rightleft|
5961 feature}
5962 Each word in this option enables the command line editing to work in
5963 right-to-left mode for a group of commands:
5964
5965 search "/" and "?" commands
5966
5967 This is useful for languages such as Hebrew, Arabic and Farsi.
5968 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5969
Bram Moolenaard94464e2015-11-02 15:28:18 +01005970 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005971'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005972 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005973 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005974 {only available when compiled with the |+ruby/dyn|
5975 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005976 Specifies the name of the Ruby shared library. The default is
5977 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005978 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005979 This option cannot be set from a |modeline| or in the |sandbox|, for
5980 security reasons.
5981
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 *'ruler'* *'ru'* *'noruler'* *'noru'*
5983'ruler' 'ru' boolean (default off)
5984 global
5985 {not in Vi}
5986 {not available when compiled without the
5987 |+cmdline_info| feature}
5988 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005989 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 text in the file is shown on the far right:
5991 Top first line is visible
5992 Bot last line is visible
5993 All first and last line are visible
5994 45% relative position in the file
5995 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005996 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005998 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 this option takes precedence over 'ruler' and 'rulerformat'
6000 If the number of characters displayed is different from the number of
6001 bytes in the text (e.g., for a TAB or a multi-byte character), both
6002 the text column (byte number) and the screen column are shown,
6003 separated with a dash.
6004 For an empty line "0-1" is shown.
6005 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006006 This option is reset when 'paste' is set and restored when 'paste' is
6007 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 If you don't want to see the ruler all the time but want to know where
6009 you are, use "g CTRL-G" |g_CTRL-G|.
6010 NOTE: This option is reset when 'compatible' is set.
6011
6012 *'rulerformat'* *'ruf'*
6013'rulerformat' 'ruf' string (default empty)
6014 global
6015 {not in Vi}
6016 {not available when compiled without the |+statusline|
6017 feature}
6018 When this option is not empty, it determines the content of the ruler
6019 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006020 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 The default ruler width is 17 characters. To make the ruler 15
6022 characters wide, put "%15(" at the start and "%)" at the end.
6023 Example: >
6024 :set rulerformat=%15(%c%V\ %p%%%)
6025<
6026 *'runtimepath'* *'rtp'* *vimfiles*
6027'runtimepath' 'rtp' string (default:
6028 Unix: "$HOME/.vim,
6029 $VIM/vimfiles,
6030 $VIMRUNTIME,
6031 $VIM/vimfiles/after,
6032 $HOME/.vim/after"
6033 Amiga: "home:vimfiles,
6034 $VIM/vimfiles,
6035 $VIMRUNTIME,
6036 $VIM/vimfiles/after,
6037 home:vimfiles/after"
6038 PC, OS/2: "$HOME/vimfiles,
6039 $VIM/vimfiles,
6040 $VIMRUNTIME,
6041 $VIM/vimfiles/after,
6042 $HOME/vimfiles/after"
6043 Macintosh: "$VIM:vimfiles,
6044 $VIMRUNTIME,
6045 $VIM:vimfiles:after"
6046 RISC-OS: "Choices:vimfiles,
6047 $VIMRUNTIME,
6048 Choices:vimfiles/after"
6049 VMS: "sys$login:vimfiles,
6050 $VIM/vimfiles,
6051 $VIMRUNTIME,
6052 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006053 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 global
6055 {not in Vi}
6056 This is a list of directories which will be searched for runtime
6057 files:
6058 filetype.vim filetypes by file name |new-filetype|
6059 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006060 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 colors/ color scheme files |:colorscheme|
6062 compiler/ compiler files |:compiler|
6063 doc/ documentation |write-local-help|
6064 ftplugin/ filetype plugins |write-filetype-plugin|
6065 indent/ indent scripts |indent-expression|
6066 keymap/ key mapping files |mbyte-keymap|
6067 lang/ menu translations |:menutrans|
6068 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006069 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 plugin/ plugin scripts |write-plugin|
6071 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006072 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 syntax/ syntax files |mysyntaxfile|
6074 tutor/ files for vimtutor |tutor|
6075
6076 And any other file searched for with the |:runtime| command.
6077
6078 The defaults for most systems are setup to search five locations:
6079 1. In your home directory, for your personal preferences.
6080 2. In a system-wide Vim directory, for preferences from the system
6081 administrator.
6082 3. In $VIMRUNTIME, for files distributed with Vim.
6083 *after-directory*
6084 4. In the "after" directory in the system-wide Vim directory. This is
6085 for the system administrator to overrule or add to the distributed
6086 defaults (rarely needed)
6087 5. In the "after" directory in your home directory. This is for
6088 personal preferences to overrule or add to the distributed defaults
6089 or system-wide settings (rarely needed).
6090
Bram Moolenaar26852122016-05-24 20:02:38 +02006091 More entries are added when using |packages|.
6092
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6094 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006095 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 wildcards.
6097 See |:runtime|.
6098 Example: >
6099 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6100< This will use the directory "~/vimruntime" first (containing your
6101 personal Vim runtime files), then "/mygroup/vim" (shared between a
6102 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6103 files).
6104 You probably should always include $VIMRUNTIME somewhere, to use the
6105 distributed runtime files. You can put a directory before $VIMRUNTIME
6106 to find files which replace a distributed runtime files. You can put
6107 a directory after $VIMRUNTIME to find files which add to distributed
6108 runtime files.
6109 This option cannot be set from a |modeline| or in the |sandbox|, for
6110 security reasons.
6111
6112 *'scroll'* *'scr'*
6113'scroll' 'scr' number (default: half the window height)
6114 local to window
6115 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6116 set to half the number of lines in the window when the window size
6117 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006118 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6120 the number of screen lines instead of file lines, makes a difference
6121 when lines wrap}
6122
6123 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6124'scrollbind' 'scb' boolean (default off)
6125 local to window
6126 {not in Vi}
6127 {not available when compiled without the |+scrollbind|
6128 feature}
6129 See also |scroll-binding|. When this option is set, the current
6130 window scrolls as other scrollbind windows (windows that also have
6131 this option set) scroll. This option is useful for viewing the
6132 differences between two versions of a file, see 'diff'.
6133 See |'scrollopt'| for options that determine how this option should be
6134 interpreted.
6135 This option is mostly reset when splitting a window to edit another
6136 file. This means that ":split | edit file" results in two windows
6137 with scroll-binding, but ":split file" does not.
6138
6139 *'scrolljump'* *'sj'*
6140'scrolljump' 'sj' number (default 1)
6141 global
6142 {not in Vi}
6143 Minimal number of lines to scroll when the cursor gets off the
6144 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6145 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006146 When set to a negative number from -1 to -100 this is used as the
6147 percentage of the window height. Thus -50 scrolls half the window
6148 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 NOTE: This option is set to 1 when 'compatible' is set.
6150
6151 *'scrolloff'* *'so'*
6152'scrolloff' 'so' number (default 0)
6153 global
6154 {not in Vi}
6155 Minimal number of screen lines to keep above and below the cursor.
6156 This will make some context visible around where you are working. If
6157 you set it to a very large value (999) the cursor line will always be
6158 in the middle of the window (except at the start or end of the file or
6159 when long lines wrap).
6160 For scrolling horizontally see 'sidescrolloff'.
6161 NOTE: This option is set to 0 when 'compatible' is set.
6162
6163 *'scrollopt'* *'sbo'*
6164'scrollopt' 'sbo' string (default "ver,jump")
6165 global
6166 {not available when compiled without the |+scrollbind|
6167 feature}
6168 {not in Vi}
6169 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006170 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6171 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 The following words are available:
6173 ver Bind vertical scrolling for 'scrollbind' windows
6174 hor Bind horizontal scrolling for 'scrollbind' windows
6175 jump Applies to the offset between two windows for vertical
6176 scrolling. This offset is the difference in the first
6177 displayed line of the bound windows. When moving
6178 around in a window, another 'scrollbind' window may
6179 reach a position before the start or after the end of
6180 the buffer. The offset is not changed though, when
6181 moving back the 'scrollbind' window will try to scroll
6182 to the desired position when possible.
6183 When now making that window the current one, two
6184 things can be done with the relative offset:
6185 1. When "jump" is not included, the relative offset is
6186 adjusted for the scroll position in the new current
6187 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006188 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 2. When "jump" is included, the other windows are
6190 scrolled to keep the same relative offset. When
6191 going back to the other window, it still uses the
6192 same relative offset.
6193 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006194 When 'diff' mode is active there always is vertical scroll binding,
6195 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196
6197 *'sections'* *'sect'*
6198'sections' 'sect' string (default "SHNHH HUnhsh")
6199 global
6200 Specifies the nroff macros that separate sections. These are pairs of
6201 two letters (See |object-motions|). The default makes a section start
6202 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6203
6204 *'secure'* *'nosecure'* *E523*
6205'secure' boolean (default off)
6206 global
6207 {not in Vi}
6208 When on, ":autocmd", shell and write commands are not allowed in
6209 ".vimrc" and ".exrc" in the current directory and map commands are
6210 displayed. Switch it off only if you know that you will not run into
6211 problems, or when the 'exrc' option is off. On Unix this option is
6212 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006213 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 'secure' at the end of your ~/.vimrc then.
6215 This option cannot be set from a |modeline| or in the |sandbox|, for
6216 security reasons.
6217
6218 *'selection'* *'sel'*
6219'selection' 'sel' string (default "inclusive")
6220 global
6221 {not in Vi}
6222 This option defines the behavior of the selection. It is only used
6223 in Visual and Select mode.
6224 Possible values:
6225 value past line inclusive ~
6226 old no yes
6227 inclusive yes yes
6228 exclusive yes no
6229 "past line" means that the cursor is allowed to be positioned one
6230 character past the line.
6231 "inclusive" means that the last character of the selection is included
6232 in an operation. For example, when "x" is used to delete the
6233 selection.
6234 Note that when "exclusive" is used and selecting from the end
6235 backwards, you cannot include the last character of a line, when
6236 starting in Normal mode and 'virtualedit' empty.
6237
6238 The 'selection' option is set by the |:behave| command.
6239
6240 *'selectmode'* *'slm'*
6241'selectmode' 'slm' string (default "")
6242 global
6243 {not in Vi}
6244 This is a comma separated list of words, which specifies when to start
6245 Select mode instead of Visual mode, when a selection is started.
6246 Possible values:
6247 mouse when using the mouse
6248 key when using shifted special keys
6249 cmd when using "v", "V" or CTRL-V
6250 See |Select-mode|.
6251 The 'selectmode' option is set by the |:behave| command.
6252
6253 *'sessionoptions'* *'ssop'*
6254'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006255 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 global
6257 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006258 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 feature}
6260 Changes the effect of the |:mksession| command. It is a comma
6261 separated list of words. Each word enables saving and restoring
6262 something:
6263 word save and restore ~
6264 blank empty windows
6265 buffers hidden and unloaded buffers, not just those in windows
6266 curdir the current directory
6267 folds manually created folds, opened/closed folds and local
6268 fold options
6269 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006270 and contain at least one lowercase letter. Only
6271 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 help the help window
6273 localoptions options and mappings local to a window or buffer (not
6274 global values for local options)
6275 options all options and mappings (also global values for local
6276 options)
6277 resize size of the Vim window: 'lines' and 'columns'
6278 sesdir the directory in which the session file is located
6279 will become the current directory (useful with
6280 projects accessed over a network from different
6281 systems)
6282 slash backslashes in file names replaced with forward
6283 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006284 tabpages all tab pages; without this only the current tab page
6285 is restored, so that you can make a session for each
6286 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 unix with Unix end-of-line format (single <NL>), even when
6288 on Windows or DOS
6289 winpos position of the whole Vim window
6290 winsize window sizes
6291
6292 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006293 When neither "curdir" nor "sesdir" is included, file names are stored
6294 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 "slash" and "unix" are useful on Windows when sharing session files
6296 with Unix. The Unix version of Vim cannot source dos format scripts,
6297 but the Windows version of Vim can source unix format scripts.
6298
6299 *'shell'* *'sh'* *E91*
6300'shell' 'sh' string (default $SHELL or "sh",
6301 MS-DOS and Win32: "command.com" or
6302 "cmd.exe", OS/2: "cmd")
6303 global
6304 Name of the shell to use for ! and :! commands. When changing the
6305 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6306 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006307 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 See |option-backslash| about including spaces and backslashes.
6309 Environment variables are expanded |:set_env|.
6310 If the name of the shell contains a space, you might need to enclose
6311 it in quotes. Example: >
6312 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6313< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006314 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 "-f" is not inside the quotes, because it is not part of the command
6316 name. And Vim automagically recognizes the backslashes that are path
6317 separators.
6318 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6319 variable to change the way external commands are executed. See the
6320 libc.inf file of DJGPP.
6321 Under MS-Windows, when the executable ends in ".com" it must be
6322 included. Thus setting the shell to "command.com" or "4dos.com"
6323 works, but "command" and "4dos" do not work for all commands (e.g.,
6324 filtering).
6325 For unknown reasons, when using "4dos.com" the current directory is
6326 changed to "C:\". To avoid this set 'shell' like this: >
6327 :set shell=command.com\ /c\ 4dos
6328< This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
6331 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006332'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006333 MS-DOS and Win32, when 'shell' does not
6334 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 global
6336 {not in Vi}
6337 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6338 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6339 systems, the default is set according to the value of 'shell', to
6340 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006341 OS/2 (EMX figures this out itself).
6342 On Unix it can have more than one flag. Each white space separated
6343 part is passed as an argument to the shell command.
6344 See |option-backslash| about including spaces and backslashes.
6345 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 This option cannot be set from a |modeline| or in the |sandbox|, for
6347 security reasons.
6348
6349 *'shellpipe'* *'sp'*
6350'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6351 global
6352 {not in Vi}
6353 {not available when compiled without the |+quickfix|
6354 feature}
6355 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006356 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006357 including spaces and backslashes.
6358 The name of the temporary file can be represented by "%s" if necessary
6359 (the file name is appended automatically if no %s appears in the value
6360 of this option).
6361 For the Amiga and MS-DOS the default is ">". The output is directly
6362 saved in a file and not echoed to the screen.
6363 For Unix the default it "| tee". The stdout of the compiler is saved
6364 in a file and echoed to the screen. If the 'shell' option is "csh" or
6365 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006366 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6367 default becomes "2>&1| tee". This means that stderr is also included.
6368 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6369 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 The initialization of this option is done after reading the ".vimrc"
6371 and the other initializations, so that when the 'shell' option is set
6372 there, the 'shellpipe' option changes automatically, unless it was
6373 explicitly set before.
6374 When 'shellpipe' is set to an empty string, no redirection of the
6375 ":make" output will be done. This is useful if you use a 'makeprg'
6376 that writes to 'makeef' by itself. If you want no piping, but do
6377 want to include the 'makeef', set 'shellpipe' to a single space.
6378 Don't forget to precede the space with a backslash: ":set sp=\ ".
6379 In the future pipes may be used for filtering and this option will
6380 become obsolete (at least for Unix).
6381 This option cannot be set from a |modeline| or in the |sandbox|, for
6382 security reasons.
6383
6384 *'shellquote'* *'shq'*
6385'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6386 contains "sh" somewhere: "\"")
6387 global
6388 {not in Vi}
6389 Quoting character(s), put around the command passed to the shell, for
6390 the "!" and ":!" commands. The redirection is kept outside of the
6391 quoting. See 'shellxquote' to include the redirection. It's
6392 probably not useful to set both options.
6393 This is an empty string by default. Only known to be useful for
6394 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6395 or bash, where it should be "\"". The default is adjusted according
6396 the value of 'shell', to reduce the need to set this option by the
6397 user. See |dos-shell|.
6398 This option cannot be set from a |modeline| or in the |sandbox|, for
6399 security reasons.
6400
6401 *'shellredir'* *'srr'*
6402'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6403 global
6404 {not in Vi}
6405 String to be used to put the output of a filter command in a temporary
6406 file. See also |:!|. See |option-backslash| about including spaces
6407 and backslashes.
6408 The name of the temporary file can be represented by "%s" if necessary
6409 (the file name is appended automatically if no %s appears in the value
6410 of this option).
6411 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6412 or "zsh" during initializations, the default becomes ">&". If the
6413 'shell' option is "sh", "ksh" or "bash" the default becomes
6414 ">%s 2>&1". This means that stderr is also included.
6415 For Win32, the Unix checks are done and additionally "cmd" is checked
6416 for, which makes the default ">%s 2>&1". Also, the same names with
6417 ".exe" appended are checked for.
6418 The initialization of this option is done after reading the ".vimrc"
6419 and the other initializations, so that when the 'shell' option is set
6420 there, the 'shellredir' option changes automatically unless it was
6421 explicitly set before.
6422 In the future pipes may be used for filtering and this option will
6423 become obsolete (at least for Unix).
6424 This option cannot be set from a |modeline| or in the |sandbox|, for
6425 security reasons.
6426
6427 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6428'shellslash' 'ssl' boolean (default off)
6429 global
6430 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6431 When set, a forward slash is used when expanding file names. This is
6432 useful when a Unix-like shell is used instead of command.com or
6433 cmd.exe. Backward slashes can still be typed, but they are changed to
6434 forward slashes by Vim.
6435 Note that setting or resetting this option has no effect for some
6436 existing file names, thus this option needs to be set before opening
6437 any file for best results. This might change in the future.
6438 'shellslash' only works when a backslash can be used as a path
6439 separator. To test if this is so use: >
6440 if exists('+shellslash')
6441<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006442 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6443'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6444 global
6445 {not in Vi}
6446 When on, use temp files for shell commands. When off use a pipe.
6447 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006448 Currently a pipe is only supported on Unix and MS-Windows 2K and
6449 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006450 :if has("filterpipe")
6451< The advantage of using a pipe is that nobody can read the temp file
6452 and the 'shell' command does not need to support redirection.
6453 The advantage of using a temp file is that the file type and encoding
6454 can be detected.
6455 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6456 |FilterWritePost| autocommands event are not triggered when
6457 'shelltemp' is off.
6458
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459 *'shelltype'* *'st'*
6460'shelltype' 'st' number (default 0)
6461 global
6462 {not in Vi} {only for the Amiga}
6463 On the Amiga this option influences the way how the commands work
6464 which use a shell.
6465 0 and 1: always use the shell
6466 2 and 3: use the shell only to filter lines
6467 4 and 5: use shell only for ':sh' command
6468 When not using the shell, the command is executed directly.
6469
6470 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6471 1 and 3: use "shell cmd" to start external commands
6472
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006473 *'shellxescape'* *'sxe'*
6474'shellxescape' 'sxe' string (default: "";
6475 for MS-DOS and MS-Windows: "\"&|<>()@^")
6476 global
6477 {not in Vi}
6478 When 'shellxquote' is set to "(" then the characters listed in this
6479 option will be escaped with a '^' character. This makes it possible
6480 to execute most external commands with cmd.exe.
6481
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 *'shellxquote'* *'sxq'*
6483'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006484 for Win32, when 'shell' is cmd.exe: "("
6485 for Win32, when 'shell' contains "sh"
6486 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 for Unix, when using system(): "\"")
6488 global
6489 {not in Vi}
6490 Quoting character(s), put around the command passed to the shell, for
6491 the "!" and ":!" commands. Includes the redirection. See
6492 'shellquote' to exclude the redirection. It's probably not useful
6493 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006494 When the value is '(' then ')' is appended. When the value is '"('
6495 then ')"' is appended.
6496 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006497 This is an empty string by default on most systems, but is known to be
6498 useful for on Win32 version, either for cmd.exe which automatically
6499 strips off the first and last quote on a command, or 3rd-party shells
6500 such as the MKS Korn Shell or bash, where it should be "\"". The
6501 default is adjusted according the value of 'shell', to reduce the need
6502 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 This option cannot be set from a |modeline| or in the |sandbox|, for
6504 security reasons.
6505
6506 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6507'shiftround' 'sr' boolean (default off)
6508 global
6509 {not in Vi}
6510 Round indent to multiple of 'shiftwidth'. Applies to > and <
6511 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6512 a multiple of 'shiftwidth' (this is Vi compatible).
6513 NOTE: This option is reset when 'compatible' is set.
6514
6515 *'shiftwidth'* *'sw'*
6516'shiftwidth' 'sw' number (default 8)
6517 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006518 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006520 When zero the 'ts' value will be used. Use the |shiftwidth()|
6521 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522
6523 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006524'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6525 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 global
6527 {not in Vi}
6528 This option helps to avoid all the |hit-enter| prompts caused by file
6529 messages, for example with CTRL-G, and to avoid some other messages.
6530 It is a list of flags:
6531 flag meaning when present ~
6532 f use "(3 of 5)" instead of "(file 3 of 5)"
6533 i use "[noeol]" instead of "[Incomplete last line]"
6534 l use "999L, 888C" instead of "999 lines, 888 characters"
6535 m use "[+]" instead of "[Modified]"
6536 n use "[New]" instead of "[New File]"
6537 r use "[RO]" instead of "[readonly]"
6538 w use "[w]" instead of "written" for file write message
6539 and "[a]" instead of "appended" for ':w >> file' command
6540 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6541 "[unix format]" and "[mac]" instead of "[mac format]".
6542 a all of the above abbreviations
6543
6544 o overwrite message for writing a file with subsequent message
6545 for reading a file (useful for ":wn" or when 'autowrite' on)
6546 O message for reading a file overwrites any previous message.
6547 Also for quickfix message (e.g., ":cn").
6548 s don't give "search hit BOTTOM, continuing at TOP" or "search
6549 hit TOP, continuing at BOTTOM" messages
6550 t truncate file message at the start if it is too long to fit
6551 on the command-line, "<" will appear in the left most column.
6552 Ignored in Ex mode.
6553 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006554 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 Ignored in Ex mode.
6556 W don't give "written" or "[w]" when writing a file
6557 A don't give the "ATTENTION" message when an existing swap file
6558 is found.
6559 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006560 c don't give |ins-completion-menu| messages. For example,
6561 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6562 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006563 q use "recording" instead of "recording @a"
6564 F don't give the file info when editing a file, like `:silent`
6565 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566
6567 This gives you the opportunity to avoid that a change between buffers
6568 requires you to hit <Enter>, but still gives as useful a message as
6569 possible for the space available. To get the whole message that you
6570 would have got with 'shm' empty, use ":file!"
6571 Useful values:
6572 shm= No abbreviation of message.
6573 shm=a Abbreviation, but no loss of information.
6574 shm=at Abbreviation, and truncate message when necessary.
6575
6576 NOTE: This option is set to the Vi default value when 'compatible' is
6577 set and to the Vim default value when 'compatible' is reset.
6578
6579 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6580'shortname' 'sn' boolean (default off)
6581 local to buffer
6582 {not in Vi, not in MS-DOS versions}
6583 Filenames are assumed to be 8 characters plus one extension of 3
6584 characters. Multiple dots in file names are not allowed. When this
6585 option is on, dots in file names are replaced with underscores when
6586 adding an extension (".~" or ".swp"). This option is not available
6587 for MS-DOS, because then it would always be on. This option is useful
6588 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6589 or crossdos. When running the Win32 GUI version under Win32s, this
6590 option is always on by default.
6591
6592 *'showbreak'* *'sbr'* *E595*
6593'showbreak' 'sbr' string (default "")
6594 global
6595 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006596 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 feature}
6598 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006599 values are "> " or "+++ ": >
6600 :set showbreak=>\
6601< Note the backslash to escape the trailing space. It's easier like
6602 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006603 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006604< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 comma (in a future version the comma might be used to separate the
6606 part that is shown at the end and at the start of a line).
6607 The characters are highlighted according to the '@' flag in
6608 'highlight'.
6609 Note that tabs after the showbreak will be displayed differently.
6610 If you want the 'showbreak' to appear in between line numbers, add the
6611 "n" flag to 'cpoptions'.
6612
6613 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6614'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6615 off)
6616 global
6617 {not in Vi}
6618 {not available when compiled without the
6619 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006620 Show (partial) command in the last line of the screen. Set this
6621 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 In Visual mode the size of the selected area is shown:
6623 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006624 If the number of bytes is different it is also displayed: "2-6"
6625 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006627 - When selecting a block, the size in screen characters:
6628 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 NOTE: This option is set to the Vi default value when 'compatible' is
6630 set and to the Vim default value when 'compatible' is reset.
6631
6632 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6633'showfulltag' 'sft' boolean (default off)
6634 global
6635 {not in Vi}
6636 When completing a word in insert mode (see |ins-completion|) from the
6637 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006638 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 matched a C function, you can see a template for what arguments are
6640 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006641 Note that this doesn't work well together with having "longest" in
6642 'completeopt', because the completion from the search pattern may not
6643 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644
6645 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6646'showmatch' 'sm' boolean (default off)
6647 global
6648 When a bracket is inserted, briefly jump to the matching one. The
6649 jump is only done if the match can be seen on the screen. The time to
6650 show the match can be set with 'matchtime'.
6651 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006652 seen or not).
6653 This option is reset when 'paste' is set and restored when 'paste' is
6654 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 When the 'm' flag is not included in 'cpoptions', typing a character
6656 will immediately move the cursor back to where it belongs.
6657 See the "sm" field in 'guicursor' for setting the cursor shape and
6658 blinking when showing the match.
6659 The 'matchpairs' option can be used to specify the characters to show
6660 matches for. 'rightleft' and 'revins' are used to look for opposite
6661 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006662 Also see the matchparen plugin for highlighting the match when moving
6663 around |pi_paren.txt|.
6664 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665
6666 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6667'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6668 global
6669 If in Insert, Replace or Visual mode put a message on the last line.
6670 Use the 'M' flag in 'highlight' to set the type of highlighting for
6671 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006672 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 doesn't mean XIM is really active, especially when 'imactivatekey' is
6674 not set.
6675 NOTE: This option is set to the Vi default value when 'compatible' is
6676 set and to the Vim default value when 'compatible' is reset.
6677
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006678 *'showtabline'* *'stal'*
6679'showtabline' 'stal' number (default 1)
6680 global
6681 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006682 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006683 feature}
6684 The value of this option specifies when the line with tab page labels
6685 will be displayed:
6686 0: never
6687 1: only if there are at least two tab pages
6688 2: always
6689 This is both for the GUI and non-GUI implementation of the tab pages
6690 line.
6691 See |tab-page| for more information about tab pages.
6692
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 *'sidescroll'* *'ss'*
6694'sidescroll' 'ss' number (default 0)
6695 global
6696 {not in Vi}
6697 The minimal number of columns to scroll horizontally. Used only when
6698 the 'wrap' option is off and the cursor is moved off of the screen.
6699 When it is zero the cursor will be put in the middle of the screen.
6700 When using a slow terminal set it to a large number or 0. When using
6701 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6702 commands.
6703
6704 *'sidescrolloff'* *'siso'*
6705'sidescrolloff' 'siso' number (default 0)
6706 global
6707 {not in Vi}
6708 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006709 right of the cursor if 'nowrap' is set. Setting this option to a
6710 value greater than 0 while having |'sidescroll'| also at a non-zero
6711 value makes some context visible in the line you are scrolling in
6712 horizontally (except at beginning of the line). Setting this option
6713 to a large value (like 999) has the effect of keeping the cursor
6714 horizontally centered in the window, as long as one does not come too
6715 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 NOTE: This option is set to 0 when 'compatible' is set.
6717
6718 Example: Try this together with 'sidescroll' and 'listchars' as
6719 in the following example to never allow the cursor to move
6720 onto the "extends" character:
6721
6722 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6723 :set sidescrolloff=1
6724
6725
6726 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6727'smartcase' 'scs' boolean (default off)
6728 global
6729 {not in Vi}
6730 Override the 'ignorecase' option if the search pattern contains upper
6731 case characters. Only used when the search pattern is typed and
6732 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006733 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6735 recalling the search pattern from history and hitting <Enter>.
6736 NOTE: This option is reset when 'compatible' is set.
6737
6738 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6739'smartindent' 'si' boolean (default off)
6740 local to buffer
6741 {not in Vi}
6742 {not available when compiled without the
6743 |+smartindent| feature}
6744 Do smart autoindenting when starting a new line. Works for C-like
6745 programs, but can also be used for other languages. 'cindent' does
6746 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006747 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006748 setting 'si' has no effect. 'indentexpr' is a more advanced
6749 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 Normally 'autoindent' should also be on when using 'smartindent'.
6751 An indent is automatically inserted:
6752 - After a line ending in '{'.
6753 - After a line starting with a keyword from 'cinwords'.
6754 - Before a line starting with '}' (only with the "O" command).
6755 When typing '}' as the first character in a new line, that line is
6756 given the same indent as the matching '{'.
6757 When typing '#' as the first character in a new line, the indent for
6758 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006759 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6761 When using the ">>" command, lines starting with '#' are not shifted
6762 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006763 NOTE: 'smartindent' is reset when 'compatible' is set.
6764 This option is reset when 'paste' is set and restored when 'paste' is
6765 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766
6767 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6768'smarttab' 'sta' boolean (default off)
6769 global
6770 {not in Vi}
6771 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006772 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6773 <BS> will delete a 'shiftwidth' worth of space at the start of the
6774 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006775 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006776 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6777 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006778 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006780 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006781 This option is reset when 'paste' is set and restored when 'paste' is
6782 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 NOTE: This option is reset when 'compatible' is set.
6784
6785 *'softtabstop'* *'sts'*
6786'softtabstop' 'sts' number (default 0)
6787 local to buffer
6788 {not in Vi}
6789 Number of spaces that a <Tab> counts for while performing editing
6790 operations, like inserting a <Tab> or using <BS>. It "feels" like
6791 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6792 used. This is useful to keep the 'ts' setting at its standard value
6793 of 8, while being able to edit like it is set to 'sts'. However,
6794 commands like "x" still work on the actual characters.
6795 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006796 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006797 'softtabstop' is set to 0 when the 'paste' option is set and restored
6798 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6800 spaces is minimized by using <Tab>s.
6801 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6802 set.
6803 NOTE: This option is set to 0 when 'compatible' is set.
6804
Bram Moolenaar217ad922005-03-20 22:37:15 +00006805 *'spell'* *'nospell'*
6806'spell' boolean (default off)
6807 local to window
6808 {not in Vi}
6809 {not available when compiled without the |+syntax|
6810 feature}
6811 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006812 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006813
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006814 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006815'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006816 local to buffer
6817 {not in Vi}
6818 {not available when compiled without the |+syntax|
6819 feature}
6820 Pattern to locate the end of a sentence. The following word will be
6821 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006822 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006823 When this check is not wanted make this option empty.
6824 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006825 Be careful with special characters, see |option-backslash| about
6826 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006827 To set this option automatically depending on the language, see
6828 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006829
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006830 *'spellfile'* *'spf'*
6831'spellfile' 'spf' string (default empty)
6832 local to buffer
6833 {not in Vi}
6834 {not available when compiled without the |+syntax|
6835 feature}
6836 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006837 commands. It must end in ".{encoding}.add". You need to include the
6838 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006839 *E765*
6840 It may also be a comma separated list of names. A count before the
6841 |zg| and |zw| commands can be used to access each. This allows using
6842 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006843 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006844 you: Using the first directory in 'runtimepath' that is writable. If
6845 there is no "spell" directory yet it will be created. For the file
6846 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006847 ignoring the region.
6848 The resulting ".spl" file will be used for spell checking, it does not
6849 have to appear in 'spelllang'.
6850 Normally one file is used for all regions, but you can add the region
6851 name if you want to. However, it will then only be used when
6852 'spellfile' is set to it, for entries in 'spelllang' only files
6853 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006854 This option cannot be set from a |modeline| or in the |sandbox|, for
6855 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006856
Bram Moolenaar217ad922005-03-20 22:37:15 +00006857 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006858'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006859 local to buffer
6860 {not in Vi}
6861 {not available when compiled without the |+syntax|
6862 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006863 A comma separated list of word list names. When the 'spell' option is
6864 on spellchecking will be done for these languages. Example: >
6865 set spelllang=en_us,nl,medical
6866< This means US English, Dutch and medical words are recognized. Words
6867 that are not recognized will be highlighted.
6868 The word list name must not include a comma or dot. Using a dash is
6869 recommended to separate the two letter language name from a
6870 specification. Thus "en-rare" is used for rare English words.
6871 A region name must come last and have the form "_xx", where "xx" is
6872 the two-letter, lower case region name. You can use more than one
6873 region by listing them: "en_us,en_ca" supports both US and Canadian
6874 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006875 Britain. (Note: currently en_au and en_nz dictionaries are older than
6876 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006877 If the name "cjk" is included East Asian characters are excluded from
6878 spell checking. This is useful when editing text that also has Asian
6879 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006880 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006881 As a special case the name of a .spl file can be given as-is. The
6882 first "_xx" in the name is removed and used as the region name
6883 (_xx is an underscore, two letters and followed by a non-letter).
6884 This is mainly for testing purposes. You must make sure the correct
6885 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006886 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006887 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6888 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006889 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006890
Bram Moolenaar98692072006-02-04 00:57:42 +00006891 If the |spellfile.vim| plugin is active and you use a language name
6892 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6893 will ask you if you want to download the file.
6894
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006895 After this option has been set successfully, Vim will source the files
6896 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006897 up to the first comma, dot or underscore.
6898 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006899
6900
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006901 *'spellsuggest'* *'sps'*
6902'spellsuggest' 'sps' string (default "best")
6903 global
6904 {not in Vi}
6905 {not available when compiled without the |+syntax|
6906 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006907 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006908 the |spellsuggest()| function. This is a comma-separated list of
6909 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006910
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006911 best Internal method that works best for English. Finds
6912 changes like "fast" and uses a bit of sound-a-like
6913 scoring to improve the ordering.
6914
6915 double Internal method that uses two methods and mixes the
6916 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006917 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006918 word. That only works when the language specifies
6919 sound folding. Can be slow and doesn't always give
6920 better results.
6921
6922 fast Internal method that only checks for simple changes:
6923 character inserts/deletes/swaps. Works well for
6924 simple typing mistakes.
6925
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006926 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006927 Not used for |spellsuggest()|. The number of
6928 suggestions is never more than the value of 'lines'
6929 minus two.
6930
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006931 file:{filename} Read file {filename}, which must have two columns,
6932 separated by a slash. The first column contains the
6933 bad word, the second column the suggested good word.
6934 Example:
6935 theribal/terrible ~
6936 Use this for common mistakes that do not appear at the
6937 top of the suggestion list with the internal methods.
6938 Lines without a slash are ignored, use this for
6939 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006940 The word in the second column must be correct,
6941 otherwise it will not be used. Add the word to an
6942 ".add" file if it is currently flagged as a spelling
6943 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006944 The file is used for all languages.
6945
6946 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6947 trouble with spaces. |v:val| holds the badly spelled
6948 word. The expression must evaluate to a List of
6949 Lists, each with a suggestion and a score.
6950 Example:
6951 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006952 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006953 internal methods use. A lower score is better.
6954 This may invoke |spellsuggest()| if you temporarily
6955 set 'spellsuggest' to exclude the "expr:" part.
6956 Errors are silently ignored, unless you set the
6957 'verbose' option to a non-zero value.
6958
6959 Only one of "best", "double" or "fast" may be used. The others may
6960 appear several times in any order. Example: >
6961 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6962<
6963 This option cannot be set from a |modeline| or in the |sandbox|, for
6964 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006965
6966
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6968'splitbelow' 'sb' boolean (default off)
6969 global
6970 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006971 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 feature}
6973 When on, splitting a window will put the new window below the current
6974 one. |:split|
6975
6976 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6977'splitright' 'spr' boolean (default off)
6978 global
6979 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006980 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 feature}
6982 When on, splitting a window will put the new window right of the
6983 current one. |:vsplit|
6984
6985 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6986'startofline' 'sol' boolean (default on)
6987 global
6988 {not in Vi}
6989 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006990 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006991 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006992 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 with a linewise operator, with "%" with a count and to buffer changing
6994 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6995 only has a line number, e.g., ":25" or ":+".
6996 In case of buffer changing commands the cursor is placed at the column
6997 where it was the last time the buffer was edited.
6998 NOTE: This option is set when 'compatible' is set.
6999
Bram Moolenaar00654022011-02-25 14:42:19 +01007000 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007002 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 {not in Vi}
7004 {not available when compiled without the |+statusline|
7005 feature}
7006 When nonempty, this option determines the content of the status line.
7007 Also see |status-line|.
7008
7009 The option consists of printf style '%' items interspersed with
7010 normal text. Each status line item is of the form:
7011 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007012 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007013 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014
Bram Moolenaar238a5642006-02-21 22:12:05 +00007015 When the option starts with "%!" then it is used as an expression,
7016 evaluated and the result is used as the option value. Example: >
7017 :set statusline=%!MyStatusLine()
7018< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007019 Note that the "%!" expression is evaluated in the context of the
7020 current window and buffer, while %{} items are evaluated in the
7021 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007022
7023 When there is error while evaluating the option then it will be made
7024 empty to avoid further errors. Otherwise screen updating would loop.
7025
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 Note that the only effect of 'ruler' when this option is set (and
7027 'laststatus' is 2) is controlling the output of |CTRL-G|.
7028
7029 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007030 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007031 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007032 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007033 minwid Minimum width of the item, padding as set by '-' & '0'.
7034 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007035 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007036 on the left for text items. Numeric items will be
7037 shifted down to maxwid-2 digits followed by '>'number
7038 where number is the amount of missing digits, much like
7039 an exponential notation.
7040 item A one letter code as described below.
7041
7042 Following is a description of the possible statusline items. The
7043 second character in "item" is the type:
7044 N for number
7045 S for string
7046 F for flags as described below
7047 - not applicable
7048
7049 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007050 f S Path to the file in the buffer, as typed or relative to current
7051 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 F S Full path to the file in the buffer.
7053 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007054 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007056 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007058 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007060 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007062 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7064 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007065 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7067 being used: "<keymap>"
7068 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007069 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 B N As above, in hexadecimal.
7071 o N Byte number in file of byte under cursor, first byte is 1.
7072 Mnemonic: Offset from start of file (with one added)
7073 {not available when compiled without |+byte_offset| feature}
7074 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007075 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007076 l N Line number.
7077 L N Number of lines in buffer.
7078 c N Column number.
7079 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007080 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081 p N Percentage through file in lines as in |CTRL-G|.
7082 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007083 percentage described for 'ruler'. Always 3 in length, unless
7084 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007085 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007087 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007088 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007089 ( - Start of item group. Can be used for setting the width and
7090 alignment of a section. Must be followed by %) somewhere.
7091 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007092 T N For 'tabline': start of tab page N label. Use %T after the last
7093 label. This information is used for mouse clicks.
7094 X N For 'tabline': start of close tab N label. Use %X after the
7095 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7096 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 < - Where to truncate line if too long. Default is at the start.
7098 No width fields allowed.
7099 = - Separation point between left and right aligned items.
7100 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007101 # - Set highlight group. The name must follow and then a # again.
7102 Thus use %#HLname# for highlight group HLname. The same
7103 highlighting is used, also for the statusline of non-current
7104 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007106 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 The difference between User{N} and StatusLine will be applied
7108 to StatusLineNC for the statusline of non-current windows.
7109 The number N must be between 1 and 9. See |hl-User1..9|
7110
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007111 When displaying a flag, Vim removes the leading comma, if any, when
7112 that flag comes right after plaintext. This will make a nice display
7113 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114
Bram Moolenaar582fd852005-03-28 20:58:01 +00007115 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 not set) and a minwid is not set for the group, the whole group will
7117 become empty. This will make a group like the following disappear
7118 completely from the statusline when none of the flags are set. >
7119 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007120< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 Beware that an expression is evaluated each and every time the status
7122 line is displayed. The current buffer and current window will be set
7123 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007124 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007126 real current buffer.
7127
Bram Moolenaar30b65812012-07-12 22:01:11 +02007128 The 'statusline' option will be evaluated in the |sandbox| if set from
7129 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007130
7131 It is not allowed to change text or jump to another window while
7132 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133
7134 If the statusline is not updated when you want it (e.g., after setting
7135 a variable that's used in an expression), you can force an update by
7136 setting an option without changing its value. Example: >
7137 :let &ro = &ro
7138
7139< A result of all digits is regarded a number for display purposes.
7140 Otherwise the result is taken as flag text and applied to the rules
7141 described above.
7142
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007143 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007144 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7145 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7146
7147 Examples:
7148 Emulate standard status line with 'ruler' set >
7149 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7150< Similar, but add ASCII value of char under the cursor (like "ga") >
7151 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7152< Display byte count and byte value, modified flag in red. >
7153 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7154 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7155< Display a ,GZ flag if a compressed file is loaded >
7156 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7157< In the |:autocmd|'s: >
7158 :let b:gzflag = 1
7159< And: >
7160 :unlet b:gzflag
7161< And define this function: >
7162 :function VarExists(var, val)
7163 : if exists(a:var) | return a:val | else | return '' | endif
7164 :endfunction
7165<
7166 *'suffixes'* *'su'*
7167'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7168 global
7169 {not in Vi}
7170 Files with these suffixes get a lower priority when multiple files
7171 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007172 suffixes. Spaces after the comma are ignored. A dot is also seen as
7173 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 separator, precede it with a backslash (see |option-backslash| about
7175 including spaces and backslashes).
7176 See 'wildignore' for completely ignoring files.
7177 The use of |:set+=| and |:set-=| is preferred when adding or removing
7178 suffixes from the list. This avoids problems when a future version
7179 uses another default.
7180
7181 *'suffixesadd'* *'sua'*
7182'suffixesadd' 'sua' string (default "")
7183 local to buffer
7184 {not in Vi}
7185 {not available when compiled without the
7186 |+file_in_path| feature}
7187 Comma separated list of suffixes, which are used when searching for a
7188 file for the "gf", "[I", etc. commands. Example: >
7189 :set suffixesadd=.java
7190<
7191 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7192'swapfile' 'swf' boolean (default on)
7193 local to buffer
7194 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007195 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 swapfile is not wanted for a specific buffer. For example, with
7197 confidential information that even root must not be able to access.
7198 Careful: All text will be in memory:
7199 - Don't use this for big files.
7200 - Recovery will be impossible!
7201 A swapfile will only be present when |'updatecount'| is non-zero and
7202 'swapfile' is set.
7203 When 'swapfile' is reset, the swap file for the current buffer is
7204 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7205 non-zero, a swap file is immediately created.
7206 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007207 If you want to open a new buffer without creating a swap file for it,
7208 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209
7210 This option is used together with 'bufhidden' and 'buftype' to
7211 specify special kinds of buffers. See |special-buffers|.
7212
7213 *'swapsync'* *'sws'*
7214'swapsync' 'sws' string (default "fsync")
7215 global
7216 {not in Vi}
7217 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007218 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 When this option is empty parts of the swap file may be in memory and
7220 not written to disk. When the system crashes you may lose more work.
7221 On Unix the system does a sync now and then without Vim asking for it,
7222 so the disadvantage of setting this option off is small. On some
7223 systems the swap file will not be written at all. For a unix system
7224 setting it to "sync" will use the sync() call instead of the default
7225 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007226 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227
7228 *'switchbuf'* *'swb'*
7229'switchbuf' 'swb' string (default "")
7230 global
7231 {not in Vi}
7232 This option controls the behavior when switching between buffers.
7233 Possible values (comma separated list):
7234 useopen If included, jump to the first open window that
7235 contains the specified buffer (if there is one).
7236 Otherwise: Do not examine other windows.
7237 This setting is checked with |quickfix| commands, when
7238 jumping to errors (":cc", ":cn", "cp", etc.). It is
7239 also used in all buffer related split commands, for
7240 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007241 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007242 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007244 a buffer for a |quickfix| command that display errors.
7245 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007246 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007247 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007248 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007250 *'synmaxcol'* *'smc'*
7251'synmaxcol' 'smc' number (default 3000)
7252 local to buffer
7253 {not in Vi}
7254 {not available when compiled without the |+syntax|
7255 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007256 Maximum column in which to search for syntax items. In long lines the
7257 text after this column is not highlighted and following lines may not
7258 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007259 This helps to avoid very slow redrawing for an XML file that is one
7260 long line.
7261 Set to zero to remove the limit.
7262
Bram Moolenaar071d4272004-06-13 20:20:40 +00007263 *'syntax'* *'syn'*
7264'syntax' 'syn' string (default empty)
7265 local to buffer
7266 {not in Vi}
7267 {not available when compiled without the |+syntax|
7268 feature}
7269 When this option is set, the syntax with this name is loaded, unless
7270 syntax highlighting has been switched off with ":syntax off".
7271 Otherwise this option does not always reflect the current syntax (the
7272 b:current_syntax variable does).
7273 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007274 not automatically recognized. Example, in an IDL file:
7275 /* vim: set syntax=idl : */ ~
7276 When a dot appears in the value then this separates two filetype
7277 names. Example:
7278 /* vim: set syntax=c.doxygen : */ ~
7279 This will use the "c" syntax first, then the "doxygen" syntax.
7280 Note that the second one must be prepared to be loaded as an addition,
7281 otherwise it will be skipped. More than one dot may appear.
7282 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 :set syntax=OFF
7284< To switch syntax highlighting on according to the current value of the
7285 'filetype' option: >
7286 :set syntax=ON
7287< What actually happens when setting the 'syntax' option is that the
7288 Syntax autocommand event is triggered with the value as argument.
7289 This option is not copied to another buffer, independent of the 's' or
7290 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007291 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007293 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007294'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007295 global
7296 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007297 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007298 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007299 When nonempty, this option determines the content of the tab pages
7300 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007301 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007302
7303 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007304 option and only when there is no GUI tab line. When 'e' is in
7305 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007306 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007307
7308 The value is evaluated like with 'statusline'. You can use
7309 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007310 the text to be displayed. Use "%1T" for the first label, "%2T" for
7311 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007312
7313 Keep in mind that only one of the tab pages is the current one, others
7314 are invisible and you can't jump to their windows.
7315
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007316
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007317 *'tabpagemax'* *'tpm'*
7318'tabpagemax' 'tpm' number (default 10)
7319 global
7320 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007321 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007322 feature}
7323 Maximum number of tab pages to be opened by the |-p| command line
7324 argument or the ":tab all" command. |tabpage|
7325
7326
7327 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328'tabstop' 'ts' number (default 8)
7329 local to buffer
7330 Number of spaces that a <Tab> in the file counts for. Also see
7331 |:retab| command, and 'softtabstop' option.
7332
7333 Note: Setting 'tabstop' to any other value than 8 can make your file
7334 appear wrong in many places (e.g., when printing it).
7335
7336 There are four main ways to use tabs in Vim:
7337 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7338 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007339 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 behave like a tab appears every 4 (or 3) characters.
7341 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7342 'expandtab'. This way you will always insert spaces. The
7343 formatting will never be messed up when 'tabstop' is changed.
7344 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007345 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 works when using Vim to edit the file.
7347 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7348 'noexpandtab'. This should then work (for initial indents only)
7349 for any tabstop setting that people use. It might be nice to have
7350 tabs after the first non-blank inserted as spaces if you do this
7351 though. Otherwise aligned comments will be wrong when 'tabstop' is
7352 changed.
7353
7354 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7355'tagbsearch' 'tbs' boolean (default on)
7356 global
7357 {not in Vi}
7358 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007359 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 searching makes searching for a tag a LOT faster, but a linear search
7361 will find more tags if the tags file wasn't properly sorted.
7362 Vim normally assumes that your tags files are sorted, or indicate that
7363 they are not sorted. Only when this is not the case does the
7364 'tagbsearch' option need to be switched off.
7365
7366 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007367 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 certain files, or retry all files with a linear search. When
7369 'tagbsearch' is off, only a linear search is done.
7370
7371 Linear searching is done anyway, for one file, when Vim finds a line
7372 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007373 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374< [The whitespace before and after the '0' must be a single <Tab>]
7375
7376 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007377 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 instead of a normal tag name, a retry is done with a linear search.
7379 Tags in unsorted tags files, and matches with different case will only
7380 be found in the retry.
7381
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007382 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007383 linear search can be avoided when case is ignored. Use a value of '2'
7384 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7385 sorted with the -f switch to "sort" in most unices, as in the command:
7386 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7387 (at least 5.5) the --sort=foldcase switch can be used for this as
7388 well. Note that case must be folded to uppercase for this to work.
7389
7390 By default, tag searches are case-sensitive. Case is ignored when
7391 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7392 "ignore".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393
7394 When 'tagbsearch' is off, tags searching is slower when a full match
7395 exists, but faster when no full match exists. Tags in unsorted tags
7396 files may only be found with 'tagbsearch' off.
7397 When the tags file is not sorted, or sorted in a wrong way (not on
7398 ASCII byte value), 'tagbsearch' should be off, or the line given above
7399 must be included in the tags file.
7400 This option doesn't affect commands that find all matching tags (e.g.,
7401 command-line completion and ":help").
7402 {Vi: always uses binary search in some versions}
7403
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007404 *'tagcase'* *'tc'*
7405'tagcase' 'tc' string (default "followic")
7406 global or local to buffer |global-local|
7407 {not in Vi}
7408 This option specifies how case is handled when searching the tags
7409 file:
7410 followic Follow the 'ignorecase' option
7411 ignore Ignore case
7412 match Match case
7413
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 *'taglength'* *'tl'*
7415'taglength' 'tl' number (default 0)
7416 global
7417 If non-zero, tags are significant up to this number of characters.
7418
7419 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7420'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7421 global
7422 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007423 If on and using a tags file in another directory, file names in that
7424 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 NOTE: This option is set to the Vi default value when 'compatible' is
7426 set and to the Vim default value when 'compatible' is reset.
7427
7428 *'tags'* *'tag'* *E433*
7429'tags' 'tag' string (default "./tags,tags", when compiled with
7430 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7431 global or local to buffer |global-local|
7432 Filenames for the tag command, separated by spaces or commas. To
7433 include a space or comma in a file name, precede it with a backslash
7434 (see |option-backslash| about including spaces and backslashes).
7435 When a file name starts with "./", the '.' is replaced with the path
7436 of the current file. But only when the 'd' flag is not included in
7437 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7438 |tags-option|.
7439 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007440 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7441 find all files named "tags" below "/lib". The filename itself cannot
7442 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7443 files called "tags?". {not available when compiled without the
7444 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007445 The |tagfiles()| function can be used to get a list of the file names
7446 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7448 files are also supported. They are automatically recognized. The
7449 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7450 differences are ignored (MS-Windows). |emacs-tags|
7451 The use of |:set+=| and |:set-=| is preferred when adding or removing
7452 file names from the list. This avoids problems when a future version
7453 uses another default.
7454 {Vi: default is "tags /usr/lib/tags"}
7455
7456 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7457'tagstack' 'tgst' boolean (default on)
7458 global
7459 {not in all versions of Vi}
7460 When on, the |tagstack| is used normally. When off, a ":tag" or
7461 ":tselect" command with an argument will not push the tag onto the
7462 tagstack. A following ":tag" without an argument, a ":pop" command or
7463 any other command that uses the tagstack will use the unmodified
7464 tagstack, but does change the pointer to the active entry.
7465 Resetting this option is useful when using a ":tag" command in a
7466 mapping which should not change the tagstack.
7467
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007468 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007469'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007470 global
7471 {not in Vi}
7472 {only available when compiled with the |+tcl/dyn|
7473 feature}
7474 Specifies the name of the Tcl shared library. The default is
7475 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007476 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007477 This option cannot be set from a |modeline| or in the |sandbox|, for
7478 security reasons.
7479
Bram Moolenaar071d4272004-06-13 20:20:40 +00007480 *'term'* *E529* *E530* *E531*
7481'term' string (default is $TERM, if that fails:
7482 in the GUI: "builtin_gui"
7483 on Amiga: "amiga"
7484 on BeOS: "beos-ansi"
7485 on Mac: "mac-ansi"
7486 on MiNT: "vt52"
7487 on MS-DOS: "pcterm"
7488 on OS/2: "os2ansi"
7489 on Unix: "ansi"
7490 on VMS: "ansi"
7491 on Win 32: "win32")
7492 global
7493 Name of the terminal. Used for choosing the terminal control
7494 characters. Environment variables are expanded |:set_env|.
7495 For example: >
7496 :set term=$TERM
7497< See |termcap|.
7498
7499 *'termbidi'* *'tbidi'*
7500 *'notermbidi'* *'notbidi'*
7501'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7502 global
7503 {not in Vi}
7504 {only available when compiled with the |+arabic|
7505 feature}
7506 The terminal is in charge of Bi-directionality of text (as specified
7507 by Unicode). The terminal is also expected to do the required shaping
7508 that some languages (such as Arabic) require.
7509 Setting this option implies that 'rightleft' will not be set when
7510 'arabic' is set and the value of 'arabicshape' will be ignored.
7511 Note that setting 'termbidi' has the immediate effect that
7512 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7513 This option is reset when the GUI is started.
7514 For further details see |arabic.txt|.
7515
7516 *'termencoding'* *'tenc'*
7517'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7518 Macintosh GUI: "macroman")
7519 global
7520 {only available when compiled with the |+multi_byte|
7521 feature}
7522 {not in Vi}
7523 Encoding used for the terminal. This specifies what character
7524 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007525 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007526 display). Except for the Mac when 'macatsui' is off, then
7527 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 *E617*
7529 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7530 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7531 Any attempts to set a different value will be rejected, and an error
7532 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007533 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007534 because the Win32 system always passes Unicode characters.
7535 When empty, the same encoding is used as for the 'encoding' option.
7536 This is the normal value.
7537 Not all combinations for 'termencoding' and 'encoding' are valid. See
7538 |encoding-table|.
7539 The value for this option must be supported by internal conversions or
7540 iconv(). When this is not possible no conversion will be done and you
7541 will probably experience problems with non-ASCII characters.
7542 Example: You are working with the locale set to euc-jp (Japanese) and
7543 want to edit a UTF-8 file: >
7544 :let &termencoding = &encoding
7545 :set encoding=utf-8
7546< You need to do this when your system has no locale support for UTF-8.
7547
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007548 *'termguicolors'* *'tgc'*
7549'termguicolors' 'tgc' boolean (default off)
7550 global
7551 {not in Vi}
7552 {not available when compiled without the
7553 |+termguicolors| feature}
7554 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7555 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7556 compatible terminal.
7557 If setting this option does not work (produces a colorless UI)
7558 reading |xterm-true-color| might help.
7559
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 *'terse'* *'noterse'*
7561'terse' boolean (default off)
7562 global
7563 When set: Add 's' flag to 'shortmess' option (this makes the message
7564 for a search that hits the start or end of the file not being
7565 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7566 shortens a lot of messages}
7567
7568 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7569'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7570 global
7571 {not in Vi}
7572 This option is obsolete. Use 'fileformats'.
7573 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7574 set to the default value for the current system. When 'textauto' is
7575 reset, 'fileformats' is made empty.
7576 NOTE: This option is set to the Vi default value when 'compatible' is
7577 set and to the Vim default value when 'compatible' is reset.
7578
7579 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7580'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7581 others: default off)
7582 local to buffer
7583 {not in Vi}
7584 This option is obsolete. Use 'fileformat'.
7585 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7586 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7587 "unix".
7588
7589 *'textwidth'* *'tw'*
7590'textwidth' 'tw' number (default 0)
7591 local to buffer
7592 {not in Vi}
7593 Maximum width of text that is being inserted. A longer line will be
7594 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007595 this.
7596 'textwidth' is set to 0 when the 'paste' option is set and restored
7597 when 'paste' is reset.
7598 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007600 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 NOTE: This option is set to 0 when 'compatible' is set.
7602
7603 *'thesaurus'* *'tsr'*
7604'thesaurus' 'tsr' string (default "")
7605 global or local to buffer |global-local|
7606 {not in Vi}
7607 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007608 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 the file should contain words with similar meaning, separated by
7610 non-keyword characters (white space is preferred). Maximum line
7611 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007612 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007613 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007614 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007615 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 after a comma are ignored, otherwise spaces are included in the file
7617 name. See |option-backslash| about using backslashes.
7618 The use of |:set+=| and |:set-=| is preferred when adding or removing
7619 directories from the list. This avoids problems when a future version
7620 uses another default.
7621 Backticks cannot be used in this option for security reasons.
7622
7623 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7624'tildeop' 'top' boolean (default off)
7625 global
7626 {not in Vi}
7627 When on: The tilde command "~" behaves like an operator.
7628 NOTE: This option is reset when 'compatible' is set.
7629
7630 *'timeout'* *'to'* *'notimeout'* *'noto'*
7631'timeout' 'to' boolean (default on)
7632 global
7633 *'ttimeout'* *'nottimeout'*
7634'ttimeout' boolean (default off)
7635 global
7636 {not in Vi}
7637 These two options together determine the behavior when part of a
7638 mapped key sequence or keyboard code has been received:
7639
7640 'timeout' 'ttimeout' action ~
7641 off off do not time out
7642 on on or off time out on :mappings and key codes
7643 off on time out on key codes
7644
7645 If both options are off, Vim will wait until either the complete
7646 mapping or key sequence has been received, or it is clear that there
7647 is no mapping or key sequence for the received characters. For
7648 example: if you have mapped "vl" and Vim has received 'v', the next
7649 character is needed to see if the 'v' is followed by an 'l'.
7650 When one of the options is on, Vim will wait for about 1 second for
7651 the next character to arrive. After that the already received
7652 characters are interpreted as single characters. The waiting time can
7653 be changed with the 'timeoutlen' option.
7654 On slow terminals or very busy systems timing out may cause
7655 malfunctioning cursor keys. If both options are off, Vim waits
7656 forever after an entered <Esc> if there are key codes that start
7657 with <Esc>. You will have to type <Esc> twice. If you do not have
7658 problems with key codes, but would like to have :mapped key
7659 sequences not timing out in 1 second, set the 'ttimeout' option and
7660 reset the 'timeout' option.
7661
7662 NOTE: 'ttimeout' is reset when 'compatible' is set.
7663
7664 *'timeoutlen'* *'tm'*
7665'timeoutlen' 'tm' number (default 1000)
7666 global
7667 {not in all versions of Vi}
7668 *'ttimeoutlen'* *'ttm'*
7669'ttimeoutlen' 'ttm' number (default -1)
7670 global
7671 {not in Vi}
7672 The time in milliseconds that is waited for a key code or mapped key
7673 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7674 when part of a command has been typed.
7675 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7676 different timeout value for key codes is desired set 'ttimeoutlen' to
7677 a non-negative number.
7678
7679 ttimeoutlen mapping delay key code delay ~
7680 < 0 'timeoutlen' 'timeoutlen'
7681 >= 0 'timeoutlen' 'ttimeoutlen'
7682
7683 The timeout only happens when the 'timeout' and 'ttimeout' options
7684 tell so. A useful setting would be >
7685 :set timeout timeoutlen=3000 ttimeoutlen=100
7686< (time out on mapping after three seconds, time out on key codes after
7687 a tenth of a second).
7688
7689 *'title'* *'notitle'*
7690'title' boolean (default off, on when title can be restored)
7691 global
7692 {not in Vi}
7693 {not available when compiled without the |+title|
7694 feature}
7695 When on, the title of the window will be set to the value of
7696 'titlestring' (if it is not empty), or to:
7697 filename [+=-] (path) - VIM
7698 Where:
7699 filename the name of the file being edited
7700 - indicates the file cannot be modified, 'ma' off
7701 + indicates the file was modified
7702 = indicates the file is read-only
7703 =+ indicates the file is read-only and modified
7704 (path) is the path of the file being edited
7705 - VIM the server name |v:servername| or "VIM"
7706 Only works if the terminal supports setting window titles
7707 (currently Amiga console, Win32 console, all GUI versions and
7708 terminals with a non- empty 't_ts' option - these are Unix xterm and
7709 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7710 *X11*
7711 When Vim was compiled with HAVE_X11 defined, the original title will
7712 be restored if possible. The output of ":version" will include "+X11"
7713 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7714 works for the icon name |'icon'|.
7715 But: When Vim was started with the |-X| argument, restoring the title
7716 will not work (except in the GUI).
7717 If the title cannot be restored, it is set to the value of 'titleold'.
7718 You might want to restore the title outside of Vim then.
7719 When using an xterm from a remote machine you can use this command:
7720 rsh machine_name xterm -display $DISPLAY &
7721 then the WINDOWID environment variable should be inherited and the
7722 title of the window should change back to what it should be after
7723 exiting Vim.
7724
7725 *'titlelen'*
7726'titlelen' number (default 85)
7727 global
7728 {not in Vi}
7729 {not available when compiled without the |+title|
7730 feature}
7731 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007732 title. When the title is longer, only the end of the path name is
7733 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 Using a percentage makes this adapt to the width of the window. But
7735 it won't work perfectly, because the actual number of characters
7736 available also depends on the font used and other things in the title
7737 bar. When 'titlelen' is zero the full path is used. Otherwise,
7738 values from 1 to 30000 percent can be used.
7739 'titlelen' is also used for the 'titlestring' option.
7740
7741 *'titleold'*
7742'titleold' string (default "Thanks for flying Vim")
7743 global
7744 {not in Vi}
7745 {only available when compiled with the |+title|
7746 feature}
7747 This option will be used for the window title when exiting Vim if the
7748 original title cannot be restored. Only happens if 'title' is on or
7749 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007750 This option cannot be set from a |modeline| or in the |sandbox|, for
7751 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 *'titlestring'*
7753'titlestring' string (default "")
7754 global
7755 {not in Vi}
7756 {not available when compiled without the |+title|
7757 feature}
7758 When this option is not empty, it will be used for the title of the
7759 window. This happens only when the 'title' option is on.
7760 Only works if the terminal supports setting window titles (currently
7761 Amiga console, Win32 console, all GUI versions and terminals with a
7762 non-empty 't_ts' option).
7763 When Vim was compiled with HAVE_X11 defined, the original title will
7764 be restored if possible |X11|.
7765 When this option contains printf-style '%' items, they will be
7766 expanded according to the rules used for 'statusline'.
7767 Example: >
7768 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7769 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7770< The value of 'titlelen' is used to align items in the middle or right
7771 of the available space.
7772 Some people prefer to have the file name first: >
7773 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7774< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007775 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 separating space only when needed.
7777 NOTE: Use of special characters in 'titlestring' may cause the display
7778 to be garbled (e.g., when it contains a CR or NL character).
7779 {not available when compiled without the |+statusline| feature}
7780
7781 *'toolbar'* *'tb'*
7782'toolbar' 'tb' string (default "icons,tooltips")
7783 global
7784 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7785 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007786 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 possible values are:
7788 icons Toolbar buttons are shown with icons.
7789 text Toolbar buttons shown with text.
7790 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007791 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 tooltips Tooltips are active for toolbar buttons.
7793 Tooltips refer to the popup help text which appears after the mouse
7794 cursor is placed over a toolbar button for a brief moment.
7795
7796 If you want the toolbar to be shown with icons as well as text, do the
7797 following: >
7798 :set tb=icons,text
7799< Motif and Athena cannot display icons and text at the same time. They
7800 will show icons if both are requested.
7801
7802 If none of the strings specified in 'toolbar' are valid or if
7803 'toolbar' is empty, this option is ignored. If you want to disable
7804 the toolbar, you need to set the 'guioptions' option. For example: >
7805 :set guioptions-=T
7806< Also see |gui-toolbar|.
7807
7808 *'toolbariconsize'* *'tbis'*
7809'toolbariconsize' 'tbis' string (default "small")
7810 global
7811 {not in Vi}
7812 {only in the GTK+ 2 GUI}
7813 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007814 tiny Use tiny icons.
7815 small Use small icons (default).
7816 medium Use medium-sized icons.
7817 large Use large icons.
7818 huge Use even larger icons.
7819 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007821 the current theme. Common dimensions are giant=48x48, huge=32x32,
7822 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823
7824 If 'toolbariconsize' is empty, the global default size as determined
7825 by user preferences or the current theme is used.
7826
7827 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7828'ttybuiltin' 'tbi' boolean (default on)
7829 global
7830 {not in Vi}
7831 When on, the builtin termcaps are searched before the external ones.
7832 When off the builtin termcaps are searched after the external ones.
7833 When this option is changed, you should set the 'term' option next for
7834 the change to take effect, for example: >
7835 :set notbi term=$TERM
7836< See also |termcap|.
7837 Rationale: The default for this option is "on", because the builtin
7838 termcap entries are generally better (many systems contain faulty
7839 xterm entries...).
7840
7841 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7842'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7843 sun-cmd, screen, rxvt, dtterm or
7844 iris-ansi; also on when running Vim in
7845 a DOS console)
7846 global
7847 {not in Vi}
7848 Indicates a fast terminal connection. More characters will be sent to
7849 the screen for redrawing, instead of using insert/delete line
7850 commands. Improves smoothness of redrawing when there are multiple
7851 windows and the terminal does not support a scrolling region.
7852 Also enables the extra writing of characters at the end of each screen
7853 line for lines that wrap. This helps when using copy/paste with the
7854 mouse in an xterm and other terminals.
7855
7856 *'ttymouse'* *'ttym'*
7857'ttymouse' 'ttym' string (default depends on 'term')
7858 global
7859 {not in Vi}
7860 {only in Unix and VMS, doesn't work in the GUI; not
7861 available when compiled without |+mouse|}
7862 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007863 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *xterm-mouse*
7865 xterm xterm-like mouse handling. The mouse generates
7866 "<Esc>[Mscr", where "scr" is three bytes:
7867 "s" = button state
7868 "c" = column plus 33
7869 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007870 This only works up to 223 columns! See "dec",
7871 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 xterm2 Works like "xterm", but with the xterm reporting the
7873 mouse position while the mouse is dragged. This works
7874 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007875 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 work. See below for how Vim detects this
7877 automatically.
7878 *netterm-mouse*
7879 netterm NetTerm mouse handling. The mouse generates
7880 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7881 for the row and column.
7882 *dec-mouse*
7883 dec DEC terminal mouse handling. The mouse generates a
7884 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007885 This is also available for an Xterm, if it was
7886 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 *jsbterm-mouse*
7888 jsbterm JSB term mouse handling.
7889 *pterm-mouse*
7890 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007891 *urxvt-mouse*
7892 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007893 The mouse works only if the terminal supports this
7894 encoding style, but it does not have 223 columns limit
7895 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007896 *sgr-mouse*
7897 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007898 mouse reporting. The mouse works even in columns
7899 beyond 223. This option is backward compatible with
7900 "xterm2" because it can also decode "xterm2" style
7901 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902
7903 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007904 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7905 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7907 recognized, if enabled at compile time. DEC terminal mouse codes
7908 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007909 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7910 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007912 set to a name that starts with "xterm", "mlterm", or "screen", and
7913 'ttymouse' is not set already.
7914 Additionally, if vim is compiled with the |+termresponse| feature and
7915 |t_RV| is set to the escape sequence to request the xterm version
7916 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007918 from 95 to 276. The "sgr" value will be set if the xterm version is
7919 277 or highter.
7920 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7921 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 :set t_RV=
7923<
7924 *'ttyscroll'* *'tsl'*
7925'ttyscroll' 'tsl' number (default 999)
7926 global
7927 Maximum number of lines to scroll the screen. If there are more lines
7928 to scroll the window is redrawn. For terminals where scrolling is
7929 very slow and redrawing is not slow this can be set to a small number,
7930 e.g., 3, to speed up displaying.
7931
7932 *'ttytype'* *'tty'*
7933'ttytype' 'tty' string (default from $TERM)
7934 global
7935 Alias for 'term', see above.
7936
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007937 *'undodir'* *'udir'*
7938'undodir' 'udir' string (default ".")
7939 global
7940 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007941 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007942 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007943 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007944 "." means using the directory of the file. The undo file name for
7945 "file.txt" is ".file.txt.un~".
7946 For other directories the file name is the full path of the edited
7947 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007948 When writing: The first directory that exists is used. "." always
7949 works, no directories after "." will be used for writing.
7950 When reading all entries are tried to find an undo file. The first
7951 undo file that exists is used. When it cannot be read an error is
7952 given, no further entry is used.
7953 See |undo-persistence|.
7954
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007955 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007956'undofile' 'udf' boolean (default off)
7957 local to buffer
7958 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007959 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007960 When on, Vim automatically saves undo history to an undo file when
7961 writing a buffer to a file, and restores undo history from the same
7962 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007963 The directory where the undo file is stored is specified by 'undodir'.
7964 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007965 The undo file is not read when 'undoreload' causes the buffer from
7966 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007967 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007968
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 *'undolevels'* *'ul'*
7970'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7971 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007972 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 {not in Vi}
7974 Maximum number of changes that can be undone. Since undo information
7975 is kept in memory, higher numbers will cause more memory to be used
7976 (nevertheless, a single change can use an unlimited amount of memory).
7977 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7978 itself: >
7979 set ul=0
7980< But you can also get Vi compatibility by including the 'u' flag in
7981 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007982 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007983 Set to -1 for no undo at all. You might want to do this only for the
7984 current buffer: >
7985 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007987
7988 The local value is set to -123456 when the global value is to be used.
7989
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007990 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007992 *'undoreload'* *'ur'*
7993'undoreload' 'ur' number (default 10000)
7994 global
7995 {not in Vi}
7996 Save the whole buffer for undo when reloading it. This applies to the
7997 ":e!" command and reloading for when the buffer changed outside of
7998 Vim. |FileChangedShell|
7999 The save only happens when this options is negative or when the number
8000 of lines is smaller than the value of this option.
8001 Set this option to zero to disable undo for a reload.
8002
8003 When saving undo for a reload, any undo file is not read.
8004
8005 Note that this causes the whole buffer to be stored in memory. Set
8006 this option to a lower value if you run out of memory.
8007
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008 *'updatecount'* *'uc'*
8009'updatecount' 'uc' number (default: 200)
8010 global
8011 {not in Vi}
8012 After typing this many characters the swap file will be written to
8013 disk. When zero, no swap file will be created at all (see chapter on
8014 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8015 Vim with the "-n" option, see |startup|. When editing in readonly
8016 mode this option will be initialized to 10000.
8017 The swapfile can be disabled per buffer with |'swapfile'|.
8018 When 'updatecount' is set from zero to non-zero, swap files are
8019 created for all buffers that have 'swapfile' set. When 'updatecount'
8020 is set to zero, existing swap files are not deleted.
8021 Also see |'swapsync'|.
8022 This option has no meaning in buffers where |'buftype'| is "nofile"
8023 or "nowrite".
8024
8025 *'updatetime'* *'ut'*
8026'updatetime' 'ut' number (default 4000)
8027 global
8028 {not in Vi}
8029 If this many milliseconds nothing is typed the swap file will be
8030 written to disk (see |crash-recovery|). Also used for the
8031 |CursorHold| autocommand event.
8032
8033 *'verbose'* *'vbs'*
8034'verbose' 'vbs' number (default 0)
8035 global
8036 {not in Vi, although some versions have a boolean
8037 verbose option}
8038 When bigger than zero, Vim will give messages about what it is doing.
8039 Currently, these messages are given:
8040 >= 1 When the viminfo file is read or written.
8041 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008042 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 >= 8 Files for which a group of autocommands is executed.
8044 >= 9 Every executed autocommand.
8045 >= 12 Every executed function.
8046 >= 13 When an exception is thrown, caught, finished, or discarded.
8047 >= 14 Anything pending in a ":finally" clause.
8048 >= 15 Every executed Ex command (truncated at 200 characters).
8049
8050 This option can also be set with the "-V" argument. See |-V|.
8051 This option is also set by the |:verbose| command.
8052
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008053 When the 'verbosefile' option is set then the verbose messages are not
8054 displayed.
8055
8056 *'verbosefile'* *'vfile'*
8057'verbosefile' 'vfile' string (default empty)
8058 global
8059 {not in Vi}
8060 When not empty all messages are written in a file with this name.
8061 When the file exists messages are appended.
8062 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008063 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008064 Setting 'verbosefile' to a new value is like making it empty first.
8065 The difference with |:redir| is that verbose messages are not
8066 displayed when 'verbosefile' is set.
8067
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 *'viewdir'* *'vdir'*
8069'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8070 "$VIM/vimfiles/view",
8071 for Unix: "~/.vim/view",
8072 for Macintosh: "$VIM:vimfiles:view"
8073 for VMS: "sys$login:vimfiles/view"
8074 for RiscOS: "Choices:vimfiles/view")
8075 global
8076 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008077 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 feature}
8079 Name of the directory where to store files for |:mkview|.
8080 This option cannot be set from a |modeline| or in the |sandbox|, for
8081 security reasons.
8082
8083 *'viewoptions'* *'vop'*
8084'viewoptions' 'vop' string (default: "folds,options,cursor")
8085 global
8086 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008087 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008088 feature}
8089 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008090 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008091 word save and restore ~
8092 cursor cursor position in file and in window
8093 folds manually created folds, opened/closed folds and local
8094 fold options
8095 options options and mappings local to a window or buffer (not
8096 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008097 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 slash backslashes in file names replaced with forward
8099 slashes
8100 unix with Unix end-of-line format (single <NL>), even when
8101 on Windows or DOS
8102
8103 "slash" and "unix" are useful on Windows when sharing view files
8104 with Unix. The Unix version of Vim cannot source dos format scripts,
8105 but the Windows version of Vim can source unix format scripts.
8106
8107 *'viminfo'* *'vi'* *E526* *E527* *E528*
8108'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008109 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8110 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8111 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 global
8113 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008114 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 feature}
8116 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008117 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 separated list of parameters, each consisting of a single character
8119 identifying the particular parameter, followed by a number or string
8120 which specifies the value of that parameter. If a particular
8121 character is left out, then the default value is used for that
8122 parameter. The following is a list of the identifying characters and
8123 the effect of their value.
8124 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008125 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 ! When included, save and restore global variables that start
8127 with an uppercase letter, and don't contain a lowercase
8128 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008129 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008130 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008131 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 " Maximum number of lines saved for each register. Old name of
8133 the '<' item, with the disadvantage that you need to put a
8134 backslash before the ", otherwise it will be recognized as the
8135 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008136 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137 % When included, save and restore the buffer list. If Vim is
8138 started with a file name argument, the buffer list is not
8139 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008140 buffer list is restored from the viminfo file. Quickfix
8141 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8142 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008143 When followed by a number, the number specifies the maximum
8144 number of buffers that are stored. Without a number all
8145 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008146 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 ' Maximum number of previously edited files for which the marks
8148 are remembered. This parameter must always be included when
8149 'viminfo' is non-empty.
8150 Including this item also means that the |jumplist| and the
8151 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008152 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008154 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 patterns are also saved. When not included, the value of
8156 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008157 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008159 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008160 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161 < Maximum number of lines saved for each register. If zero then
8162 registers are not saved. When not included, all lines are
8163 saved. '"' is the old name for this item.
8164 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008165 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008167 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008168 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 c When included, convert the text in the viminfo file from the
8170 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008171 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008172 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008173 f Whether file marks need to be stored. If zero, file marks ('0
8174 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008175 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008177 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 h Disable the effect of 'hlsearch' when loading the viminfo
8179 file. When not included, it depends on whether ":nohlsearch"
8180 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008181 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 n Name of the viminfo file. The name must immediately follow
8183 the 'n'. Must be the last one! If the "-i" argument was
8184 given when starting Vim, that file name overrides the one
8185 given here with 'viminfo'. Environment variables are expanded
8186 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008187 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008188 r Removable media. The argument is a string (up to the next
8189 ','). This parameter can be given several times. Each
8190 specifies the start of a path for which no marks will be
8191 stored. This is to avoid removable media. For MS-DOS you
8192 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8193 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8194 ignored. Maximum length of each 'r' argument is 50
8195 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008196 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 s Maximum size of an item in Kbyte. If zero then registers are
8198 not saved. Currently only applies to registers. The default
8199 "s10" will exclude registers with more than 10 Kbyte of text.
8200 Also see the '<' item above: line count limit.
8201
8202 Example: >
8203 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8204<
8205 '50 Marks will be remembered for the last 50 files you
8206 edited.
8207 <1000 Contents of registers (up to 1000 lines each) will be
8208 remembered.
8209 s100 Registers with more than 100 Kbyte text are skipped.
8210 :0 Command-line history will not be saved.
8211 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8212 no / Since '/' is not specified, the default will be used,
8213 that is, save all of the search history, and also the
8214 previous search and substitute patterns.
8215 no % The buffer list will not be saved nor read back.
8216 no h 'hlsearch' highlighting will be restored.
8217
8218 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8219 load the contents of the file, this is not done automatically.
8220
8221 This option cannot be set from a |modeline| or in the |sandbox|, for
8222 security reasons.
8223
8224 *'virtualedit'* *'ve'*
8225'virtualedit' 've' string (default "")
8226 global
8227 {not in Vi}
8228 {not available when compiled without the
8229 |+virtualedit| feature}
8230 A comma separated list of these words:
8231 block Allow virtual editing in Visual block mode.
8232 insert Allow virtual editing in Insert mode.
8233 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008234 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008235
Bram Moolenaar071d4272004-06-13 20:20:40 +00008236 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008237 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 of the line. Useful for selecting a rectangle in Visual mode and
8239 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008240 "onemore" is not the same, it will only allow moving the cursor just
8241 after the last character of the line. This makes some commands more
8242 consistent. Previously the cursor was always past the end of the line
8243 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008244 break some plugins or Vim scripts. For example because |l| can move
8245 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008246 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008247 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008248 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008249 It doesn't make sense to combine "all" with "onemore", but you will
8250 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008251
8252 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8253'visualbell' 'vb' boolean (default off)
8254 global
8255 {not in Vi}
8256 Use visual bell instead of beeping. The terminal code to display the
8257 visual bell is given with 't_vb'. When no beep or flash is wanted,
8258 use ":set vb t_vb=".
8259 Note: When the GUI starts, 't_vb' is reset to its default value. You
8260 might want to set it again in your |gvimrc|.
8261 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8262 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8263 where 40 is the time in msec.
8264 Does not work on the Amiga, you always get a screen flash.
8265 Also see 'errorbells'.
8266
8267 *'warn'* *'nowarn'*
8268'warn' boolean (default on)
8269 global
8270 Give a warning message when a shell command is used while the buffer
8271 has been changed.
8272
8273 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8274'weirdinvert' 'wiv' boolean (default off)
8275 global
8276 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008277 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 It is provided for backwards compatibility with version 4.x.
8279 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8280 vice versa. Has no effect when the GUI is running.
8281
8282 *'whichwrap'* *'ww'*
8283'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8284 global
8285 {not in Vi}
8286 Allow specified keys that move the cursor left/right to move to the
8287 previous/next line when the cursor is on the first/last character in
8288 the line. Concatenate characters to allow this for these keys:
8289 char key mode ~
8290 b <BS> Normal and Visual
8291 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008292 h "h" Normal and Visual (not recommended)
8293 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 < <Left> Normal and Visual
8295 > <Right> Normal and Visual
8296 ~ "~" Normal
8297 [ <Left> Insert and Replace
8298 ] <Right> Insert and Replace
8299 For example: >
8300 :set ww=<,>,[,]
8301< allows wrap only when cursor keys are used.
8302 When the movement keys are used in combination with a delete or change
8303 operator, the <EOL> also counts for a character. This makes "3h"
8304 different from "3dh" when the cursor crosses the end of a line. This
8305 is also true for "x" and "X", because they do the same as "dl" and
8306 "dh". If you use this, you may also want to use the mapping
8307 ":map <BS> X" to make backspace delete the character in front of the
8308 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008309 When 'l' is included and it is used after an operator at the end of a
8310 line then it will not move to the next line. This makes "dl", "cl",
8311 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 NOTE: This option is set to the Vi default value when 'compatible' is
8313 set and to the Vim default value when 'compatible' is reset.
8314
8315 *'wildchar'* *'wc'*
8316'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8317 global
8318 {not in Vi}
8319 Character you have to type to start wildcard expansion in the
8320 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008321 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 The character is not recognized when used inside a macro. See
8323 'wildcharm' for that.
8324 Although 'wc' is a number option, you can set it to a special key: >
8325 :set wc=<Esc>
8326< NOTE: This option is set to the Vi default value when 'compatible' is
8327 set and to the Vim default value when 'compatible' is reset.
8328
8329 *'wildcharm'* *'wcm'*
8330'wildcharm' 'wcm' number (default: none (0))
8331 global
8332 {not in Vi}
8333 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008334 recognized when used inside a macro. You can find "spare" command-line
8335 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 you'll never actually type 'wildcharm', just use it in mappings that
8337 automatically invoke completion mode, e.g.: >
8338 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008339 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340< Then after typing :ss you can use CTRL-P & CTRL-N.
8341
8342 *'wildignore'* *'wig'*
8343'wildignore' 'wig' string (default "")
8344 global
8345 {not in Vi}
8346 {not available when compiled without the |+wildignore|
8347 feature}
8348 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008349 patterns is ignored when expanding |wildcards|, completing file or
8350 directory names, and influences the result of |expand()|, |glob()| and
8351 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8353 Also see 'suffixes'.
8354 Example: >
8355 :set wildignore=*.o,*.obj
8356< The use of |:set+=| and |:set-=| is preferred when adding or removing
8357 a pattern from the list. This avoids problems when a future version
8358 uses another default.
8359
Bram Moolenaar94950a92010-12-02 16:01:29 +01008360
Bram Moolenaar81af9252010-12-10 20:35:50 +01008361 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008362'wildignorecase' 'wic' boolean (default off)
8363 global
8364 {not in Vi}
8365 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008366 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008367 Does not apply when the shell is used to expand wildcards, which
8368 happens when there are special characters.
8369
8370
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8372'wildmenu' 'wmnu' boolean (default off)
8373 global
8374 {not in Vi}
8375 {not available if compiled without the |+wildmenu|
8376 feature}
8377 When 'wildmenu' is on, command-line completion operates in an enhanced
8378 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8379 the possible matches are shown just above the command line, with the
8380 first match highlighted (overwriting the status line, if there is
8381 one). Keys that show the previous/next match, such as <Tab> or
8382 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8383 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8384 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008385 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 If there are more matches than can fit in the line, a ">" is shown on
8387 the right and/or a "<" is shown on the left. The status line scrolls
8388 as needed.
8389 The "wildmenu" mode is abandoned when a key is hit that is not used
8390 for selecting a completion.
8391 While the "wildmenu" is active the following keys have special
8392 meanings:
8393
8394 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8395 <Down> - in filename/menu name completion: move into a
8396 subdirectory or submenu.
8397 <CR> - in menu completion, when the cursor is just after a
8398 dot: move into a submenu.
8399 <Up> - in filename/menu name completion: move up into
8400 parent directory or parent menu.
8401
8402 This makes the menus accessible from the console |console-menus|.
8403
8404 If you prefer the <Left> and <Right> keys to move the cursor instead
8405 of selecting a different match, use this: >
8406 :cnoremap <Left> <Space><BS><Left>
8407 :cnoremap <Right> <Space><BS><Right>
8408<
8409 The "WildMenu" highlighting is used for displaying the current match
8410 |hl-WildMenu|.
8411
8412 *'wildmode'* *'wim'*
8413'wildmode' 'wim' string (Vim default: "full")
8414 global
8415 {not in Vi}
8416 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008417 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008418 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 first part specifies the behavior for the first use of 'wildchar',
8420 The second part for the second use, etc.
8421 These are the possible values for each part:
8422 "" Complete only the first match.
8423 "full" Complete the next full match. After the last match,
8424 the original string is used and then the first match
8425 again.
8426 "longest" Complete till longest common string. If this doesn't
8427 result in a longer string, use the next part.
8428 "longest:full" Like "longest", but also start 'wildmenu' if it is
8429 enabled.
8430 "list" When more than one match, list all matches.
8431 "list:full" When more than one match, list all matches and
8432 complete first match.
8433 "list:longest" When more than one match, list all matches and
8434 complete till longest common string.
8435 When there is only a single match, it is fully completed in all cases.
8436
8437 Examples: >
8438 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008439< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008440 :set wildmode=longest,full
8441< Complete longest common string, then each full match >
8442 :set wildmode=list:full
8443< List all matches and complete each full match >
8444 :set wildmode=list,full
8445< List all matches without completing, then each full match >
8446 :set wildmode=longest,list
8447< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008448 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008450 *'wildoptions'* *'wop'*
8451'wildoptions' 'wop' string (default "")
8452 global
8453 {not in Vi}
8454 {not available when compiled without the |+wildignore|
8455 feature}
8456 A list of words that change how command line completion is done.
8457 Currently only one word is allowed:
8458 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008459 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008460 is displayed per line. Often used tag kinds are:
8461 d #define
8462 f function
8463 Also see |cmdline-completion|.
8464
Bram Moolenaar071d4272004-06-13 20:20:40 +00008465 *'winaltkeys'* *'wak'*
8466'winaltkeys' 'wak' string (default "menu")
8467 global
8468 {not in Vi}
8469 {only used in Win32, Motif, GTK and Photon GUI}
8470 Some GUI versions allow the access to menu entries by using the ALT
8471 key in combination with a character that appears underlined in the
8472 menu. This conflicts with the use of the ALT key for mappings and
8473 entering special characters. This option tells what to do:
8474 no Don't use ALT keys for menus. ALT key combinations can be
8475 mapped, but there is no automatic handling. This can then be
8476 done with the |:simalt| command.
8477 yes ALT key handling is done by the windowing system. ALT key
8478 combinations cannot be mapped.
8479 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008480 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481 keys can be mapped.
8482 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8483 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008484 This option is not used for <F10>; on Win32 and with GTK <F10> will
8485 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008486
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008487 *'window'* *'wi'*
8488'window' 'wi' number (default screen height - 1)
8489 global
8490 Window height. Do not confuse this with the height of the Vim window,
8491 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008492 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8493 value is smaller than 'lines' minus one. The screen will scroll
8494 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008495 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8496 in a much smarter way, taking care of wrapping lines.
8497 When resizing the Vim window, the value is smaller than 1 or more than
8498 or equal to 'lines' it will be set to 'lines' minus 1.
8499 {Vi also uses the option to specify the number of displayed lines}
8500
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501 *'winheight'* *'wh'* *E591*
8502'winheight' 'wh' number (default 1)
8503 global
8504 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008505 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008506 feature}
8507 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008508 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008509 focus goes to a window that is smaller, its size is increased, at the
8510 cost of the height of other windows.
8511 Set 'winheight' to a small number for normal editing.
8512 Set it to 999 to make the current window fill most of the screen.
8513 Other windows will be only 'winminheight' high. This has the drawback
8514 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8515 to create only two windows, set the option after startup is done,
8516 using the |VimEnter| event: >
8517 au VimEnter * set winheight=999
8518< Minimum value is 1.
8519 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008520 height of the current window.
8521 'winheight' applies to the current window. Use 'winminheight' to set
8522 the minimal height for other windows.
8523
8524 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8525'winfixheight' 'wfh' boolean (default off)
8526 local to window
8527 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008528 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008529 feature}
8530 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008531 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8532 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 The height may be changed anyway when running out of room.
8534
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008535 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8536'winfixwidth' 'wfw' boolean (default off)
8537 local to window
8538 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008539 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008540 feature}
8541 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008542 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008543 The width may be changed anyway when running out of room.
8544
Bram Moolenaar071d4272004-06-13 20:20:40 +00008545 *'winminheight'* *'wmh'*
8546'winminheight' 'wmh' number (default 1)
8547 global
8548 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008549 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008550 feature}
8551 The minimal height of a window, when it's not the current window.
8552 This is a hard minimum, windows will never become smaller.
8553 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8554 status bar) if necessary. They will return to at least one line when
8555 they become active (since the cursor has to have somewhere to go.)
8556 Use 'winheight' to set the minimal height of the current window.
8557 This option is only checked when making a window smaller. Don't use a
8558 large number, it will cause errors when opening more than a few
8559 windows. A value of 0 to 3 is reasonable.
8560
8561 *'winminwidth'* *'wmw'*
8562'winminwidth' 'wmw' number (default 1)
8563 global
8564 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008565 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 feature}
8567 The minimal width of a window, when it's not the current window.
8568 This is a hard minimum, windows will never become smaller.
8569 When set to zero, windows may be "squashed" to zero columns (i.e. just
8570 a vertical separator) if necessary. They will return to at least one
8571 line when they become active (since the cursor has to have somewhere
8572 to go.)
8573 Use 'winwidth' to set the minimal width of the current window.
8574 This option is only checked when making a window smaller. Don't use a
8575 large number, it will cause errors when opening more than a few
8576 windows. A value of 0 to 12 is reasonable.
8577
8578 *'winwidth'* *'wiw'* *E592*
8579'winwidth' 'wiw' number (default 20)
8580 global
8581 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008582 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 feature}
8584 Minimal number of columns for the current window. This is not a hard
8585 minimum, Vim will use fewer columns if there is not enough room. If
8586 the current window is smaller, its size is increased, at the cost of
8587 the width of other windows. Set it to 999 to make the current window
8588 always fill the screen. Set it to a small number for normal editing.
8589 The width is not adjusted after one of the commands to change the
8590 width of the current window.
8591 'winwidth' applies to the current window. Use 'winminwidth' to set
8592 the minimal width for other windows.
8593
8594 *'wrap'* *'nowrap'*
8595'wrap' boolean (default on)
8596 local to window
8597 {not in Vi}
8598 This option changes how text is displayed. It doesn't change the text
8599 in the buffer, see 'textwidth' for that.
8600 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008601 displaying continues on the next line. When off lines will not wrap
8602 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008603 moved to a part that is not shown, the screen will scroll
8604 horizontally.
8605 The line will be broken in the middle of a word if necessary. See
8606 'linebreak' to get the break at a word boundary.
8607 To make scrolling horizontally a bit more useful, try this: >
8608 :set sidescroll=5
8609 :set listchars+=precedes:<,extends:>
8610< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008611 This option can't be set from a |modeline| when the 'diff' option is
8612 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613
8614 *'wrapmargin'* *'wm'*
8615'wrapmargin' 'wm' number (default 0)
8616 local to buffer
8617 Number of characters from the right window border where wrapping
8618 starts. When typing text beyond this limit, an <EOL> will be inserted
8619 and inserting continues on the next line.
8620 Options that add a margin, such as 'number' and 'foldcolumn', cause
8621 the text width to be further reduced. This is Vi compatible.
8622 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008623 This option is set to 0 when 'paste' is set and restored when 'paste'
8624 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8626 and less usefully}
8627
8628 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8629'wrapscan' 'ws' boolean (default on) *E384* *E385*
8630 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008631 Searches wrap around the end of the file. Also applies to |]s| and
8632 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008633
8634 *'write'* *'nowrite'*
8635'write' boolean (default on)
8636 global
8637 {not in Vi}
8638 Allows writing files. When not set, writing a file is not allowed.
8639 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008640 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008641 argument. Filtering text is still possible, even though this requires
8642 writing a temporary file.
8643
8644 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8645'writeany' 'wa' boolean (default off)
8646 global
8647 Allows writing to any file with no need for "!" override.
8648
8649 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8650'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8651 otherwise)
8652 global
8653 {not in Vi}
8654 Make a backup before overwriting a file. The backup is removed after
8655 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008656 also on.
8657 WARNING: Switching this option off means that when Vim fails to write
8658 your buffer correctly and then, for whatever reason, Vim exits, you
8659 lose both the original file and what you were writing. Only reset
8660 this option if your file system is almost full and it makes the write
8661 fail (and make sure not to exit Vim until the write was successful).
8662 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 When the 'backupskip' pattern matches, a backup is not made anyway.
8664 NOTE: This option is set to the default value when 'compatible' is
8665 set.
8666
8667 *'writedelay'* *'wd'*
8668'writedelay' 'wd' number (default 0)
8669 global
8670 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008671 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 screen. When non-zero, characters are sent to the terminal one by
8673 one. For MS-DOS pcterm this does not work. For debugging purposes.
8674
8675 vim:tw=78:ts=8:ft=help:norl: