blob: c531168e39edc8063c1f3cb60bcdd221a9a188ad [file] [log] [blame]
Bram Moolenaar58b85342016-08-14 19:54:54 +02001*options.txt* For Vim version 7.4. Last change: 2016 Aug 14
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
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200264When editing a buffer that has been edited before, the options from the window
265that was last closed are used again. If this buffer has been edited in this
266window, the values from back then are used. Otherwise the values from the
267last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
730
731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
732'autochdir' 'acd' boolean (default off)
733 global
734 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
746 {not in Vi}
747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
769 {not in Vi}
770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {small difference from Vi: After the indent is deleted when typing
802 <Esc> or <CR>, the cursor position when moving up or down is after the
803 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
804
805 *'autoread'* *'ar'* *'noautoread'* *'noar'*
806'autoread' 'ar' boolean (default off)
807 global or local to buffer |global-local|
808 {not in Vi}
809 When a file has been detected to have been changed outside of Vim and
810 it has not been changed inside of Vim, automatically read it again.
811 When the file has been deleted this is not done. |timestamp|
812 If this option has a local value, use this command to switch back to
813 using the global value: >
814 :set autoread<
815<
816 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
817'autowrite' 'aw' boolean (default off)
818 global
819 Write the contents of the file, if it has been modified, on each
820 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000821 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
823 Note that for some commands the 'autowrite' option is not used, see
824 'autowriteall' for that.
825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
829 {not in Vi}
830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
832 Setting this option also implies that Vim behaves like 'autowrite' has
833 been set.
834
835 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200836'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 global
838 {not in Vi}
839 When set to "dark", Vim will try to use colors that look good on a
840 dark background. When set to "light", Vim will try to use colors that
841 look good on a light background. Any other value is illegal.
842 Vim tries to set the default value according to the terminal used.
843 This will not always be correct.
844 Setting this option does not change the background color, it tells Vim
845 what the background color looks like. For changing the background
846 color, see |:hi-normal|.
847
848 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000850 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 setting 'background' will cause the color scheme to be reloaded. If
853 the color scheme adjusts to the value of 'background' this will work.
854 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 When setting 'background' to the default value with: >
858 :set background&
859< Vim will guess the value. In the GUI this should work correctly,
860 in other cases Vim might not be able to guess the right value.
861
862 When starting the GUI, the default value for 'background' will be
863 "light". When the value is not set in the .gvimrc, and Vim detects
864 that the background is actually quite dark, 'background' is set to
865 "dark". But this happens only AFTER the .gvimrc file has been read
866 (because the window needs to be opened to find the actual background
867 color). To get around this, force the GUI window to be opened by
868 putting a ":gui" command in the .gvimrc file, before where the value
869 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870
871 For MS-DOS, Windows and OS/2 the default is "dark".
872 For other systems "dark" is used when 'term' is "linux",
873 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
874 background. Otherwise the default is "light".
875
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 Normally this option would be set in the .vimrc file. Possibly
877 depending on the terminal name. Example: >
878 :if &term == "pcterm"
879 : set background=dark
880 :endif
881< When this option is set, the default settings for the highlight groups
882 will change. To use other settings, place ":highlight" commands AFTER
883 the setting of the 'background' option.
884 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
885 to select the colors for syntax highlighting. After changing this
886 option, you must load syntax.vim again to see the result. This can be
887 done with ":syntax on".
888
889 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200890'backspace' 'bs' string (default "", set to "indent,eol,start"
891 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 global
893 {not in Vi}
894 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
895 mode. This is a list of items, separated by commas. Each item allows
896 a way to backspace over something:
897 value effect ~
898 indent allow backspacing over autoindent
899 eol allow backspacing over line breaks (join lines)
900 start allow backspacing over the start of insert; CTRL-W and CTRL-U
901 stop once at the start of insert.
902
903 When the value is empty, Vi compatible backspacing is used.
904
905 For backwards compatibility with version 5.4 and earlier:
906 value effect ~
907 0 same as ":set backspace=" (Vi compatible)
908 1 same as ":set backspace=indent,eol"
909 2 same as ":set backspace=indent,eol,start"
910
911 See |:fixdel| if your <BS> or <Del> key does not do what you want.
912 NOTE: This option is set to "" when 'compatible' is set.
913
914 *'backup'* *'bk'* *'nobackup'* *'nobk'*
915'backup' 'bk' boolean (default off)
916 global
917 {not in Vi}
918 Make a backup before overwriting a file. Leave it around after the
919 file has been successfully written. If you do not want to keep the
920 backup file, but you do want a backup while the file is being
921 written, reset this option and set the 'writebackup' option (this is
922 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000923 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000924 |backup-table| for more explanations.
925 When the 'backupskip' pattern matches, a backup is not made anyway.
926 When 'patchmode' is set, the backup may be renamed to become the
927 oldest version of a file.
928 NOTE: This option is reset when 'compatible' is set.
929
930 *'backupcopy'* *'bkc'*
931'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200932 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 {not in Vi}
934 When writing a file and a backup is made, this option tells how it's
935 done. This is a comma separated list of words.
936
937 The main values are:
938 "yes" make a copy of the file and overwrite the original one
939 "no" rename the file and write a new one
940 "auto" one of the previous, what works best
941
942 Extra values that can be combined with the ones above are:
943 "breaksymlink" always break symlinks when writing
944 "breakhardlink" always break hardlinks when writing
945
946 Making a copy and overwriting the original file:
947 - Takes extra time to copy the file.
948 + When the file has special attributes, is a (hard/symbolic) link or
949 has a resource fork, all this is preserved.
950 - When the file is a link the backup will have the name of the link,
951 not of the real file.
952
953 Renaming the file and writing a new one:
954 + It's fast.
955 - Sometimes not all attributes of the file can be copied to the new
956 file.
957 - When the file is a link the new file will not be a link.
958
959 The "auto" value is the middle way: When Vim sees that renaming file
960 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000961 the file is not a link) that is used. When problems are expected, a
962 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
964 The "breaksymlink" and "breakhardlink" values can be used in
965 combination with any of "yes", "no" and "auto". When included, they
966 force Vim to always break either symbolic or hard links by doing
967 exactly what the "no" option does, renaming the original file to
968 become the backup and writing a new file in its place. This can be
969 useful for example in source trees where all the files are symbolic or
970 hard links and any changes should stay in the local source tree, not
971 be propagated back to the original source.
972 *crontab*
973 One situation where "no" and "auto" will cause problems: A program
974 that opens a file, invokes Vim to edit that file, and then tests if
975 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000976 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 example.
978
979 When a copy is made, the original file is truncated and then filled
980 with the new text. This means that protection bits, owner and
981 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 group of the backup is set to the group of the original file. If this
984 fails, the protection bits for the group are made the same as for
985 others.
986
987 When the file is renamed this is the other way around: The backup has
988 the same attributes of the original file, and the newly written file
989 is owned by the current user. When the file was a (hard/symbolic)
990 link, the new file will not! That's why the "auto" value doesn't
991 rename when the file is a link. The owner and group of the newly
992 written file will be set to the same ones as the original file, but
993 the system may refuse to do this. In that case the "auto" value will
994 again not rename the file.
995
996 *'backupdir'* *'bdir'*
997'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100998 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 for Unix: ".,~/tmp,~/")
1000 global
1001 {not in Vi}
1002 List of directories for the backup file, separated with commas.
1003 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001004 where this is possible. The directory must exist, Vim will not
1005 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001006 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 impossible!). Writing may fail because of this.
1008 - A directory "." means to put the backup file in the same directory
1009 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001010 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 put the backup file relative to where the edited file is. The
1012 leading "." is replaced with the path name of the edited file.
1013 ("." inside a directory name has no special meaning).
1014 - Spaces after the comma are ignored, other spaces are considered part
1015 of the directory name. To have a space at the start of a directory
1016 name, precede it with a backslash.
1017 - To include a comma in a directory name precede it with a backslash.
1018 - A directory name may end in an '/'.
1019 - Environment variables are expanded |:set_env|.
1020 - Careful with '\' characters, type one before a space, type two to
1021 get one in the option (see |option-backslash|), for example: >
1022 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1023< - For backwards compatibility with Vim version 3.0 a '>' at the start
1024 of the option is removed.
1025 See also 'backup' and 'writebackup' options.
1026 If you want to hide your backup files on Unix, consider this value: >
1027 :set backupdir=./.backup,~/.backup,.,/tmp
1028< You must create a ".backup" directory in each directory and in your
1029 home directory for this to work properly.
1030 The use of |:set+=| and |:set-=| is preferred when adding or removing
1031 directories from the list. This avoids problems when a future version
1032 uses another default.
1033 This option cannot be set from a |modeline| or in the |sandbox|, for
1034 security reasons.
1035
1036 *'backupext'* *'bex'* *E589*
1037'backupext' 'bex' string (default "~", for VMS: "_")
1038 global
1039 {not in Vi}
1040 String which is appended to a file name to make the name of the
1041 backup file. The default is quite unusual, because this avoids
1042 accidentally overwriting existing files with a backup file. You might
1043 prefer using ".bak", but make sure that you don't have files with
1044 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001045 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001047 If you like to keep a lot of backups, you could use a BufWritePre
1048 autocommand to change 'backupext' just before writing the file to
1049 include a timestamp. >
1050 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1051< Use 'backupdir' to put the backup in a different directory.
1052
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 *'backupskip'* *'bsk'*
1054'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1055 global
1056 {not in Vi}
1057 {not available when compiled without the |+wildignore|
1058 feature}
1059 A list of file patterns. When one of the patterns matches with the
1060 name of the file which is written, no backup file is created. Both
1061 the specified file name and the full path name of the file are used.
1062 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1063 Watch out for special characters, see |option-backslash|.
1064 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001065 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001066
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001067 WARNING: Not having a backup file means that when Vim fails to write
1068 your buffer correctly and then, for whatever reason, Vim exits, you
1069 lose both the original file and what you were writing. Only disable
1070 backups if you don't care about losing the file.
1071
Bram Moolenaar02467872007-05-06 13:22:01 +00001072 Note that environment variables are not expanded. If you want to use
1073 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001074 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001075
1076< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001077 backup would be made by renaming the original file crontab won't see
1078 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079
1080 *'balloondelay'* *'bdlay'*
1081'balloondelay' 'bdlay' number (default: 600)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
1085 feature}
1086 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1087
1088 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1089'ballooneval' 'beval' boolean (default off)
1090 global
1091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001093 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 Switch on the |balloon-eval| functionality.
1095
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096 *'balloonexpr'* *'bexpr'*
1097'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001098 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001099 {not in Vi}
1100 {only available when compiled with the |+balloon_eval|
1101 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001102 Expression for text to show in evaluation balloon. It is only used
1103 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001104
1105 v:beval_bufnr number of the buffer in which balloon is going to show
1106 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001107 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001108 v:beval_lnum line number
1109 v:beval_col column number (byte index)
1110 v:beval_text word under or after the mouse pointer
1111
1112 The evaluation of the expression must not have side effects!
1113 Example: >
1114 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001115 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001116 \', column ' . v:beval_col .
1117 \ ' of file ' . bufname(v:beval_bufnr) .
1118 \ ' on word "' . v:beval_text . '"'
1119 endfunction
1120 set bexpr=MyBalloonExpr()
1121 set ballooneval
1122<
1123 NOTE: The balloon is displayed only if the cursor is on a text
1124 character. If the result of evaluating 'balloonexpr' is not empty,
1125 Vim does not try to send a message to an external debugger (Netbeans
1126 or Sun Workshop).
1127
Bram Moolenaar30b65812012-07-12 22:01:11 +02001128 The expression will be evaluated in the |sandbox| when set from a
1129 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001130
1131 It is not allowed to change text or jump to another window while
1132 evaluating 'balloonexpr' |textlock|.
1133
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001134 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001135 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001136< When they are supported "\n" characters will start a new line. If the
1137 expression evaluates to a |List| this is equal to using each List item
1138 as a string and putting "\n" in between them.
1139
Bram Moolenaar165bc692015-07-21 17:53:25 +02001140 *'belloff'* *'bo'*
1141'belloff' 'bo' string (default "")
1142 global
1143 {not in Vi}
1144 Specifies for which events the bell will not be rung. It is a comma
1145 separated list of items. For each item that is present, the bell
1146 will be silenced. This is most useful to specify specific events in
1147 insert mode to be silenced.
1148
1149 item meaning when present ~
1150 all All events.
1151 backspace When hitting <BS> or <Del> and deleting results in an
1152 error.
1153 cursor Fail to move around using the cursor keys or
1154 <PageUp>/<PageDown> in |Insert-mode|.
1155 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1156 |i_CTRL-X_CTRL-T|.
1157 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1158 |i_CTRL-E|.
1159 ctrlg Unknown Char after <C-G> in Insert mode.
1160 error Other Error occurred (e.g. try to join last line)
1161 (mostly used in |Normal-mode| or |Cmdline-mode|).
1162 esc hitting <Esc> in |Normal-mode|.
1163 ex In |Visual-mode|, hitting |Q| results in an error.
1164 hangul Error occurred when using hangul input.
1165 insertmode Pressing <Esc> in 'insertmode'.
1166 lang Calling the beep module for Lua/Mzscheme/TCL.
1167 mess No output available for |g<|.
1168 showmatch Error occurred for 'showmatch' function.
1169 operator Empty region error |cpo-E|.
1170 register Unknown register after <C-R> in |Insert-mode|.
1171 shell Bell from shell output |:!|.
1172 spell Error happened on spell suggest.
1173 wildmode More matches in |cmdline-completion| available
1174 (depends on the 'wildmode' setting).
1175
1176 This is most useful, to fine tune when in insert mode the bell should
1177 be rung. For normal mode and ex commands, the bell is often rung to
1178 indicate that an error occurred. It can be silenced by adding the
1179 "error" keyword.
1180
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1182'binary' 'bin' boolean (default off)
1183 local to buffer
1184 {not in Vi}
1185 This option should be set before editing a binary file. You can also
1186 use the |-b| Vim argument. When this option is switched on a few
1187 options will be changed (also when it already was on):
1188 'textwidth' will be set to 0
1189 'wrapmargin' will be set to 0
1190 'modeline' will be off
1191 'expandtab' will be off
1192 Also, 'fileformat' and 'fileformats' options will not be used, the
1193 file is read and written like 'fileformat' was "unix" (a single <NL>
1194 separates lines).
1195 The 'fileencoding' and 'fileencodings' options will not be used, the
1196 file is read without conversion.
1197 NOTE: When you start editing a(nother) file while the 'bin' option is
1198 on, settings from autocommands may change the settings again (e.g.,
1199 'textwidth'), causing trouble when editing. You might want to set
1200 'bin' again when the file has been loaded.
1201 The previous values of these options are remembered and restored when
1202 'bin' is switched from on to off. Each buffer has its own set of
1203 saved option values.
1204 To edit a file with 'binary' set you can use the |++bin| argument.
1205 This avoids you have to do ":set bin", which would have effect for all
1206 files you edit.
1207 When writing a file the <EOL> for the last line is only written if
1208 there was one in the original file (normally Vim appends an <EOL> to
1209 the last line if there is none; this would make the file longer). See
1210 the 'endofline' option.
1211
1212 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1213'bioskey' 'biosk' boolean (default on)
1214 global
1215 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001216 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217
1218 *'bomb'* *'nobomb'*
1219'bomb' boolean (default off)
1220 local to buffer
1221 {not in Vi}
1222 {only available when compiled with the |+multi_byte|
1223 feature}
1224 When writing a file and the following conditions are met, a BOM (Byte
1225 Order Mark) is prepended to the file:
1226 - this option is on
1227 - the 'binary' option is off
1228 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1229 endian variants.
1230 Some applications use the BOM to recognize the encoding of the file.
1231 Often used for UCS-2 files on MS-Windows. For other applications it
1232 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001233 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1235 check for the presence of the BOM is done and 'bomb' set accordingly.
1236 Unless 'binary' is set, it is removed from the first line, so that you
1237 don't see it when editing. When you don't change the options, the BOM
1238 will be restored when writing the file.
1239
1240 *'breakat'* *'brk'*
1241'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1242 global
1243 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001244 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 feature}
1246 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001247 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1248 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001250 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001251'breakindent' 'bri' boolean (default off)
1252 local to window
1253 {not in Vi}
1254 {not available when compiled without the |+linebreak|
1255 feature}
1256 Every wrapped line will continue visually indented (same amount of
1257 space as the beginning of that line), thus preserving horizontal blocks
1258 of text.
1259
1260 *'breakindentopt'* *'briopt'*
1261'breakindentopt' 'briopt' string (default empty)
1262 local to window
1263 {not in Vi}
1264 {not available when compiled without the |+linebreak|
1265 feature}
1266 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001267 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001268 min:{n} Minimum text width that will be kept after
1269 applying 'breakindent', even if the resulting
1270 text should normally be narrower. This prevents
1271 text indented almost to the right window border
1272 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001273 shift:{n} After applying 'breakindent', the wrapped line's
1274 beginning will be shifted by the given number of
1275 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276 indentation (negative) or emphasizing the line
1277 continuation (positive).
1278 sbr Display the 'showbreak' value before applying the
1279 additional indent.
1280 The default value for min is 20 and shift is 0.
1281
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001283'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001285 {not in Vi} {only for Motif, Athena, GTK, Mac and
1286 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001288 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001289 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 buffer Use the directory of the related buffer.
1291 current Use the current directory.
1292 {path} Use the specified directory
1293
1294 *'bufhidden'* *'bh'*
1295'bufhidden' 'bh' string (default: "")
1296 local to buffer
1297 {not in Vi}
1298 {not available when compiled without the |+quickfix|
1299 feature}
1300 This option specifies what happens when a buffer is no longer
1301 displayed in a window:
1302 <empty> follow the global 'hidden' option
1303 hide hide the buffer (don't unload it), also when 'hidden'
1304 is not set
1305 unload unload the buffer, also when 'hidden' is set or using
1306 |:hide|
1307 delete delete the buffer from the buffer list, also when
1308 'hidden' is set or using |:hide|, like using
1309 |:bdelete|
1310 wipe wipe out the buffer from the buffer list, also when
1311 'hidden' is set or using |:hide|, like using
1312 |:bwipeout|
1313
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001314 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001315 are lost without a warning. Also, these values may break autocommands
1316 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 This option is used together with 'buftype' and 'swapfile' to specify
1318 special kinds of buffers. See |special-buffers|.
1319
1320 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1321'buflisted' 'bl' boolean (default: on)
1322 local to buffer
1323 {not in Vi}
1324 When this option is set, the buffer shows up in the buffer list. If
1325 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1326 This option is reset by Vim for buffers that are only used to remember
1327 a file name or marks. Vim sets it when starting to edit a buffer.
1328 But not when moving to a buffer with ":buffer".
1329
1330 *'buftype'* *'bt'* *E382*
1331'buftype' 'bt' string (default: "")
1332 local to buffer
1333 {not in Vi}
1334 {not available when compiled without the |+quickfix|
1335 feature}
1336 The value of this option specifies the type of a buffer:
1337 <empty> normal buffer
1338 nofile buffer which is not related to a file and will not be
1339 written
1340 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001341 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001342 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001343 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001345 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 help help buffer (you are not supposed to set this
1347 manually)
1348
1349 This option is used together with 'bufhidden' and 'swapfile' to
1350 specify special kinds of buffers. See |special-buffers|.
1351
1352 Be careful with changing this option, it can have many side effects!
1353
Bram Moolenaar280f1262006-01-30 00:14:18 +00001354 A "quickfix" buffer is only used for the error list and the location
1355 list. This value is set by the |:cwindow| and |:lwindow| commands and
1356 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
1358 "nofile" and "nowrite" buffers are similar:
1359 both: The buffer is not to be written to disk, ":w" doesn't
1360 work (":w filename" does work though).
1361 both: The buffer is never considered to be |'modified'|.
1362 There is no warning when the changes will be lost, for
1363 example when you quit Vim.
1364 both: A swap file is only created when using too much memory
1365 (when 'swapfile' has been reset there is never a swap
1366 file).
1367 nofile only: The buffer name is fixed, it is not handled like a
1368 file name. It is not modified in response to a |:cd|
1369 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001370 both: When using ":e bufname" and already editing "bufname"
1371 the buffer is made empty and autocommands are
1372 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001373 *E676*
1374 "acwrite" implies that the buffer name is not related to a file, like
1375 "nofile", but it will be written. Thus, in contrast to "nofile" and
1376 "nowrite", ":w" does work and a modified buffer can't be abandoned
1377 without saving. For writing there must be matching |BufWriteCmd|,
1378 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 *'casemap'* *'cmp'*
1381'casemap' 'cmp' string (default: "internal,keepascii")
1382 global
1383 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001384 {only available when compiled with the |+multi_byte|
1385 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 Specifies details about changing the case of letters. It may contain
1387 these words, separated by a comma:
1388 internal Use internal case mapping functions, the current
1389 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001390 matters when 'encoding' is a Unicode encoding,
1391 "latin1" or "iso-8859-15". When "internal" is
1392 omitted, the towupper() and towlower() system library
1393 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1395 case mapping, the current locale is not effective.
1396 This probably only matters for Turkish.
1397
1398 *'cdpath'* *'cd'* *E344* *E346*
1399'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1400 global
1401 {not in Vi}
1402 {not available when compiled without the
1403 |+file_in_path| feature}
1404 This is a list of directories which will be searched when using the
1405 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001406 for has a relative path, not an absolute part starting with "/", "./"
1407 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 The 'cdpath' option's value has the same form and semantics as
1409 |'path'|. Also see |file-searching|.
1410 The default value is taken from $CDPATH, with a "," prepended to look
1411 in the current directory first.
1412 If the default value taken from $CDPATH is not what you want, include
1413 a modified version of the following command in your vimrc file to
1414 override it: >
1415 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1416< This option cannot be set from a |modeline| or in the |sandbox|, for
1417 security reasons.
1418 (parts of 'cdpath' can be passed to the shell to expand file names).
1419
1420 *'cedit'*
1421'cedit' string (Vi default: "", Vim default: CTRL-F)
1422 global
1423 {not in Vi}
1424 {not available when compiled without the |+vertsplit|
1425 feature}
1426 The key used in Command-line Mode to open the command-line window.
1427 The default is CTRL-F when 'compatible' is off.
1428 Only non-printable keys are allowed.
1429 The key can be specified as a single character, but it is difficult to
1430 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001431 :exe "set cedit=\<C-Y>"
1432 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433< |Nvi| also has this option, but it only uses the first character.
1434 See |cmdwin|.
1435
1436 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1437'charconvert' 'ccv' string (default "")
1438 global
1439 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001440 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 {not in Vi}
1442 An expression that is used for character encoding conversion. It is
1443 evaluated when a file that is to be read or has been written has a
1444 different encoding from what is desired.
1445 'charconvert' is not used when the internal iconv() function is
1446 supported and is able to do the conversion. Using iconv() is
1447 preferred, because it is much faster.
1448 'charconvert' is not used when reading stdin |--|, because there is no
1449 file to convert from. You will have to save the text in a file first.
1450 The expression must return zero or an empty string for success,
1451 non-zero for failure.
1452 The possible encoding names encountered are in 'encoding'.
1453 Additionally, names given in 'fileencodings' and 'fileencoding' are
1454 used.
1455 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1456 is done internally by Vim, 'charconvert' is not used for this.
1457 'charconvert' is also used to convert the viminfo file, if the 'c'
1458 flag is present in 'viminfo'. Also used for Unicode conversion.
1459 Example: >
1460 set charconvert=CharConvert()
1461 fun CharConvert()
1462 system("recode "
1463 \ . v:charconvert_from . ".." . v:charconvert_to
1464 \ . " <" . v:fname_in . " >" v:fname_out)
1465 return v:shell_error
1466 endfun
1467< The related Vim variables are:
1468 v:charconvert_from name of the current encoding
1469 v:charconvert_to name of the desired encoding
1470 v:fname_in name of the input file
1471 v:fname_out name of the output file
1472 Note that v:fname_in and v:fname_out will never be the same.
1473 Note that v:charconvert_from and v:charconvert_to may be different
1474 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1475 Encryption is not done by Vim when using 'charconvert'. If you want
1476 to encrypt the file after conversion, 'charconvert' should take care
1477 of this.
1478 This option cannot be set from a |modeline| or in the |sandbox|, for
1479 security reasons.
1480
1481 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1482'cindent' 'cin' boolean (default off)
1483 local to buffer
1484 {not in Vi}
1485 {not available when compiled without the |+cindent|
1486 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001487 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 that trigger reindenting in insert mode and 'cinoptions' to set your
1489 preferred indent style.
1490 If 'indentexpr' is not empty, it overrules 'cindent'.
1491 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1492 the "=" operator indents using this algorithm rather than calling an
1493 external program.
1494 See |C-indenting|.
1495 When you don't like the way 'cindent' works, try the 'smartindent'
1496 option or 'indentexpr'.
1497 This option is not used when 'paste' is set.
1498 NOTE: This option is reset when 'compatible' is set.
1499
1500 *'cinkeys'* *'cink'*
1501'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1502 local to buffer
1503 {not in Vi}
1504 {not available when compiled without the |+cindent|
1505 feature}
1506 A list of keys that, when typed in Insert mode, cause reindenting of
1507 the current line. Only used if 'cindent' is on and 'indentexpr' is
1508 empty.
1509 For the format of this option see |cinkeys-format|.
1510 See |C-indenting|.
1511
1512 *'cinoptions'* *'cino'*
1513'cinoptions' 'cino' string (default "")
1514 local to buffer
1515 {not in Vi}
1516 {not available when compiled without the |+cindent|
1517 feature}
1518 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1519 program. See |cinoptions-values| for the values of this option, and
1520 |C-indenting| for info on C indenting in general.
1521
1522
1523 *'cinwords'* *'cinw'*
1524'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without both the
1528 |+cindent| and the |+smartindent| features}
1529 These keywords start an extra indent in the next line when
1530 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1531 an appropriate place (inside {}).
1532 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1533 matter, include the keyword both the uppercase and lowercase:
1534 "if,If,IF".
1535
1536 *'clipboard'* *'cb'*
1537'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1538 for X-windows, "" otherwise)
1539 global
1540 {not in Vi}
1541 {only in GUI versions or when the |+xterm_clipboard|
1542 feature is included}
1543 This option is a list of comma separated names.
1544 These names are recognized:
1545
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001546 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 unnamed When included, Vim will use the clipboard register '*'
1548 for all yank, delete, change and put operations which
1549 would normally go to the unnamed register. When a
1550 register is explicitly specified, it will always be
1551 used regardless of whether "unnamed" is in 'clipboard'
1552 or not. The clipboard register can always be
1553 explicitly accessed using the "* notation. Also see
1554 |gui-clipboard|.
1555
Bram Moolenaar30b65812012-07-12 22:01:11 +02001556 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001557 unnamedplus A variant of the "unnamed" flag which uses the
1558 clipboard register '+' (|quoteplus|) instead of
1559 register '*' for all yank, delete, change and put
1560 operations which would normally go to the unnamed
1561 register. When "unnamed" is also included to the
1562 option, yank operations (but not delete, change or
1563 put) will additionally copy the text into register
1564 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001565 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001566 Availability can be checked with: >
1567 if has('unnamedplus')
1568<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001569 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 autoselect Works like the 'a' flag in 'guioptions': If present,
1571 then whenever Visual mode is started, or the Visual
1572 area extended, Vim tries to become the owner of the
1573 windowing system's global selection or put the
1574 selected text on the clipboard used by the selection
1575 register "*. See |guioptions_a| and |quotestar| for
1576 details. When the GUI is active, the 'a' flag in
1577 'guioptions' is used, when the GUI is not active, this
1578 "autoselect" flag is used.
1579 Also applies to the modeless selection.
1580
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001581 *clipboard-autoselectplus*
1582 autoselectplus Like "autoselect" but using the + register instead of
1583 the * register. Compare to the 'P' flag in
1584 'guioptions'.
1585
1586 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 autoselectml Like "autoselect", but for the modeless selection
1588 only. Compare to the 'A' flag in 'guioptions'.
1589
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001590 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001591 html When the clipboard contains HTML, use this when
1592 pasting. When putting text on the clipboard, mark it
1593 as HTML. This works to copy rendered HTML from
1594 Firefox, paste it as raw HTML in Vim, select the HTML
1595 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001596 You probably want to add this only temporarily,
1597 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001598 Only supported for GTK version 2 and later.
1599 Only available with the |+multi_byte| feature.
1600
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001601 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 exclude:{pattern}
1603 Defines a pattern that is matched against the name of
1604 the terminal 'term'. If there is a match, no
1605 connection will be made to the X server. This is
1606 useful in this situation:
1607 - Running Vim in a console.
1608 - $DISPLAY is set to start applications on another
1609 display.
1610 - You do not want to connect to the X server in the
1611 console, but do want this in a terminal emulator.
1612 To never connect to the X server use: >
1613 exclude:.*
1614< This has the same effect as using the |-X| argument.
1615 Note that when there is no connection to the X server
1616 the window title won't be restored and the clipboard
1617 cannot be accessed.
1618 The value of 'magic' is ignored, {pattern} is
1619 interpreted as if 'magic' was on.
1620 The rest of the option value will be used for
1621 {pattern}, this must be the last entry.
1622
1623 *'cmdheight'* *'ch'*
1624'cmdheight' 'ch' number (default 1)
1625 global
1626 {not in Vi}
1627 Number of screen lines to use for the command-line. Helps avoiding
1628 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001629 The value of this option is stored with the tab page, so that each tab
1630 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631
1632 *'cmdwinheight'* *'cwh'*
1633'cmdwinheight' 'cwh' number (default 7)
1634 global
1635 {not in Vi}
1636 {not available when compiled without the |+vertsplit|
1637 feature}
1638 Number of screen lines to use for the command-line window. |cmdwin|
1639
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001640 *'colorcolumn'* *'cc'*
1641'colorcolumn' 'cc' string (default "")
1642 local to window
1643 {not in Vi}
1644 {not available when compiled without the |+syntax|
1645 feature}
1646 'colorcolumn' is a comma separated list of screen columns that are
1647 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1648 text. Will make screen redrawing slower.
1649 The screen column can be an absolute number, or a number preceded with
1650 '+' or '-', which is added to or subtracted from 'textwidth'. >
1651
1652 :set cc=+1 " highlight column after 'textwidth'
1653 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1654 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1655<
1656 When 'textwidth' is zero then the items with '-' and '+' are not used.
1657 A maximum of 256 columns are highlighted.
1658
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 *'columns'* *'co'* *E594*
1660'columns' 'co' number (default 80 or terminal width)
1661 global
1662 {not in Vi}
1663 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001664 initialization and does not have to be set by hand. Also see
1665 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 When Vim is running in the GUI or in a resizable window, setting this
1667 option will cause the window size to be changed. When you only want
1668 to use the size for the GUI, put the command in your |gvimrc| file.
1669 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001670 number of columns of the display, the display may be messed up. For
1671 the GUI it is always possible and Vim limits the number of columns to
1672 what fits on the screen. You can use this command to get the widest
1673 window possible: >
1674 :set columns=9999
1675< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676
1677 *'comments'* *'com'* *E524* *E525*
1678'comments' 'com' string (default
1679 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1680 local to buffer
1681 {not in Vi}
1682 {not available when compiled without the |+comments|
1683 feature}
1684 A comma separated list of strings that can start a comment line. See
1685 |format-comments|. See |option-backslash| about using backslashes to
1686 insert a space.
1687
1688 *'commentstring'* *'cms'* *E537*
1689'commentstring' 'cms' string (default "/*%s*/")
1690 local to buffer
1691 {not in Vi}
1692 {not available when compiled without the |+folding|
1693 feature}
1694 A template for a comment. The "%s" in the value is replaced with the
1695 comment text. Currently only used to add markers for folding, see
1696 |fold-marker|.
1697
1698 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001699'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001700 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 global
1702 {not in Vi}
1703 This option has the effect of making Vim either more Vi-compatible, or
1704 make Vim behave in a more useful way.
1705 This is a special kind of option, because when it's set or reset,
1706 other options are also changed as a side effect. CAREFUL: Setting or
1707 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001708 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 set this option in your vimrc file, you should probably put it at the
1710 very start.
1711 By default this option is on and the Vi defaults are used for the
1712 options. This default was chosen for those people who want to use Vim
1713 just like Vi, and don't even (want to) know about the 'compatible'
1714 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001715 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001716 this option is switched off, and all options that have not been
1717 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001718 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001719 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001720 happen for the system-wide vimrc or gvimrc file, nor for a file given
1721 with the |-u| argument). Also see |compatible-default| and
1722 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 You can also set this option with the "-C" argument, and reset it with
1724 "-N". See |-C| and |-N|.
1725 Switching this option off makes the Vim defaults be used for options
1726 that have a different Vi and Vim default value. See the options
1727 marked with a '+' below. Other options are not modified.
1728 At the moment this option is set, several other options will be set
1729 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001730 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 editing.
1732 See also 'cpoptions'.
1733
1734 option + set value effect ~
1735
1736 'allowrevins' off no CTRL-_ command
1737 'backupcopy' Unix: "yes" backup file is a copy
1738 others: "auto" copy or rename backup file
1739 'backspace' "" normal backspace
1740 'backup' off no backup file
1741 'cindent' off no C code indentation
1742 'cedit' + "" no key to open the |cmdwin|
1743 'cpoptions' + (all flags) Vi-compatible flags
1744 'cscopetag' off don't use cscope for ":tag"
1745 'cscopetagorder' 0 see |cscopetagorder|
1746 'cscopeverbose' off see |cscopeverbose|
1747 'digraph' off no digraphs
1748 'esckeys' + off no <Esc>-keys in Insert mode
1749 'expandtab' off tabs not expanded to spaces
1750 'fileformats' + "" no automatic file format detection,
1751 "dos,unix" except for DOS, Windows and OS/2
1752 'formatoptions' + "vt" Vi compatible formatting
1753 'gdefault' off no default 'g' flag for ":s"
1754 'history' + 0 no commandline history
1755 'hkmap' off no Hebrew keyboard mapping
1756 'hkmapp' off no phonetic Hebrew keyboard mapping
1757 'hlsearch' off no highlighting of search matches
1758 'incsearch' off no incremental searching
1759 'indentexpr' "" no indenting by expression
1760 'insertmode' off do not start in Insert mode
1761 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1762 characters and '_'
1763 'joinspaces' on insert 2 spaces after period
1764 'modeline' + off no modelines
1765 'more' + off no pauses in listings
1766 'revins' off no reverse insert
1767 'ruler' off no ruler
1768 'scrolljump' 1 no jump scroll
1769 'scrolloff' 0 no scroll offset
1770 'shiftround' off indent not rounded to shiftwidth
1771 'shortmess' + "" no shortening of messages
1772 'showcmd' + off command characters not shown
1773 'showmode' + off current mode not shown
1774 'smartcase' off no automatic ignore case switch
1775 'smartindent' off no smart indentation
1776 'smarttab' off no smart tab size
1777 'softtabstop' 0 tabs are always 'tabstop' positions
1778 'startofline' on goto startofline with some commands
1779 'tagrelative' + off tag file names are not relative
1780 'textauto' + off no automatic textmode detection
1781 'textwidth' 0 no automatic line wrap
1782 'tildeop' off tilde is not an operator
1783 'ttimeout' off no terminal timeout
1784 'whichwrap' + "" left-right movements don't wrap
1785 'wildchar' + CTRL-E only when the current value is <Tab>
1786 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001787 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789 *'complete'* *'cpt'* *E535*
1790'complete' 'cpt' string (default: ".,w,b,u,t,i")
1791 local to buffer
1792 {not in Vi}
1793 This option specifies how keyword completion |ins-completion| works
1794 when CTRL-P or CTRL-N are used. It is also used for whole-line
1795 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1796 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001797 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 w scan buffers from other windows
1799 b scan other loaded buffers that are in the buffer list
1800 u scan the unloaded buffers that are in the buffer list
1801 U scan the buffers that are not in the buffer list
1802 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001803 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 k{dict} scan the file {dict}. Several "k" flags can be given,
1805 patterns are valid too. For example: >
1806 :set cpt=k/usr/dict/*,k~/spanish
1807< s scan the files given with the 'thesaurus' option
1808 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1809 are valid too.
1810 i scan current and included files
1811 d scan current and included files for defined name or macro
1812 |i_CTRL-X_CTRL-D|
1813 ] tag completion
1814 t same as "]"
1815
1816 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1817 not executed, this may lead to unexpected completions from some files
1818 (gzipped files for example). Unloaded buffers are not scanned for
1819 whole-line completion.
1820
1821 The default is ".,w,b,u,t,i", which means to scan:
1822 1. the current buffer
1823 2. buffers in other windows
1824 3. other loaded buffers
1825 4. unloaded buffers
1826 5. tags
1827 6. included files
1828
1829 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001830 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1831 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001833 *'completefunc'* *'cfu'*
1834'completefunc' 'cfu' string (default: empty)
1835 local to buffer
1836 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001837 {not available when compiled without the |+eval|
1838 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001839 This option specifies a function to be used for Insert mode completion
1840 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001841 See |complete-functions| for an explanation of how the function is
1842 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001843 This option cannot be set from a |modeline| or in the |sandbox|, for
1844 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001845
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001846 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001847'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001848 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001849 {not available when compiled without the
1850 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001851 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001852 A comma separated list of options for Insert mode completion
1853 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001854
1855 menu Use a popup menu to show the possible completions. The
1856 menu is only shown when there is more than one match and
1857 sufficient colors are available. |ins-completion-menu|
1858
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001859 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001860 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001861 match, e.g., what file it comes from.
1862
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001863 longest Only insert the longest common text of the matches. If
1864 the menu is displayed you can use CTRL-L to add more
1865 characters. Whether case is ignored depends on the kind
1866 of completion. For buffer text the 'ignorecase' option is
1867 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001868
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001869 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001870 completion in the preview window. Only works in
1871 combination with "menu" or "menuone".
1872
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001873 noinsert Do not insert any text for a match until the user selects
1874 a match from the menu. Only works in combination with
1875 "menu" or "menuone". No effect if "longest" is present.
1876
1877 noselect Do not select a match in the menu, force the user to
1878 select one from the menu. Only works in combination with
1879 "menu" or "menuone".
1880
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001881
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001882 *'concealcursor'* *'cocu'*
1883'concealcursor' 'cocu' string (default: "")
1884 local to window
1885 {not in Vi}
1886 {not available when compiled without the |+conceal|
1887 feature}
1888 Sets the modes in which text in the cursor line can also be concealed.
1889 When the current mode is listed then concealing happens just like in
1890 other lines.
1891 n Normal mode
1892 v Visual mode
1893 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001894 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001895
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001896 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001897 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001898 are moving around text is concealed, but when starting to insert text
1899 or selecting a Visual area the concealed text is displayed, so that
1900 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001901 Keep in mind that the cursor position is not always where it's
1902 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001903
1904
1905'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001906 number (default 0)
1907 local to window
1908 {not in Vi}
1909 {not available when compiled without the |+conceal|
1910 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001911 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1912 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001913
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001914 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001915 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001916 1 Each block of concealed text is replaced with one
1917 character. If the syntax item does not have a custom
1918 replacement character defined (see |:syn-cchar|) the
1919 character defined in 'listchars' is used (default is a
1920 space).
1921 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001922 2 Concealed text is completely hidden unless it has a
1923 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001924 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001925 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001926
Bram Moolenaara7781e02010-07-19 20:13:22 +02001927 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001928 edit and copy the text. This can be changed with the 'concealcursor'
1929 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001930
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1932'confirm' 'cf' boolean (default off)
1933 global
1934 {not in Vi}
1935 When 'confirm' is on, certain operations that would normally
1936 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1937 instead raise a |dialog| asking if you wish to save the current
1938 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1939 If 'confirm' is off you can still activate confirmation for one
1940 command only (this is most useful in mappings) with the |:confirm|
1941 command.
1942 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1943
1944 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1945'conskey' 'consk' boolean (default off)
1946 global
1947 {not in Vi} {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001948 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949
1950 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1951'copyindent' 'ci' boolean (default off)
1952 local to buffer
1953 {not in Vi}
1954 Copy the structure of the existing lines indent when autoindenting a
1955 new line. Normally the new indent is reconstructed by a series of
1956 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1957 in which case only spaces are used). Enabling this option makes the
1958 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001959 existing line. 'expandtab' has no effect on these characters, a Tab
1960 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 line, the remaining space is filled in the normal manner.
1962 NOTE: 'copyindent' is reset when 'compatible' is set.
1963 Also see 'preserveindent'.
1964
Bram Moolenaare0fa3742016-02-20 15:47:01 +01001965 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966'cpoptions' 'cpo' string (Vim default: "aABceFs",
1967 Vi default: all flags)
1968 global
1969 {not in Vi}
1970 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001971 this indicates Vi-compatible behavior. This is used for things where
1972 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 'cpoptions' stands for "compatible-options".
1974 Commas can be added for readability.
1975 To avoid problems with flags that are added in the future, use the
1976 "+=" and "-=" feature of ":set" |add-option-flags|.
1977 NOTE: This option is set to the Vi default value when 'compatible' is
1978 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001979 NOTE: This option is set to the POSIX default value at startup when
1980 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001981 variable exists |posix|. This means Vim tries to behave like the
1982 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983
1984 contains behavior ~
1985 *cpo-a*
1986 a When included, a ":read" command with a file name
1987 argument will set the alternate file name for the
1988 current window.
1989 *cpo-A*
1990 A When included, a ":write" command with a file name
1991 argument will set the alternate file name for the
1992 current window.
1993 *cpo-b*
1994 b "\|" in a ":map" command is recognized as the end of
1995 the map command. The '\' is included in the mapping,
1996 the text after the '|' is interpreted as the next
1997 command. Use a CTRL-V instead of a backslash to
1998 include the '|' in the mapping. Applies to all
1999 mapping, abbreviation, menu and autocmd commands.
2000 See also |map_bar|.
2001 *cpo-B*
2002 B A backslash has no special meaning in mappings,
2003 abbreviations and the "to" part of the menu commands.
2004 Remove this flag to be able to use a backslash like a
2005 CTRL-V. For example, the command ":map X \<Esc>"
2006 results in X being mapped to:
2007 'B' included: "\^[" (^[ is a real <Esc>)
2008 'B' excluded: "<Esc>" (5 characters)
2009 ('<' excluded in both cases)
2010 *cpo-c*
2011 c Searching continues at the end of any match at the
2012 cursor position, but not further than the start of the
2013 next line. When not present searching continues
2014 one character from the cursor position. With 'c'
2015 "abababababab" only gets three matches when repeating
2016 "/abab", without 'c' there are five matches.
2017 *cpo-C*
2018 C Do not concatenate sourced lines that start with a
2019 backslash. See |line-continuation|.
2020 *cpo-d*
2021 d Using "./" in the 'tags' option doesn't mean to use
2022 the tags file relative to the current file, but the
2023 tags file in the current directory.
2024 *cpo-D*
2025 D Can't use CTRL-K to enter a digraph after Normal mode
2026 commands with a character argument, like |r|, |f| and
2027 |t|.
2028 *cpo-e*
2029 e When executing a register with ":@r", always add a
2030 <CR> to the last line, also when the register is not
2031 linewise. If this flag is not present, the register
2032 is not linewise and the last line does not end in a
2033 <CR>, then the last line is put on the command-line
2034 and can be edited before hitting <CR>.
2035 *cpo-E*
2036 E It is an error when using "y", "d", "c", "g~", "gu" or
2037 "gU" on an Empty region. The operators only work when
2038 at least one character is to be operate on. Example:
2039 This makes "y0" fail in the first column.
2040 *cpo-f*
2041 f When included, a ":read" command with a file name
2042 argument will set the file name for the current buffer,
2043 if the current buffer doesn't have a file name yet.
2044 *cpo-F*
2045 F When included, a ":write" command with a file name
2046 argument will set the file name for the current
2047 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002048 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 *cpo-g*
2050 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002051 *cpo-H*
2052 H When using "I" on a line with only blanks, insert
2053 before the last blank. Without this flag insert after
2054 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 *cpo-i*
2056 i When included, interrupting the reading of a file will
2057 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002058 *cpo-I*
2059 I When moving the cursor up or down just after inserting
2060 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 *cpo-j*
2062 j When joining lines, only add two spaces after a '.',
2063 not after '!' or '?'. Also see 'joinspaces'.
2064 *cpo-J*
2065 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002066 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 white space.
2068 *cpo-k*
2069 k Disable the recognition of raw key codes in
2070 mappings, abbreviations, and the "to" part of menu
2071 commands. For example, if <Key> sends ^[OA (where ^[
2072 is <Esc>), the command ":map X ^[OA" results in X
2073 being mapped to:
2074 'k' included: "^[OA" (3 characters)
2075 'k' excluded: "<Key>" (one key code)
2076 Also see the '<' flag below.
2077 *cpo-K*
2078 K Don't wait for a key code to complete when it is
2079 halfway a mapping. This breaks mapping <F1><F1> when
2080 only part of the second <F1> has been read. It
2081 enables cancelling the mapping by typing <F1><Esc>.
2082 *cpo-l*
2083 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002084 literally, only "\]", "\^", "\-" and "\\" are special.
2085 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2087 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002088 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 *cpo-L*
2090 L When the 'list' option is set, 'wrapmargin',
2091 'textwidth', 'softtabstop' and Virtual Replace mode
2092 (see |gR|) count a <Tab> as two characters, instead of
2093 the normal behavior of a <Tab>.
2094 *cpo-m*
2095 m When included, a showmatch will always wait half a
2096 second. When not included, a showmatch will wait half
2097 a second or until a character is typed. |'showmatch'|
2098 *cpo-M*
2099 M When excluded, "%" matching will take backslashes into
2100 account. Thus in "( \( )" and "\( ( \)" the outer
2101 parenthesis match. When included "%" ignores
2102 backslashes, which is Vi compatible.
2103 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002104 n When included, the column used for 'number' and
2105 'relativenumber' will also be used for text of wrapped
2106 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 *cpo-o*
2108 o Line offset to search command is not remembered for
2109 next search.
2110 *cpo-O*
2111 O Don't complain if a file is being overwritten, even
2112 when it didn't exist when editing it. This is a
2113 protection against a file unexpectedly created by
2114 someone else. Vi didn't complain about this.
2115 *cpo-p*
2116 p Vi compatible Lisp indenting. When not present, a
2117 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002118 *cpo-P*
2119 P When included, a ":write" command that appends to a
2120 file will set the file name for the current buffer, if
2121 the current buffer doesn't have a file name yet and
2122 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002123 *cpo-q*
2124 q When joining multiple lines leave the cursor at the
2125 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *cpo-r*
2127 r Redo ("." command) uses "/" to repeat a search
2128 command, instead of the actually used search string.
2129 *cpo-R*
2130 R Remove marks from filtered lines. Without this flag
2131 marks are kept like |:keepmarks| was used.
2132 *cpo-s*
2133 s Set buffer options when entering the buffer for the
2134 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002135 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 set when the buffer is created.
2137 *cpo-S*
2138 S Set buffer options always when entering a buffer
2139 (except 'readonly', 'fileformat', 'filetype' and
2140 'syntax'). This is the (most) Vi compatible setting.
2141 The options are set to the values in the current
2142 buffer. When you change an option and go to another
2143 buffer, the value is copied. Effectively makes the
2144 buffer options global to all buffers.
2145
2146 's' 'S' copy buffer options
2147 no no when buffer created
2148 yes no when buffer first entered (default)
2149 X yes each time when buffer entered (vi comp.)
2150 *cpo-t*
2151 t Search pattern for the tag command is remembered for
2152 "n" command. Otherwise Vim only puts the pattern in
2153 the history for search pattern, but doesn't change the
2154 last used search pattern.
2155 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002156 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 *cpo-v*
2158 v Backspaced characters remain visible on the screen in
2159 Insert mode. Without this flag the characters are
2160 erased from the screen right away. With this flag the
2161 screen newly typed text overwrites backspaced
2162 characters.
2163 *cpo-w*
2164 w When using "cw" on a blank character, only change one
2165 character and not all blanks until the start of the
2166 next word.
2167 *cpo-W*
2168 W Don't overwrite a readonly file. When omitted, ":w!"
2169 overwrites a readonly file, if possible.
2170 *cpo-x*
2171 x <Esc> on the command-line executes the command-line.
2172 The default in Vim is to abandon the command-line,
2173 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002174 *cpo-X*
2175 X When using a count with "R" the replaced text is
2176 deleted only once. Also when repeating "R" with "."
2177 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 *cpo-y*
2179 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 *cpo-Z*
2181 Z When using "w!" while the 'readonly' option is set,
2182 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 *cpo-!*
2184 ! When redoing a filter command, use the last used
2185 external command, whatever it was. Otherwise the last
2186 used -filter- command is used.
2187 *cpo-$*
2188 $ When making a change to one line, don't redisplay the
2189 line, but put a '$' at the end of the changed text.
2190 The changed text will be overwritten when you type the
2191 new text. The line is redisplayed if you type any
2192 command that moves the cursor from the insertion
2193 point.
2194 *cpo-%*
2195 % Vi-compatible matching is done for the "%" command.
2196 Does not recognize "#if", "#endif", etc.
2197 Does not recognize "/*" and "*/".
2198 Parens inside single and double quotes are also
2199 counted, causing a string that contains a paren to
2200 disturb the matching. For example, in a line like
2201 "if (strcmp("foo(", s))" the first paren does not
2202 match the last one. When this flag is not included,
2203 parens inside single and double quotes are treated
2204 specially. When matching a paren outside of quotes,
2205 everything inside quotes is ignored. When matching a
2206 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002207 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002208 This flag is also used for other features, such as
2209 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002210 *cpo--*
2211 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002212 it would go above the first line or below the last
2213 line. Without it the cursor moves to the first or
2214 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002215 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002216 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002217 *cpo-+*
2218 + When included, a ":write file" command will reset the
2219 'modified' flag of the buffer, even though the buffer
2220 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002221 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222 * Use ":*" in the same way as ":@". When not included,
2223 ":*" is an alias for ":'<,'>", select the Visual area.
2224 *cpo-<*
2225 < Disable the recognition of special key codes in |<>|
2226 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002227 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 ":map X <Tab>" results in X being mapped to:
2229 '<' included: "<Tab>" (5 characters)
2230 '<' excluded: "^I" (^I is a real <Tab>)
2231 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002232 *cpo->*
2233 > When appending to a register, put a line break before
2234 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002235 *cpo-;*
2236 ; When using |,| or |;| to repeat the last |t| search
2237 and the cursor is right in front of the searched
2238 character, the cursor won't move. When not included,
2239 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002240 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002241
2242 POSIX flags. These are not included in the Vi default value, except
2243 when $VIM_POSIX was set on startup. |posix|
2244
2245 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002246 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002248 *cpo-&*
2249 & When ":preserve" was used keep the swap file when
2250 exiting normally while this buffer is still loaded.
2251 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002252 *cpo-\*
2253 \ Backslash in a [] range in a search pattern is taken
2254 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002255 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2256 '\' excluded: "/[ \-]" finds <Space> and '-'
2257 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002258 *cpo-/*
2259 / When "%" is used as the replacement string in a |:s|
2260 command, use the previous replacement string. |:s%|
2261 *cpo-{*
2262 { The |{| and |}| commands also stop at a "{" character
2263 at the start of a line.
2264 *cpo-.*
2265 . The ":chdir" and ":cd" commands fail if the current
2266 buffer is modified, unless ! is used. Vim doesn't
2267 need this, since it remembers the full path of an
2268 opened file.
2269 *cpo-bar*
2270 | The value of the $LINES and $COLUMNS environment
2271 variables overrule the terminal size values obtained
2272 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002273
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002275 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002276'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002277 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002278 {not in Vi}
2279 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002280 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002281 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002282 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002283 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002284 blowfish Blowfish method. Medium strong encryption but it has
2285 an implementation flaw. Requires Vim 7.3 or later,
2286 files can NOT be read by Vim 7.2 and older. This adds
2287 a "seed" to the file, every time you write the file
2288 the encrypted bytes will be different.
2289 *blowfish2*
2290 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002291 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002292 and older. This adds a "seed" to the file, every time
2293 you write the file the encrypted bytes will be
2294 different. The whole undo file is encrypted, not just
2295 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002296
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002297 You should use "blowfish2", also to re-encrypt older files.
2298
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002299 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002300 to the detected method of the file being read. Thus if you write it
2301 without changing 'cryptmethod' the same method will be used.
2302 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002303 explicitly write it, you don't get a warning unless there are other
2304 modifications. Also see |:X|.
2305
2306 When setting the global value to an empty string, it will end up with
2307 the value "zip". When setting the local value to an empty string the
2308 buffer will use the global value.
2309
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002310 When a new encryption method is added in a later version of Vim, and
2311 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002312 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002313
2314
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 *'cscopepathcomp'* *'cspc'*
2316'cscopepathcomp' 'cspc' number (default 0)
2317 global
2318 {not available when compiled without the |+cscope|
2319 feature}
2320 {not in Vi}
2321 Determines how many components of the path to show in a list of tags.
2322 See |cscopepathcomp|.
2323
2324 *'cscopeprg'* *'csprg'*
2325'cscopeprg' 'csprg' string (default "cscope")
2326 global
2327 {not available when compiled without the |+cscope|
2328 feature}
2329 {not in Vi}
2330 Specifies the command to execute cscope. See |cscopeprg|.
2331 This option cannot be set from a |modeline| or in the |sandbox|, for
2332 security reasons.
2333
2334 *'cscopequickfix'* *'csqf'*
2335'cscopequickfix' 'csqf' string (default "")
2336 global
2337 {not available when compiled without the |+cscope|
2338 or |+quickfix| features}
2339 {not in Vi}
2340 Specifies whether to use quickfix window to show cscope results.
2341 See |cscopequickfix|.
2342
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002343 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002344'cscoperelative' 'csre' boolean (default off)
2345 global
2346 {not available when compiled without the |+cscope|
2347 feature}
2348 {not in Vi}
2349 In the absence of a prefix (-P) for cscope. setting this option enables
2350 to use the basename of cscope.out path as the prefix.
2351 See |cscoperelative|.
2352
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2354'cscopetag' 'cst' boolean (default off)
2355 global
2356 {not available when compiled without the |+cscope|
2357 feature}
2358 {not in Vi}
2359 Use cscope for tag commands. See |cscope-options|.
2360 NOTE: This option is reset when 'compatible' is set.
2361
2362 *'cscopetagorder'* *'csto'*
2363'cscopetagorder' 'csto' number (default 0)
2364 global
2365 {not available when compiled without the |+cscope|
2366 feature}
2367 {not in Vi}
2368 Determines the order in which ":cstag" performs a search. See
2369 |cscopetagorder|.
2370 NOTE: This option is set to 0 when 'compatible' is set.
2371
2372 *'cscopeverbose'* *'csverb'*
2373 *'nocscopeverbose'* *'nocsverb'*
2374'cscopeverbose' 'csverb' boolean (default off)
2375 global
2376 {not available when compiled without the |+cscope|
2377 feature}
2378 {not in Vi}
2379 Give messages when adding a cscope database. See |cscopeverbose|.
2380 NOTE: This option is reset when 'compatible' is set.
2381
Bram Moolenaar860cae12010-06-05 23:22:07 +02002382 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2383'cursorbind' 'crb' boolean (default off)
2384 local to window
2385 {not in Vi}
2386 {not available when compiled without the |+cursorbind|
2387 feature}
2388 When this option is set, as the cursor in the current
2389 window moves other cursorbound windows (windows that also have
2390 this option set) move their cursors to the corresponding line and
2391 column. This option is useful for viewing the
2392 differences between two versions of a file (see 'diff'); in diff mode,
2393 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002394 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002395
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002396
2397 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2398'cursorcolumn' 'cuc' boolean (default off)
2399 local to window
2400 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002401 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002402 feature}
2403 Highlight the screen column of the cursor with CursorColumn
2404 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2405 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002406 If you only want the highlighting in the current window you can use
2407 these autocommands: >
2408 au WinLeave * set nocursorline nocursorcolumn
2409 au WinEnter * set cursorline cursorcolumn
2410<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002411
2412 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2413'cursorline' 'cul' boolean (default off)
2414 local to window
2415 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002416 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002417 feature}
2418 Highlight the screen line of the cursor with CursorLine
2419 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2420 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002421 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002422 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002423
2424
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 *'debug'*
2426'debug' string (default "")
2427 global
2428 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002429 These values can be used:
2430 msg Error messages that would otherwise be omitted will be given
2431 anyway.
2432 throw Error messages that would otherwise be omitted will be given
2433 anyway and also throw an exception and set |v:errmsg|.
2434 beep A message will be given when otherwise only a beep would be
2435 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002436 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002437 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2438 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439
2440 *'define'* *'def'*
2441'define' 'def' string (default "^\s*#\s*define")
2442 global or local to buffer |global-local|
2443 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002444 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 pattern, just like for the "/" command. This option is used for the
2446 commands like "[i" and "[d" |include-search|. The 'isident' option is
2447 used to recognize the defined name after the match:
2448 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2449 See |option-backslash| about inserting backslashes to include a space
2450 or backslash.
2451 The default value is for C programs. For C++ this value would be
2452 useful, to include const type declarations: >
2453 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2454< When using the ":set" command, you need to double the backslashes!
2455
2456 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2457'delcombine' 'deco' boolean (default off)
2458 global
2459 {not in Vi}
2460 {only available when compiled with the |+multi_byte|
2461 feature}
2462 If editing Unicode and this option is set, backspace and Normal mode
2463 "x" delete each combining character on its own. When it is off (the
2464 default) the character along with its combining characters are
2465 deleted.
2466 Note: When 'delcombine' is set "xx" may work different from "2x"!
2467
2468 This is useful for Arabic, Hebrew and many other languages where one
2469 may have combining characters overtop of base characters, and want
2470 to remove only the combining ones.
2471
2472 *'dictionary'* *'dict'*
2473'dictionary' 'dict' string (default "")
2474 global or local to buffer |global-local|
2475 {not in Vi}
2476 List of file names, separated by commas, that are used to lookup words
2477 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2478 contain a list of words. This can be one word per line, or several
2479 words per line, separated by non-keyword characters (white space is
2480 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002481 When this option is empty, or an entry "spell" is present, spell
2482 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002483 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 after a comma are ignored, otherwise spaces are included in the file
2485 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002486 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 Where to find a list of words?
2488 - On FreeBSD, there is the file "/usr/share/dict/words".
2489 - In the Simtel archive, look in the "msdos/linguist" directory.
2490 - In "miscfiles" of the GNU collection.
2491 The use of |:set+=| and |:set-=| is preferred when adding or removing
2492 directories from the list. This avoids problems when a future version
2493 uses another default.
2494 Backticks cannot be used in this option for security reasons.
2495
2496 *'diff'* *'nodiff'*
2497'diff' boolean (default off)
2498 local to window
2499 {not in Vi}
2500 {not available when compiled without the |+diff|
2501 feature}
2502 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002503 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504
2505 *'dex'* *'diffexpr'*
2506'diffexpr' 'dex' string (default "")
2507 global
2508 {not in Vi}
2509 {not available when compiled without the |+diff|
2510 feature}
2511 Expression which is evaluated to obtain an ed-style diff file from two
2512 versions of a file. See |diff-diffexpr|.
2513 This option cannot be set from a |modeline| or in the |sandbox|, for
2514 security reasons.
2515
2516 *'dip'* *'diffopt'*
2517'diffopt' 'dip' string (default "filler")
2518 global
2519 {not in Vi}
2520 {not available when compiled without the |+diff|
2521 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002522 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 All are optional. Items must be separated by a comma.
2524
2525 filler Show filler lines, to keep the text
2526 synchronized with a window that has inserted
2527 lines at the same position. Mostly useful
2528 when windows are side-by-side and 'scrollbind'
2529 is set.
2530
2531 context:{n} Use a context of {n} lines between a change
2532 and a fold that contains unchanged lines.
2533 When omitted a context of six lines is used.
2534 See |fold-diff|.
2535
2536 icase Ignore changes in case of text. "a" and "A"
2537 are considered the same. Adds the "-i" flag
2538 to the "diff" command if 'diffexpr' is empty.
2539
2540 iwhite Ignore changes in amount of white space. Adds
2541 the "-b" flag to the "diff" command if
2542 'diffexpr' is empty. Check the documentation
2543 of the "diff" command for what this does
2544 exactly. It should ignore adding trailing
2545 white space, but not leading white space.
2546
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002547 horizontal Start diff mode with horizontal splits (unless
2548 explicitly specified otherwise).
2549
2550 vertical Start diff mode with vertical splits (unless
2551 explicitly specified otherwise).
2552
2553 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2554 starting diff mode. Without this 2 is used.
2555
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 Examples: >
2557
2558 :set diffopt=filler,context:4
2559 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002560 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561<
2562 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2563'digraph' 'dg' boolean (default off)
2564 global
2565 {not in Vi}
2566 {not available when compiled without the |+digraphs|
2567 feature}
2568 Enable the entering of digraphs in Insert mode with {char1} <BS>
2569 {char2}. See |digraphs|.
2570 NOTE: This option is reset when 'compatible' is set.
2571
2572 *'directory'* *'dir'*
2573'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002574 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 for Unix: ".,~/tmp,/var/tmp,/tmp")
2576 global
2577 List of directory names for the swap file, separated with commas.
2578 - The swap file will be created in the first directory where this is
2579 possible.
2580 - Empty means that no swap file will be used (recovery is
2581 impossible!).
2582 - A directory "." means to put the swap file in the same directory as
2583 the edited file. On Unix, a dot is prepended to the file name, so
2584 it doesn't show in a directory listing. On MS-Windows the "hidden"
2585 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002586 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 put the swap file relative to where the edited file is. The leading
2588 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002589 - For Unix and Win32, if a directory ends in two path separators "//"
2590 or "\\", the swap file name will be built from the complete path to
2591 the file with all path separators substituted to percent '%' signs.
2592 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002593 On Win32, when a separating comma is following, you must use "//",
2594 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 - Spaces after the comma are ignored, other spaces are considered part
2596 of the directory name. To have a space at the start of a directory
2597 name, precede it with a backslash.
2598 - To include a comma in a directory name precede it with a backslash.
2599 - A directory name may end in an ':' or '/'.
2600 - Environment variables are expanded |:set_env|.
2601 - Careful with '\' characters, type one before a space, type two to
2602 get one in the option (see |option-backslash|), for example: >
2603 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2604< - For backwards compatibility with Vim version 3.0 a '>' at the start
2605 of the option is removed.
2606 Using "." first in the list is recommended. This means that editing
2607 the same file twice will result in a warning. Using "/tmp" on Unix is
2608 discouraged: When the system crashes you lose the swap file.
2609 "/var/tmp" is often not cleared when rebooting, thus is a better
2610 choice than "/tmp". But it can contain a lot of files, your swap
2611 files get lost in the crowd. That is why a "tmp" directory in your
2612 home directory is tried first.
2613 The use of |:set+=| and |:set-=| is preferred when adding or removing
2614 directories from the list. This avoids problems when a future version
2615 uses another default.
2616 This option cannot be set from a |modeline| or in the |sandbox|, for
2617 security reasons.
2618 {Vi: directory to put temp file in, defaults to "/tmp"}
2619
2620 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002621'display' 'dy' string (default "", set to "truncate" in
2622 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 global
2624 {not in Vi}
2625 Change the way text is displayed. This is comma separated list of
2626 flags:
2627 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002628 in a window will be displayed. "@@@" is put in the
2629 last columns of the last screen line to indicate the
2630 rest of the line is not displayed.
2631 truncate Like "lastline", but "@@@" is displayed in the first
2632 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 uhex Show unprintable characters hexadecimal as <xx>
2634 instead of using ^C and ~C.
2635
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002636 When neither "lastline" or "truncate" is included, a last line that
2637 doesn't fit is replaced with "@" lines.
2638
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 *'eadirection'* *'ead'*
2640'eadirection' 'ead' string (default "both")
2641 global
2642 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002643 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 feature}
2645 Tells when the 'equalalways' option applies:
2646 ver vertically, width of windows is not affected
2647 hor horizontally, height of windows is not affected
2648 both width and height of windows is affected
2649
2650 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2651'edcompatible' 'ed' boolean (default off)
2652 global
2653 Makes the 'g' and 'c' flags of the ":substitute" command to be
2654 toggled each time the flag is given. See |complex-change|. See
2655 also 'gdefault' option.
2656 Switching this option on is discouraged!
2657
Bram Moolenaar03413f42016-04-12 21:07:15 +02002658 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002659'emoji' 'emo' boolean (default: on)
2660 global
2661 {not in Vi}
2662 {only available when compiled with the |+multi_byte|
2663 feature}
2664 When on all Unicode emoji characters are considered to be full width.
2665
2666
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 *'encoding'* *'enc'* *E543*
2668'encoding' 'enc' string (default: "latin1" or value from $LANG)
2669 global
2670 {only available when compiled with the |+multi_byte|
2671 feature}
2672 {not in Vi}
2673 Sets the character encoding used inside Vim. It applies to text in
2674 the buffers, registers, Strings in expressions, text stored in the
2675 viminfo file, etc. It sets the kind of characters which Vim can work
2676 with. See |encoding-names| for the possible values.
2677
2678 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002679 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002681 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682
Bram Moolenaar865242e2010-07-14 21:12:05 +02002683 This option cannot be set from a |modeline|. It would most likely
2684 corrupt the text.
2685
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2687 "utf-8". Although care has been taken to allow different values of
2688 'encoding', "utf-8" is the natural choice for the environment and
2689 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002690 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 versions, and to avoid changing the encoding of newly created files
2692 without your knowledge (in case 'fileencodings' is empty).
2693
2694 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002695 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 iconv() or as specified with 'charconvert'.
2697
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002698 If you need to know whether 'encoding' is a multi-byte encoding, you
2699 can use: >
2700 if has("multi_byte_encoding")
2701<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 Normally 'encoding' will be equal to your current locale. This will
2703 be the default if Vim recognizes your environment settings. If
2704 'encoding' is not set to the current locale, 'termencoding' must be
2705 set to convert typed and displayed text. See |encoding-table|.
2706
2707 When you set this option, it fires the |EncodingChanged| autocommand
2708 event so that you can set up fonts if necessary.
2709
2710 When the option is set, the value is converted to lowercase. Thus
2711 you can set it with uppercase values too. Underscores are translated
2712 to '-' signs.
2713 When the encoding is recognized, it is changed to the standard name.
2714 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2715 "iso-8859-2" and "utf8" becomes "utf-8".
2716
2717 Note: "latin1" is also used when the encoding could not be detected.
2718 This only works when editing files in the same encoding! When the
2719 actual character set is not latin1, make sure 'fileencoding' and
2720 'fileencodings' are empty. When conversion is needed, switch to using
2721 utf-8.
2722
2723 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2724 You don't notice this while editing, but it does matter for the
2725 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2726 setting 'encoding' to one of these values instead of utf-8 only has
2727 effect for encoding used for files when 'fileencoding' is empty.
2728
Bram Moolenaar661b1822005-07-28 22:36:45 +00002729 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2730 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2733'endofline' 'eol' boolean (default on)
2734 local to buffer
2735 {not in Vi}
2736 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002737 is on, or 'fixeol' option is off, no <EOL> will be written for the
2738 last line in the file. This option is automatically set or reset when
2739 starting to edit a new file, depending on whether file has an <EOL>
2740 for the last line in the file. Normally you don't have to set or
2741 reset this option.
2742 When 'binary' is off and 'fixeol' is on the value is not used when
2743 writing the file. When 'binary' is on or 'fixeol' is off it is used
2744 to remember the presence of a <EOL> for the last line in the file, so
2745 that when you write the file the situation from the original file can
2746 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747
2748 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2749'equalalways' 'ea' boolean (default on)
2750 global
2751 {not in Vi}
2752 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002753 splitting or closing a window. This also happens the moment the
2754 option is switched on. When off, splitting a window will reduce the
2755 size of the current window and leave the other windows the same. When
2756 closing a window the extra lines are given to the window next to it
2757 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 When mixing vertically and horizontally split windows, a minimal size
2759 is computed and some windows may be larger if there is room. The
2760 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002761 Changing the height and width of a window can be avoided by setting
2762 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002763 If a window size is specified when creating a new window sizes are
2764 currently not equalized (it's complicated, but may be implemented in
2765 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766
2767 *'equalprg'* *'ep'*
2768'equalprg' 'ep' string (default "")
2769 global or local to buffer |global-local|
2770 {not in Vi}
2771 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002772 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002773 or 'indentexpr'. When Vim was compiled without internal formatting,
2774 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002775 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 about including spaces and backslashes.
2777 This option cannot be set from a |modeline| or in the |sandbox|, for
2778 security reasons.
2779
2780 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2781'errorbells' 'eb' boolean (default off)
2782 global
2783 Ring the bell (beep or screen flash) for error messages. This only
2784 makes a difference for error messages, the bell will be used always
2785 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002786 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002787 screen flash or do nothing. See 'belloff' to finetune when to ring the
2788 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789
2790 *'errorfile'* *'ef'*
2791'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2792 others: "errors.err")
2793 global
2794 {not in Vi}
2795 {not available when compiled without the |+quickfix|
2796 feature}
2797 Name of the errorfile for the QuickFix mode (see |:cf|).
2798 When the "-q" command-line argument is used, 'errorfile' is set to the
2799 following argument. See |-q|.
2800 NOT used for the ":make" command. See 'makeef' for that.
2801 Environment variables are expanded |:set_env|.
2802 See |option-backslash| about including spaces and backslashes.
2803 This option cannot be set from a |modeline| or in the |sandbox|, for
2804 security reasons.
2805
2806 *'errorformat'* *'efm'*
2807'errorformat' 'efm' string (default is very long)
2808 global or local to buffer |global-local|
2809 {not in Vi}
2810 {not available when compiled without the |+quickfix|
2811 feature}
2812 Scanf-like description of the format for the lines in the error file
2813 (see |errorformat|).
2814
2815 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2816'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2817 global
2818 {not in Vi}
2819 Function keys that start with an <Esc> are recognized in Insert
2820 mode. When this option is off, the cursor and function keys cannot be
2821 used in Insert mode if they start with an <Esc>. The advantage of
2822 this is that the single <Esc> is recognized immediately, instead of
2823 after one second. Instead of resetting this option, you might want to
2824 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2825 when 'esckeys' is off, you can still map anything, but the cursor keys
2826 won't work by default.
2827 NOTE: This option is set to the Vi default value when 'compatible' is
2828 set and to the Vim default value when 'compatible' is reset.
2829
2830 *'eventignore'* *'ei'*
2831'eventignore' 'ei' string (default "")
2832 global
2833 {not in Vi}
2834 {not available when compiled without the |+autocmd|
2835 feature}
2836 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002837 When set to "all" or when "all" is one of the items, all autocommand
2838 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 Otherwise this is a comma separated list of event names. Example: >
2840 :set ei=WinEnter,WinLeave
2841<
2842 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2843'expandtab' 'et' boolean (default off)
2844 local to buffer
2845 {not in Vi}
2846 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2849 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002850 This option is reset when the 'paste' option is set and restored when
2851 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 NOTE: This option is reset when 'compatible' is set.
2853
2854 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2855'exrc' 'ex' boolean (default off)
2856 global
2857 {not in Vi}
2858 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2859 directory. If you switch this option on you should also consider
2860 setting the 'secure' option (see |initialization|). Using a local
2861 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2862 also see |.vimrc| and |gui-init|.
2863 This option cannot be set from a |modeline| or in the |sandbox|, for
2864 security reasons.
2865
2866 *'fileencoding'* *'fenc'* *E213*
2867'fileencoding' 'fenc' string (default: "")
2868 local to buffer
2869 {only available when compiled with the |+multi_byte|
2870 feature}
2871 {not in Vi}
2872 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002873
Bram Moolenaar071d4272004-06-13 20:20:40 +00002874 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002875 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 When 'fileencoding' is empty, the same value as 'encoding' will be
2877 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002878 Conversion will also be done when 'encoding' and 'fileencoding' are
2879 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2880 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002882 'encoding' is "utf-8" or another Unicode encoding, conversion
2883 is most likely done in a way that the reverse conversion
2884 results in the same text. When 'encoding' is not "utf-8" some
2885 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002886
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 See 'encoding' for the possible values. Additionally, values may be
2888 specified that can be handled by the converter, see
2889 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002890
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 When reading a file 'fileencoding' will be set from 'fileencodings'.
2892 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002893 'fileencoding', use the |++enc| argument. One exception: when
2894 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002895 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002896
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2898 When the option is set, the value is converted to lowercase. Thus
2899 you can set it with uppercase values too. '_' characters are
2900 replaced with '-'. If a name is recognized from the list for
2901 'encoding', it is replaced by the standard name. For example
2902 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002903
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 When this option is set, after starting to edit a file, the 'modified'
2905 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002906
2907 Keep in mind that changing 'fenc' from a modeline happens
2908 AFTER the text has been read, thus it applies to when the file will be
2909 written. If you do set 'fenc' in a modeline, you might want to set
2910 'nomodified' to avoid not being able to ":q".
2911
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 This option can not be changed when 'modifiable' is off.
2913
2914 *'fe'*
2915 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002916 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 old short name was 'fe', which is no longer used.
2918
2919 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002920'fileencodings' 'fencs' string (default: "ucs-bom",
2921 "ucs-bom,utf-8,default,latin1" when
2922 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 global
2924 {only available when compiled with the |+multi_byte|
2925 feature}
2926 {not in Vi}
2927 This is a list of character encodings considered when starting to edit
2928 an existing file. When a file is read, Vim tries to use the first
2929 mentioned character encoding. If an error is detected, the next one
2930 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002931 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 an empty string, which means the value of 'encoding' is used.
2933 WARNING: Conversion can cause loss of information! When
2934 'encoding' is "utf-8" (or one of the other Unicode variants)
2935 conversion is most likely done in a way that the reverse
2936 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002937 "utf-8" some non-ASCII characters may be lost! You can use
2938 the |++bad| argument to specify what is done with characters
2939 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 For an empty file or a file with only ASCII characters most encodings
2941 will work and the first entry of 'fileencodings' will be used (except
2942 "ucs-bom", which requires the BOM to be present). If you prefer
2943 another encoding use an BufReadPost autocommand event to test if your
2944 preferred encoding is to be used. Example: >
2945 au BufReadPost * if search('\S', 'w') == 0 |
2946 \ set fenc=iso-2022-jp | endif
2947< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2948 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002949 When the |++enc| argument is used then the value of 'fileencodings' is
2950 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002951 Note that 'fileencodings' is not used for a new file, the global value
2952 of 'fileencoding' is used instead. You can set it with: >
2953 :setglobal fenc=iso-8859-2
2954< This means that a non-existing file may get a different encoding than
2955 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 The special value "ucs-bom" can be used to check for a Unicode BOM
2957 (Byte Order Mark) at the start of the file. It must not be preceded
2958 by "utf-8" or another Unicode encoding for this to work properly.
2959 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2960 because Vim cannot detect an error, thus the encoding is always
2961 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002962 The special value "default" can be used for the encoding from the
2963 environment. This is the default value for 'encoding'. It is useful
2964 when 'encoding' is set to "utf-8" and your environment uses a
2965 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002966 When 'encoding' is "utf-8" and a file contains an illegal byte
2967 sequence it won't be recognized as UTF-8. You can use the |8g8|
2968 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 WRONG VALUES: WHAT'S WRONG:
2970 latin1,utf-8 "latin1" will always be used
2971 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2972 file
2973 cp1250,latin1 "cp1250" will always be used
2974 If 'fileencodings' is empty, 'fileencoding' is not modified.
2975 See 'fileencoding' for the possible values.
2976 Setting this option does not have an effect until the next time a file
2977 is read.
2978
2979 *'fileformat'* *'ff'*
2980'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2981 Unix default: "unix",
2982 Macintosh default: "mac")
2983 local to buffer
2984 {not in Vi}
2985 This gives the <EOL> of the current buffer, which is used for
2986 reading/writing the buffer from/to a file:
2987 dos <CR> <NL>
2988 unix <NL>
2989 mac <CR>
2990 When "dos" is used, CTRL-Z at the end of a file is ignored.
2991 See |file-formats| and |file-read|.
2992 For the character encoding of the file see 'fileencoding'.
2993 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002994 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 This option is set automatically when starting to edit a file and
2996 'fileformats' is not empty and 'binary' is off.
2997 When this option is set, after starting to edit a file, the 'modified'
2998 option is set, because the file would be different when written.
2999 This option can not be changed when 'modifiable' is off.
3000 For backwards compatibility: When this option is set to "dos",
3001 'textmode' is set, otherwise 'textmode' is reset.
3002
3003 *'fileformats'* *'ffs'*
3004'fileformats' 'ffs' string (default:
3005 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
3006 Vim Unix: "unix,dos",
3007 Vim Mac: "mac,unix,dos",
3008 Vi Cygwin: "unix,dos",
3009 Vi others: "")
3010 global
3011 {not in Vi}
3012 This gives the end-of-line (<EOL>) formats that will be tried when
3013 starting to edit a new buffer and when reading a file into an existing
3014 buffer:
3015 - When empty, the format defined with 'fileformat' will be used
3016 always. It is not set automatically.
3017 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 'fileformats' name will be used when a file is read into an existing
3020 buffer, no matter what 'fileformat' for that buffer is set to.
3021 - When more than one name is present, separated by commas, automatic
3022 <EOL> detection will be done when reading a file. When starting to
3023 edit a file, a check is done for the <EOL>:
3024 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3025 'fileformat' is set to "dos".
3026 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003027 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003029 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3030 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003031 This means that "mac" is only chosen when:
3032 "unix" is not present or no <NL> is found in the file, and
3033 "dos" is not present or no <CR><NL> is found in the file.
3034 Except: if "unix" was chosen, but there is a <CR> before
3035 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003036 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 4. If 'fileformat' is still not set, the first name from
3038 'fileformats' is used.
3039 When reading a file into an existing buffer, the same is done, but
3040 this happens like 'fileformat' has been set appropriately for that
3041 file only, the option is not changed.
3042 When 'binary' is set, the value of 'fileformats' is not used.
3043
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003044 When Vim starts up with an empty buffer the first item is used. You
3045 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003046
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3048 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3049 done:
3050 - When 'fileformats' is empty, there is no automatic detection. Dos
3051 format will be used.
3052 - When 'fileformats' is set to one or more names, automatic detection
3053 is done. This is based on the first <NL> in the file: If there is a
3054 <CR> in front of it, Dos format is used, otherwise Unix format is
3055 used.
3056 Also see |file-formats|.
3057 For backwards compatibility: When this option is set to an empty
3058 string or one format (no comma is included), 'textauto' is reset,
3059 otherwise 'textauto' is set.
3060 NOTE: This option is set to the Vi default value when 'compatible' is
3061 set and to the Vim default value when 'compatible' is reset.
3062
Bram Moolenaarbf884932013-04-05 22:26:15 +02003063 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3064'fileignorecase' 'fic' boolean (default on for systems where case in file
3065 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003066 global
3067 {not in Vi}
3068 When set case is ignored when using file names and directories.
3069 See 'wildignorecase' for only ignoring case when doing completion.
3070
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 *'filetype'* *'ft'*
3072'filetype' 'ft' string (default: "")
3073 local to buffer
3074 {not in Vi}
3075 {not available when compiled without the |+autocmd|
3076 feature}
3077 When this option is set, the FileType autocommand event is triggered.
3078 All autocommands that match with the value of this option will be
3079 executed. Thus the value of 'filetype' is used in place of the file
3080 name.
3081 Otherwise this option does not always reflect the current file type.
3082 This option is normally set when the file type is detected. To enable
3083 this use the ":filetype on" command. |:filetype|
3084 Setting this option to a different value is most useful in a modeline,
3085 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003086 Example, for in an IDL file:
3087 /* vim: set filetype=idl : */ ~
3088 |FileType| |filetypes|
3089 When a dot appears in the value then this separates two filetype
3090 names. Example:
3091 /* vim: set filetype=c.doxygen : */ ~
3092 This will use the "c" filetype first, then the "doxygen" filetype.
3093 This works both for filetype plugins and for syntax files. More than
3094 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 This option is not copied to another buffer, independent of the 's' or
3096 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003097 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098
3099 *'fillchars'* *'fcs'*
3100'fillchars' 'fcs' string (default "vert:|,fold:-")
3101 global
3102 {not in Vi}
3103 {not available when compiled without the |+windows|
3104 and |+folding| features}
3105 Characters to fill the statuslines and vertical separators.
3106 It is a comma separated list of items:
3107
3108 item default Used for ~
3109 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003110 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 vert:c '|' vertical separators |:vsplit|
3112 fold:c '-' filling 'foldtext'
3113 diff:c '-' deleted lines of the 'diff' option
3114
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003115 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003116 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 otherwise.
3118
3119 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003120 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121< This is similar to the default, except that these characters will also
3122 be used when there is highlighting.
3123
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003124 for "stl" and "stlnc" only single-byte values are supported.
3125
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 The highlighting used for these items:
3127 item highlight group ~
3128 stl:c StatusLine |hl-StatusLine|
3129 stlnc:c StatusLineNC |hl-StatusLineNC|
3130 vert:c VertSplit |hl-VertSplit|
3131 fold:c Folded |hl-Folded|
3132 diff:c DiffDelete |hl-DiffDelete|
3133
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003134 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3135'fixendofline' 'fixeol' boolean (default on)
3136 local to buffer
3137 {not in Vi}
3138 When writing a file and this option is on, <EOL> at the end of file
3139 will be restored if missing. Turn this option off if you want to
3140 preserve the situation from the original file.
3141 When the 'binary' option is set the value of this option doesn't
3142 matter.
3143 See the 'endofline' option.
3144
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3146'fkmap' 'fk' boolean (default off) *E198*
3147 global
3148 {not in Vi}
3149 {only available when compiled with the |+rightleft|
3150 feature}
3151 When on, the keyboard is mapped for the Farsi character set.
3152 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003153 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154
3155 *'foldclose'* *'fcl'*
3156'foldclose' 'fcl' string (default "")
3157 global
3158 {not in Vi}
3159 {not available when compiled without the |+folding|
3160 feature}
3161 When set to "all", a fold is closed when the cursor isn't in it and
3162 its level is higher than 'foldlevel'. Useful if you want folds to
3163 automatically close when moving out of them.
3164
3165 *'foldcolumn'* *'fdc'*
3166'foldcolumn' 'fdc' number (default 0)
3167 local to window
3168 {not in Vi}
3169 {not available when compiled without the |+folding|
3170 feature}
3171 When non-zero, a column with the specified width is shown at the side
3172 of the window which indicates open and closed folds. The maximum
3173 value is 12.
3174 See |folding|.
3175
3176 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3177'foldenable' 'fen' boolean (default on)
3178 local to window
3179 {not in Vi}
3180 {not available when compiled without the |+folding|
3181 feature}
3182 When off, all folds are open. This option can be used to quickly
3183 switch between showing all text unfolded and viewing the text with
3184 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003185 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 'foldenable' is off.
3187 This option is set by commands that create a new fold or close a fold.
3188 See |folding|.
3189
3190 *'foldexpr'* *'fde'*
3191'foldexpr' 'fde' string (default: "0")
3192 local to window
3193 {not in Vi}
3194 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003195 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003197 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003198
Bram Moolenaar30b65812012-07-12 22:01:11 +02003199 The expression will be evaluated in the |sandbox| if set from a
3200 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003201 This option can't be set from a |modeline| when the 'diff' option is
3202 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003203
3204 It is not allowed to change text or jump to another window while
3205 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206
3207 *'foldignore'* *'fdi'*
3208'foldignore' 'fdi' string (default: "#")
3209 local to window
3210 {not in Vi}
3211 {not available when compiled without the |+folding|
3212 feature}
3213 Used only when 'foldmethod' is "indent". Lines starting with
3214 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003215 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 The default "#" works well for C programs. See |fold-indent|.
3217
3218 *'foldlevel'* *'fdl'*
3219'foldlevel' 'fdl' number (default: 0)
3220 local to window
3221 {not in Vi}
3222 {not available when compiled without the |+folding|
3223 feature}
3224 Sets the fold level: Folds with a higher level will be closed.
3225 Setting this option to zero will close all folds. Higher numbers will
3226 close fewer folds.
3227 This option is set by commands like |zm|, |zM| and |zR|.
3228 See |fold-foldlevel|.
3229
3230 *'foldlevelstart'* *'fdls'*
3231'foldlevelstart' 'fdls' number (default: -1)
3232 global
3233 {not in Vi}
3234 {not available when compiled without the |+folding|
3235 feature}
3236 Sets 'foldlevel' when starting to edit another buffer in a window.
3237 Useful to always start editing with all folds closed (value zero),
3238 some folds closed (one) or no folds closed (99).
3239 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003240 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 ignores this option and closes all folds.
3242 It is also done before BufReadPre autocommands, to allow an autocmd to
3243 overrule the 'foldlevel' value for specific files.
3244 When the value is negative, it is not used.
3245
3246 *'foldmarker'* *'fmr'* *E536*
3247'foldmarker' 'fmr' string (default: "{{{,}}}")
3248 local to window
3249 {not in Vi}
3250 {not available when compiled without the |+folding|
3251 feature}
3252 The start and end marker used when 'foldmethod' is "marker". There
3253 must be one comma, which separates the start and end marker. The
3254 marker is a literal string (a regular expression would be too slow).
3255 See |fold-marker|.
3256
3257 *'foldmethod'* *'fdm'*
3258'foldmethod' 'fdm' string (default: "manual")
3259 local to window
3260 {not in Vi}
3261 {not available when compiled without the |+folding|
3262 feature}
3263 The kind of folding used for the current window. Possible values:
3264 |fold-manual| manual Folds are created manually.
3265 |fold-indent| indent Lines with equal indent form a fold.
3266 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3267 |fold-marker| marker Markers are used to specify folds.
3268 |fold-syntax| syntax Syntax highlighting items specify folds.
3269 |fold-diff| diff Fold text that is not changed.
3270
3271 *'foldminlines'* *'fml'*
3272'foldminlines' 'fml' number (default: 1)
3273 local to window
3274 {not in Vi}
3275 {not available when compiled without the |+folding|
3276 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003277 Sets the number of screen lines above which a fold can be displayed
3278 closed. Also for manually closed folds. With the default value of
3279 one a fold can only be closed if it takes up two or more screen lines.
3280 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003281 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 "zc" to close a fold, which is displayed open because it's smaller
3283 than 'foldminlines', a following "zc" may close a containing fold.
3284
3285 *'foldnestmax'* *'fdn'*
3286'foldnestmax' 'fdn' number (default: 20)
3287 local to window
3288 {not in Vi}
3289 {not available when compiled without the |+folding|
3290 feature}
3291 Sets the maximum nesting of folds for the "indent" and "syntax"
3292 methods. This avoids that too many folds will be created. Using more
3293 than 20 doesn't work, because the internal limit is 20.
3294
3295 *'foldopen'* *'fdo'*
3296'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3297 search,tag,undo")
3298 global
3299 {not in Vi}
3300 {not available when compiled without the |+folding|
3301 feature}
3302 Specifies for which type of commands folds will be opened, if the
3303 command moves the cursor into a closed fold. It is a comma separated
3304 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003305 NOTE: When the command is part of a mapping this option is not used.
3306 Add the |zv| command to the mapping to get the same effect.
3307 (rationale: the mapping may want to control opening folds itself)
3308
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 item commands ~
3310 all any
3311 block "(", "{", "[[", "[{", etc.
3312 hor horizontal movements: "l", "w", "fx", etc.
3313 insert any command in Insert mode
3314 jump far jumps: "G", "gg", etc.
3315 mark jumping to a mark: "'m", CTRL-O, etc.
3316 percent "%"
3317 quickfix ":cn", ":crew", ":make", etc.
3318 search search for a pattern: "/", "n", "*", "gd", etc.
3319 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003320 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 tag jumping to a tag: ":ta", CTRL-T, etc.
3322 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 When a movement command is used for an operator (e.g., "dl" or "y%")
3324 this option is not used. This means the operator will include the
3325 whole closed fold.
3326 Note that vertical movements are not here, because it would make it
3327 very difficult to move onto a closed fold.
3328 In insert mode the folds containing the cursor will always be open
3329 when text is inserted.
3330 To close folds you can re-apply 'foldlevel' with the |zx| command or
3331 set the 'foldclose' option to "all".
3332
3333 *'foldtext'* *'fdt'*
3334'foldtext' 'fdt' string (default: "foldtext()")
3335 local to window
3336 {not in Vi}
3337 {not available when compiled without the |+folding|
3338 feature}
3339 An expression which is used to specify the text displayed for a closed
3340 fold. See |fold-foldtext|.
3341
Bram Moolenaar30b65812012-07-12 22:01:11 +02003342 The expression will be evaluated in the |sandbox| if set from a
3343 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003344
3345 It is not allowed to change text or jump to another window while
3346 evaluating 'foldtext' |textlock|.
3347
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003348 *'formatexpr'* *'fex'*
3349'formatexpr' 'fex' string (default "")
3350 local to buffer
3351 {not in Vi}
3352 {not available when compiled without the |+eval|
3353 feature}
3354 Expression which is evaluated to format a range of lines for the |gq|
3355 operator or automatic formatting (see 'formatoptions'). When this
3356 option is empty 'formatprg' is used.
3357
3358 The |v:lnum| variable holds the first line to be formatted.
3359 The |v:count| variable holds the number of lines to be formatted.
3360 The |v:char| variable holds the character that is going to be
3361 inserted if the expression is being evaluated due to
3362 automatic formatting. This can be empty. Don't insert
3363 it yet!
3364
3365 Example: >
3366 :set formatexpr=mylang#Format()
3367< This will invoke the mylang#Format() function in the
3368 autoload/mylang.vim file in 'runtimepath'. |autoload|
3369
3370 The expression is also evaluated when 'textwidth' is set and adding
3371 text beyond that limit. This happens under the same conditions as
3372 when internal formatting is used. Make sure the cursor is kept in the
3373 same spot relative to the text then! The |mode()| function will
3374 return "i" or "R" in this situation.
3375
3376 When the expression evaluates to non-zero Vim will fall back to using
3377 the internal format mechanism.
3378
3379 The expression will be evaluated in the |sandbox| when set from a
3380 modeline, see |sandbox-option|. That stops the option from working,
3381 since changing the buffer text is not allowed.
3382
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 *'formatoptions'* *'fo'*
3384'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3385 local to buffer
3386 {not in Vi}
3387 This is a sequence of letters which describes how automatic
3388 formatting is to be done. See |fo-table|. When the 'paste' option is
3389 on, no formatting is done (like 'formatoptions' is empty). Commas can
3390 be inserted for readability.
3391 To avoid problems with flags that are added in the future, use the
3392 "+=" and "-=" feature of ":set" |add-option-flags|.
3393 NOTE: This option is set to the Vi default value when 'compatible' is
3394 set and to the Vim default value when 'compatible' is reset.
3395
Bram Moolenaar86b68352004-12-27 21:59:20 +00003396 *'formatlistpat'* *'flp'*
3397'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3398 local to buffer
3399 {not in Vi}
3400 A pattern that is used to recognize a list header. This is used for
3401 the "n" flag in 'formatoptions'.
3402 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003403 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003404 while still checking more characters. There must be a character
3405 following the pattern, when it matches the whole line it is handled
3406 like there is no match.
3407 The default recognizes a number, followed by an optional punctuation
3408 character and white space.
3409
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 *'formatprg'* *'fp'*
3411'formatprg' 'fp' string (default "")
3412 global
3413 {not in Vi}
3414 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003415 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003417 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003418 If the 'formatexpr' option is not empty it will be used instead.
3419 Otherwise, if 'formatprg' option is an empty string, the internal
3420 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003421 Environment variables are expanded |:set_env|. See |option-backslash|
3422 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003423 This option cannot be set from a |modeline| or in the |sandbox|, for
3424 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425
Bram Moolenaard94464e2015-11-02 15:28:18 +01003426 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003427'fsync' 'fs' boolean (default on)
3428 global
3429 {not in Vi}
3430 When on, the library function fsync() will be called after writing a
3431 file. This will flush a file to disk, ensuring that it is safely
3432 written even on filesystems which do metadata-only journaling. This
3433 will force the harddrive to spin up on Linux systems running in laptop
3434 mode, so it may be undesirable in some situations. Be warned that
3435 turning this off increases the chances of data loss after a crash. On
3436 systems without an fsync() implementation, this variable is always
3437 off.
3438 Also see 'swapsync' for controlling fsync() on swap files.
3439
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3441'gdefault' 'gd' boolean (default off)
3442 global
3443 {not in Vi}
3444 When on, the ":substitute" flag 'g' is default on. This means that
3445 all matches in a line are substituted instead of one. When a 'g' flag
3446 is given to a ":substitute" command, this will toggle the substitution
3447 of all or one match. See |complex-change|.
3448
3449 command 'gdefault' on 'gdefault' off ~
3450 :s/// subst. all subst. one
3451 :s///g subst. one subst. all
3452 :s///gg subst. all subst. one
3453
3454 NOTE: This option is reset when 'compatible' is set.
3455
3456 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003457'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 global
3459 {not in Vi}
3460 Format to recognize for the ":grep" command output.
3461 This is a scanf-like string that uses the same format as the
3462 'errorformat' option: see |errorformat|.
3463
3464 *'grepprg'* *'gp'*
3465'grepprg' 'gp' string (default "grep -n ",
3466 Unix: "grep -n $* /dev/null",
3467 Win32: "findstr /n" or "grep -n",
3468 VMS: "SEARCH/NUMBERS ")
3469 global or local to buffer |global-local|
3470 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003471 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 and '#' characters, which are expanded like when used in a command-
3473 line. The placeholder "$*" is allowed to specify where the arguments
3474 will be included. Environment variables are expanded |:set_env|. See
3475 |option-backslash| about including spaces and backslashes.
3476 When your "grep" accepts the "-H" argument, use this to make ":grep"
3477 also work well with a single file: >
3478 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003479< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003480 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3481 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003482 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 apply equally to 'grepprg'.
3484 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3485 otherwise it's "grep -n".
3486 This option cannot be set from a |modeline| or in the |sandbox|, for
3487 security reasons.
3488
3489 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3490'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3491 ve:ver35-Cursor,
3492 o:hor50-Cursor,
3493 i-ci:ver25-Cursor/lCursor,
3494 r-cr:hor20-Cursor/lCursor,
3495 sm:block-Cursor
3496 -blinkwait175-blinkoff150-blinkon175",
3497 for MS-DOS and Win32 console:
3498 "n-v-c:block,o:hor50,i-ci:hor15,
3499 r-cr:hor30,sm:block")
3500 global
3501 {not in Vi}
3502 {only available when compiled with GUI enabled, and
3503 for MS-DOS and Win32 console}
3504 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003505 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 the height of the cursor can be changed. This can be done by
3507 specifying a block cursor, or a percentage for a vertical or
3508 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003509 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3510 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003512 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 mode-list and an argument-list:
3514 mode-list:argument-list,mode-list:argument-list,..
3515 The mode-list is a dash separated list of these modes:
3516 n Normal mode
3517 v Visual mode
3518 ve Visual mode with 'selection' "exclusive" (same as 'v',
3519 if not specified)
3520 o Operator-pending mode
3521 i Insert mode
3522 r Replace mode
3523 c Command-line Normal (append) mode
3524 ci Command-line Insert mode
3525 cr Command-line Replace mode
3526 sm showmatch in Insert mode
3527 a all modes
3528 The argument-list is a dash separated list of these arguments:
3529 hor{N} horizontal bar, {N} percent of the character height
3530 ver{N} vertical bar, {N} percent of the character width
3531 block block cursor, fills the whole character
3532 [only one of the above three should be present]
3533 blinkwait{N} *cursor-blinking*
3534 blinkon{N}
3535 blinkoff{N}
3536 blink times for cursor: blinkwait is the delay before
3537 the cursor starts blinking, blinkon is the time that
3538 the cursor is shown and blinkoff is the time that the
3539 cursor is not shown. The times are in msec. When one
3540 of the numbers is zero, there is no blinking. The
3541 default is: "blinkwait700-blinkon400-blinkoff250".
3542 These numbers are used for a missing entry. This
3543 means that blinking is enabled by default. To switch
3544 blinking off you can use "blinkon0". The cursor only
3545 blinks when Vim is waiting for input, not while
3546 executing a command.
3547 To make the cursor blink in an xterm, see
3548 |xterm-blink|.
3549 {group-name}
3550 a highlight group name, that sets the color and font
3551 for the cursor
3552 {group-name}/{group-name}
3553 Two highlight group names, the first is used when
3554 no language mappings are used, the other when they
3555 are. |language-mapping|
3556
3557 Examples of parts:
3558 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3559 block cursor with colors from the "nCursor"
3560 highlight group
3561 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3562 In Insert and Command-line Insert mode, use a
3563 30% vertical bar cursor with colors from the
3564 "iCursor" highlight group. Blink a bit
3565 faster.
3566
3567 The 'a' mode is different. It will set the given argument-list for
3568 all modes. It does not reset anything to defaults. This can be used
3569 to do a common setting for all modes. For example, to switch off
3570 blinking: "a:blinkon0"
3571
3572 Examples of cursor highlighting: >
3573 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3574 :highlight Cursor gui=NONE guifg=bg guibg=fg
3575<
3576 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003577 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578'guifont' 'gfn' string (default "")
3579 global
3580 {not in Vi}
3581 {only available when compiled with GUI enabled}
3582 This is a list of fonts which will be used for the GUI version of Vim.
3583 In its simplest form the value is just one font name. When
3584 the font cannot be found you will get an error message. To try other
3585 font names a list can be specified, font names separated with commas.
3586 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003587
Bram Moolenaar05159a02005-02-26 23:04:13 +00003588 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3589 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003590
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 Spaces after a comma are ignored. To include a comma in a font name
3592 precede it with a backslash. Setting an option requires an extra
3593 backslash before a space and a backslash. See also
3594 |option-backslash|. For example: >
3595 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003596< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003598
3599 If none of the fonts can be loaded, Vim will keep the current setting.
3600 If an empty font list is given, Vim will try using other resource
3601 settings (for X, it will use the Vim.font resource), and finally it
3602 will try some builtin default which should always be there ("7x13" in
3603 the case of X). The font names given should be "normal" fonts. Vim
3604 will try to find the related bold and italic fonts.
3605
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003606 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003607 :set guifont=*
3608< will bring up a font requester, where you can pick the font you want.
3609
3610 The font name depends on the GUI used. See |setting-guifont| for a
3611 way to set 'guifont' for various systems.
3612
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 For the GTK+ 2 GUI the font name looks like this: >
3614 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003615< That's all. XLFDs are not used. For Chinese this is reported to work
3616 well: >
3617 if has("gui_gtk2")
3618 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3619 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3620 endif
3621<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003622 For Mac OSX you can use something like this: >
3623 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003624< Also see 'macatsui', it can help fix display problems.
3625 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003627 width). An exception is GTK 2: all fonts are accepted, but
3628 mono-spaced fonts look best.
3629
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 To preview a font on X11, you might be able to use the "xfontsel"
3631 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003632
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 For the Win32 GUI *E244* *E245*
3634 - takes these options in the font name:
3635 hXX - height is XX (points, can be floating-point)
3636 wXX - width is XX (points, can be floating-point)
3637 b - bold
3638 i - italic
3639 u - underline
3640 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003641 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3643 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3644 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003645 Normally you would use "cDEFAULT".
Bram Moolenaar03413f42016-04-12 21:07:15 +02003646 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
Bram Moolenaar06d2d382016-05-20 17:24:11 +02003647 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02003648 Normally you would use "qDEFAULT".
Bram Moolenaardc1f1642016-08-16 18:33:43 +02003649 Some quality values are not supported in legacy OSs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650
3651 Use a ':' to separate the options.
3652 - A '_' can be used in the place of a space, so you don't need to use
3653 backslashes to escape the spaces.
3654 - Examples: >
3655 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3656 :set guifont=Andale_Mono:h7.5:w4.5
3657< See also |font-sizes|.
3658
3659 *'guifontset'* *'gfs'*
3660 *E250* *E252* *E234* *E597* *E598*
3661'guifontset' 'gfs' string (default "")
3662 global
3663 {not in Vi}
3664 {only available when compiled with GUI enabled and
3665 with the |+xfontset| feature}
3666 {not available in the GTK+ 2 GUI}
3667 When not empty, specifies two (or more) fonts to be used. The first
3668 one for normal English, the second one for your special language. See
3669 |xfontset|.
3670 Setting this option also means that all font names will be handled as
3671 a fontset name. Also the ones used for the "font" argument of the
3672 |:highlight| command.
3673 The fonts must match with the current locale. If fonts for the
3674 character sets that the current locale uses are not included, setting
3675 'guifontset' will fail.
3676 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3677 the comma-separated names are alternative names, one of which will be
3678 used. In 'guifontset' the whole string is one fontset name,
3679 including the commas. It is not possible to specify alternative
3680 fontset names.
3681 This example works on many X11 systems: >
3682 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3683<
3684 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3685'guifontwide' 'gfw' string (default "")
3686 global
3687 {not in Vi}
3688 {only available when compiled with GUI enabled}
3689 When not empty, specifies a comma-separated list of fonts to be used
3690 for double-width characters. The first font that can be loaded is
3691 used.
3692 Note: The size of these fonts must be exactly twice as wide as the one
3693 specified with 'guifont' and the same height.
3694
3695 All GUI versions but GTK+ 2:
3696
3697 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3698 'guifontset' is empty or invalid.
3699 When 'guifont' is set and a valid font is found in it and
3700 'guifontwide' is empty Vim will attempt to find a matching
3701 double-width font and set 'guifontwide' to it.
3702
3703 GTK+ 2 GUI only: *guifontwide_gtk2*
3704
3705 If set and valid, 'guifontwide' is always used for double width
3706 characters, even if 'encoding' is not set to "utf-8".
3707 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003708 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 font for characters not available in 'guifont'. Thus you do not need
3710 to set 'guifontwide' at all unless you want to override the choice
3711 made by Pango/Xft.
3712
Bram Moolenaar0f272122013-01-23 18:37:40 +01003713 Windows +multibyte only: *guifontwide_win_mbyte*
3714
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003715 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003716
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 *'guiheadroom'* *'ghr'*
3718'guiheadroom' 'ghr' number (default 50)
3719 global
3720 {not in Vi} {only for GTK and X11 GUI}
3721 The number of pixels subtracted from the screen height when fitting
3722 the GUI window on the screen. Set this before the GUI is started,
3723 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003724 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 lines will be left for window decorations and other items on the
3726 screen. Set it to a negative value to allow windows taller than the
3727 screen.
3728
3729 *'guioptions'* *'go'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003730'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is
3731 removed in |defaults.vim|),
3732 "aegimrLtT" (GTK, Motif and Athena),
3733 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 global
3735 {not in Vi}
3736 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003737 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 sequence of letters which describes what components and options of the
3739 GUI should be used.
3740 To avoid problems with flags that are added in the future, use the
3741 "+=" and "-=" feature of ":set" |add-option-flags|.
3742
3743 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003744 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 'a' Autoselect: If present, then whenever VISUAL mode is started,
3746 or the Visual area extended, Vim tries to become the owner of
3747 the windowing system's global selection. This means that the
3748 Visually highlighted text is available for pasting into other
3749 applications as well as into Vim itself. When the Visual mode
3750 ends, possibly due to an operation on the text, or when an
3751 application wants to paste the selection, the highlighted text
3752 is automatically yanked into the "* selection register.
3753 Thus the selection is still available for pasting into other
3754 applications after the VISUAL mode has ended.
3755 If not present, then Vim won't become the owner of the
3756 windowing system's global selection unless explicitly told to
3757 by a yank or delete operation for the "* register.
3758 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003759 *'go-P'*
3760 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003761 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003762 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003763 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 applies to the modeless selection.
3765
3766 'guioptions' autoselect Visual autoselect modeless ~
3767 "" - -
3768 "a" yes yes
3769 "A" - yes
3770 "aA" yes yes
3771
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 'c' Use console dialogs instead of popup dialogs for simple
3774 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003775 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003776 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003777 'guitablabel' can be used to change the text in the labels.
3778 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003779 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003780 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'f' Foreground: Don't use fork() to detach the GUI from the shell
3783 where it was started. Use this for programs that wait for the
3784 editor to finish (e.g., an e-mail program). Alternatively you
3785 can use "gvim -f" or ":gui -f" to start the GUI in the
3786 foreground. |gui-fork|
3787 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003788 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003789 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3791 corner of the window. It's black&white on non-GTK, because of
3792 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003793 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003795 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003796 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003798 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 file is sourced the system menu has already been loaded; the
3800 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003801 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'g' Grey menu items: Make menu items that are not active grey. If
3803 'g' is not included inactive menu items are not shown at all.
3804 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003805 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 't' Include tearoff menu items. Currently only works for Win32,
3807 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003808 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003809 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003810 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003811 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'R' Right-hand scrollbar is present when there is a vertically
3815 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003816 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003818 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 'L' Left-hand scrollbar is present when there is a vertically
3820 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003821 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3823 the longest visible line, or on the cursor line if the 'h'
3824 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003825 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 'h' Limit horizontal scrollbar size to the length of the cursor
3827 line. Reduces computations. |gui-horiz-scroll|
3828
3829 And yes, you may even have scrollbars on the left AND the right if
3830 you really want to :-). See |gui-scrollbars| for more information.
3831
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003832 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 'v' Use a vertical button layout for dialogs. When not included,
3834 a horizontal layout is preferred, but when it doesn't fit a
3835 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003836 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837 'p' Use Pointer callbacks for X11 GUI. This is required for some
3838 window managers. If the cursor is not blinking or hollow at
3839 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003840 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003842 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003843 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844
Bram Moolenaar02467872007-05-06 13:22:01 +00003845
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 *'guipty'* *'noguipty'*
3847'guipty' boolean (default on)
3848 global
3849 {not in Vi}
3850 {only available when compiled with GUI enabled}
3851 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3852 I/O to/from shell commands. See |gui-pty|.
3853
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003854 *'guitablabel'* *'gtl'*
3855'guitablabel' 'gtl' string (default empty)
3856 global
3857 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003858 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003859 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003860 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003861 pages line. When empty and when the result is empty Vim will use a
3862 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003863
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003864 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003865 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003866
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003867 Only used when the GUI tab pages line is displayed. 'e' must be
3868 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3869 used.
3870
Bram Moolenaar57657d82006-04-21 22:12:41 +00003871 *'guitabtooltip'* *'gtt'*
3872'guitabtooltip' 'gtt' string (default empty)
3873 global
3874 {not in Vi}
3875 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003876 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003877 When nonempty describes the text to use in a tooltip for the GUI tab
3878 pages line. When empty Vim will use a default tooltip.
3879 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003880 You can include a line break. Simplest method is to use |:let|: >
3881 :let &guitabtooltip = "line one\nline two"
3882<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003883
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 *'helpfile'* *'hf'*
3885'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3886 (others) "$VIMRUNTIME/doc/help.txt")
3887 global
3888 {not in Vi}
3889 Name of the main help file. All distributed help files should be
3890 placed together in one directory. Additionally, all "doc" directories
3891 in 'runtimepath' will be used.
3892 Environment variables are expanded |:set_env|. For example:
3893 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003894 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 spaces and backslashes.
3896 This option cannot be set from a |modeline| or in the |sandbox|, for
3897 security reasons.
3898
3899 *'helpheight'* *'hh'*
3900'helpheight' 'hh' number (default 20)
3901 global
3902 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003903 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 feature}
3905 Minimal initial height of the help window when it is opened with the
3906 ":help" command. The initial height of the help window is half of the
3907 current window, or (when the 'ea' option is on) the same as other
3908 windows. When the height is less than 'helpheight', the height is
3909 set to 'helpheight'. Set to zero to disable.
3910
3911 *'helplang'* *'hlg'*
3912'helplang' 'hlg' string (default: messages language or empty)
3913 global
3914 {only available when compiled with the |+multi_lang|
3915 feature}
3916 {not in Vi}
3917 Comma separated list of languages. Vim will use the first language
3918 for which the desired help can be found. The English help will always
3919 be used as a last resort. You can add "en" to prefer English over
3920 another language, but that will only find tags that exist in that
3921 language and not in the English help.
3922 Example: >
3923 :set helplang=de,it
3924< This will first search German, then Italian and finally English help
3925 files.
3926 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3927 try to find the tag in the current language before using this option.
3928 See |help-translated|.
3929
3930 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3931'hidden' 'hid' boolean (default off)
3932 global
3933 {not in Vi}
3934 When off a buffer is unloaded when it is |abandon|ed. When on a
3935 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3936 displayed in another window, it does not become hidden, of course.
3937 The commands that move through the buffer list sometimes make a buffer
3938 hidden although the 'hidden' option is off: When the buffer is
3939 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003940 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003941 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 This option is set for one command with ":hide {command}" |:hide|.
3943 WARNING: It's easy to forget that you have changes in hidden buffers.
3944 Think twice when using ":q!" or ":qa!".
3945
3946 *'highlight'* *'hl'*
3947'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003948 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3949 d:Directory,e:ErrorMsg,i:IncSearch,
3950 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3951 N:CursorLineNr,r:Question,s:StatusLine,
3952 S:StatusLineNC,c:VertSplit,t:Title,
3953 v:Visual,w:WarningMsg,W:WildMenu,f:Folded,
3954 F:FoldColumn,A:DiffAdd,C:DiffChange,
3955 D:DiffDelete,T:DiffText,>:SignColumn,
3956 B:SpellBad,P:SpellCap,R:SpellRare,
3957 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003958 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 global
3960 {not in Vi}
3961 This option can be used to set highlighting mode for various
3962 occasions. It is a comma separated list of character pairs. The
3963 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003964 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003966 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3967 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 characters from 'showbreak'
3969 |hl-Directory| d directories in CTRL-D listing and other special
3970 things in listings
3971 |hl-ErrorMsg| e error messages
3972 h (obsolete, ignored)
3973 |hl-IncSearch| i 'incsearch' highlighting
3974 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3975 |hl-MoreMsg| m |more-prompt|
3976 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003977 |hl-LineNr| n line number for ":number" and ":#" commands, and
3978 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003979 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3980 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 |hl-Question| r |hit-enter| prompt and yes/no questions
3982 |hl-StatusLine| s status line of current window |status-line|
3983 |hl-StatusLineNC| S status lines of not-current windows
3984 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3985 |hl-VertSplit| c column used to separate vertically split windows
3986 |hl-Visual| v Visual mode
3987 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3988 Selection" Only X11 Gui's |gui-x11| and
3989 |xterm-clipboard|.
3990 |hl-WarningMsg| w warning messages
3991 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3992 |hl-Folded| f line used for closed folds
3993 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003994 |hl-DiffAdd| A added line in diff mode
3995 |hl-DiffChange| C changed line in diff mode
3996 |hl-DiffDelete| D deleted line in diff mode
3997 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003999 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02004000 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00004001 |hl-SpellRare| R rare word |spell|
4002 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02004003 |hl-Conceal| - the placeholders used for concealed characters
4004 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00004005 |hl-Pmenu| + popup menu normal line
4006 |hl-PmenuSel| = popup menu normal line
4007 |hl-PmenuSbar| x popup menu scrollbar
4008 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009
4010 The display modes are:
4011 r reverse (termcap entry "mr" and "me")
4012 i italic (termcap entry "ZH" and "ZR")
4013 b bold (termcap entry "md" and "me")
4014 s standout (termcap entry "so" and "se")
4015 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004016 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 n no highlighting
4018 - no highlighting
4019 : use a highlight group
4020 The default is used for occasions that are not included.
4021 If you want to change what the display modes do, see |dos-colors|
4022 for an example.
4023 When using the ':' display mode, this must be followed by the name of
4024 a highlight group. A highlight group can be used to define any type
4025 of highlighting, including using color. See |:highlight| on how to
4026 define one. The default uses a different group for each occasion.
4027 See |highlight-default| for the default highlight groups.
4028
4029 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4030'hlsearch' 'hls' boolean (default off)
4031 global
4032 {not in Vi}
4033 {not available when compiled without the
4034 |+extra_search| feature}
4035 When there is a previous search pattern, highlight all its matches.
4036 The type of highlighting used can be set with the 'l' occasion in the
4037 'highlight' option. This uses the "Search" highlight group by
4038 default. Note that only the matching text is highlighted, any offsets
4039 are not applied.
4040 See also: 'incsearch' and |:match|.
4041 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004042 off with |:nohlsearch|. This does not change the option value, as
4043 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004044 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 When the search pattern can match an end-of-line, Vim will try to
4046 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004047 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004049 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004050 You can specify whether the highlight status is restored on startup
4051 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004052 NOTE: This option is reset when 'compatible' is set.
4053
4054 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004055'history' 'hi' number (Vim default: 50, Vi default: 0,
4056 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 global
4058 {not in Vi}
4059 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004060 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004062 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 NOTE: This option is set to the Vi default value when 'compatible' is
4064 set and to the Vim default value when 'compatible' is reset.
4065
4066 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4067'hkmap' 'hk' boolean (default off)
4068 global
4069 {not in Vi}
4070 {only available when compiled with the |+rightleft|
4071 feature}
4072 When on, the keyboard is mapped for the Hebrew character set.
4073 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4074 toggle this option. See |rileft.txt|.
4075 NOTE: This option is reset when 'compatible' is set.
4076
4077 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4078'hkmapp' 'hkp' boolean (default off)
4079 global
4080 {not in Vi}
4081 {only available when compiled with the |+rightleft|
4082 feature}
4083 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4084 This is useful if you have a non-Hebrew keyboard.
4085 See |rileft.txt|.
4086 NOTE: This option is reset when 'compatible' is set.
4087
4088 *'icon'* *'noicon'*
4089'icon' boolean (default off, on when title can be restored)
4090 global
4091 {not in Vi}
4092 {not available when compiled without the |+title|
4093 feature}
4094 When on, the icon text of the window will be set to the value of
4095 'iconstring' (if it is not empty), or to the name of the file
4096 currently being edited. Only the last part of the name is used.
4097 Overridden by the 'iconstring' option.
4098 Only works if the terminal supports setting window icons (currently
4099 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4100 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4101 builtin termcap).
4102 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004103 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004105 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106
4107 *'iconstring'*
4108'iconstring' string (default "")
4109 global
4110 {not in Vi}
4111 {not available when compiled without the |+title|
4112 feature}
4113 When this option is not empty, it will be used for the icon text of
4114 the window. This happens only when the 'icon' option is on.
4115 Only works if the terminal supports setting window icon text
4116 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4117 Does not work for MS Windows.
4118 When Vim was compiled with HAVE_X11 defined, the original icon will be
4119 restored if possible |X11|.
4120 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004121 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122 'titlestring' for example settings.
4123 {not available when compiled without the |+statusline| feature}
4124
4125 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4126'ignorecase' 'ic' boolean (default off)
4127 global
4128 Ignore case in search patterns. Also used when searching in the tags
4129 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004130 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 Can be overruled by using "\c" or "\C" in the pattern, see
4132 |/ignorecase|.
4133
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004134 *'imactivatefunc'* *'imaf'*
4135'imactivatefunc' 'imaf' string (default "")
4136 global
4137 {not in Vi}
4138 {only available when compiled with |+xim| and
4139 |+GUI_GTK|}
4140 This option specifies a function that will be called to
4141 activate/inactivate Input Method.
4142
4143 Example: >
4144 function ImActivateFunc(active)
4145 if a:active
4146 ... do something
4147 else
4148 ... do something
4149 endif
4150 " return value is not used
4151 endfunction
4152 set imactivatefunc=ImActivateFunc
4153<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 *'imactivatekey'* *'imak'*
4155'imactivatekey' 'imak' string (default "")
4156 global
4157 {not in Vi}
4158 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004159 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 Specifies the key that your Input Method in X-Windows uses for
4161 activation. When this is specified correctly, vim can fully control
4162 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4163 You can't use this option to change the activation key, the option
4164 tells Vim what the key is.
4165 Format:
4166 [MODIFIER_FLAG-]KEY_STRING
4167
4168 These characters can be used for MODIFIER_FLAG (case is ignored):
4169 S Shift key
4170 L Lock key
4171 C Control key
4172 1 Mod1 key
4173 2 Mod2 key
4174 3 Mod3 key
4175 4 Mod4 key
4176 5 Mod5 key
4177 Combinations are allowed, for example "S-C-space" or "SC-space" are
4178 both shift+ctrl+space.
4179 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4180
4181 Example: >
4182 :set imactivatekey=S-space
4183< "S-space" means shift+space. This is the activation key for kinput2 +
4184 canna (Japanese), and ami (Korean).
4185
4186 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4187'imcmdline' 'imc' boolean (default off)
4188 global
4189 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004190 {only available when compiled with the |+xim|,
4191 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 When set the Input Method is always on when starting to edit a command
4193 line, unless entering a search pattern (see 'imsearch' for that).
4194 Setting this option is useful when your input method allows entering
4195 English characters directly, e.g., when it's used to type accented
4196 characters with dead keys.
4197
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004198 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4200 global
4201 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004202 {only available when compiled with the |+xim|,
4203 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 When set the Input Method is never used. This is useful to disable
4205 the IM when it doesn't work properly.
4206 Currently this option is on by default for SGI/IRIX machines. This
4207 may change in later releases.
4208
4209 *'iminsert'* *'imi'*
4210'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4211 local to buffer
4212 {not in Vi}
4213 Specifies whether :lmap or an Input Method (IM) is to be used in
4214 Insert mode. Valid values:
4215 0 :lmap is off and IM is off
4216 1 :lmap is ON and IM is off
4217 2 :lmap is off and IM is ON
4218 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4219 or |global-ime|.
4220 To always reset the option to zero when leaving Insert mode with <Esc>
4221 this can be used: >
4222 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4223< This makes :lmap and IM turn off automatically when leaving Insert
4224 mode.
4225 Note that this option changes when using CTRL-^ in Insert mode
4226 |i_CTRL-^|.
4227 The value is set to 1 when setting 'keymap' to a valid keymap name.
4228 It is also used for the argument of commands like "r" and "f".
4229 The value 0 may not work correctly with Athena and Motif with some XIM
4230 methods. Use 'imdisable' to disable XIM then.
4231
4232 *'imsearch'* *'ims'*
4233'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4234 local to buffer
4235 {not in Vi}
4236 Specifies whether :lmap or an Input Method (IM) is to be used when
4237 entering a search pattern. Valid values:
4238 -1 the value of 'iminsert' is used, makes it look like
4239 'iminsert' is also used when typing a search pattern
4240 0 :lmap is off and IM is off
4241 1 :lmap is ON and IM is off
4242 2 :lmap is off and IM is ON
4243 Note that this option changes when using CTRL-^ in Command-line mode
4244 |c_CTRL-^|.
4245 The value is set to 1 when it is not -1 and setting the 'keymap'
4246 option to a valid keymap name.
4247 The value 0 may not work correctly with Athena and Motif with some XIM
4248 methods. Use 'imdisable' to disable XIM then.
4249
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004250 *'imstatusfunc'* *'imsf'*
4251'imstatusfunc' 'imsf' string (default "")
4252 global
4253 {not in Vi}
4254 {only available when compiled with |+xim| and
4255 |+GUI_GTK|}
4256 This option specifies a function that is called to obtain the status
4257 of Input Method. It must return a positive number when IME is active.
4258
4259 Example: >
4260 function ImStatusFunc()
4261 let is_active = ...do something
4262 return is_active ? 1 : 0
4263 endfunction
4264 set imstatusfunc=ImStatusFunc
4265<
4266 NOTE: This function is invoked very often. Keep it fast.
4267
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 *'include'* *'inc'*
4269'include' 'inc' string (default "^\s*#\s*include")
4270 global or local to buffer |global-local|
4271 {not in Vi}
4272 {not available when compiled without the
4273 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004274 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 pattern, just like for the "/" command (See |pattern|). The default
4276 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004277 "]I", "[d", etc.
4278 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004279 comes after the matched pattern. But if "\zs" appears in the pattern
4280 then the text matched from "\zs" to the end, or until "\ze" if it
4281 appears, is used as the file name. Use this to include characters
4282 that are not in 'isfname', such as a space. You can then use
4283 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004284 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285
4286 *'includeexpr'* *'inex'*
4287'includeexpr' 'inex' string (default "")
4288 local to buffer
4289 {not in Vi}
4290 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004291 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004293 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 :set includeexpr=substitute(v:fname,'\\.','/','g')
4295< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004296
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004298 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 Also used for |<cfile>|.
4300
Bram Moolenaar30b65812012-07-12 22:01:11 +02004301 The expression will be evaluated in the |sandbox| when set from a
4302 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004303
4304 It is not allowed to change text or jump to another window while
4305 evaluating 'includeexpr' |textlock|.
4306
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004308'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4309 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 global
4311 {not in Vi}
4312 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004313 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004314 While typing a search command, show where the pattern, as it was typed
4315 so far, matches. The matched string is highlighted. If the pattern
4316 is invalid or not found, nothing is shown. The screen will be updated
4317 often, this is only useful on fast terminals.
4318 Note that the match will be shown, but the cursor will return to its
4319 original position when no match is found and when pressing <Esc>. You
4320 still need to finish the search command with <Enter> to move the
4321 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004322 When compiled with the |+reltime| feature Vim only searches for about
4323 half a second. With a complicated pattern and/or a lot of text the
4324 match may not be found. This is to avoid that Vim hangs while you
4325 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004326 The highlighting can be set with the 'i' flag in 'highlight'.
4327 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004328 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004329 to the command line. If 'ignorecase' and 'smartcase' are set and the
4330 command line has no uppercase characters, the added character is
4331 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004332 CTRL-R CTRL-W can be used to add the word at the end of the current
4333 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 NOTE: This option is reset when 'compatible' is set.
4335
4336 *'indentexpr'* *'inde'*
4337'indentexpr' 'inde' string (default "")
4338 local to buffer
4339 {not in Vi}
4340 {not available when compiled without the |+cindent|
4341 or |+eval| features}
4342 Expression which is evaluated to obtain the proper indent for a line.
4343 It is used when a new line is created, for the |=| operator and
4344 in Insert mode as specified with the 'indentkeys' option.
4345 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004346 'smartindent' indenting. When 'lisp' is set, this option is
4347 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 When 'paste' is set this option is not used for indenting.
4349 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004350 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 when the expression is evaluated (but it may be moved around).
4352 The expression must return the number of spaces worth of indent. It
4353 can return "-1" to keep the current indent (this means 'autoindent' is
4354 used for the indent).
4355 Functions useful for computing the indent are |indent()|, |cindent()|
4356 and |lispindent()|.
4357 The evaluation of the expression must not have side effects! It must
4358 not change the text, jump to another window, etc. Afterwards the
4359 cursor position is always restored, thus the cursor may be moved.
4360 Normally this option would be set to call a function: >
4361 :set indentexpr=GetMyIndent()
4362< Error messages will be suppressed, unless the 'debug' option contains
4363 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004364 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 NOTE: This option is made empty when 'compatible' is set.
4366
Bram Moolenaar30b65812012-07-12 22:01:11 +02004367 The expression will be evaluated in the |sandbox| when set from a
4368 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004369
4370 It is not allowed to change text or jump to another window while
4371 evaluating 'indentexpr' |textlock|.
4372
4373
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 *'indentkeys'* *'indk'*
4375'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4376 local to buffer
4377 {not in Vi}
4378 {not available when compiled without the |+cindent|
4379 feature}
4380 A list of keys that, when typed in Insert mode, cause reindenting of
4381 the current line. Only happens if 'indentexpr' isn't empty.
4382 The format is identical to 'cinkeys', see |indentkeys-format|.
4383 See |C-indenting| and |indent-expression|.
4384
4385 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4386'infercase' 'inf' boolean (default off)
4387 local to buffer
4388 {not in Vi}
4389 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004390 'ignorecase' is also on, the case of the match is adjusted depending
4391 on the typed text. If the typed text contains a lowercase letter
4392 where the match has an upper case letter, the completed part is made
4393 lowercase. If the typed text has no lowercase letters and the match
4394 has a lowercase letter where the typed text has an uppercase letter,
4395 and there is a letter before it, the completed part is made uppercase.
4396 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397
4398 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4399'insertmode' 'im' boolean (default off)
4400 global
4401 {not in Vi}
4402 Makes Vim work in a way that Insert mode is the default mode. Useful
4403 if you want to use Vim as a modeless editor. Used for |evim|.
4404 These Insert mode commands will be useful:
4405 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004406 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 this is a mapping, it is executed as if 'insertmode' was off.
4408 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004410 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4411 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412
4413 These items change when 'insertmode' is set:
4414 - when starting to edit of a file, Vim goes to Insert mode.
4415 - <Esc> in Insert mode is a no-op and beeps.
4416 - <Esc> in Normal mode makes Vim go to Insert mode.
4417 - CTRL-L in Insert mode is a command, it is not inserted.
4418 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4419 However, when <Esc> is used inside a mapping, it behaves like
4420 'insertmode' was not set. This was done to be able to use the same
4421 mappings with 'insertmode' set or not set.
4422 When executing commands with |:normal| 'insertmode' is not used.
4423
4424 NOTE: This option is reset when 'compatible' is set.
4425
4426 *'isfname'* *'isf'*
4427'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4428 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4429 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4430 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4431 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4432 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4433 global
4434 {not in Vi}
4435 The characters specified by this option are included in file names and
4436 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004437 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 Multi-byte characters 256 and above are always included, only the
4439 characters up to 255 are specified with this option.
4440 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004441 Think twice before adding white space to this option. Although a
4442 space may appear inside a file name, the effect will be that Vim
4443 doesn't know where a file name starts or ends when doing completion.
4444 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445
4446 Note that on systems using a backslash as path separator, Vim tries to
4447 do its best to make it work as you would expect. That is a bit
4448 tricky, since Vi originally used the backslash to escape special
4449 characters. Vim will not remove a backslash in front of a normal file
4450 name character on these systems, but it will on Unix and alikes. The
4451 '&' and '^' are not included by default, because these are special for
4452 cmd.exe.
4453
4454 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004455 Each part can be a single character number or a range. A range is two
4456 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457 decimal number between 0 and 255 or the ASCII character itself (does
4458 not work for digits). Example:
4459 "_,-,128-140,#-43" (include '_' and '-' and the range
4460 128 to 140 and '#' to 43)
4461 If a part starts with '^', the following character number or range
4462 will be excluded from the option. The option is interpreted from left
4463 to right. Put the excluded character after the range where it is
4464 included. To include '^' itself use it as the last character of the
4465 option or the end of a range. Example:
4466 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4467 If the character is '@', all characters where isalpha() returns TRUE
4468 are included. Normally these are the characters a to z and A to Z,
4469 plus accented characters. To include '@' itself use "@-@". Examples:
4470 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004471 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 "a-z,A-Z,@-@" All letters plus the '@' character.
4473 A comma can be included by using it where a character number is
4474 expected. Example:
4475 "48-57,,,_" Digits, comma and underscore.
4476 A comma can be excluded by prepending a '^'. Example:
4477 " -~,^,,9" All characters from space to '~', excluding
4478 comma, plus <Tab>.
4479 See |option-backslash| about including spaces and backslashes.
4480
4481 *'isident'* *'isi'*
4482'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4483 "@,48-57,_,128-167,224-235"
4484 otherwise: "@,48-57,_,192-255")
4485 global
4486 {not in Vi}
4487 The characters given by this option are included in identifiers.
4488 Identifiers are used in recognizing environment variables and after a
4489 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004490 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 option.
4492 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004493 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4495
4496 *'iskeyword'* *'isk'*
4497'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4498 "@,48-57,_,128-167,224-235"
4499 otherwise: "@,48-57,_,192-255"
4500 Vi default: "@,48-57,_")
4501 local to buffer
4502 {not in Vi}
4503 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004504 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 'isfname' for a description of the format of this option. For C
4506 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4507 For a help file it is set to all non-blank printable characters except
4508 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4509 command).
4510 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004511 This option also influences syntax highlighting, unless the syntax
4512 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 NOTE: This option is set to the Vi default value when 'compatible' is
4514 set and to the Vim default value when 'compatible' is reset.
4515
4516 *'isprint'* *'isp'*
4517'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4518 "@,~-255"; otherwise: "@,161-255")
4519 global
4520 {not in Vi}
4521 The characters given by this option are displayed directly on the
4522 screen. It is also used for "\p" in a |pattern|. The characters from
4523 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4524 even when they are not included in 'isprint' or excluded. See
4525 'isfname' for a description of the format of this option.
4526
4527 Non-printable characters are displayed with two characters:
4528 0 - 31 "^@" - "^_"
4529 32 - 126 always single characters
4530 127 "^?"
4531 128 - 159 "~@" - "~_"
4532 160 - 254 "| " - "|~"
4533 255 "~?"
4534 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4535 displayed as <xx>, with the hexadecimal value of the byte.
4536 When 'display' contains "uhex" all unprintable characters are
4537 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004538 The SpecialKey highlighting will be used for unprintable characters.
4539 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
4541 Multi-byte characters 256 and above are always included, only the
4542 characters up to 255 are specified with this option. When a character
4543 is printable but it is not available in the current font, a
4544 replacement character will be shown.
4545 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4546 There is no option to specify these characters.
4547
4548 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4549'joinspaces' 'js' boolean (default on)
4550 global
4551 {not in Vi}
4552 Insert two spaces after a '.', '?' and '!' with a join command.
4553 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4554 Otherwise only one space is inserted.
4555 NOTE: This option is set when 'compatible' is set.
4556
4557 *'key'*
4558'key' string (default "")
4559 local to buffer
4560 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004561 {only available when compiled with the |+cryptv|
4562 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004564 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 Careful: Do not set the key value by hand, someone might see the typed
4566 key. Use the |:X| command. But you can make 'key' empty: >
4567 :set key=
4568< It is not possible to get the value of this option with ":set key" or
4569 "echo &key". This is to avoid showing it to someone who shouldn't
4570 know. It also means you cannot see it yourself once you have set it,
4571 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004572 You can use "&key" in an expression to detect whether encryption is
4573 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574
4575 *'keymap'* *'kmp'* *E544*
4576'keymap' 'kmp' string (default "")
4577 local to buffer
4578 {not in Vi}
4579 {only available when compiled with the |+keymap|
4580 feature}
4581 Name of a keyboard mapping. See |mbyte-keymap|.
4582 Setting this option to a valid keymap name has the side effect of
4583 setting 'iminsert' to one, so that the keymap becomes effective.
4584 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004585 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586
4587 *'keymodel'* *'km'*
4588'keymodel' 'km' string (default "")
4589 global
4590 {not in Vi}
4591 List of comma separated words, which enable special things that keys
4592 can do. These values can be used:
4593 startsel Using a shifted special key starts selection (either
4594 Select mode or Visual mode, depending on "key" being
4595 present in 'selectmode').
4596 stopsel Using a not-shifted special key stops selection.
4597 Special keys in this context are the cursor keys, <End>, <Home>,
4598 <PageUp> and <PageDown>.
4599 The 'keymodel' option is set by the |:behave| command.
4600
4601 *'keywordprg'* *'kp'*
4602'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004603 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 global or local to buffer |global-local|
4605 {not in Vi}
4606 Program to use for the |K| command. Environment variables are
4607 expanded |:set_env|. ":help" may be used to access the Vim internal
4608 help. (Note that previously setting the global option to the empty
4609 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004610 When the first character is ":", the command is invoked as a Vim
4611 Ex command prefixed with [count].
4612 When "man", "man -s" or an Ex command is used, Vim will automatically
4613 translate a count for the "K" command and pass it as the first
4614 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 See |option-backslash| about including spaces and backslashes.
4616 Example: >
4617 :set keywordprg=man\ -s
4618< This option cannot be set from a |modeline| or in the |sandbox|, for
4619 security reasons.
4620
4621 *'langmap'* *'lmap'* *E357* *E358*
4622'langmap' 'lmap' string (default "")
4623 global
4624 {not in Vi}
4625 {only available when compiled with the |+langmap|
4626 feature}
4627 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004628 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004629 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 care of translating these special characters to the original meaning
4631 of the key. This means you don't have to change the keyboard mode to
4632 be able to execute Normal mode commands.
4633 This is the opposite of the 'keymap' option, where characters are
4634 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004635 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4636 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004637 This option cannot be set from a |modeline| or in the |sandbox|, for
4638 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004640 Example (for Greek, in UTF-8): *greek* >
4641 :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 +00004642< Example (exchanges meaning of z and y for commands): >
4643 :set langmap=zy,yz,ZY,YZ
4644<
4645 The 'langmap' option is a list of parts, separated with commas. Each
4646 part can be in one of two forms:
4647 1. A list of pairs. Each pair is a "from" character immediately
4648 followed by the "to" character. Examples: "aA", "aAbBcC".
4649 2. A list of "from" characters, a semi-colon and a list of "to"
4650 characters. Example: "abc;ABC"
4651 Example: "aA,fgh;FGH,cCdDeE"
4652 Special characters need to be preceded with a backslash. These are
4653 ";", ',' and backslash itself.
4654
4655 This will allow you to activate vim actions without having to switch
4656 back and forth between the languages. Your language characters will
4657 be understood as normal vim English characters (according to the
4658 langmap mappings) in the following cases:
4659 o Normal/Visual mode (commands, buffer/register names, user mappings)
4660 o Insert/Replace Mode: Register names after CTRL-R
4661 o Insert/Replace Mode: Mappings
4662 Characters entered in Command-line mode will NOT be affected by
4663 this option. Note that this option can be changed at any time
4664 allowing to switch between mappings for different languages/encodings.
4665 Use a mapping to avoid having to type it each time!
4666
4667 *'langmenu'* *'lm'*
4668'langmenu' 'lm' string (default "")
4669 global
4670 {not in Vi}
4671 {only available when compiled with the |+menu| and
4672 |+multi_lang| features}
4673 Language to use for menu translation. Tells which file is loaded
4674 from the "lang" directory in 'runtimepath': >
4675 "lang/menu_" . &langmenu . ".vim"
4676< (without the spaces). For example, to always use the Dutch menus, no
4677 matter what $LANG is set to: >
4678 :set langmenu=nl_NL.ISO_8859-1
4679< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004680 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 If your $LANG is set to a non-English language but you do want to use
4682 the English menus: >
4683 :set langmenu=none
4684< This option must be set before loading menus, switching on filetype
4685 detection or syntax highlighting. Once the menus are defined setting
4686 this option has no effect. But you could do this: >
4687 :source $VIMRUNTIME/delmenu.vim
4688 :set langmenu=de_DE.ISO_8859-1
4689 :source $VIMRUNTIME/menu.vim
4690< Warning: This deletes all menus that you defined yourself!
4691
Bram Moolenaard94464e2015-11-02 15:28:18 +01004692 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004693'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004694 global
4695 {not in Vi}
4696 {only available when compiled with the |+langmap|
4697 feature}
4698 When on, setting 'langmap' does not apply to characters resulting from
4699 a mapping. This basically means, if you noticed that setting
4700 'langmap' disables some of your mappings, try setting this option.
4701 This option defaults to off for backwards compatibility. Set it on if
4702 that works for you to avoid mappings to break.
4703
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 *'laststatus'* *'ls'*
4705'laststatus' 'ls' number (default 1)
4706 global
4707 {not in Vi}
4708 The value of this option influences when the last window will have a
4709 status line:
4710 0: never
4711 1: only if there are at least two windows
4712 2: always
4713 The screen looks nicer with a status line if you have several
4714 windows, but it takes another screen line. |status-line|
4715
4716 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4717'lazyredraw' 'lz' boolean (default off)
4718 global
4719 {not in Vi}
4720 When this option is set, the screen will not be redrawn while
4721 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004722 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 update use |:redraw|.
4724
4725 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4726'linebreak' 'lbr' boolean (default off)
4727 local to window
4728 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004729 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004731 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 than at the last character that fits on the screen. Unlike
4733 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004734 it only affects the way the file is displayed, not its contents.
4735 If 'breakindent' is set, line is visually indented. Then, the value
4736 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004737 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 Note that <Tab> characters after an <EOL> are mostly not displayed
4739 with the right amount of white space.
4740
4741 *'lines'* *E593*
4742'lines' number (default 24 or terminal height)
4743 global
4744 Number of lines of the Vim window.
4745 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004746 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 When Vim is running in the GUI or in a resizable window, setting this
4748 option will cause the window size to be changed. When you only want
4749 to use the size for the GUI, put the command in your |gvimrc| file.
4750 Vim limits the number of lines to what fits on the screen. You can
4751 use this command to get the tallest window possible: >
4752 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004753< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004754 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 When you set this option and Vim is unable to change the physical
4756 number of lines of the display, the display may be messed up.
4757
4758 *'linespace'* *'lsp'*
4759'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4760 global
4761 {not in Vi}
4762 {only in the GUI}
4763 Number of pixel lines inserted between characters. Useful if the font
4764 uses the full character cell height, making lines touch each other.
4765 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004766 With some fonts there can be too much room between lines (to have
4767 space for ascents and descents). Then it makes sense to set
4768 'linespace' to a negative value. This may cause display problems
4769 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770
4771 *'lisp'* *'nolisp'*
4772'lisp' boolean (default off)
4773 local to buffer
4774 {not available when compiled without the |+lispindent|
4775 feature}
4776 Lisp mode: When <Enter> is typed in insert mode set the indent for
4777 the next line to Lisp standards (well, sort of). Also happens with
4778 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4779 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4780 better. Also see 'lispwords'.
4781 The '-' character is included in keyword characters. Redefines the
4782 "=" operator to use this same indentation algorithm rather than
4783 calling an external program if 'equalprg' is empty.
4784 This option is not used when 'paste' is set.
4785 {Vi: Does it a little bit differently}
4786
4787 *'lispwords'* *'lw'*
4788'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004789 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 {not in Vi}
4791 {not available when compiled without the |+lispindent|
4792 feature}
4793 Comma separated list of words that influence the Lisp indenting.
4794 |'lisp'|
4795
4796 *'list'* *'nolist'*
4797'list' boolean (default off)
4798 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004799 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4800 line. Useful to see the difference between tabs and spaces and for
4801 trailing blanks. Further changed by the 'listchars' option.
4802
4803 The cursor is displayed at the start of the space a Tab character
4804 occupies, not at the end as usual in Normal mode. To get this cursor
4805 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004806 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004807<
4808 Note that list mode will also affect formatting (set with 'textwidth'
4809 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 changing the way tabs are displayed.
4811
4812 *'listchars'* *'lcs'*
4813'listchars' 'lcs' string (default "eol:$")
4814 global
4815 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004816 Strings to use in 'list' mode and for the |:list| command. It is a
4817 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004818 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 eol:c Character to show at the end of each line. When
4820 omitted, there is no extra character at the end of the
4821 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004822 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004823 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004825 fill the space that the tab normally occupies.
4826 "tab:>-" will show a tab that takes four spaces as
4827 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004828 *lcs-space*
4829 space:c Character to show for a space. When omitted, spaces
4830 are left blank.
4831 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004832 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004833 trailing spaces are blank. Overrides the "space"
4834 setting for trailing spaces.
4835 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 extends:c Character to show in the last column, when 'wrap' is
4837 off and the line continues beyond the right of the
4838 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004839 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 precedes:c Character to show in the first column, when 'wrap'
4841 is off and there is text preceding the character
4842 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004843 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004844 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004845 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004846 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004847 nbsp:c Character to show for a non-breakable space character
4848 (0xA0 (160 decimal) and U+202F). Left blank when
4849 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004851 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004852 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004853 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854
4855 Examples: >
4856 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004857 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 :set lcs=extends:>,precedes:<
4859< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004860 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004861 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862
4863 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4864'loadplugins' 'lpl' boolean (default on)
4865 global
4866 {not in Vi}
4867 When on the plugin scripts are loaded when starting up |load-plugins|.
4868 This option can be reset in your |vimrc| file to disable the loading
4869 of plugins.
4870 Note that using the "-u NONE" and "--noplugin" command line arguments
4871 reset this option. |-u| |--noplugin|
4872
Bram Moolenaard94464e2015-11-02 15:28:18 +01004873 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004874'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004875 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004876 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01004877 {only available when compiled with the |+lua/dyn|
4878 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004879 Specifies the name of the Lua shared library. The default is
4880 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004881 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004882 This option cannot be set from a |modeline| or in the |sandbox|, for
4883 security reasons.
4884
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004885 *'macatsui'* *'nomacatsui'*
4886'macatsui' boolean (default on)
4887 global
4888 {only available in Mac GUI version}
4889 This is a workaround for when drawing doesn't work properly. When set
4890 and compiled with multi-byte support ATSUI text drawing is used. When
4891 not set ATSUI text drawing is not used. Switch this option off when
4892 you experience drawing problems. In a future version the problems may
4893 be solved and this option becomes obsolete. Therefore use this method
4894 to unset it: >
4895 if exists('&macatsui')
4896 set nomacatsui
4897 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004898< Another option to check if you have drawing problems is
4899 'termencoding'.
4900
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 *'magic'* *'nomagic'*
4902'magic' boolean (default on)
4903 global
4904 Changes the special characters that can be used in search patterns.
4905 See |pattern|.
4906 NOTE: To avoid portability problems with using patterns, always keep
4907 this option at the default "on". Only switch it off when working with
4908 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004909 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910
4911 *'makeef'* *'mef'*
4912'makeef' 'mef' string (default: "")
4913 global
4914 {not in Vi}
4915 {not available when compiled without the |+quickfix|
4916 feature}
4917 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4918 and the |:grep| command.
4919 When it is empty, an internally generated temp file will be used.
4920 When "##" is included, it is replaced by a number to make the name
4921 unique. This makes sure that the ":make" command doesn't overwrite an
4922 existing file.
4923 NOT used for the ":cf" command. See 'errorfile' for that.
4924 Environment variables are expanded |:set_env|.
4925 See |option-backslash| about including spaces and backslashes.
4926 This option cannot be set from a |modeline| or in the |sandbox|, for
4927 security reasons.
4928
4929 *'makeprg'* *'mp'*
4930'makeprg' 'mp' string (default "make", VMS: "MMS")
4931 global or local to buffer |global-local|
4932 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004933 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004934 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4935 which are expanded to the current and alternate file name. Use |::S|
4936 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004937 Environment variables are expanded |:set_env|. See |option-backslash|
4938 about including spaces and backslashes.
4939 Note that a '|' must be escaped twice: once for ":set" and once for
4940 the interpretation of a command. When you use a filter called
4941 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 :set makeprg=gmake\ \\\|\ myfilter
4943< The placeholder "$*" can be given (even multiple times) to specify
4944 where the arguments will be included, for example: >
4945 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4946< This option cannot be set from a |modeline| or in the |sandbox|, for
4947 security reasons.
4948
4949 *'matchpairs'* *'mps'*
4950'matchpairs' 'mps' string (default "(:),{:},[:]")
4951 local to buffer
4952 {not in Vi}
4953 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004954 other.
4955 Only character pairs are allowed that are different, thus you cannot
4956 jump between two double quotes.
4957 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004958 The pairs must be separated by a comma. Example for including '<' and
4959 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 :set mps+=<:>
4961
4962< A more exotic example, to jump between the '=' and ';' in an
4963 assignment, useful for languages like C and Java: >
4964 :au FileType c,cpp,java set mps+==:;
4965
4966< For a more advanced way of using "%", see the matchit.vim plugin in
4967 the $VIMRUNTIME/macros directory. |add-local-help|
4968
4969 *'matchtime'* *'mat'*
4970'matchtime' 'mat' number (default 5)
4971 global
4972 {not in Vi}{in Nvi}
4973 Tenths of a second to show the matching paren, when 'showmatch' is
4974 set. Note that this is not in milliseconds, like other options that
4975 set a time. This is to be compatible with Nvi.
4976
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004977 *'maxcombine'* *'mco'*
4978'maxcombine' 'mco' number (default 2)
4979 global
4980 {not in Vi}
4981 {only available when compiled with the |+multi_byte|
4982 feature}
4983 The maximum number of combining characters supported for displaying.
4984 Only used when 'encoding' is "utf-8".
4985 The default is OK for most languages. Hebrew may require 4.
4986 Maximum value is 6.
4987 Even when this option is set to 2 you can still edit text with more
4988 combining characters, you just can't see them. Use |g8| or |ga|.
4989 See |mbyte-combining|.
4990
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 *'maxfuncdepth'* *'mfd'*
4992'maxfuncdepth' 'mfd' number (default 100)
4993 global
4994 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004995 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004996 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 Maximum depth of function calls for user functions. This normally
4998 catches endless recursion. When using a recursive function with
4999 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5000 more memory, there is the danger of failing when memory is exhausted.
5001 See also |:function|.
5002
5003 *'maxmapdepth'* *'mmd'* *E223*
5004'maxmapdepth' 'mmd' number (default 1000)
5005 global
5006 {not in Vi}
5007 Maximum number of times a mapping is done without resulting in a
5008 character to be used. This normally catches endless mappings, like
5009 ":map x y" with ":map y x". It still does not catch ":map g wg",
5010 because the 'w' is used before the next mapping is done. See also
5011 |key-mapping|.
5012
5013 *'maxmem'* *'mm'*
5014'maxmem' 'mm' number (default between 256 to 5120 (system
5015 dependent) or half the amount of memory
5016 available)
5017 global
5018 {not in Vi}
5019 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5020 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005021 other memory to be freed. The maximum usable value is about 2000000.
5022 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005024 *'maxmempattern'* *'mmp'*
5025'maxmempattern' 'mmp' number (default 1000)
5026 global
5027 {not in Vi}
5028 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005029 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005030 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005031 When Vim runs into the limit it gives an error message and mostly
5032 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005033 Running into the limit often means that the pattern is very
5034 inefficient or too complex. This may already happen with the pattern
5035 "\(.\)*" on a very long line. ".*" works much better.
5036 Vim may run out of memory before hitting the 'maxmempattern' limit.
5037
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 *'maxmemtot'* *'mmt'*
5039'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5040 dependent) or half the amount of memory
5041 available)
5042 global
5043 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005044 Maximum amount of memory in Kbyte to use for all buffers together.
5045 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005046 without a limit.
5047 On 64 bit machines higher values might work. But hey, do you really
5048 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005049 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005050 need the memory to store undo info.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005051 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052
5053 *'menuitems'* *'mis'*
5054'menuitems' 'mis' number (default 25)
5055 global
5056 {not in Vi}
5057 {not available when compiled without the |+menu|
5058 feature}
5059 Maximum number of items to use in a menu. Used for menus that are
5060 generated from a list of items, e.g., the Buffers menu. Changing this
5061 option has no direct effect, the menu must be refreshed first.
5062
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005063 *'mkspellmem'* *'msm'*
5064'mkspellmem' 'msm' string (default "460000,2000,500")
5065 global
5066 {not in Vi}
5067 {not available when compiled without the |+syntax|
5068 feature}
5069 Parameters for |:mkspell|. This tunes when to start compressing the
5070 word tree. Compression can be slow when there are many words, but
5071 it's needed to avoid running out of memory. The amount of memory used
5072 per word depends very much on how similar the words are, that's why
5073 this tuning is complicated.
5074
5075 There are three numbers, separated by commas:
5076 {start},{inc},{added}
5077
5078 For most languages the uncompressed word tree fits in memory. {start}
5079 gives the amount of memory in Kbyte that can be used before any
5080 compression is done. It should be a bit smaller than the amount of
5081 memory that is available to Vim.
5082
5083 When going over the {start} limit the {inc} number specifies the
5084 amount of memory in Kbyte that can be allocated before another
5085 compression is done. A low number means compression is done after
5086 less words are added, which is slow. A high number means more memory
5087 will be allocated.
5088
5089 After doing compression, {added} times 1024 words can be added before
5090 the {inc} limit is ignored and compression is done when any extra
5091 amount of memory is needed. A low number means there is a smaller
5092 chance of hitting the {inc} limit, less memory is used but it's
5093 slower.
5094
5095 The languages for which these numbers are important are Italian and
5096 Hungarian. The default works for when you have about 512 Mbyte. If
5097 you have 1 Gbyte you could use: >
5098 :set mkspellmem=900000,3000,800
5099< If you have less than 512 Mbyte |:mkspell| may fail for some
5100 languages, no matter what you set 'mkspellmem' to.
5101
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005103'modeline' 'ml' boolean (Vim default: on (off for root),
5104 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 local to buffer
5106 *'modelines'* *'mls'*
5107'modelines' 'mls' number (default 5)
5108 global
5109 {not in Vi}
5110 If 'modeline' is on 'modelines' gives the number of lines that is
5111 checked for set commands. If 'modeline' is off or 'modelines' is zero
5112 no lines are checked. See |modeline|.
5113 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5114 set and to the Vim default value when 'compatible' is reset.
5115
5116 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5117'modifiable' 'ma' boolean (default on)
5118 local to buffer
5119 {not in Vi} *E21*
5120 When off the buffer contents cannot be changed. The 'fileformat' and
5121 'fileencoding' options also can't be changed.
5122 Can be reset with the |-M| command line argument.
5123
5124 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5125'modified' 'mod' boolean (default off)
5126 local to buffer
5127 {not in Vi}
5128 When on, the buffer is considered to be modified. This option is set
5129 when:
5130 1. A change was made to the text since it was last written. Using the
5131 |undo| command to go back to the original text will reset the
5132 option. But undoing changes that were made before writing the
5133 buffer will set the option again, since the text is different from
5134 when it was written.
5135 2. 'fileformat' or 'fileencoding' is different from its original
5136 value. The original value is set when the buffer is read or
5137 written. A ":set nomodified" command also resets the original
5138 values to the current values and the 'modified' option will be
5139 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005140 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005141 This option is not set when a change is made to the buffer as the
5142 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5143 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5144 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5146 will be ignored.
5147
5148 *'more'* *'nomore'*
5149'more' boolean (Vim default: on, Vi default: off)
5150 global
5151 {not in Vi}
5152 When on, listings pause when the whole screen is filled. You will get
5153 the |more-prompt|. When this option is off there are no pauses, the
5154 listing continues until finished.
5155 NOTE: This option is set to the Vi default value when 'compatible' is
5156 set and to the Vim default value when 'compatible' is reset.
5157
5158 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005159'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5160 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 global
5162 {not in Vi}
5163 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005164 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5165 sysmouse and Linux console with gpm). For using the mouse in the
5166 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 The mouse can be enabled for different modes:
5168 n Normal mode
5169 v Visual mode
5170 i Insert mode
5171 c Command-line mode
5172 h all previous modes when editing a help file
5173 a all previous modes
5174 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 Normally you would enable the mouse in all four modes with: >
5176 :set mouse=a
5177< When the mouse is not enabled, the GUI will still use the mouse for
5178 modeless selection. This doesn't move the text cursor.
5179
5180 See |mouse-using|. Also see |'clipboard'|.
5181
5182 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005183 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 the mouse buttons can still be used by keeping the shift key pressed.
5185 Also see the 'clipboard' option.
5186
5187 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5188'mousefocus' 'mousef' boolean (default off)
5189 global
5190 {not in Vi}
5191 {only works in the GUI}
5192 The window that the mouse pointer is on is automatically activated.
5193 When changing the window layout or window focus in another way, the
5194 mouse pointer is moved to the window with keyboard focus. Off is the
5195 default because it makes using the pull down menus a little goofy, as
5196 a pointer transit may activate a window unintentionally.
5197
5198 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5199'mousehide' 'mh' boolean (default on)
5200 global
5201 {not in Vi}
5202 {only works in the GUI}
5203 When on, the mouse pointer is hidden when characters are typed.
5204 The mouse pointer is restored when the mouse is moved.
5205
5206 *'mousemodel'* *'mousem'*
5207'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5208 global
5209 {not in Vi}
5210 Sets the model to use for the mouse. The name mostly specifies what
5211 the right mouse button is used for:
5212 extend Right mouse button extends a selection. This works
5213 like in an xterm.
5214 popup Right mouse button pops up a menu. The shifted left
5215 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005216 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 popup_setpos Like "popup", but the cursor will be moved to the
5218 position where the mouse was clicked, and thus the
5219 selected operation will act upon the clicked object.
5220 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005221 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 course, that right clicking outside a selection will
5223 end Visual mode.
5224 Overview of what button does what for each model:
5225 mouse extend popup(_setpos) ~
5226 left click place cursor place cursor
5227 left drag start selection start selection
5228 shift-left search word extend selection
5229 right click extend selection popup menu (place cursor)
5230 right drag extend selection -
5231 middle click paste paste
5232
5233 In the "popup" model the right mouse button produces a pop-up menu.
5234 You need to define this first, see |popup-menu|.
5235
5236 Note that you can further refine the meaning of buttons with mappings.
5237 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5238 selection (because that's handled in the GUI code directly).
5239
5240 The 'mousemodel' option is set by the |:behave| command.
5241
5242 *'mouseshape'* *'mouses'* *E547*
5243'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005244 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 global
5246 {not in Vi}
5247 {only available when compiled with the |+mouseshape|
5248 feature}
5249 This option tells Vim what the mouse pointer should look like in
5250 different modes. The option is a comma separated list of parts, much
5251 like used for 'guicursor'. Each part consist of a mode/location-list
5252 and an argument-list:
5253 mode-list:shape,mode-list:shape,..
5254 The mode-list is a dash separated list of these modes/locations:
5255 In a normal window: ~
5256 n Normal mode
5257 v Visual mode
5258 ve Visual mode with 'selection' "exclusive" (same as 'v',
5259 if not specified)
5260 o Operator-pending mode
5261 i Insert mode
5262 r Replace mode
5263
5264 Others: ~
5265 c appending to the command-line
5266 ci inserting in the command-line
5267 cr replacing in the command-line
5268 m at the 'Hit ENTER' or 'More' prompts
5269 ml idem, but cursor in the last line
5270 e any mode, pointer below last window
5271 s any mode, pointer on a status line
5272 sd any mode, while dragging a status line
5273 vs any mode, pointer on a vertical separator line
5274 vd any mode, while dragging a vertical separator line
5275 a everywhere
5276
5277 The shape is one of the following:
5278 avail name looks like ~
5279 w x arrow Normal mouse pointer
5280 w x blank no pointer at all (use with care!)
5281 w x beam I-beam
5282 w x updown up-down sizing arrows
5283 w x leftright left-right sizing arrows
5284 w x busy The system's usual busy pointer
5285 w x no The system's usual 'no input' pointer
5286 x udsizing indicates up-down resizing
5287 x lrsizing indicates left-right resizing
5288 x crosshair like a big thin +
5289 x hand1 black hand
5290 x hand2 white hand
5291 x pencil what you write with
5292 x question big ?
5293 x rightup-arrow arrow pointing right-up
5294 w x up-arrow arrow pointing up
5295 x <number> any X11 pointer number (see X11/cursorfont.h)
5296
5297 The "avail" column contains a 'w' if the shape is available for Win32,
5298 x for X11.
5299 Any modes not specified or shapes not available use the normal mouse
5300 pointer.
5301
5302 Example: >
5303 :set mouseshape=s:udsizing,m:no
5304< will make the mouse turn to a sizing arrow over the status lines and
5305 indicate no input when the hit-enter prompt is displayed (since
5306 clicking the mouse has no effect in this state.)
5307
5308 *'mousetime'* *'mouset'*
5309'mousetime' 'mouset' number (default 500)
5310 global
5311 {not in Vi}
5312 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5313 time in msec between two mouse clicks for the second click to be
5314 recognized as a multi click.
5315
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005316 *'mzquantum'* *'mzq'*
5317'mzquantum' 'mzq' number (default 100)
5318 global
5319 {not in Vi}
5320 {not available when compiled without the |+mzscheme|
5321 feature}
5322 The number of milliseconds between polls for MzScheme threads.
5323 Negative or zero value means no thread scheduling.
5324
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005326'nrformats' 'nf' string (default "bin,octal,hex",
5327 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 local to buffer
5329 {not in Vi}
5330 This defines what bases Vim will consider for numbers when using the
5331 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5332 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005333 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005335 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005336 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005338 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 considered to be hexadecimal. Example: Using CTRL-X on
5340 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005341 bin If included, numbers starting with "0b" or "0B" will be
5342 considered to be binary. Example: Using CTRL-X on
5343 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344 Numbers which simply begin with a digit in the range 1-9 are always
5345 considered decimal. This also happens for numbers that are not
5346 recognized as octal or hex.
5347
5348 *'number'* *'nu'* *'nonumber'* *'nonu'*
5349'number' 'nu' boolean (default off)
5350 local to window
5351 Print the line number in front of each line. When the 'n' option is
5352 excluded from 'cpoptions' a wrapped line will not use the column of
5353 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005354 The 'numberwidth' option can be used to set the room used for the line
5355 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356 When a long, wrapped line doesn't start with the first character, '-'
5357 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005358 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5359 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005360 *number_relativenumber*
5361 The 'relativenumber' option changes the displayed number to be
5362 relative to the cursor. Together with 'number' there are these
5363 four combinations (cursor in line 3):
5364
Bram Moolenaar3848e002016-03-19 18:42:29 +01005365 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005366 'nornu' 'nornu' 'rnu' 'rnu'
5367
5368 |apple | 1 apple | 2 apple | 2 apple
5369 |pear | 2 pear | 1 pear | 1 pear
5370 |nobody | 3 nobody | 0 nobody |3 nobody
5371 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005373 *'numberwidth'* *'nuw'*
5374'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5375 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005376 {not in Vi}
5377 {only available when compiled with the |+linebreak|
5378 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005379 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005380 when the 'number' or 'relativenumber' option is set or printing lines
5381 with a line number. Since one space is always between the number and
5382 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005383 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005384 fit the highest line number in the buffer respectively the number of
5385 rows in the window, depending on whether 'number' or 'relativenumber'
5386 is set. Thus with the Vim default of 4 there is room for a line number
5387 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005388 The minimum value is 1, the maximum value is 10.
5389 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5390
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005391 *'omnifunc'* *'ofu'*
5392'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005393 local to buffer
5394 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005395 {not available when compiled without the |+eval|
5396 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005397 This option specifies a function to be used for Insert mode omni
5398 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005399 See |complete-functions| for an explanation of how the function is
5400 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005401 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005402 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005403 This option cannot be set from a |modeline| or in the |sandbox|, for
5404 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005405
5406
Bram Moolenaar02467872007-05-06 13:22:01 +00005407 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005408'opendevice' 'odev' boolean (default off)
5409 global
5410 {not in Vi}
5411 {only for MS-DOS, MS-Windows and OS/2}
5412 Enable reading and writing from devices. This may get Vim stuck on a
5413 device that can be opened but doesn't actually do the I/O. Therefore
5414 it is off by default.
5415 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5416 result in editing a device.
5417
5418
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005419 *'operatorfunc'* *'opfunc'*
5420'operatorfunc' 'opfunc' string (default: empty)
5421 global
5422 {not in Vi}
5423 This option specifies a function to be called by the |g@| operator.
5424 See |:map-operator| for more info and an example.
5425
5426 This option cannot be set from a |modeline| or in the |sandbox|, for
5427 security reasons.
5428
5429
Bram Moolenaar251e1912011-06-19 05:09:16 +02005430 *'osfiletype'* *'oft'*
5431'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432 local to buffer
5433 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005434 This option was supported on RISC OS, which has been removed.
5435
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005437 *'packpath'* *'pp'*
5438'packpath' 'pp' string (default: see 'runtimepath')
5439 {not in Vi}
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005440 Directories used to find packages. See |packages|.
5441
5442
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005444'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 global
5446 Specifies the nroff macros that separate paragraphs. These are pairs
5447 of two letters (see |object-motions|).
5448
5449 *'paste'* *'nopaste'*
5450'paste' boolean (default off)
5451 global
5452 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005453 Put Vim in Paste mode. This is useful if you want to cut or copy
5454 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 unexpected effects.
5456 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005457 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005458 knows about pasting and will mostly do the right thing without 'paste'
5459 being set. The same is true for a terminal where Vim handles the
5460 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005461 This option is reset when starting the GUI. Thus if you set it in
5462 your .vimrc it will work in a terminal, but not in the GUI. Setting
5463 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5464 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 When the 'paste' option is switched on (also when it was already on):
5466 - mapping in Insert mode and Command-line mode is disabled
5467 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005469 - 'expandtab' is reset
5470 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 - 'revins' is reset
5472 - 'ruler' is reset
5473 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005474 - 'smartindent' is reset
5475 - 'smarttab' is reset
5476 - 'softtabstop' is set to 0
5477 - 'textwidth' is set to 0
5478 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005480 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005481 - 'indentexpr'
5482 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 NOTE: When you start editing another file while the 'paste' option is
5484 on, settings from the modelines or autocommands may change the
5485 settings again, causing trouble when pasting text. You might want to
5486 set the 'paste' option again.
5487 When the 'paste' option is reset the mentioned options are restored to
5488 the value before the moment 'paste' was switched from off to on.
5489 Resetting 'paste' before ever setting it does not have any effect.
5490 Since mapping doesn't work while 'paste' is active, you need to use
5491 the 'pastetoggle' option to toggle the 'paste' option with some key.
5492
5493 *'pastetoggle'* *'pt'*
5494'pastetoggle' 'pt' string (default "")
5495 global
5496 {not in Vi}
5497 When non-empty, specifies the key sequence that toggles the 'paste'
5498 option. This is like specifying a mapping: >
5499 :map {keys} :set invpaste<CR>
5500< Where {keys} is the value of 'pastetoggle'.
5501 The difference is that it will work even when 'paste' is set.
5502 'pastetoggle' works in Insert mode and Normal mode, but not in
5503 Command-line mode.
5504 Mappings are checked first, thus overrule 'pastetoggle'. However,
5505 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5506 this: >
5507 :map <F10> :set paste<CR>
5508 :map <F11> :set nopaste<CR>
5509 :imap <F10> <C-O>:set paste<CR>
5510 :imap <F11> <nop>
5511 :set pastetoggle=<F11>
5512< This will make <F10> start paste mode and <F11> stop paste mode.
5513 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5514 mode everything is inserted literally, except the 'pastetoggle' key
5515 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005516 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517
5518 *'pex'* *'patchexpr'*
5519'patchexpr' 'pex' string (default "")
5520 global
5521 {not in Vi}
5522 {not available when compiled without the |+diff|
5523 feature}
5524 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005525 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526
Bram Moolenaardbc28022014-07-26 13:40:44 +02005527 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528'patchmode' 'pm' string (default "")
5529 global
5530 {not in Vi}
5531 When non-empty the oldest version of a file is kept. This can be used
5532 to keep the original version of a file if you are changing files in a
5533 source distribution. Only the first time that a file is written a
5534 copy of the original file will be kept. The name of the copy is the
5535 name of the original file with the string in the 'patchmode' option
5536 appended. This option should start with a dot. Use a string like
5537 ".org". 'backupdir' must not be empty for this to work (Detail: The
5538 backup file is renamed to the patchmode file after the new file has
5539 been successfully written, that's why it must be possible to write a
5540 backup file). If there was no file to be backed up, an empty file is
5541 created.
5542 When the 'backupskip' pattern matches, a patchmode file is not made.
5543 Using 'patchmode' for compressed files appends the extension at the
5544 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5545 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005546 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005548 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549'path' 'pa' string (default on Unix: ".,/usr/include,,"
5550 on OS/2: ".,/emx/include,,"
5551 other systems: ".,,")
5552 global or local to buffer |global-local|
5553 {not in Vi}
5554 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005555 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5556 provided that the file being searched for has a relative path (not
5557 starting with "/", "./" or "../"). The directories in the 'path'
5558 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559 - Use commas to separate directory names: >
5560 :set path=.,/usr/local/include,/usr/include
5561< - Spaces can also be used to separate directory names (for backwards
5562 compatibility with version 3.0). To have a space in a directory
5563 name, precede it with an extra backslash, and escape the space: >
5564 :set path=.,/dir/with\\\ space
5565< - To include a comma in a directory name precede it with an extra
5566 backslash: >
5567 :set path=.,/dir/with\\,comma
5568< - To search relative to the directory of the current file, use: >
5569 :set path=.
5570< - To search in the current directory use an empty string between two
5571 commas: >
5572 :set path=,,
5573< - A directory name may end in a ':' or '/'.
5574 - Environment variables are expanded |:set_env|.
5575 - When using |netrw.vim| URLs can be used. For example, adding
5576 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005577 - Search upwards and downwards in a directory tree using "*", "**" and
5578 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005579 {not available when compiled without the |+path_extra| feature}
5580 - Careful with '\' characters, type two to get one in the option: >
5581 :set path=.,c:\\include
5582< Or just use '/' instead: >
5583 :set path=.,c:/include
5584< Don't forget "." or files won't even be found in the same directory as
5585 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005586 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 it is something like 256 or 1024 characters.
5588 You can check if all the include files are found, using the value of
5589 'path', see |:checkpath|.
5590 The use of |:set+=| and |:set-=| is preferred when adding or removing
5591 directories from the list. This avoids problems when a future version
5592 uses another default. To remove the current directory use: >
5593 :set path-=
5594< To add the current directory use: >
5595 :set path+=
5596< To use an environment variable, you probably need to replace the
5597 separator. Here is an example to append $INCL, in which directory
5598 names are separated with a semi-colon: >
5599 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5600< Replace the ';' with a ':' or whatever separator is used. Note that
5601 this doesn't work when $INCL contains a comma or white space.
5602
Bram Moolenaard94464e2015-11-02 15:28:18 +01005603 *'perldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005604'perldll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005605 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005606 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005607 {only available when compiled with the |+perl/dyn|
5608 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005609 Specifies the name of the Perl shared library. The default is
5610 DYNAMIC_PERL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005611 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005612 This option cannot be set from a |modeline| or in the |sandbox|, for
5613 security reasons.
5614
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5616'preserveindent' 'pi' boolean (default off)
5617 local to buffer
5618 {not in Vi}
5619 When changing the indent of the current line, preserve as much of the
5620 indent structure as possible. Normally the indent is replaced by a
5621 series of tabs followed by spaces as required (unless |'expandtab'| is
5622 enabled, in which case only spaces are used). Enabling this option
5623 means the indent will preserve as many existing characters as possible
5624 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005625 'expandtab' does not apply to the preserved white space, a Tab remains
5626 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 NOTE: When using ">>" multiple times the resulting indent is a mix of
5628 tabs and spaces. You might not like this.
5629 NOTE: 'preserveindent' is reset when 'compatible' is set.
5630 Also see 'copyindent'.
5631 Use |:retab| to clean up white space.
5632
5633 *'previewheight'* *'pvh'*
5634'previewheight' 'pvh' number (default 12)
5635 global
5636 {not in Vi}
5637 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005638 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 Default height for a preview window. Used for |:ptag| and associated
5640 commands. Used for |CTRL-W_}| when no count is given.
5641
5642 *'previewwindow'* *'nopreviewwindow'*
5643 *'pvw'* *'nopvw'* *E590*
5644'previewwindow' 'pvw' boolean (default off)
5645 local to window
5646 {not in Vi}
5647 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005648 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005649 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 set. It's normally not set directly, but by using one of the commands
5651 |:ptag|, |:pedit|, etc.
5652
5653 *'printdevice'* *'pdev'*
5654'printdevice' 'pdev' string (default empty)
5655 global
5656 {not in Vi}
5657 {only available when compiled with the |+printer|
5658 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005659 The name of the printer to be used for |:hardcopy|.
5660 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005661 This option cannot be set from a |modeline| or in the |sandbox|, for
5662 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663
Bram Moolenaar8299df92004-07-10 09:47:34 +00005664 *'printencoding'* *'penc'*
5665'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 global
5667 {not in Vi}
5668 {only available when compiled with the |+printer|
5669 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005670 Sets the character encoding used when printing.
5671 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672
5673 *'printexpr'* *'pexpr'*
5674'printexpr' 'pexpr' String (default: see below)
5675 global
5676 {not in Vi}
5677 {only available when compiled with the |+printer|
5678 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005679 Expression used to print the PostScript produced with |:hardcopy|.
5680 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681
Bram Moolenaar8299df92004-07-10 09:47:34 +00005682 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683'printfont' 'pfn' string (default "courier")
5684 global
5685 {not in Vi}
5686 {only available when compiled with the |+printer|
5687 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005688 The name of the font that will be used for |:hardcopy|.
5689 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690
5691 *'printheader'* *'pheader'*
5692'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5693 global
5694 {not in Vi}
5695 {only available when compiled with the |+printer|
5696 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005697 The format of the header produced in |:hardcopy| output.
5698 See |pheader-option|.
5699
5700 *'printmbcharset'* *'pmbcs'*
5701'printmbcharset' 'pmbcs' string (default "")
5702 global
5703 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005704 {only available when compiled with the |+printer|,
5705 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005706 The CJK character set to be used for CJK output from |:hardcopy|.
5707 See |pmbcs-option|.
5708
5709 *'printmbfont'* *'pmbfn'*
5710'printmbfont' 'pmbfn' string (default "")
5711 global
5712 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005713 {only available when compiled with the |+printer|,
5714 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005715 List of font names to be used for CJK output from |:hardcopy|.
5716 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
5718 *'printoptions'* *'popt'*
5719'printoptions' 'popt' string (default "")
5720 global
5721 {not in Vi}
5722 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005723 List of items that control the format of the output of |:hardcopy|.
5724 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005726 *'prompt'* *'noprompt'*
5727'prompt' boolean (default on)
5728 global
5729 When on a ":" prompt is used in Ex mode.
5730
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005731 *'pumheight'* *'ph'*
5732'pumheight' 'ph' number (default 0)
5733 global
5734 {not available when compiled without the
5735 |+insert_expand| feature}
5736 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005737 Determines the maximum number of items to show in the popup menu for
5738 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005739 |ins-completion-menu|.
5740
Bram Moolenaard94464e2015-11-02 15:28:18 +01005741 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005742'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005743 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005744 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005745 {only available when compiled with the |+python/dyn|
5746 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005747 Specifies the name of the Python 2.x shared library. The default is
5748 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005749 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005750 This option cannot be set from a |modeline| or in the |sandbox|, for
5751 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005752
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005753 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005754'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005755 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005756 {not in Vi}
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005757 {only available when compiled with the |+python3/dyn|
5758 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005759 Specifies the name of the Python 3 shared library. The default is
5760 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005761 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005762 This option cannot be set from a |modeline| or in the |sandbox|, for
5763 security reasons.
5764
Bram Moolenaar677ee682005-01-27 14:41:15 +00005765 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005766'quoteescape' 'qe' string (default "\")
5767 local to buffer
5768 {not in Vi}
5769 The characters that are used to escape quotes in a string. Used for
5770 objects like a', a" and a` |a'|.
5771 When one of the characters in this option is found inside a string,
5772 the following character will be skipped. The default value makes the
5773 text "foo\"bar\\" considered to be one string.
5774
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5776'readonly' 'ro' boolean (default off)
5777 local to buffer
5778 If on, writes fail unless you use a '!'. Protects you from
5779 accidentally overwriting a file. Default on when Vim is started
5780 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005781 When using ":w!" the 'readonly' option is reset for the current
5782 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005784 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005785
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005786 *'redrawtime'* *'rdt'*
5787'redrawtime' 'rdt' number (default 2000)
5788 global
5789 {not in Vi}
5790 {only available when compiled with the |+reltime|
5791 feature}
5792 The time in milliseconds for redrawing the display. This applies to
5793 searching for patterns for 'hlsearch' and |:match| highlighting.
5794 When redrawing takes more than this many milliseconds no further
5795 matches will be highlighted. This is used to avoid that Vim hangs
5796 when using a very complicated pattern.
5797
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005798 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005799'regexpengine' 're' number (default 0)
5800 global
5801 {not in Vi}
5802 This selects the default regexp engine. |two-engines|
5803 The possible values are:
5804 0 automatic selection
5805 1 old engine
5806 2 NFA engine
5807 Note that when using the NFA engine and the pattern contains something
5808 that is not supported the pattern will not match. This is only useful
5809 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005810 Using automatic selection enables Vim to switch the engine, if the
5811 default engine becomes too costly. E.g., when the NFA engine uses too
5812 many states. This should prevent Vim from hanging on a combination of
5813 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005814
Bram Moolenaar64486672010-05-16 15:46:46 +02005815 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5816'relativenumber' 'rnu' boolean (default off)
5817 local to window
5818 {not in Vi}
5819 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005820 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005821 precede some vertical motion commands (e.g. j k + -) with, without
5822 having to calculate it yourself. Especially useful in combination with
5823 other commands (e.g. y d c < > gq gw =).
5824 When the 'n' option is excluded from 'cpoptions' a wrapped
5825 line will not use the column of line numbers (this is the default when
5826 'compatible' isn't set).
5827 The 'numberwidth' option can be used to set the room used for the line
5828 number.
5829 When a long, wrapped line doesn't start with the first character, '-'
5830 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005831 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5832 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005833
5834 The number in front of the cursor line also depends on the value of
5835 'number', see |number_relativenumber| for all combinations of the two
5836 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005837
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 *'remap'* *'noremap'*
5839'remap' boolean (default on)
5840 global
5841 Allows for mappings to work recursively. If you do not want this for
5842 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005843 NOTE: To avoid portability problems with Vim scripts, always keep
5844 this option at the default "on". Only switch it off when working with
5845 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005847 *'renderoptions'* *'rop'*
5848'renderoptions' 'rop' string (default: empty)
5849 global
5850 {not in Vi}
5851 {only available when compiled with GUI and DIRECTX on
5852 MS-Windows}
5853 Select a text renderer and set its options. The options depend on the
5854 renderer.
5855
5856 Syntax: >
5857 set rop=type:{renderer}(,{name}:{value})*
5858<
5859 Currently, only one optional renderer is available.
5860
5861 render behavior ~
5862 directx Vim will draw text using DirectX (DirectWrite). It makes
5863 drawn glyphs more beautiful than default GDI.
5864 It requires 'encoding' is "utf-8", and only works on
5865 MS-Windows Vista or newer version.
5866
5867 Options:
5868 name meaning type value ~
5869 gamma gamma float 1.0 - 2.2 (maybe)
5870 contrast enhancedContrast float (unknown)
5871 level clearTypeLevel float (unknown)
5872 geom pixelGeometry int 0 - 2 (see below)
5873 renmode renderingMode int 0 - 6 (see below)
5874 taamode textAntialiasMode int 0 - 3 (see below)
5875
5876 See this URL for detail:
5877 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5878
5879 For geom: structure of a device pixel.
5880 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5881 1 - DWRITE_PIXEL_GEOMETRY_RGB
5882 2 - DWRITE_PIXEL_GEOMETRY_BGR
5883
5884 See this URL for detail:
5885 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5886
5887 For renmode: method of rendering glyphs.
5888 0 - DWRITE_RENDERING_MODE_DEFAULT
5889 1 - DWRITE_RENDERING_MODE_ALIASED
5890 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5891 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5892 4 - DWRITE_RENDERING_MODE_NATURAL
5893 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5894 6 - DWRITE_RENDERING_MODE_OUTLINE
5895
5896 See this URL for detail:
5897 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5898
5899 For taamode: antialiasing mode used for drawing text.
5900 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5901 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5902 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5903 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5904
5905 See this URL for detail:
5906 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5907
5908 Example: >
5909 set encoding=utf-8
5910 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5911 set rop=type:directx
5912<
5913 If select a raster font (Courier, Terminal or FixedSys) to
5914 'guifont', it fallbacks to be drawn by GDI automatically.
5915
5916 Other render types are currently not supported.
5917
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 *'report'*
5919'report' number (default 2)
5920 global
5921 Threshold for reporting number of lines changed. When the number of
5922 changed lines is more than 'report' a message will be given for most
5923 ":" commands. If you want it always, set 'report' to 0.
5924 For the ":substitute" command the number of substitutions is used
5925 instead of the number of lines.
5926
5927 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5928'restorescreen' 'rs' boolean (default on)
5929 global
5930 {not in Vi} {only in Windows 95/NT console version}
5931 When set, the screen contents is restored when exiting Vim. This also
5932 happens when executing external commands.
5933
5934 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5935 options in your .vimrc. To disable restoring:
5936 set t_ti= t_te=
5937 To enable restoring (for an xterm):
5938 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5939 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5940
5941 *'revins'* *'ri'* *'norevins'* *'nori'*
5942'revins' 'ri' boolean (default off)
5943 global
5944 {not in Vi}
5945 {only available when compiled with the |+rightleft|
5946 feature}
5947 Inserting characters in Insert mode will work backwards. See "typing
5948 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5949 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005950 NOTE: This option is reset when 'compatible' is set.
5951 This option is reset when 'paste' is set and restored when 'paste' is
5952 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953
5954 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5955'rightleft' 'rl' boolean (default off)
5956 local to window
5957 {not in Vi}
5958 {only available when compiled with the |+rightleft|
5959 feature}
5960 When on, display orientation becomes right-to-left, i.e., characters
5961 that are stored in the file appear from the right to the left.
5962 Using this option, it is possible to edit files for languages that
5963 are written from the right to the left such as Hebrew and Arabic.
5964 This option is per window, so it is possible to edit mixed files
5965 simultaneously, or to view the same file in both ways (this is
5966 useful whenever you have a mixed text file with both right-to-left
5967 and left-to-right strings so that both sets are displayed properly
5968 in different windows). Also see |rileft.txt|.
5969
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005970 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971'rightleftcmd' 'rlc' string (default "search")
5972 local to window
5973 {not in Vi}
5974 {only available when compiled with the |+rightleft|
5975 feature}
5976 Each word in this option enables the command line editing to work in
5977 right-to-left mode for a group of commands:
5978
5979 search "/" and "?" commands
5980
5981 This is useful for languages such as Hebrew, Arabic and Farsi.
5982 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5983
Bram Moolenaard94464e2015-11-02 15:28:18 +01005984 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005985'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005986 global
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005987 {not in Vi}
Bram Moolenaard94464e2015-11-02 15:28:18 +01005988 {only available when compiled with the |+ruby/dyn|
5989 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005990 Specifies the name of the Ruby shared library. The default is
5991 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005992 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005993 This option cannot be set from a |modeline| or in the |sandbox|, for
5994 security reasons.
5995
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005997'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 global
5999 {not in Vi}
6000 {not available when compiled without the
6001 |+cmdline_info| feature}
6002 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006003 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 text in the file is shown on the far right:
6005 Top first line is visible
6006 Bot last line is visible
6007 All first and last line are visible
6008 45% relative position in the file
6009 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006010 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006011 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006012 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 this option takes precedence over 'ruler' and 'rulerformat'
6014 If the number of characters displayed is different from the number of
6015 bytes in the text (e.g., for a TAB or a multi-byte character), both
6016 the text column (byte number) and the screen column are shown,
6017 separated with a dash.
6018 For an empty line "0-1" is shown.
6019 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006020 This option is reset when 'paste' is set and restored when 'paste' is
6021 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 If you don't want to see the ruler all the time but want to know where
6023 you are, use "g CTRL-G" |g_CTRL-G|.
6024 NOTE: This option is reset when 'compatible' is set.
6025
6026 *'rulerformat'* *'ruf'*
6027'rulerformat' 'ruf' string (default empty)
6028 global
6029 {not in Vi}
6030 {not available when compiled without the |+statusline|
6031 feature}
6032 When this option is not empty, it determines the content of the ruler
6033 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006034 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 The default ruler width is 17 characters. To make the ruler 15
6036 characters wide, put "%15(" at the start and "%)" at the end.
6037 Example: >
6038 :set rulerformat=%15(%c%V\ %p%%%)
6039<
6040 *'runtimepath'* *'rtp'* *vimfiles*
6041'runtimepath' 'rtp' string (default:
6042 Unix: "$HOME/.vim,
6043 $VIM/vimfiles,
6044 $VIMRUNTIME,
6045 $VIM/vimfiles/after,
6046 $HOME/.vim/after"
6047 Amiga: "home:vimfiles,
6048 $VIM/vimfiles,
6049 $VIMRUNTIME,
6050 $VIM/vimfiles/after,
6051 home:vimfiles/after"
6052 PC, OS/2: "$HOME/vimfiles,
6053 $VIM/vimfiles,
6054 $VIMRUNTIME,
6055 $VIM/vimfiles/after,
6056 $HOME/vimfiles/after"
6057 Macintosh: "$VIM:vimfiles,
6058 $VIMRUNTIME,
6059 $VIM:vimfiles:after"
6060 RISC-OS: "Choices:vimfiles,
6061 $VIMRUNTIME,
6062 Choices:vimfiles/after"
6063 VMS: "sys$login:vimfiles,
6064 $VIM/vimfiles,
6065 $VIMRUNTIME,
6066 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006067 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 global
6069 {not in Vi}
6070 This is a list of directories which will be searched for runtime
6071 files:
6072 filetype.vim filetypes by file name |new-filetype|
6073 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006074 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 colors/ color scheme files |:colorscheme|
6076 compiler/ compiler files |:compiler|
6077 doc/ documentation |write-local-help|
6078 ftplugin/ filetype plugins |write-filetype-plugin|
6079 indent/ indent scripts |indent-expression|
6080 keymap/ key mapping files |mbyte-keymap|
6081 lang/ menu translations |:menutrans|
6082 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006083 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 plugin/ plugin scripts |write-plugin|
6085 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006086 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 syntax/ syntax files |mysyntaxfile|
6088 tutor/ files for vimtutor |tutor|
6089
6090 And any other file searched for with the |:runtime| command.
6091
6092 The defaults for most systems are setup to search five locations:
6093 1. In your home directory, for your personal preferences.
6094 2. In a system-wide Vim directory, for preferences from the system
6095 administrator.
6096 3. In $VIMRUNTIME, for files distributed with Vim.
6097 *after-directory*
6098 4. In the "after" directory in the system-wide Vim directory. This is
6099 for the system administrator to overrule or add to the distributed
6100 defaults (rarely needed)
6101 5. In the "after" directory in your home directory. This is for
6102 personal preferences to overrule or add to the distributed defaults
6103 or system-wide settings (rarely needed).
6104
Bram Moolenaar26852122016-05-24 20:02:38 +02006105 More entries are added when using |packages|.
6106
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6108 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006109 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 wildcards.
6111 See |:runtime|.
6112 Example: >
6113 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6114< This will use the directory "~/vimruntime" first (containing your
6115 personal Vim runtime files), then "/mygroup/vim" (shared between a
6116 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6117 files).
6118 You probably should always include $VIMRUNTIME somewhere, to use the
6119 distributed runtime files. You can put a directory before $VIMRUNTIME
6120 to find files which replace a distributed runtime files. You can put
6121 a directory after $VIMRUNTIME to find files which add to distributed
6122 runtime files.
6123 This option cannot be set from a |modeline| or in the |sandbox|, for
6124 security reasons.
6125
6126 *'scroll'* *'scr'*
6127'scroll' 'scr' number (default: half the window height)
6128 local to window
6129 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6130 set to half the number of lines in the window when the window size
6131 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006132 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6134 the number of screen lines instead of file lines, makes a difference
6135 when lines wrap}
6136
6137 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6138'scrollbind' 'scb' boolean (default off)
6139 local to window
6140 {not in Vi}
6141 {not available when compiled without the |+scrollbind|
6142 feature}
6143 See also |scroll-binding|. When this option is set, the current
6144 window scrolls as other scrollbind windows (windows that also have
6145 this option set) scroll. This option is useful for viewing the
6146 differences between two versions of a file, see 'diff'.
6147 See |'scrollopt'| for options that determine how this option should be
6148 interpreted.
6149 This option is mostly reset when splitting a window to edit another
6150 file. This means that ":split | edit file" results in two windows
6151 with scroll-binding, but ":split file" does not.
6152
6153 *'scrolljump'* *'sj'*
6154'scrolljump' 'sj' number (default 1)
6155 global
6156 {not in Vi}
6157 Minimal number of lines to scroll when the cursor gets off the
6158 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6159 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006160 When set to a negative number from -1 to -100 this is used as the
6161 percentage of the window height. Thus -50 scrolls half the window
6162 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 NOTE: This option is set to 1 when 'compatible' is set.
6164
6165 *'scrolloff'* *'so'*
6166'scrolloff' 'so' number (default 0)
6167 global
6168 {not in Vi}
6169 Minimal number of screen lines to keep above and below the cursor.
6170 This will make some context visible around where you are working. If
6171 you set it to a very large value (999) the cursor line will always be
6172 in the middle of the window (except at the start or end of the file or
6173 when long lines wrap).
6174 For scrolling horizontally see 'sidescrolloff'.
6175 NOTE: This option is set to 0 when 'compatible' is set.
6176
6177 *'scrollopt'* *'sbo'*
6178'scrollopt' 'sbo' string (default "ver,jump")
6179 global
6180 {not available when compiled without the |+scrollbind|
6181 feature}
6182 {not in Vi}
6183 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006184 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6185 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 The following words are available:
6187 ver Bind vertical scrolling for 'scrollbind' windows
6188 hor Bind horizontal scrolling for 'scrollbind' windows
6189 jump Applies to the offset between two windows for vertical
6190 scrolling. This offset is the difference in the first
6191 displayed line of the bound windows. When moving
6192 around in a window, another 'scrollbind' window may
6193 reach a position before the start or after the end of
6194 the buffer. The offset is not changed though, when
6195 moving back the 'scrollbind' window will try to scroll
6196 to the desired position when possible.
6197 When now making that window the current one, two
6198 things can be done with the relative offset:
6199 1. When "jump" is not included, the relative offset is
6200 adjusted for the scroll position in the new current
6201 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006202 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 2. When "jump" is included, the other windows are
6204 scrolled to keep the same relative offset. When
6205 going back to the other window, it still uses the
6206 same relative offset.
6207 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006208 When 'diff' mode is active there always is vertical scroll binding,
6209 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210
6211 *'sections'* *'sect'*
6212'sections' 'sect' string (default "SHNHH HUnhsh")
6213 global
6214 Specifies the nroff macros that separate sections. These are pairs of
6215 two letters (See |object-motions|). The default makes a section start
6216 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6217
6218 *'secure'* *'nosecure'* *E523*
6219'secure' boolean (default off)
6220 global
6221 {not in Vi}
6222 When on, ":autocmd", shell and write commands are not allowed in
6223 ".vimrc" and ".exrc" in the current directory and map commands are
6224 displayed. Switch it off only if you know that you will not run into
6225 problems, or when the 'exrc' option is off. On Unix this option is
6226 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006227 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 'secure' at the end of your ~/.vimrc then.
6229 This option cannot be set from a |modeline| or in the |sandbox|, for
6230 security reasons.
6231
6232 *'selection'* *'sel'*
6233'selection' 'sel' string (default "inclusive")
6234 global
6235 {not in Vi}
6236 This option defines the behavior of the selection. It is only used
6237 in Visual and Select mode.
6238 Possible values:
6239 value past line inclusive ~
6240 old no yes
6241 inclusive yes yes
6242 exclusive yes no
6243 "past line" means that the cursor is allowed to be positioned one
6244 character past the line.
6245 "inclusive" means that the last character of the selection is included
6246 in an operation. For example, when "x" is used to delete the
6247 selection.
6248 Note that when "exclusive" is used and selecting from the end
6249 backwards, you cannot include the last character of a line, when
6250 starting in Normal mode and 'virtualedit' empty.
6251
6252 The 'selection' option is set by the |:behave| command.
6253
6254 *'selectmode'* *'slm'*
6255'selectmode' 'slm' string (default "")
6256 global
6257 {not in Vi}
6258 This is a comma separated list of words, which specifies when to start
6259 Select mode instead of Visual mode, when a selection is started.
6260 Possible values:
6261 mouse when using the mouse
6262 key when using shifted special keys
6263 cmd when using "v", "V" or CTRL-V
6264 See |Select-mode|.
6265 The 'selectmode' option is set by the |:behave| command.
6266
6267 *'sessionoptions'* *'ssop'*
6268'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006269 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 global
6271 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006272 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 feature}
6274 Changes the effect of the |:mksession| command. It is a comma
6275 separated list of words. Each word enables saving and restoring
6276 something:
6277 word save and restore ~
6278 blank empty windows
6279 buffers hidden and unloaded buffers, not just those in windows
6280 curdir the current directory
6281 folds manually created folds, opened/closed folds and local
6282 fold options
6283 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006284 and contain at least one lowercase letter. Only
6285 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 help the help window
6287 localoptions options and mappings local to a window or buffer (not
6288 global values for local options)
6289 options all options and mappings (also global values for local
6290 options)
6291 resize size of the Vim window: 'lines' and 'columns'
6292 sesdir the directory in which the session file is located
6293 will become the current directory (useful with
6294 projects accessed over a network from different
6295 systems)
6296 slash backslashes in file names replaced with forward
6297 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006298 tabpages all tab pages; without this only the current tab page
6299 is restored, so that you can make a session for each
6300 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 unix with Unix end-of-line format (single <NL>), even when
6302 on Windows or DOS
6303 winpos position of the whole Vim window
6304 winsize window sizes
6305
6306 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006307 When neither "curdir" nor "sesdir" is included, file names are stored
6308 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 "slash" and "unix" are useful on Windows when sharing session files
6310 with Unix. The Unix version of Vim cannot source dos format scripts,
6311 but the Windows version of Vim can source unix format scripts.
6312
6313 *'shell'* *'sh'* *E91*
6314'shell' 'sh' string (default $SHELL or "sh",
6315 MS-DOS and Win32: "command.com" or
6316 "cmd.exe", OS/2: "cmd")
6317 global
6318 Name of the shell to use for ! and :! commands. When changing the
6319 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6320 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006321 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 See |option-backslash| about including spaces and backslashes.
6323 Environment variables are expanded |:set_env|.
6324 If the name of the shell contains a space, you might need to enclose
6325 it in quotes. Example: >
6326 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6327< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 "-f" is not inside the quotes, because it is not part of the command
6330 name. And Vim automagically recognizes the backslashes that are path
6331 separators.
6332 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6333 variable to change the way external commands are executed. See the
6334 libc.inf file of DJGPP.
6335 Under MS-Windows, when the executable ends in ".com" it must be
6336 included. Thus setting the shell to "command.com" or "4dos.com"
6337 works, but "command" and "4dos" do not work for all commands (e.g.,
6338 filtering).
6339 For unknown reasons, when using "4dos.com" the current directory is
6340 changed to "C:\". To avoid this set 'shell' like this: >
6341 :set shell=command.com\ /c\ 4dos
6342< This option cannot be set from a |modeline| or in the |sandbox|, for
6343 security reasons.
6344
6345 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006346'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006347 MS-DOS and Win32, when 'shell' does not
6348 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 global
6350 {not in Vi}
6351 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6352 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6353 systems, the default is set according to the value of 'shell', to
6354 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006355 OS/2 (EMX figures this out itself).
6356 On Unix it can have more than one flag. Each white space separated
6357 part is passed as an argument to the shell command.
6358 See |option-backslash| about including spaces and backslashes.
6359 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 This option cannot be set from a |modeline| or in the |sandbox|, for
6361 security reasons.
6362
6363 *'shellpipe'* *'sp'*
6364'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6365 global
6366 {not in Vi}
6367 {not available when compiled without the |+quickfix|
6368 feature}
6369 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006370 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006371 including spaces and backslashes.
6372 The name of the temporary file can be represented by "%s" if necessary
6373 (the file name is appended automatically if no %s appears in the value
6374 of this option).
6375 For the Amiga and MS-DOS the default is ">". The output is directly
6376 saved in a file and not echoed to the screen.
6377 For Unix the default it "| tee". The stdout of the compiler is saved
6378 in a file and echoed to the screen. If the 'shell' option is "csh" or
6379 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006380 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6381 default becomes "2>&1| tee". This means that stderr is also included.
6382 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6383 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 The initialization of this option is done after reading the ".vimrc"
6385 and the other initializations, so that when the 'shell' option is set
6386 there, the 'shellpipe' option changes automatically, unless it was
6387 explicitly set before.
6388 When 'shellpipe' is set to an empty string, no redirection of the
6389 ":make" output will be done. This is useful if you use a 'makeprg'
6390 that writes to 'makeef' by itself. If you want no piping, but do
6391 want to include the 'makeef', set 'shellpipe' to a single space.
6392 Don't forget to precede the space with a backslash: ":set sp=\ ".
6393 In the future pipes may be used for filtering and this option will
6394 become obsolete (at least for Unix).
6395 This option cannot be set from a |modeline| or in the |sandbox|, for
6396 security reasons.
6397
6398 *'shellquote'* *'shq'*
6399'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6400 contains "sh" somewhere: "\"")
6401 global
6402 {not in Vi}
6403 Quoting character(s), put around the command passed to the shell, for
6404 the "!" and ":!" commands. The redirection is kept outside of the
6405 quoting. See 'shellxquote' to include the redirection. It's
6406 probably not useful to set both options.
6407 This is an empty string by default. Only known to be useful for
6408 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6409 or bash, where it should be "\"". The default is adjusted according
6410 the value of 'shell', to reduce the need to set this option by the
6411 user. See |dos-shell|.
6412 This option cannot be set from a |modeline| or in the |sandbox|, for
6413 security reasons.
6414
6415 *'shellredir'* *'srr'*
6416'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6417 global
6418 {not in Vi}
6419 String to be used to put the output of a filter command in a temporary
6420 file. See also |:!|. See |option-backslash| about including spaces
6421 and backslashes.
6422 The name of the temporary file can be represented by "%s" if necessary
6423 (the file name is appended automatically if no %s appears in the value
6424 of this option).
6425 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6426 or "zsh" during initializations, the default becomes ">&". If the
6427 'shell' option is "sh", "ksh" or "bash" the default becomes
6428 ">%s 2>&1". This means that stderr is also included.
6429 For Win32, the Unix checks are done and additionally "cmd" is checked
6430 for, which makes the default ">%s 2>&1". Also, the same names with
6431 ".exe" appended are checked for.
6432 The initialization of this option is done after reading the ".vimrc"
6433 and the other initializations, so that when the 'shell' option is set
6434 there, the 'shellredir' option changes automatically unless it was
6435 explicitly set before.
6436 In the future pipes may be used for filtering and this option will
6437 become obsolete (at least for Unix).
6438 This option cannot be set from a |modeline| or in the |sandbox|, for
6439 security reasons.
6440
6441 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6442'shellslash' 'ssl' boolean (default off)
6443 global
6444 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6445 When set, a forward slash is used when expanding file names. This is
6446 useful when a Unix-like shell is used instead of command.com or
6447 cmd.exe. Backward slashes can still be typed, but they are changed to
6448 forward slashes by Vim.
6449 Note that setting or resetting this option has no effect for some
6450 existing file names, thus this option needs to be set before opening
6451 any file for best results. This might change in the future.
6452 'shellslash' only works when a backslash can be used as a path
6453 separator. To test if this is so use: >
6454 if exists('+shellslash')
6455<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006456 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6457'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6458 global
6459 {not in Vi}
6460 When on, use temp files for shell commands. When off use a pipe.
6461 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006462 Currently a pipe is only supported on Unix and MS-Windows 2K and
6463 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006464 :if has("filterpipe")
6465< The advantage of using a pipe is that nobody can read the temp file
6466 and the 'shell' command does not need to support redirection.
6467 The advantage of using a temp file is that the file type and encoding
6468 can be detected.
6469 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6470 |FilterWritePost| autocommands event are not triggered when
6471 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006472 The `system()` function does not respect this option and always uses
6473 temp files.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006474
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 *'shelltype'* *'st'*
6476'shelltype' 'st' number (default 0)
6477 global
6478 {not in Vi} {only for the Amiga}
6479 On the Amiga this option influences the way how the commands work
6480 which use a shell.
6481 0 and 1: always use the shell
6482 2 and 3: use the shell only to filter lines
6483 4 and 5: use shell only for ':sh' command
6484 When not using the shell, the command is executed directly.
6485
6486 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6487 1 and 3: use "shell cmd" to start external commands
6488
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006489 *'shellxescape'* *'sxe'*
6490'shellxescape' 'sxe' string (default: "";
6491 for MS-DOS and MS-Windows: "\"&|<>()@^")
6492 global
6493 {not in Vi}
6494 When 'shellxquote' is set to "(" then the characters listed in this
6495 option will be escaped with a '^' character. This makes it possible
6496 to execute most external commands with cmd.exe.
6497
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 *'shellxquote'* *'sxq'*
6499'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006500 for Win32, when 'shell' is cmd.exe: "("
6501 for Win32, when 'shell' contains "sh"
6502 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 for Unix, when using system(): "\"")
6504 global
6505 {not in Vi}
6506 Quoting character(s), put around the command passed to the shell, for
6507 the "!" and ":!" commands. Includes the redirection. See
6508 'shellquote' to exclude the redirection. It's probably not useful
6509 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006510 When the value is '(' then ')' is appended. When the value is '"('
6511 then ')"' is appended.
6512 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006513 This is an empty string by default on most systems, but is known to be
6514 useful for on Win32 version, either for cmd.exe which automatically
6515 strips off the first and last quote on a command, or 3rd-party shells
6516 such as the MKS Korn Shell or bash, where it should be "\"". The
6517 default is adjusted according the value of 'shell', to reduce the need
6518 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 This option cannot be set from a |modeline| or in the |sandbox|, for
6520 security reasons.
6521
6522 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6523'shiftround' 'sr' boolean (default off)
6524 global
6525 {not in Vi}
6526 Round indent to multiple of 'shiftwidth'. Applies to > and <
6527 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6528 a multiple of 'shiftwidth' (this is Vi compatible).
6529 NOTE: This option is reset when 'compatible' is set.
6530
6531 *'shiftwidth'* *'sw'*
6532'shiftwidth' 'sw' number (default 8)
6533 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006534 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006536 When zero the 'ts' value will be used. Use the |shiftwidth()|
6537 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538
6539 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006540'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6541 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 global
6543 {not in Vi}
6544 This option helps to avoid all the |hit-enter| prompts caused by file
6545 messages, for example with CTRL-G, and to avoid some other messages.
6546 It is a list of flags:
6547 flag meaning when present ~
6548 f use "(3 of 5)" instead of "(file 3 of 5)"
6549 i use "[noeol]" instead of "[Incomplete last line]"
6550 l use "999L, 888C" instead of "999 lines, 888 characters"
6551 m use "[+]" instead of "[Modified]"
6552 n use "[New]" instead of "[New File]"
6553 r use "[RO]" instead of "[readonly]"
6554 w use "[w]" instead of "written" for file write message
6555 and "[a]" instead of "appended" for ':w >> file' command
6556 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6557 "[unix format]" and "[mac]" instead of "[mac format]".
6558 a all of the above abbreviations
6559
6560 o overwrite message for writing a file with subsequent message
6561 for reading a file (useful for ":wn" or when 'autowrite' on)
6562 O message for reading a file overwrites any previous message.
6563 Also for quickfix message (e.g., ":cn").
6564 s don't give "search hit BOTTOM, continuing at TOP" or "search
6565 hit TOP, continuing at BOTTOM" messages
6566 t truncate file message at the start if it is too long to fit
6567 on the command-line, "<" will appear in the left most column.
6568 Ignored in Ex mode.
6569 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006570 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 Ignored in Ex mode.
6572 W don't give "written" or "[w]" when writing a file
6573 A don't give the "ATTENTION" message when an existing swap file
6574 is found.
6575 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006576 c don't give |ins-completion-menu| messages. For example,
6577 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6578 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006579 q use "recording" instead of "recording @a"
6580 F don't give the file info when editing a file, like `:silent`
6581 was used for the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582
6583 This gives you the opportunity to avoid that a change between buffers
6584 requires you to hit <Enter>, but still gives as useful a message as
6585 possible for the space available. To get the whole message that you
6586 would have got with 'shm' empty, use ":file!"
6587 Useful values:
6588 shm= No abbreviation of message.
6589 shm=a Abbreviation, but no loss of information.
6590 shm=at Abbreviation, and truncate message when necessary.
6591
6592 NOTE: This option is set to the Vi default value when 'compatible' is
6593 set and to the Vim default value when 'compatible' is reset.
6594
6595 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6596'shortname' 'sn' boolean (default off)
6597 local to buffer
6598 {not in Vi, not in MS-DOS versions}
6599 Filenames are assumed to be 8 characters plus one extension of 3
6600 characters. Multiple dots in file names are not allowed. When this
6601 option is on, dots in file names are replaced with underscores when
6602 adding an extension (".~" or ".swp"). This option is not available
6603 for MS-DOS, because then it would always be on. This option is useful
6604 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6605 or crossdos. When running the Win32 GUI version under Win32s, this
6606 option is always on by default.
6607
6608 *'showbreak'* *'sbr'* *E595*
6609'showbreak' 'sbr' string (default "")
6610 global
6611 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006612 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 feature}
6614 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006615 values are "> " or "+++ ": >
6616 :set showbreak=>\
6617< Note the backslash to escape the trailing space. It's easier like
6618 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006619 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006620< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 comma (in a future version the comma might be used to separate the
6622 part that is shown at the end and at the start of a line).
6623 The characters are highlighted according to the '@' flag in
6624 'highlight'.
6625 Note that tabs after the showbreak will be displayed differently.
6626 If you want the 'showbreak' to appear in between line numbers, add the
6627 "n" flag to 'cpoptions'.
6628
6629 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006630'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6631 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 global
6633 {not in Vi}
6634 {not available when compiled without the
6635 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006636 Show (partial) command in the last line of the screen. Set this
6637 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 In Visual mode the size of the selected area is shown:
6639 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006640 If the number of bytes is different it is also displayed: "2-6"
6641 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006643 - When selecting a block, the size in screen characters:
6644 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 NOTE: This option is set to the Vi default value when 'compatible' is
6646 set and to the Vim default value when 'compatible' is reset.
6647
6648 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6649'showfulltag' 'sft' boolean (default off)
6650 global
6651 {not in Vi}
6652 When completing a word in insert mode (see |ins-completion|) from the
6653 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006654 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 matched a C function, you can see a template for what arguments are
6656 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006657 Note that this doesn't work well together with having "longest" in
6658 'completeopt', because the completion from the search pattern may not
6659 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660
6661 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6662'showmatch' 'sm' boolean (default off)
6663 global
6664 When a bracket is inserted, briefly jump to the matching one. The
6665 jump is only done if the match can be seen on the screen. The time to
6666 show the match can be set with 'matchtime'.
6667 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006668 seen or not).
6669 This option is reset when 'paste' is set and restored when 'paste' is
6670 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 When the 'm' flag is not included in 'cpoptions', typing a character
6672 will immediately move the cursor back to where it belongs.
6673 See the "sm" field in 'guicursor' for setting the cursor shape and
6674 blinking when showing the match.
6675 The 'matchpairs' option can be used to specify the characters to show
6676 matches for. 'rightleft' and 'revins' are used to look for opposite
6677 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006678 Also see the matchparen plugin for highlighting the match when moving
6679 around |pi_paren.txt|.
6680 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681
6682 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6683'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6684 global
6685 If in Insert, Replace or Visual mode put a message on the last line.
6686 Use the 'M' flag in 'highlight' to set the type of highlighting for
6687 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006688 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 doesn't mean XIM is really active, especially when 'imactivatekey' is
6690 not set.
6691 NOTE: This option is set to the Vi default value when 'compatible' is
6692 set and to the Vim default value when 'compatible' is reset.
6693
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006694 *'showtabline'* *'stal'*
6695'showtabline' 'stal' number (default 1)
6696 global
6697 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006698 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006699 feature}
6700 The value of this option specifies when the line with tab page labels
6701 will be displayed:
6702 0: never
6703 1: only if there are at least two tab pages
6704 2: always
6705 This is both for the GUI and non-GUI implementation of the tab pages
6706 line.
6707 See |tab-page| for more information about tab pages.
6708
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 *'sidescroll'* *'ss'*
6710'sidescroll' 'ss' number (default 0)
6711 global
6712 {not in Vi}
6713 The minimal number of columns to scroll horizontally. Used only when
6714 the 'wrap' option is off and the cursor is moved off of the screen.
6715 When it is zero the cursor will be put in the middle of the screen.
6716 When using a slow terminal set it to a large number or 0. When using
6717 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6718 commands.
6719
6720 *'sidescrolloff'* *'siso'*
6721'sidescrolloff' 'siso' number (default 0)
6722 global
6723 {not in Vi}
6724 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006725 right of the cursor if 'nowrap' is set. Setting this option to a
6726 value greater than 0 while having |'sidescroll'| also at a non-zero
6727 value makes some context visible in the line you are scrolling in
6728 horizontally (except at beginning of the line). Setting this option
6729 to a large value (like 999) has the effect of keeping the cursor
6730 horizontally centered in the window, as long as one does not come too
6731 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 NOTE: This option is set to 0 when 'compatible' is set.
6733
6734 Example: Try this together with 'sidescroll' and 'listchars' as
6735 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006736 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006737
6738 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6739 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006740<
6741 *'signcolumn'* *'scl'*
6742'signcolumn' 'scl' string (default "auto")
6743 local to window
6744 {not in Vi}
6745 {not available when compiled without the |+signs|
6746 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006747 Whether or not to draw the signcolumn. Valid values are:
6748 "auto" only when there is a sign to display
6749 "no" never
6750 "yes" always
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751
6752
6753 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6754'smartcase' 'scs' boolean (default off)
6755 global
6756 {not in Vi}
6757 Override the 'ignorecase' option if the search pattern contains upper
6758 case characters. Only used when the search pattern is typed and
6759 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006760 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6762 recalling the search pattern from history and hitting <Enter>.
6763 NOTE: This option is reset when 'compatible' is set.
6764
6765 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6766'smartindent' 'si' boolean (default off)
6767 local to buffer
6768 {not in Vi}
6769 {not available when compiled without the
6770 |+smartindent| feature}
6771 Do smart autoindenting when starting a new line. Works for C-like
6772 programs, but can also be used for other languages. 'cindent' does
6773 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006774 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006775 setting 'si' has no effect. 'indentexpr' is a more advanced
6776 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 Normally 'autoindent' should also be on when using 'smartindent'.
6778 An indent is automatically inserted:
6779 - After a line ending in '{'.
6780 - After a line starting with a keyword from 'cinwords'.
6781 - Before a line starting with '}' (only with the "O" command).
6782 When typing '}' as the first character in a new line, that line is
6783 given the same indent as the matching '{'.
6784 When typing '#' as the first character in a new line, the indent for
6785 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006786 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6788 When using the ">>" command, lines starting with '#' are not shifted
6789 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006790 NOTE: 'smartindent' is reset when 'compatible' is set.
6791 This option is reset when 'paste' is set and restored when 'paste' is
6792 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793
6794 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6795'smarttab' 'sta' boolean (default off)
6796 global
6797 {not in Vi}
6798 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006799 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6800 <BS> will delete a 'shiftwidth' worth of space at the start of the
6801 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006802 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006803 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6804 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006805 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006807 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006808 This option is reset when 'paste' is set and restored when 'paste' is
6809 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 NOTE: This option is reset when 'compatible' is set.
6811
6812 *'softtabstop'* *'sts'*
6813'softtabstop' 'sts' number (default 0)
6814 local to buffer
6815 {not in Vi}
6816 Number of spaces that a <Tab> counts for while performing editing
6817 operations, like inserting a <Tab> or using <BS>. It "feels" like
6818 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6819 used. This is useful to keep the 'ts' setting at its standard value
6820 of 8, while being able to edit like it is set to 'sts'. However,
6821 commands like "x" still work on the actual characters.
6822 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006823 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006824 'softtabstop' is set to 0 when the 'paste' option is set and restored
6825 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6827 spaces is minimized by using <Tab>s.
6828 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6829 set.
6830 NOTE: This option is set to 0 when 'compatible' is set.
6831
Bram Moolenaar217ad922005-03-20 22:37:15 +00006832 *'spell'* *'nospell'*
6833'spell' boolean (default off)
6834 local to window
6835 {not in Vi}
6836 {not available when compiled without the |+syntax|
6837 feature}
6838 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006839 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006840
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006841 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006842'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006843 local to buffer
6844 {not in Vi}
6845 {not available when compiled without the |+syntax|
6846 feature}
6847 Pattern to locate the end of a sentence. The following word will be
6848 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006849 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006850 When this check is not wanted make this option empty.
6851 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006852 Be careful with special characters, see |option-backslash| about
6853 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006854 To set this option automatically depending on the language, see
6855 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006856
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006857 *'spellfile'* *'spf'*
6858'spellfile' 'spf' string (default empty)
6859 local to buffer
6860 {not in Vi}
6861 {not available when compiled without the |+syntax|
6862 feature}
6863 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006864 commands. It must end in ".{encoding}.add". You need to include the
6865 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006866 *E765*
6867 It may also be a comma separated list of names. A count before the
6868 |zg| and |zw| commands can be used to access each. This allows using
6869 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006870 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006871 you: Using the first directory in 'runtimepath' that is writable. If
6872 there is no "spell" directory yet it will be created. For the file
6873 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006874 ignoring the region.
6875 The resulting ".spl" file will be used for spell checking, it does not
6876 have to appear in 'spelllang'.
6877 Normally one file is used for all regions, but you can add the region
6878 name if you want to. However, it will then only be used when
6879 'spellfile' is set to it, for entries in 'spelllang' only files
6880 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006881 This option cannot be set from a |modeline| or in the |sandbox|, for
6882 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006883
Bram Moolenaar217ad922005-03-20 22:37:15 +00006884 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006885'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006886 local to buffer
6887 {not in Vi}
6888 {not available when compiled without the |+syntax|
6889 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006890 A comma separated list of word list names. When the 'spell' option is
6891 on spellchecking will be done for these languages. Example: >
6892 set spelllang=en_us,nl,medical
6893< This means US English, Dutch and medical words are recognized. Words
6894 that are not recognized will be highlighted.
6895 The word list name must not include a comma or dot. Using a dash is
6896 recommended to separate the two letter language name from a
6897 specification. Thus "en-rare" is used for rare English words.
6898 A region name must come last and have the form "_xx", where "xx" is
6899 the two-letter, lower case region name. You can use more than one
6900 region by listing them: "en_us,en_ca" supports both US and Canadian
6901 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006902 Britain. (Note: currently en_au and en_nz dictionaries are older than
6903 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006904 If the name "cjk" is included East Asian characters are excluded from
6905 spell checking. This is useful when editing text that also has Asian
6906 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006907 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006908 As a special case the name of a .spl file can be given as-is. The
6909 first "_xx" in the name is removed and used as the region name
6910 (_xx is an underscore, two letters and followed by a non-letter).
6911 This is mainly for testing purposes. You must make sure the correct
6912 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006913 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006914 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6915 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006916 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006917
Bram Moolenaar98692072006-02-04 00:57:42 +00006918 If the |spellfile.vim| plugin is active and you use a language name
6919 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6920 will ask you if you want to download the file.
6921
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006922 After this option has been set successfully, Vim will source the files
6923 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006924 up to the first comma, dot or underscore.
6925 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006926
6927
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006928 *'spellsuggest'* *'sps'*
6929'spellsuggest' 'sps' string (default "best")
6930 global
6931 {not in Vi}
6932 {not available when compiled without the |+syntax|
6933 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006934 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006935 the |spellsuggest()| function. This is a comma-separated list of
6936 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006937
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006938 best Internal method that works best for English. Finds
6939 changes like "fast" and uses a bit of sound-a-like
6940 scoring to improve the ordering.
6941
6942 double Internal method that uses two methods and mixes the
6943 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006944 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006945 word. That only works when the language specifies
6946 sound folding. Can be slow and doesn't always give
6947 better results.
6948
6949 fast Internal method that only checks for simple changes:
6950 character inserts/deletes/swaps. Works well for
6951 simple typing mistakes.
6952
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006953 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006954 Not used for |spellsuggest()|. The number of
6955 suggestions is never more than the value of 'lines'
6956 minus two.
6957
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006958 file:{filename} Read file {filename}, which must have two columns,
6959 separated by a slash. The first column contains the
6960 bad word, the second column the suggested good word.
6961 Example:
6962 theribal/terrible ~
6963 Use this for common mistakes that do not appear at the
6964 top of the suggestion list with the internal methods.
6965 Lines without a slash are ignored, use this for
6966 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006967 The word in the second column must be correct,
6968 otherwise it will not be used. Add the word to an
6969 ".add" file if it is currently flagged as a spelling
6970 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006971 The file is used for all languages.
6972
6973 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6974 trouble with spaces. |v:val| holds the badly spelled
6975 word. The expression must evaluate to a List of
6976 Lists, each with a suggestion and a score.
6977 Example:
6978 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006979 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006980 internal methods use. A lower score is better.
6981 This may invoke |spellsuggest()| if you temporarily
6982 set 'spellsuggest' to exclude the "expr:" part.
6983 Errors are silently ignored, unless you set the
6984 'verbose' option to a non-zero value.
6985
6986 Only one of "best", "double" or "fast" may be used. The others may
6987 appear several times in any order. Example: >
6988 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6989<
6990 This option cannot be set from a |modeline| or in the |sandbox|, for
6991 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006992
6993
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6995'splitbelow' 'sb' boolean (default off)
6996 global
6997 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006998 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 feature}
7000 When on, splitting a window will put the new window below the current
7001 one. |:split|
7002
7003 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7004'splitright' 'spr' boolean (default off)
7005 global
7006 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007007 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007008 feature}
7009 When on, splitting a window will put the new window right of the
7010 current one. |:vsplit|
7011
7012 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7013'startofline' 'sol' boolean (default on)
7014 global
7015 {not in Vi}
7016 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007017 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007018 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007019 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 with a linewise operator, with "%" with a count and to buffer changing
7021 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7022 only has a line number, e.g., ":25" or ":+".
7023 In case of buffer changing commands the cursor is placed at the column
7024 where it was the last time the buffer was edited.
7025 NOTE: This option is set when 'compatible' is set.
7026
Bram Moolenaar00654022011-02-25 14:42:19 +01007027 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007029 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 {not in Vi}
7031 {not available when compiled without the |+statusline|
7032 feature}
7033 When nonempty, this option determines the content of the status line.
7034 Also see |status-line|.
7035
7036 The option consists of printf style '%' items interspersed with
7037 normal text. Each status line item is of the form:
7038 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007039 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007040 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041
Bram Moolenaar238a5642006-02-21 22:12:05 +00007042 When the option starts with "%!" then it is used as an expression,
7043 evaluated and the result is used as the option value. Example: >
7044 :set statusline=%!MyStatusLine()
7045< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007046 Note that the "%!" expression is evaluated in the context of the
7047 current window and buffer, while %{} items are evaluated in the
7048 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007049
7050 When there is error while evaluating the option then it will be made
7051 empty to avoid further errors. Otherwise screen updating would loop.
7052
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 Note that the only effect of 'ruler' when this option is set (and
7054 'laststatus' is 2) is controlling the output of |CTRL-G|.
7055
7056 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007057 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007059 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 minwid Minimum width of the item, padding as set by '-' & '0'.
7061 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007062 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 on the left for text items. Numeric items will be
7064 shifted down to maxwid-2 digits followed by '>'number
7065 where number is the amount of missing digits, much like
7066 an exponential notation.
7067 item A one letter code as described below.
7068
7069 Following is a description of the possible statusline items. The
7070 second character in "item" is the type:
7071 N for number
7072 S for string
7073 F for flags as described below
7074 - not applicable
7075
7076 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007077 f S Path to the file in the buffer, as typed or relative to current
7078 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 F S Full path to the file in the buffer.
7080 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007081 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007083 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007085 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007087 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007089 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
7091 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007092 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7094 being used: "<keymap>"
7095 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007096 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 B N As above, in hexadecimal.
7098 o N Byte number in file of byte under cursor, first byte is 1.
7099 Mnemonic: Offset from start of file (with one added)
7100 {not available when compiled without |+byte_offset| feature}
7101 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007102 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 l N Line number.
7104 L N Number of lines in buffer.
7105 c N Column number.
7106 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007107 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 p N Percentage through file in lines as in |CTRL-G|.
7109 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007110 percentage described for 'ruler'. Always 3 in length, unless
7111 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007112 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007114 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00007115 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 ( - Start of item group. Can be used for setting the width and
7117 alignment of a section. Must be followed by %) somewhere.
7118 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007119 T N For 'tabline': start of tab page N label. Use %T after the last
7120 label. This information is used for mouse clicks.
7121 X N For 'tabline': start of close tab N label. Use %X after the
7122 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7123 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 < - Where to truncate line if too long. Default is at the start.
7125 No width fields allowed.
7126 = - Separation point between left and right aligned items.
7127 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007128 # - Set highlight group. The name must follow and then a # again.
7129 Thus use %#HLname# for highlight group HLname. The same
7130 highlighting is used, also for the statusline of non-current
7131 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007133 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007134 The difference between User{N} and StatusLine will be applied
7135 to StatusLineNC for the statusline of non-current windows.
7136 The number N must be between 1 and 9. See |hl-User1..9|
7137
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007138 When displaying a flag, Vim removes the leading comma, if any, when
7139 that flag comes right after plaintext. This will make a nice display
7140 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
Bram Moolenaar582fd852005-03-28 20:58:01 +00007142 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 not set) and a minwid is not set for the group, the whole group will
7144 become empty. This will make a group like the following disappear
7145 completely from the statusline when none of the flags are set. >
7146 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaare392eb42015-11-19 20:38:09 +01007147< *g:actual_curbuf*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 Beware that an expression is evaluated each and every time the status
7149 line is displayed. The current buffer and current window will be set
7150 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007151 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007153 real current buffer.
7154
Bram Moolenaar30b65812012-07-12 22:01:11 +02007155 The 'statusline' option will be evaluated in the |sandbox| if set from
7156 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007157
7158 It is not allowed to change text or jump to another window while
7159 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160
7161 If the statusline is not updated when you want it (e.g., after setting
7162 a variable that's used in an expression), you can force an update by
7163 setting an option without changing its value. Example: >
7164 :let &ro = &ro
7165
7166< A result of all digits is regarded a number for display purposes.
7167 Otherwise the result is taken as flag text and applied to the rules
7168 described above.
7169
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007170 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7172 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7173
7174 Examples:
7175 Emulate standard status line with 'ruler' set >
7176 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7177< Similar, but add ASCII value of char under the cursor (like "ga") >
7178 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7179< Display byte count and byte value, modified flag in red. >
7180 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7181 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7182< Display a ,GZ flag if a compressed file is loaded >
7183 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7184< In the |:autocmd|'s: >
7185 :let b:gzflag = 1
7186< And: >
7187 :unlet b:gzflag
7188< And define this function: >
7189 :function VarExists(var, val)
7190 : if exists(a:var) | return a:val | else | return '' | endif
7191 :endfunction
7192<
7193 *'suffixes'* *'su'*
7194'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7195 global
7196 {not in Vi}
7197 Files with these suffixes get a lower priority when multiple files
7198 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007199 suffixes. Spaces after the comma are ignored. A dot is also seen as
7200 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 separator, precede it with a backslash (see |option-backslash| about
7202 including spaces and backslashes).
7203 See 'wildignore' for completely ignoring files.
7204 The use of |:set+=| and |:set-=| is preferred when adding or removing
7205 suffixes from the list. This avoids problems when a future version
7206 uses another default.
7207
7208 *'suffixesadd'* *'sua'*
7209'suffixesadd' 'sua' string (default "")
7210 local to buffer
7211 {not in Vi}
7212 {not available when compiled without the
7213 |+file_in_path| feature}
7214 Comma separated list of suffixes, which are used when searching for a
7215 file for the "gf", "[I", etc. commands. Example: >
7216 :set suffixesadd=.java
7217<
7218 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7219'swapfile' 'swf' boolean (default on)
7220 local to buffer
7221 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007222 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 swapfile is not wanted for a specific buffer. For example, with
7224 confidential information that even root must not be able to access.
7225 Careful: All text will be in memory:
7226 - Don't use this for big files.
7227 - Recovery will be impossible!
7228 A swapfile will only be present when |'updatecount'| is non-zero and
7229 'swapfile' is set.
7230 When 'swapfile' is reset, the swap file for the current buffer is
7231 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7232 non-zero, a swap file is immediately created.
7233 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007234 If you want to open a new buffer without creating a swap file for it,
7235 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236
7237 This option is used together with 'bufhidden' and 'buftype' to
7238 specify special kinds of buffers. See |special-buffers|.
7239
7240 *'swapsync'* *'sws'*
7241'swapsync' 'sws' string (default "fsync")
7242 global
7243 {not in Vi}
7244 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007245 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 When this option is empty parts of the swap file may be in memory and
7247 not written to disk. When the system crashes you may lose more work.
7248 On Unix the system does a sync now and then without Vim asking for it,
7249 so the disadvantage of setting this option off is small. On some
7250 systems the swap file will not be written at all. For a unix system
7251 setting it to "sync" will use the sync() call instead of the default
7252 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007253 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254
7255 *'switchbuf'* *'swb'*
7256'switchbuf' 'swb' string (default "")
7257 global
7258 {not in Vi}
7259 This option controls the behavior when switching between buffers.
7260 Possible values (comma separated list):
7261 useopen If included, jump to the first open window that
7262 contains the specified buffer (if there is one).
7263 Otherwise: Do not examine other windows.
7264 This setting is checked with |quickfix| commands, when
7265 jumping to errors (":cc", ":cn", "cp", etc.). It is
7266 also used in all buffer related split commands, for
7267 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007268 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007269 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007271 a buffer for a |quickfix| command that display errors.
7272 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007273 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007274 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007275 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007277 *'synmaxcol'* *'smc'*
7278'synmaxcol' 'smc' number (default 3000)
7279 local to buffer
7280 {not in Vi}
7281 {not available when compiled without the |+syntax|
7282 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007283 Maximum column in which to search for syntax items. In long lines the
7284 text after this column is not highlighted and following lines may not
7285 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007286 This helps to avoid very slow redrawing for an XML file that is one
7287 long line.
7288 Set to zero to remove the limit.
7289
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 *'syntax'* *'syn'*
7291'syntax' 'syn' string (default empty)
7292 local to buffer
7293 {not in Vi}
7294 {not available when compiled without the |+syntax|
7295 feature}
7296 When this option is set, the syntax with this name is loaded, unless
7297 syntax highlighting has been switched off with ":syntax off".
7298 Otherwise this option does not always reflect the current syntax (the
7299 b:current_syntax variable does).
7300 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007301 not automatically recognized. Example, in an IDL file:
7302 /* vim: set syntax=idl : */ ~
7303 When a dot appears in the value then this separates two filetype
7304 names. Example:
7305 /* vim: set syntax=c.doxygen : */ ~
7306 This will use the "c" syntax first, then the "doxygen" syntax.
7307 Note that the second one must be prepared to be loaded as an addition,
7308 otherwise it will be skipped. More than one dot may appear.
7309 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 :set syntax=OFF
7311< To switch syntax highlighting on according to the current value of the
7312 'filetype' option: >
7313 :set syntax=ON
7314< What actually happens when setting the 'syntax' option is that the
7315 Syntax autocommand event is triggered with the value as argument.
7316 This option is not copied to another buffer, independent of the 's' or
7317 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007318 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007320 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007321'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007322 global
7323 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007324 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007325 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007326 When nonempty, this option determines the content of the tab pages
7327 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007328 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007329
7330 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007331 option and only when there is no GUI tab line. When 'e' is in
7332 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007333 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007334
7335 The value is evaluated like with 'statusline'. You can use
7336 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007337 the text to be displayed. Use "%1T" for the first label, "%2T" for
7338 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007339
7340 Keep in mind that only one of the tab pages is the current one, others
7341 are invisible and you can't jump to their windows.
7342
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007343
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007344 *'tabpagemax'* *'tpm'*
7345'tabpagemax' 'tpm' number (default 10)
7346 global
7347 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007348 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007349 feature}
7350 Maximum number of tab pages to be opened by the |-p| command line
7351 argument or the ":tab all" command. |tabpage|
7352
7353
7354 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007355'tabstop' 'ts' number (default 8)
7356 local to buffer
7357 Number of spaces that a <Tab> in the file counts for. Also see
7358 |:retab| command, and 'softtabstop' option.
7359
7360 Note: Setting 'tabstop' to any other value than 8 can make your file
7361 appear wrong in many places (e.g., when printing it).
7362
7363 There are four main ways to use tabs in Vim:
7364 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7365 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007366 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 behave like a tab appears every 4 (or 3) characters.
7368 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7369 'expandtab'. This way you will always insert spaces. The
7370 formatting will never be messed up when 'tabstop' is changed.
7371 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007372 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007373 works when using Vim to edit the file.
7374 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7375 'noexpandtab'. This should then work (for initial indents only)
7376 for any tabstop setting that people use. It might be nice to have
7377 tabs after the first non-blank inserted as spaces if you do this
7378 though. Otherwise aligned comments will be wrong when 'tabstop' is
7379 changed.
7380
7381 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7382'tagbsearch' 'tbs' boolean (default on)
7383 global
7384 {not in Vi}
7385 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 searching makes searching for a tag a LOT faster, but a linear search
7388 will find more tags if the tags file wasn't properly sorted.
7389 Vim normally assumes that your tags files are sorted, or indicate that
7390 they are not sorted. Only when this is not the case does the
7391 'tagbsearch' option need to be switched off.
7392
7393 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 certain files, or retry all files with a linear search. When
7396 'tagbsearch' is off, only a linear search is done.
7397
7398 Linear searching is done anyway, for one file, when Vim finds a line
7399 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007400 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401< [The whitespace before and after the '0' must be a single <Tab>]
7402
7403 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007404 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405 instead of a normal tag name, a retry is done with a linear search.
7406 Tags in unsorted tags files, and matches with different case will only
7407 be found in the retry.
7408
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007409 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007410 linear search can be avoided when case is ignored. Use a value of '2'
7411 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7412 sorted with the -f switch to "sort" in most unices, as in the command:
7413 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7414 (at least 5.5) the --sort=foldcase switch can be used for this as
7415 well. Note that case must be folded to uppercase for this to work.
7416
7417 By default, tag searches are case-sensitive. Case is ignored when
7418 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7419 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007420 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7421 'tagcase' is "smart", and the pattern contains only lowercase
7422 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423
7424 When 'tagbsearch' is off, tags searching is slower when a full match
7425 exists, but faster when no full match exists. Tags in unsorted tags
7426 files may only be found with 'tagbsearch' off.
7427 When the tags file is not sorted, or sorted in a wrong way (not on
7428 ASCII byte value), 'tagbsearch' should be off, or the line given above
7429 must be included in the tags file.
7430 This option doesn't affect commands that find all matching tags (e.g.,
7431 command-line completion and ":help").
7432 {Vi: always uses binary search in some versions}
7433
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007434 *'tagcase'* *'tc'*
7435'tagcase' 'tc' string (default "followic")
7436 global or local to buffer |global-local|
7437 {not in Vi}
7438 This option specifies how case is handled when searching the tags
7439 file:
7440 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007441 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007442 ignore Ignore case
7443 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007444 smart Ignore case unless an upper case letter is used
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007445
Bram Moolenaar071d4272004-06-13 20:20:40 +00007446 *'taglength'* *'tl'*
7447'taglength' 'tl' number (default 0)
7448 global
7449 If non-zero, tags are significant up to this number of characters.
7450
7451 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7452'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7453 global
7454 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007455 If on and using a tags file in another directory, file names in that
7456 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 NOTE: This option is set to the Vi default value when 'compatible' is
7458 set and to the Vim default value when 'compatible' is reset.
7459
7460 *'tags'* *'tag'* *E433*
7461'tags' 'tag' string (default "./tags,tags", when compiled with
7462 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7463 global or local to buffer |global-local|
7464 Filenames for the tag command, separated by spaces or commas. To
7465 include a space or comma in a file name, precede it with a backslash
7466 (see |option-backslash| about including spaces and backslashes).
7467 When a file name starts with "./", the '.' is replaced with the path
7468 of the current file. But only when the 'd' flag is not included in
7469 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7470 |tags-option|.
7471 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007472 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7473 find all files named "tags" below "/lib". The filename itself cannot
7474 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7475 files called "tags?". {not available when compiled without the
7476 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007477 The |tagfiles()| function can be used to get a list of the file names
7478 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7480 files are also supported. They are automatically recognized. The
7481 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7482 differences are ignored (MS-Windows). |emacs-tags|
7483 The use of |:set+=| and |:set-=| is preferred when adding or removing
7484 file names from the list. This avoids problems when a future version
7485 uses another default.
7486 {Vi: default is "tags /usr/lib/tags"}
7487
7488 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7489'tagstack' 'tgst' boolean (default on)
7490 global
7491 {not in all versions of Vi}
7492 When on, the |tagstack| is used normally. When off, a ":tag" or
7493 ":tselect" command with an argument will not push the tag onto the
7494 tagstack. A following ":tag" without an argument, a ":pop" command or
7495 any other command that uses the tagstack will use the unmodified
7496 tagstack, but does change the pointer to the active entry.
7497 Resetting this option is useful when using a ":tag" command in a
7498 mapping which should not change the tagstack.
7499
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007500 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007501'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007502 global
7503 {not in Vi}
7504 {only available when compiled with the |+tcl/dyn|
7505 feature}
7506 Specifies the name of the Tcl shared library. The default is
7507 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007508 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007509 This option cannot be set from a |modeline| or in the |sandbox|, for
7510 security reasons.
7511
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 *'term'* *E529* *E530* *E531*
7513'term' string (default is $TERM, if that fails:
7514 in the GUI: "builtin_gui"
7515 on Amiga: "amiga"
7516 on BeOS: "beos-ansi"
7517 on Mac: "mac-ansi"
7518 on MiNT: "vt52"
7519 on MS-DOS: "pcterm"
7520 on OS/2: "os2ansi"
7521 on Unix: "ansi"
7522 on VMS: "ansi"
7523 on Win 32: "win32")
7524 global
7525 Name of the terminal. Used for choosing the terminal control
7526 characters. Environment variables are expanded |:set_env|.
7527 For example: >
7528 :set term=$TERM
7529< See |termcap|.
7530
7531 *'termbidi'* *'tbidi'*
7532 *'notermbidi'* *'notbidi'*
7533'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7534 global
7535 {not in Vi}
7536 {only available when compiled with the |+arabic|
7537 feature}
7538 The terminal is in charge of Bi-directionality of text (as specified
7539 by Unicode). The terminal is also expected to do the required shaping
7540 that some languages (such as Arabic) require.
7541 Setting this option implies that 'rightleft' will not be set when
7542 'arabic' is set and the value of 'arabicshape' will be ignored.
7543 Note that setting 'termbidi' has the immediate effect that
7544 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7545 This option is reset when the GUI is started.
7546 For further details see |arabic.txt|.
7547
7548 *'termencoding'* *'tenc'*
7549'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7550 Macintosh GUI: "macroman")
7551 global
7552 {only available when compiled with the |+multi_byte|
7553 feature}
7554 {not in Vi}
7555 Encoding used for the terminal. This specifies what character
7556 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007557 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007558 display). Except for the Mac when 'macatsui' is off, then
7559 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 *E617*
7561 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7562 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7563 Any attempts to set a different value will be rejected, and an error
7564 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007565 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 because the Win32 system always passes Unicode characters.
7567 When empty, the same encoding is used as for the 'encoding' option.
7568 This is the normal value.
7569 Not all combinations for 'termencoding' and 'encoding' are valid. See
7570 |encoding-table|.
7571 The value for this option must be supported by internal conversions or
7572 iconv(). When this is not possible no conversion will be done and you
7573 will probably experience problems with non-ASCII characters.
7574 Example: You are working with the locale set to euc-jp (Japanese) and
7575 want to edit a UTF-8 file: >
7576 :let &termencoding = &encoding
7577 :set encoding=utf-8
7578< You need to do this when your system has no locale support for UTF-8.
7579
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007580 *'termguicolors'* *'tgc'*
7581'termguicolors' 'tgc' boolean (default off)
7582 global
7583 {not in Vi}
7584 {not available when compiled without the
7585 |+termguicolors| feature}
7586 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
7587 the terminal (thus using 24-bit color). Requires a ISO-8613-3
7588 compatible terminal.
7589 If setting this option does not work (produces a colorless UI)
7590 reading |xterm-true-color| might help.
7591
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 *'terse'* *'noterse'*
7593'terse' boolean (default off)
7594 global
7595 When set: Add 's' flag to 'shortmess' option (this makes the message
7596 for a search that hits the start or end of the file not being
7597 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7598 shortens a lot of messages}
7599
7600 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7601'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7602 global
7603 {not in Vi}
7604 This option is obsolete. Use 'fileformats'.
7605 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7606 set to the default value for the current system. When 'textauto' is
7607 reset, 'fileformats' is made empty.
7608 NOTE: This option is set to the Vi default value when 'compatible' is
7609 set and to the Vim default value when 'compatible' is reset.
7610
7611 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7612'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7613 others: default off)
7614 local to buffer
7615 {not in Vi}
7616 This option is obsolete. Use 'fileformat'.
7617 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7618 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7619 "unix".
7620
7621 *'textwidth'* *'tw'*
7622'textwidth' 'tw' number (default 0)
7623 local to buffer
7624 {not in Vi}
7625 Maximum width of text that is being inserted. A longer line will be
7626 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007627 this.
7628 'textwidth' is set to 0 when the 'paste' option is set and restored
7629 when 'paste' is reset.
7630 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007632 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 NOTE: This option is set to 0 when 'compatible' is set.
7634
7635 *'thesaurus'* *'tsr'*
7636'thesaurus' 'tsr' string (default "")
7637 global or local to buffer |global-local|
7638 {not in Vi}
7639 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007640 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 the file should contain words with similar meaning, separated by
7642 non-keyword characters (white space is preferred). Maximum line
7643 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007644 To obtain a file to be used here, check out this ftp site:
Bram Moolenaar38a55632016-02-15 22:07:32 +01007645 [Sorry this link doesn't work anymore, do you know the right one?]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007646 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007647 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 after a comma are ignored, otherwise spaces are included in the file
7649 name. See |option-backslash| about using backslashes.
7650 The use of |:set+=| and |:set-=| is preferred when adding or removing
7651 directories from the list. This avoids problems when a future version
7652 uses another default.
7653 Backticks cannot be used in this option for security reasons.
7654
7655 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7656'tildeop' 'top' boolean (default off)
7657 global
7658 {not in Vi}
7659 When on: The tilde command "~" behaves like an operator.
7660 NOTE: This option is reset when 'compatible' is set.
7661
7662 *'timeout'* *'to'* *'notimeout'* *'noto'*
7663'timeout' 'to' boolean (default on)
7664 global
7665 *'ttimeout'* *'nottimeout'*
7666'ttimeout' boolean (default off)
7667 global
7668 {not in Vi}
7669 These two options together determine the behavior when part of a
7670 mapped key sequence or keyboard code has been received:
7671
7672 'timeout' 'ttimeout' action ~
7673 off off do not time out
7674 on on or off time out on :mappings and key codes
7675 off on time out on key codes
7676
7677 If both options are off, Vim will wait until either the complete
7678 mapping or key sequence has been received, or it is clear that there
7679 is no mapping or key sequence for the received characters. For
7680 example: if you have mapped "vl" and Vim has received 'v', the next
7681 character is needed to see if the 'v' is followed by an 'l'.
7682 When one of the options is on, Vim will wait for about 1 second for
7683 the next character to arrive. After that the already received
7684 characters are interpreted as single characters. The waiting time can
7685 be changed with the 'timeoutlen' option.
7686 On slow terminals or very busy systems timing out may cause
7687 malfunctioning cursor keys. If both options are off, Vim waits
7688 forever after an entered <Esc> if there are key codes that start
7689 with <Esc>. You will have to type <Esc> twice. If you do not have
7690 problems with key codes, but would like to have :mapped key
7691 sequences not timing out in 1 second, set the 'ttimeout' option and
7692 reset the 'timeout' option.
7693
7694 NOTE: 'ttimeout' is reset when 'compatible' is set.
7695
7696 *'timeoutlen'* *'tm'*
7697'timeoutlen' 'tm' number (default 1000)
7698 global
7699 {not in all versions of Vi}
7700 *'ttimeoutlen'* *'ttm'*
7701'ttimeoutlen' 'ttm' number (default -1)
7702 global
7703 {not in Vi}
7704 The time in milliseconds that is waited for a key code or mapped key
7705 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7706 when part of a command has been typed.
7707 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7708 different timeout value for key codes is desired set 'ttimeoutlen' to
7709 a non-negative number.
7710
7711 ttimeoutlen mapping delay key code delay ~
7712 < 0 'timeoutlen' 'timeoutlen'
7713 >= 0 'timeoutlen' 'ttimeoutlen'
7714
7715 The timeout only happens when the 'timeout' and 'ttimeout' options
7716 tell so. A useful setting would be >
7717 :set timeout timeoutlen=3000 ttimeoutlen=100
7718< (time out on mapping after three seconds, time out on key codes after
7719 a tenth of a second).
7720
7721 *'title'* *'notitle'*
7722'title' boolean (default off, on when title can be restored)
7723 global
7724 {not in Vi}
7725 {not available when compiled without the |+title|
7726 feature}
7727 When on, the title of the window will be set to the value of
7728 'titlestring' (if it is not empty), or to:
7729 filename [+=-] (path) - VIM
7730 Where:
7731 filename the name of the file being edited
7732 - indicates the file cannot be modified, 'ma' off
7733 + indicates the file was modified
7734 = indicates the file is read-only
7735 =+ indicates the file is read-only and modified
7736 (path) is the path of the file being edited
7737 - VIM the server name |v:servername| or "VIM"
7738 Only works if the terminal supports setting window titles
7739 (currently Amiga console, Win32 console, all GUI versions and
7740 terminals with a non- empty 't_ts' option - these are Unix xterm and
7741 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7742 *X11*
7743 When Vim was compiled with HAVE_X11 defined, the original title will
7744 be restored if possible. The output of ":version" will include "+X11"
7745 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7746 works for the icon name |'icon'|.
7747 But: When Vim was started with the |-X| argument, restoring the title
7748 will not work (except in the GUI).
7749 If the title cannot be restored, it is set to the value of 'titleold'.
7750 You might want to restore the title outside of Vim then.
7751 When using an xterm from a remote machine you can use this command:
7752 rsh machine_name xterm -display $DISPLAY &
7753 then the WINDOWID environment variable should be inherited and the
7754 title of the window should change back to what it should be after
7755 exiting Vim.
7756
7757 *'titlelen'*
7758'titlelen' number (default 85)
7759 global
7760 {not in Vi}
7761 {not available when compiled without the |+title|
7762 feature}
7763 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007764 title. When the title is longer, only the end of the path name is
7765 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007766 Using a percentage makes this adapt to the width of the window. But
7767 it won't work perfectly, because the actual number of characters
7768 available also depends on the font used and other things in the title
7769 bar. When 'titlelen' is zero the full path is used. Otherwise,
7770 values from 1 to 30000 percent can be used.
7771 'titlelen' is also used for the 'titlestring' option.
7772
7773 *'titleold'*
7774'titleold' string (default "Thanks for flying Vim")
7775 global
7776 {not in Vi}
7777 {only available when compiled with the |+title|
7778 feature}
7779 This option will be used for the window title when exiting Vim if the
7780 original title cannot be restored. Only happens if 'title' is on or
7781 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007782 This option cannot be set from a |modeline| or in the |sandbox|, for
7783 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 *'titlestring'*
7785'titlestring' string (default "")
7786 global
7787 {not in Vi}
7788 {not available when compiled without the |+title|
7789 feature}
7790 When this option is not empty, it will be used for the title of the
7791 window. This happens only when the 'title' option is on.
7792 Only works if the terminal supports setting window titles (currently
7793 Amiga console, Win32 console, all GUI versions and terminals with a
7794 non-empty 't_ts' option).
7795 When Vim was compiled with HAVE_X11 defined, the original title will
7796 be restored if possible |X11|.
7797 When this option contains printf-style '%' items, they will be
7798 expanded according to the rules used for 'statusline'.
7799 Example: >
7800 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7801 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7802< The value of 'titlelen' is used to align items in the middle or right
7803 of the available space.
7804 Some people prefer to have the file name first: >
7805 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7806< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007807 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 separating space only when needed.
7809 NOTE: Use of special characters in 'titlestring' may cause the display
7810 to be garbled (e.g., when it contains a CR or NL character).
7811 {not available when compiled without the |+statusline| feature}
7812
7813 *'toolbar'* *'tb'*
7814'toolbar' 'tb' string (default "icons,tooltips")
7815 global
7816 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7817 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007818 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 possible values are:
7820 icons Toolbar buttons are shown with icons.
7821 text Toolbar buttons shown with text.
7822 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007823 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 tooltips Tooltips are active for toolbar buttons.
7825 Tooltips refer to the popup help text which appears after the mouse
7826 cursor is placed over a toolbar button for a brief moment.
7827
7828 If you want the toolbar to be shown with icons as well as text, do the
7829 following: >
7830 :set tb=icons,text
7831< Motif and Athena cannot display icons and text at the same time. They
7832 will show icons if both are requested.
7833
7834 If none of the strings specified in 'toolbar' are valid or if
7835 'toolbar' is empty, this option is ignored. If you want to disable
7836 the toolbar, you need to set the 'guioptions' option. For example: >
7837 :set guioptions-=T
7838< Also see |gui-toolbar|.
7839
7840 *'toolbariconsize'* *'tbis'*
7841'toolbariconsize' 'tbis' string (default "small")
7842 global
7843 {not in Vi}
7844 {only in the GTK+ 2 GUI}
7845 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007846 tiny Use tiny icons.
7847 small Use small icons (default).
7848 medium Use medium-sized icons.
7849 large Use large icons.
7850 huge Use even larger icons.
7851 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01007853 the current theme. Common dimensions are giant=48x48, huge=32x32,
7854 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855
7856 If 'toolbariconsize' is empty, the global default size as determined
7857 by user preferences or the current theme is used.
7858
7859 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7860'ttybuiltin' 'tbi' boolean (default on)
7861 global
7862 {not in Vi}
7863 When on, the builtin termcaps are searched before the external ones.
7864 When off the builtin termcaps are searched after the external ones.
7865 When this option is changed, you should set the 'term' option next for
7866 the change to take effect, for example: >
7867 :set notbi term=$TERM
7868< See also |termcap|.
7869 Rationale: The default for this option is "on", because the builtin
7870 termcap entries are generally better (many systems contain faulty
7871 xterm entries...).
7872
7873 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7874'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7875 sun-cmd, screen, rxvt, dtterm or
7876 iris-ansi; also on when running Vim in
7877 a DOS console)
7878 global
7879 {not in Vi}
7880 Indicates a fast terminal connection. More characters will be sent to
7881 the screen for redrawing, instead of using insert/delete line
7882 commands. Improves smoothness of redrawing when there are multiple
7883 windows and the terminal does not support a scrolling region.
7884 Also enables the extra writing of characters at the end of each screen
7885 line for lines that wrap. This helps when using copy/paste with the
7886 mouse in an xterm and other terminals.
7887
7888 *'ttymouse'* *'ttym'*
7889'ttymouse' 'ttym' string (default depends on 'term')
7890 global
7891 {not in Vi}
7892 {only in Unix and VMS, doesn't work in the GUI; not
7893 available when compiled without |+mouse|}
7894 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007895 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896 *xterm-mouse*
7897 xterm xterm-like mouse handling. The mouse generates
7898 "<Esc>[Mscr", where "scr" is three bytes:
7899 "s" = button state
7900 "c" = column plus 33
7901 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007902 This only works up to 223 columns! See "dec",
7903 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 xterm2 Works like "xterm", but with the xterm reporting the
7905 mouse position while the mouse is dragged. This works
7906 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007907 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 work. See below for how Vim detects this
7909 automatically.
7910 *netterm-mouse*
7911 netterm NetTerm mouse handling. The mouse generates
7912 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7913 for the row and column.
7914 *dec-mouse*
7915 dec DEC terminal mouse handling. The mouse generates a
7916 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007917 This is also available for an Xterm, if it was
7918 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 *jsbterm-mouse*
7920 jsbterm JSB term mouse handling.
7921 *pterm-mouse*
7922 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007923 *urxvt-mouse*
7924 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007925 The mouse works only if the terminal supports this
7926 encoding style, but it does not have 223 columns limit
7927 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007928 *sgr-mouse*
7929 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007930 mouse reporting. The mouse works even in columns
7931 beyond 223. This option is backward compatible with
7932 "xterm2" because it can also decode "xterm2" style
7933 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934
7935 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007936 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7937 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7939 recognized, if enabled at compile time. DEC terminal mouse codes
7940 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007941 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7942 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar58b85342016-08-14 19:54:54 +02007944 set to a name that starts with "xterm", "mlterm", "screen", "st" (full
7945 match only), "st-" or "stterm", and 'ttymouse' is not set already.
Bram Moolenaare968e362014-05-13 20:23:24 +02007946 Additionally, if vim is compiled with the |+termresponse| feature and
7947 |t_RV| is set to the escape sequence to request the xterm version
7948 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007950 from 95 to 276. The "sgr" value will be set if the xterm version is
7951 277 or highter.
7952 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7953 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 :set t_RV=
7955<
7956 *'ttyscroll'* *'tsl'*
7957'ttyscroll' 'tsl' number (default 999)
7958 global
7959 Maximum number of lines to scroll the screen. If there are more lines
7960 to scroll the window is redrawn. For terminals where scrolling is
7961 very slow and redrawing is not slow this can be set to a small number,
7962 e.g., 3, to speed up displaying.
7963
7964 *'ttytype'* *'tty'*
7965'ttytype' 'tty' string (default from $TERM)
7966 global
7967 Alias for 'term', see above.
7968
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007969 *'undodir'* *'udir'*
7970'undodir' 'udir' string (default ".")
7971 global
7972 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007973 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007974 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007975 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007976 "." means using the directory of the file. The undo file name for
7977 "file.txt" is ".file.txt.un~".
7978 For other directories the file name is the full path of the edited
7979 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007980 When writing: The first directory that exists is used. "." always
7981 works, no directories after "." will be used for writing.
7982 When reading all entries are tried to find an undo file. The first
7983 undo file that exists is used. When it cannot be read an error is
7984 given, no further entry is used.
7985 See |undo-persistence|.
7986
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007987 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007988'undofile' 'udf' boolean (default off)
7989 local to buffer
7990 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007991 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007992 When on, Vim automatically saves undo history to an undo file when
7993 writing a buffer to a file, and restores undo history from the same
7994 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007995 The directory where the undo file is stored is specified by 'undodir'.
7996 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007997 The undo file is not read when 'undoreload' causes the buffer from
7998 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007999 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008000
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 *'undolevels'* *'ul'*
8002'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8003 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008004 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008005 {not in Vi}
8006 Maximum number of changes that can be undone. Since undo information
8007 is kept in memory, higher numbers will cause more memory to be used
8008 (nevertheless, a single change can use an unlimited amount of memory).
8009 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8010 itself: >
8011 set ul=0
8012< But you can also get Vi compatibility by including the 'u' flag in
8013 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008014 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008015 Set to -1 for no undo at all. You might want to do this only for the
8016 current buffer: >
8017 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008019
8020 The local value is set to -123456 when the global value is to be used.
8021
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008022 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008024 *'undoreload'* *'ur'*
8025'undoreload' 'ur' number (default 10000)
8026 global
8027 {not in Vi}
8028 Save the whole buffer for undo when reloading it. This applies to the
8029 ":e!" command and reloading for when the buffer changed outside of
8030 Vim. |FileChangedShell|
8031 The save only happens when this options is negative or when the number
8032 of lines is smaller than the value of this option.
8033 Set this option to zero to disable undo for a reload.
8034
8035 When saving undo for a reload, any undo file is not read.
8036
8037 Note that this causes the whole buffer to be stored in memory. Set
8038 this option to a lower value if you run out of memory.
8039
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 *'updatecount'* *'uc'*
8041'updatecount' 'uc' number (default: 200)
8042 global
8043 {not in Vi}
8044 After typing this many characters the swap file will be written to
8045 disk. When zero, no swap file will be created at all (see chapter on
8046 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8047 Vim with the "-n" option, see |startup|. When editing in readonly
8048 mode this option will be initialized to 10000.
8049 The swapfile can be disabled per buffer with |'swapfile'|.
8050 When 'updatecount' is set from zero to non-zero, swap files are
8051 created for all buffers that have 'swapfile' set. When 'updatecount'
8052 is set to zero, existing swap files are not deleted.
8053 Also see |'swapsync'|.
8054 This option has no meaning in buffers where |'buftype'| is "nofile"
8055 or "nowrite".
8056
8057 *'updatetime'* *'ut'*
8058'updatetime' 'ut' number (default 4000)
8059 global
8060 {not in Vi}
8061 If this many milliseconds nothing is typed the swap file will be
8062 written to disk (see |crash-recovery|). Also used for the
8063 |CursorHold| autocommand event.
8064
8065 *'verbose'* *'vbs'*
8066'verbose' 'vbs' number (default 0)
8067 global
8068 {not in Vi, although some versions have a boolean
8069 verbose option}
8070 When bigger than zero, Vim will give messages about what it is doing.
8071 Currently, these messages are given:
8072 >= 1 When the viminfo file is read or written.
8073 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008074 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008075 >= 8 Files for which a group of autocommands is executed.
8076 >= 9 Every executed autocommand.
8077 >= 12 Every executed function.
8078 >= 13 When an exception is thrown, caught, finished, or discarded.
8079 >= 14 Anything pending in a ":finally" clause.
8080 >= 15 Every executed Ex command (truncated at 200 characters).
8081
8082 This option can also be set with the "-V" argument. See |-V|.
8083 This option is also set by the |:verbose| command.
8084
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008085 When the 'verbosefile' option is set then the verbose messages are not
8086 displayed.
8087
8088 *'verbosefile'* *'vfile'*
8089'verbosefile' 'vfile' string (default empty)
8090 global
8091 {not in Vi}
8092 When not empty all messages are written in a file with this name.
8093 When the file exists messages are appended.
8094 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008095 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008096 Setting 'verbosefile' to a new value is like making it empty first.
8097 The difference with |:redir| is that verbose messages are not
8098 displayed when 'verbosefile' is set.
8099
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 *'viewdir'* *'vdir'*
8101'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8102 "$VIM/vimfiles/view",
8103 for Unix: "~/.vim/view",
8104 for Macintosh: "$VIM:vimfiles:view"
8105 for VMS: "sys$login:vimfiles/view"
8106 for RiscOS: "Choices:vimfiles/view")
8107 global
8108 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008109 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 feature}
8111 Name of the directory where to store files for |:mkview|.
8112 This option cannot be set from a |modeline| or in the |sandbox|, for
8113 security reasons.
8114
8115 *'viewoptions'* *'vop'*
8116'viewoptions' 'vop' string (default: "folds,options,cursor")
8117 global
8118 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008119 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 feature}
8121 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008122 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 word save and restore ~
8124 cursor cursor position in file and in window
8125 folds manually created folds, opened/closed folds and local
8126 fold options
8127 options options and mappings local to a window or buffer (not
8128 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008129 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 slash backslashes in file names replaced with forward
8131 slashes
8132 unix with Unix end-of-line format (single <NL>), even when
8133 on Windows or DOS
8134
8135 "slash" and "unix" are useful on Windows when sharing view files
8136 with Unix. The Unix version of Vim cannot source dos format scripts,
8137 but the Windows version of Vim can source unix format scripts.
8138
8139 *'viminfo'* *'vi'* *E526* *E527* *E528*
8140'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008141 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8142 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8143 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 global
8145 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008146 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 feature}
8148 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008149 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 separated list of parameters, each consisting of a single character
8151 identifying the particular parameter, followed by a number or string
8152 which specifies the value of that parameter. If a particular
8153 character is left out, then the default value is used for that
8154 parameter. The following is a list of the identifying characters and
8155 the effect of their value.
8156 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008157 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 ! When included, save and restore global variables that start
8159 with an uppercase letter, and don't contain a lowercase
8160 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008161 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008162 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008163 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 " Maximum number of lines saved for each register. Old name of
8165 the '<' item, with the disadvantage that you need to put a
8166 backslash before the ", otherwise it will be recognized as the
8167 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008168 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 % When included, save and restore the buffer list. If Vim is
8170 started with a file name argument, the buffer list is not
8171 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008172 buffer list is restored from the viminfo file. Quickfix
8173 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8174 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008175 When followed by a number, the number specifies the maximum
8176 number of buffers that are stored. Without a number all
8177 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008178 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 ' Maximum number of previously edited files for which the marks
8180 are remembered. This parameter must always be included when
8181 'viminfo' is non-empty.
8182 Including this item also means that the |jumplist| and the
8183 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008184 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008185 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008186 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 patterns are also saved. When not included, the value of
8188 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008189 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008191 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008192 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 < Maximum number of lines saved for each register. If zero then
8194 registers are not saved. When not included, all lines are
8195 saved. '"' is the old name for this item.
8196 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008197 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008199 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008200 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008201 c When included, convert the text in the viminfo file from the
8202 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008203 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008204 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008205 f Whether file marks need to be stored. If zero, file marks ('0
8206 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008207 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008209 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210 h Disable the effect of 'hlsearch' when loading the viminfo
8211 file. When not included, it depends on whether ":nohlsearch"
8212 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008213 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 n Name of the viminfo file. The name must immediately follow
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008215 the 'n'. Must be at the end of the option! If the "-i"
8216 argument was given when starting Vim, that file name overrides
8217 the one given here with 'viminfo'. Environment variables are
8218 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008219 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 r Removable media. The argument is a string (up to the next
8221 ','). This parameter can be given several times. Each
8222 specifies the start of a path for which no marks will be
8223 stored. This is to avoid removable media. For MS-DOS you
8224 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8225 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8226 ignored. Maximum length of each 'r' argument is 50
8227 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008228 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229 s Maximum size of an item in Kbyte. If zero then registers are
8230 not saved. Currently only applies to registers. The default
8231 "s10" will exclude registers with more than 10 Kbyte of text.
8232 Also see the '<' item above: line count limit.
8233
8234 Example: >
8235 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8236<
8237 '50 Marks will be remembered for the last 50 files you
8238 edited.
8239 <1000 Contents of registers (up to 1000 lines each) will be
8240 remembered.
8241 s100 Registers with more than 100 Kbyte text are skipped.
8242 :0 Command-line history will not be saved.
8243 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8244 no / Since '/' is not specified, the default will be used,
8245 that is, save all of the search history, and also the
8246 previous search and substitute patterns.
8247 no % The buffer list will not be saved nor read back.
8248 no h 'hlsearch' highlighting will be restored.
8249
8250 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8251 load the contents of the file, this is not done automatically.
8252
8253 This option cannot be set from a |modeline| or in the |sandbox|, for
8254 security reasons.
8255
8256 *'virtualedit'* *'ve'*
8257'virtualedit' 've' string (default "")
8258 global
8259 {not in Vi}
8260 {not available when compiled without the
8261 |+virtualedit| feature}
8262 A comma separated list of these words:
8263 block Allow virtual editing in Visual block mode.
8264 insert Allow virtual editing in Insert mode.
8265 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008266 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008267
Bram Moolenaar071d4272004-06-13 20:20:40 +00008268 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008269 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008270 of the line. Useful for selecting a rectangle in Visual mode and
8271 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008272 "onemore" is not the same, it will only allow moving the cursor just
8273 after the last character of the line. This makes some commands more
8274 consistent. Previously the cursor was always past the end of the line
8275 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008276 break some plugins or Vim scripts. For example because |l| can move
8277 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008278 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008279 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008280 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008281 It doesn't make sense to combine "all" with "onemore", but you will
8282 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283
8284 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8285'visualbell' 'vb' boolean (default off)
8286 global
8287 {not in Vi}
8288 Use visual bell instead of beeping. The terminal code to display the
8289 visual bell is given with 't_vb'. When no beep or flash is wanted,
8290 use ":set vb t_vb=".
8291 Note: When the GUI starts, 't_vb' is reset to its default value. You
8292 might want to set it again in your |gvimrc|.
8293 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8294 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8295 where 40 is the time in msec.
8296 Does not work on the Amiga, you always get a screen flash.
8297 Also see 'errorbells'.
8298
8299 *'warn'* *'nowarn'*
8300'warn' boolean (default on)
8301 global
8302 Give a warning message when a shell command is used while the buffer
8303 has been changed.
8304
8305 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8306'weirdinvert' 'wiv' boolean (default off)
8307 global
8308 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008309 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 It is provided for backwards compatibility with version 4.x.
8311 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8312 vice versa. Has no effect when the GUI is running.
8313
8314 *'whichwrap'* *'ww'*
8315'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8316 global
8317 {not in Vi}
8318 Allow specified keys that move the cursor left/right to move to the
8319 previous/next line when the cursor is on the first/last character in
8320 the line. Concatenate characters to allow this for these keys:
8321 char key mode ~
8322 b <BS> Normal and Visual
8323 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008324 h "h" Normal and Visual (not recommended)
8325 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008326 < <Left> Normal and Visual
8327 > <Right> Normal and Visual
8328 ~ "~" Normal
8329 [ <Left> Insert and Replace
8330 ] <Right> Insert and Replace
8331 For example: >
8332 :set ww=<,>,[,]
8333< allows wrap only when cursor keys are used.
8334 When the movement keys are used in combination with a delete or change
8335 operator, the <EOL> also counts for a character. This makes "3h"
8336 different from "3dh" when the cursor crosses the end of a line. This
8337 is also true for "x" and "X", because they do the same as "dl" and
8338 "dh". If you use this, you may also want to use the mapping
8339 ":map <BS> X" to make backspace delete the character in front of the
8340 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008341 When 'l' is included and it is used after an operator at the end of a
8342 line then it will not move to the next line. This makes "dl", "cl",
8343 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008344 NOTE: This option is set to the Vi default value when 'compatible' is
8345 set and to the Vim default value when 'compatible' is reset.
8346
8347 *'wildchar'* *'wc'*
8348'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8349 global
8350 {not in Vi}
8351 Character you have to type to start wildcard expansion in the
8352 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008353 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 The character is not recognized when used inside a macro. See
8355 'wildcharm' for that.
8356 Although 'wc' is a number option, you can set it to a special key: >
8357 :set wc=<Esc>
8358< NOTE: This option is set to the Vi default value when 'compatible' is
8359 set and to the Vim default value when 'compatible' is reset.
8360
8361 *'wildcharm'* *'wcm'*
8362'wildcharm' 'wcm' number (default: none (0))
8363 global
8364 {not in Vi}
8365 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008366 recognized when used inside a macro. You can find "spare" command-line
8367 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008368 you'll never actually type 'wildcharm', just use it in mappings that
8369 automatically invoke completion mode, e.g.: >
8370 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008371 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008372< Then after typing :ss you can use CTRL-P & CTRL-N.
8373
8374 *'wildignore'* *'wig'*
8375'wildignore' 'wig' string (default "")
8376 global
8377 {not in Vi}
8378 {not available when compiled without the |+wildignore|
8379 feature}
8380 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008381 patterns is ignored when expanding |wildcards|, completing file or
8382 directory names, and influences the result of |expand()|, |glob()| and
8383 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8385 Also see 'suffixes'.
8386 Example: >
8387 :set wildignore=*.o,*.obj
8388< The use of |:set+=| and |:set-=| is preferred when adding or removing
8389 a pattern from the list. This avoids problems when a future version
8390 uses another default.
8391
Bram Moolenaar94950a92010-12-02 16:01:29 +01008392
Bram Moolenaar81af9252010-12-10 20:35:50 +01008393 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008394'wildignorecase' 'wic' boolean (default off)
8395 global
8396 {not in Vi}
8397 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008398 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008399 Does not apply when the shell is used to expand wildcards, which
8400 happens when there are special characters.
8401
8402
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008404'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405 global
8406 {not in Vi}
8407 {not available if compiled without the |+wildmenu|
8408 feature}
8409 When 'wildmenu' is on, command-line completion operates in an enhanced
8410 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8411 the possible matches are shown just above the command line, with the
8412 first match highlighted (overwriting the status line, if there is
8413 one). Keys that show the previous/next match, such as <Tab> or
8414 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8415 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8416 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008417 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 If there are more matches than can fit in the line, a ">" is shown on
8419 the right and/or a "<" is shown on the left. The status line scrolls
8420 as needed.
8421 The "wildmenu" mode is abandoned when a key is hit that is not used
8422 for selecting a completion.
8423 While the "wildmenu" is active the following keys have special
8424 meanings:
8425
8426 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8427 <Down> - in filename/menu name completion: move into a
8428 subdirectory or submenu.
8429 <CR> - in menu completion, when the cursor is just after a
8430 dot: move into a submenu.
8431 <Up> - in filename/menu name completion: move up into
8432 parent directory or parent menu.
8433
8434 This makes the menus accessible from the console |console-menus|.
8435
8436 If you prefer the <Left> and <Right> keys to move the cursor instead
8437 of selecting a different match, use this: >
8438 :cnoremap <Left> <Space><BS><Left>
8439 :cnoremap <Right> <Space><BS><Right>
8440<
8441 The "WildMenu" highlighting is used for displaying the current match
8442 |hl-WildMenu|.
8443
8444 *'wildmode'* *'wim'*
8445'wildmode' 'wim' string (Vim default: "full")
8446 global
8447 {not in Vi}
8448 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008449 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008450 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008451 first part specifies the behavior for the first use of 'wildchar',
8452 The second part for the second use, etc.
8453 These are the possible values for each part:
8454 "" Complete only the first match.
8455 "full" Complete the next full match. After the last match,
8456 the original string is used and then the first match
8457 again.
8458 "longest" Complete till longest common string. If this doesn't
8459 result in a longer string, use the next part.
8460 "longest:full" Like "longest", but also start 'wildmenu' if it is
8461 enabled.
8462 "list" When more than one match, list all matches.
8463 "list:full" When more than one match, list all matches and
8464 complete first match.
8465 "list:longest" When more than one match, list all matches and
8466 complete till longest common string.
8467 When there is only a single match, it is fully completed in all cases.
8468
8469 Examples: >
8470 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008471< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 :set wildmode=longest,full
8473< Complete longest common string, then each full match >
8474 :set wildmode=list:full
8475< List all matches and complete each full match >
8476 :set wildmode=list,full
8477< List all matches without completing, then each full match >
8478 :set wildmode=longest,list
8479< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008480 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008481
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008482 *'wildoptions'* *'wop'*
8483'wildoptions' 'wop' string (default "")
8484 global
8485 {not in Vi}
8486 {not available when compiled without the |+wildignore|
8487 feature}
8488 A list of words that change how command line completion is done.
8489 Currently only one word is allowed:
8490 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008491 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008492 is displayed per line. Often used tag kinds are:
8493 d #define
8494 f function
8495 Also see |cmdline-completion|.
8496
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497 *'winaltkeys'* *'wak'*
8498'winaltkeys' 'wak' string (default "menu")
8499 global
8500 {not in Vi}
8501 {only used in Win32, Motif, GTK and Photon GUI}
8502 Some GUI versions allow the access to menu entries by using the ALT
8503 key in combination with a character that appears underlined in the
8504 menu. This conflicts with the use of the ALT key for mappings and
8505 entering special characters. This option tells what to do:
8506 no Don't use ALT keys for menus. ALT key combinations can be
8507 mapped, but there is no automatic handling. This can then be
8508 done with the |:simalt| command.
8509 yes ALT key handling is done by the windowing system. ALT key
8510 combinations cannot be mapped.
8511 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008512 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 keys can be mapped.
8514 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8515 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008516 This option is not used for <F10>; on Win32 and with GTK <F10> will
8517 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008518
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008519 *'window'* *'wi'*
8520'window' 'wi' number (default screen height - 1)
8521 global
8522 Window height. Do not confuse this with the height of the Vim window,
8523 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008524 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8525 value is smaller than 'lines' minus one. The screen will scroll
8526 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008527 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8528 in a much smarter way, taking care of wrapping lines.
8529 When resizing the Vim window, the value is smaller than 1 or more than
8530 or equal to 'lines' it will be set to 'lines' minus 1.
8531 {Vi also uses the option to specify the number of displayed lines}
8532
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 *'winheight'* *'wh'* *E591*
8534'winheight' 'wh' number (default 1)
8535 global
8536 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008537 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008538 feature}
8539 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008540 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008541 focus goes to a window that is smaller, its size is increased, at the
8542 cost of the height of other windows.
8543 Set 'winheight' to a small number for normal editing.
8544 Set it to 999 to make the current window fill most of the screen.
8545 Other windows will be only 'winminheight' high. This has the drawback
8546 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8547 to create only two windows, set the option after startup is done,
8548 using the |VimEnter| event: >
8549 au VimEnter * set winheight=999
8550< Minimum value is 1.
8551 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 height of the current window.
8553 'winheight' applies to the current window. Use 'winminheight' to set
8554 the minimal height for other windows.
8555
8556 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8557'winfixheight' 'wfh' boolean (default off)
8558 local to window
8559 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008560 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008561 feature}
8562 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008563 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8564 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008565 The height may be changed anyway when running out of room.
8566
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008567 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8568'winfixwidth' 'wfw' boolean (default off)
8569 local to window
8570 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008571 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008572 feature}
8573 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008574 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008575 The width may be changed anyway when running out of room.
8576
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 *'winminheight'* *'wmh'*
8578'winminheight' 'wmh' number (default 1)
8579 global
8580 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008581 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 feature}
8583 The minimal height of a window, when it's not the current window.
8584 This is a hard minimum, windows will never become smaller.
8585 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8586 status bar) if necessary. They will return to at least one line when
8587 they become active (since the cursor has to have somewhere to go.)
8588 Use 'winheight' to set the minimal height of the current window.
8589 This option is only checked when making a window smaller. Don't use a
8590 large number, it will cause errors when opening more than a few
8591 windows. A value of 0 to 3 is reasonable.
8592
8593 *'winminwidth'* *'wmw'*
8594'winminwidth' 'wmw' number (default 1)
8595 global
8596 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008597 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008598 feature}
8599 The minimal width of a window, when it's not the current window.
8600 This is a hard minimum, windows will never become smaller.
8601 When set to zero, windows may be "squashed" to zero columns (i.e. just
8602 a vertical separator) if necessary. They will return to at least one
8603 line when they become active (since the cursor has to have somewhere
8604 to go.)
8605 Use 'winwidth' to set the minimal width of the current window.
8606 This option is only checked when making a window smaller. Don't use a
8607 large number, it will cause errors when opening more than a few
8608 windows. A value of 0 to 12 is reasonable.
8609
8610 *'winwidth'* *'wiw'* *E592*
8611'winwidth' 'wiw' number (default 20)
8612 global
8613 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008614 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 feature}
8616 Minimal number of columns for the current window. This is not a hard
8617 minimum, Vim will use fewer columns if there is not enough room. If
8618 the current window is smaller, its size is increased, at the cost of
8619 the width of other windows. Set it to 999 to make the current window
8620 always fill the screen. Set it to a small number for normal editing.
8621 The width is not adjusted after one of the commands to change the
8622 width of the current window.
8623 'winwidth' applies to the current window. Use 'winminwidth' to set
8624 the minimal width for other windows.
8625
8626 *'wrap'* *'nowrap'*
8627'wrap' boolean (default on)
8628 local to window
8629 {not in Vi}
8630 This option changes how text is displayed. It doesn't change the text
8631 in the buffer, see 'textwidth' for that.
8632 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008633 displaying continues on the next line. When off lines will not wrap
8634 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008635 moved to a part that is not shown, the screen will scroll
8636 horizontally.
8637 The line will be broken in the middle of a word if necessary. See
8638 'linebreak' to get the break at a word boundary.
8639 To make scrolling horizontally a bit more useful, try this: >
8640 :set sidescroll=5
8641 :set listchars+=precedes:<,extends:>
8642< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008643 This option can't be set from a |modeline| when the 'diff' option is
8644 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645
8646 *'wrapmargin'* *'wm'*
8647'wrapmargin' 'wm' number (default 0)
8648 local to buffer
8649 Number of characters from the right window border where wrapping
8650 starts. When typing text beyond this limit, an <EOL> will be inserted
8651 and inserting continues on the next line.
8652 Options that add a margin, such as 'number' and 'foldcolumn', cause
8653 the text width to be further reduced. This is Vi compatible.
8654 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008655 This option is set to 0 when 'paste' is set and restored when 'paste'
8656 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008657 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8658 and less usefully}
8659
8660 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8661'wrapscan' 'ws' boolean (default on) *E384* *E385*
8662 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008663 Searches wrap around the end of the file. Also applies to |]s| and
8664 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665
8666 *'write'* *'nowrite'*
8667'write' boolean (default on)
8668 global
8669 {not in Vi}
8670 Allows writing files. When not set, writing a file is not allowed.
8671 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008672 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008673 argument. Filtering text is still possible, even though this requires
8674 writing a temporary file.
8675
8676 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8677'writeany' 'wa' boolean (default off)
8678 global
8679 Allows writing to any file with no need for "!" override.
8680
8681 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8682'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8683 otherwise)
8684 global
8685 {not in Vi}
8686 Make a backup before overwriting a file. The backup is removed after
8687 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008688 also on.
8689 WARNING: Switching this option off means that when Vim fails to write
8690 your buffer correctly and then, for whatever reason, Vim exits, you
8691 lose both the original file and what you were writing. Only reset
8692 this option if your file system is almost full and it makes the write
8693 fail (and make sure not to exit Vim until the write was successful).
8694 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008695 When the 'backupskip' pattern matches, a backup is not made anyway.
8696 NOTE: This option is set to the default value when 'compatible' is
8697 set.
8698
8699 *'writedelay'* *'wd'*
8700'writedelay' 'wd' number (default 0)
8701 global
8702 {not in Vi}
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008703 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 screen. When non-zero, characters are sent to the terminal one by
8705 one. For MS-DOS pcterm this does not work. For debugging purposes.
8706
8707 vim:tw=78:ts=8:ft=help:norl: