blob: 3cb667d35d1ea4e78a3de9b7640e36081d10d60a [file] [log] [blame]
Bram Moolenaarca635012015-09-25 20:34:21 +02001*options.txt* For Vim version 7.4. Last change: 2015 Sep 15
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 Moolenaar18400e62015-01-27 15:58:40 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
245has its own copy of this option, thus can each have their own value. This
246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
264When editing a buffer that has been edited before, the last used window
265options are used again. If this buffer has been edited in this window, the
266values from back then are used. Otherwise the values from the window where
267the buffer was edited last are used.
268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
730
731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
732'autochdir' 'acd' boolean (default off)
733 global
734 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
746 {not in Vi}
747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
769 {not in Vi}
770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 {small difference from Vi: After the indent is deleted when typing
802 <Esc> or <CR>, the cursor position when moving up or down is after the
803 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
804
805 *'autoread'* *'ar'* *'noautoread'* *'noar'*
806'autoread' 'ar' boolean (default off)
807 global or local to buffer |global-local|
808 {not in Vi}
809 When a file has been detected to have been changed outside of Vim and
810 it has not been changed inside of Vim, automatically read it again.
811 When the file has been deleted this is not done. |timestamp|
812 If this option has a local value, use this command to switch back to
813 using the global value: >
814 :set autoread<
815<
816 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
817'autowrite' 'aw' boolean (default off)
818 global
819 Write the contents of the file, if it has been modified, on each
820 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000821 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
823 Note that for some commands the 'autowrite' option is not used, see
824 'autowriteall' for that.
825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
829 {not in Vi}
830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
832 Setting this option also implies that Vim behaves like 'autowrite' has
833 been set.
834
835 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200836'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 global
838 {not in Vi}
839 When set to "dark", Vim will try to use colors that look good on a
840 dark background. When set to "light", Vim will try to use colors that
841 look good on a light background. Any other value is illegal.
842 Vim tries to set the default value according to the terminal used.
843 This will not always be correct.
844 Setting this option does not change the background color, it tells Vim
845 what the background color looks like. For changing the background
846 color, see |:hi-normal|.
847
848 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000850 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100851 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000852 setting 'background' will cause the color scheme to be reloaded. If
853 the color scheme adjusts to the value of 'background' this will work.
854 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100855 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000856
857 When setting 'background' to the default value with: >
858 :set background&
859< Vim will guess the value. In the GUI this should work correctly,
860 in other cases Vim might not be able to guess the right value.
861
862 When starting the GUI, the default value for 'background' will be
863 "light". When the value is not set in the .gvimrc, and Vim detects
864 that the background is actually quite dark, 'background' is set to
865 "dark". But this happens only AFTER the .gvimrc file has been read
866 (because the window needs to be opened to find the actual background
867 color). To get around this, force the GUI window to be opened by
868 putting a ":gui" command in the .gvimrc file, before where the value
869 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200870
871 For MS-DOS, Windows and OS/2 the default is "dark".
872 For other systems "dark" is used when 'term' is "linux",
873 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
874 background. Otherwise the default is "light".
875
Bram Moolenaar071d4272004-06-13 20:20:40 +0000876 Normally this option would be set in the .vimrc file. Possibly
877 depending on the terminal name. Example: >
878 :if &term == "pcterm"
879 : set background=dark
880 :endif
881< When this option is set, the default settings for the highlight groups
882 will change. To use other settings, place ":highlight" commands AFTER
883 the setting of the 'background' option.
884 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
885 to select the colors for syntax highlighting. After changing this
886 option, you must load syntax.vim again to see the result. This can be
887 done with ":syntax on".
888
889 *'backspace'* *'bs'*
890'backspace' 'bs' string (default "")
891 global
892 {not in Vi}
893 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
894 mode. This is a list of items, separated by commas. Each item allows
895 a way to backspace over something:
896 value effect ~
897 indent allow backspacing over autoindent
898 eol allow backspacing over line breaks (join lines)
899 start allow backspacing over the start of insert; CTRL-W and CTRL-U
900 stop once at the start of insert.
901
902 When the value is empty, Vi compatible backspacing is used.
903
904 For backwards compatibility with version 5.4 and earlier:
905 value effect ~
906 0 same as ":set backspace=" (Vi compatible)
907 1 same as ":set backspace=indent,eol"
908 2 same as ":set backspace=indent,eol,start"
909
910 See |:fixdel| if your <BS> or <Del> key does not do what you want.
911 NOTE: This option is set to "" when 'compatible' is set.
912
913 *'backup'* *'bk'* *'nobackup'* *'nobk'*
914'backup' 'bk' boolean (default off)
915 global
916 {not in Vi}
917 Make a backup before overwriting a file. Leave it around after the
918 file has been successfully written. If you do not want to keep the
919 backup file, but you do want a backup while the file is being
920 written, reset this option and set the 'writebackup' option (this is
921 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000922 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 |backup-table| for more explanations.
924 When the 'backupskip' pattern matches, a backup is not made anyway.
925 When 'patchmode' is set, the backup may be renamed to become the
926 oldest version of a file.
927 NOTE: This option is reset when 'compatible' is set.
928
929 *'backupcopy'* *'bkc'*
930'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200931 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000932 {not in Vi}
933 When writing a file and a backup is made, this option tells how it's
934 done. This is a comma separated list of words.
935
936 The main values are:
937 "yes" make a copy of the file and overwrite the original one
938 "no" rename the file and write a new one
939 "auto" one of the previous, what works best
940
941 Extra values that can be combined with the ones above are:
942 "breaksymlink" always break symlinks when writing
943 "breakhardlink" always break hardlinks when writing
944
945 Making a copy and overwriting the original file:
946 - Takes extra time to copy the file.
947 + When the file has special attributes, is a (hard/symbolic) link or
948 has a resource fork, all this is preserved.
949 - When the file is a link the backup will have the name of the link,
950 not of the real file.
951
952 Renaming the file and writing a new one:
953 + It's fast.
954 - Sometimes not all attributes of the file can be copied to the new
955 file.
956 - When the file is a link the new file will not be a link.
957
958 The "auto" value is the middle way: When Vim sees that renaming file
959 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000960 the file is not a link) that is used. When problems are expected, a
961 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962
963 The "breaksymlink" and "breakhardlink" values can be used in
964 combination with any of "yes", "no" and "auto". When included, they
965 force Vim to always break either symbolic or hard links by doing
966 exactly what the "no" option does, renaming the original file to
967 become the backup and writing a new file in its place. This can be
968 useful for example in source trees where all the files are symbolic or
969 hard links and any changes should stay in the local source tree, not
970 be propagated back to the original source.
971 *crontab*
972 One situation where "no" and "auto" will cause problems: A program
973 that opens a file, invokes Vim to edit that file, and then tests if
974 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000975 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976 example.
977
978 When a copy is made, the original file is truncated and then filled
979 with the new text. This means that protection bits, owner and
980 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000981 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 group of the backup is set to the group of the original file. If this
983 fails, the protection bits for the group are made the same as for
984 others.
985
986 When the file is renamed this is the other way around: The backup has
987 the same attributes of the original file, and the newly written file
988 is owned by the current user. When the file was a (hard/symbolic)
989 link, the new file will not! That's why the "auto" value doesn't
990 rename when the file is a link. The owner and group of the newly
991 written file will be set to the same ones as the original file, but
992 the system may refuse to do this. In that case the "auto" value will
993 again not rename the file.
994
995 *'backupdir'* *'bdir'*
996'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100997 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 for Unix: ".,~/tmp,~/")
999 global
1000 {not in Vi}
1001 List of directories for the backup file, separated with commas.
1002 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001003 where this is possible. The directory must exist, Vim will not
1004 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +01001005 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 impossible!). Writing may fail because of this.
1007 - A directory "." means to put the backup file in the same directory
1008 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001009 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 put the backup file relative to where the edited file is. The
1011 leading "." is replaced with the path name of the edited file.
1012 ("." inside a directory name has no special meaning).
1013 - Spaces after the comma are ignored, other spaces are considered part
1014 of the directory name. To have a space at the start of a directory
1015 name, precede it with a backslash.
1016 - To include a comma in a directory name precede it with a backslash.
1017 - A directory name may end in an '/'.
1018 - Environment variables are expanded |:set_env|.
1019 - Careful with '\' characters, type one before a space, type two to
1020 get one in the option (see |option-backslash|), for example: >
1021 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1022< - For backwards compatibility with Vim version 3.0 a '>' at the start
1023 of the option is removed.
1024 See also 'backup' and 'writebackup' options.
1025 If you want to hide your backup files on Unix, consider this value: >
1026 :set backupdir=./.backup,~/.backup,.,/tmp
1027< You must create a ".backup" directory in each directory and in your
1028 home directory for this to work properly.
1029 The use of |:set+=| and |:set-=| is preferred when adding or removing
1030 directories from the list. This avoids problems when a future version
1031 uses another default.
1032 This option cannot be set from a |modeline| or in the |sandbox|, for
1033 security reasons.
1034
1035 *'backupext'* *'bex'* *E589*
1036'backupext' 'bex' string (default "~", for VMS: "_")
1037 global
1038 {not in Vi}
1039 String which is appended to a file name to make the name of the
1040 backup file. The default is quite unusual, because this avoids
1041 accidentally overwriting existing files with a backup file. You might
1042 prefer using ".bak", but make sure that you don't have files with
1043 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001044 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001046 If you like to keep a lot of backups, you could use a BufWritePre
1047 autocommand to change 'backupext' just before writing the file to
1048 include a timestamp. >
1049 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1050< Use 'backupdir' to put the backup in a different directory.
1051
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 *'backupskip'* *'bsk'*
1053'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1054 global
1055 {not in Vi}
1056 {not available when compiled without the |+wildignore|
1057 feature}
1058 A list of file patterns. When one of the patterns matches with the
1059 name of the file which is written, no backup file is created. Both
1060 the specified file name and the full path name of the file are used.
1061 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1062 Watch out for special characters, see |option-backslash|.
1063 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001064 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001065
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001066 WARNING: Not having a backup file means that when Vim fails to write
1067 your buffer correctly and then, for whatever reason, Vim exits, you
1068 lose both the original file and what you were writing. Only disable
1069 backups if you don't care about losing the file.
1070
Bram Moolenaar02467872007-05-06 13:22:01 +00001071 Note that environment variables are not expanded. If you want to use
1072 $HOME you must expand it explicitly, e.g.: >
1073 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1074
1075< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001076 backup would be made by renaming the original file crontab won't see
1077 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078
1079 *'balloondelay'* *'bdlay'*
1080'balloondelay' 'bdlay' number (default: 600)
1081 global
1082 {not in Vi}
1083 {only available when compiled with the |+balloon_eval|
1084 feature}
1085 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1086
1087 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1088'ballooneval' 'beval' boolean (default off)
1089 global
1090 {not in Vi}
1091 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001092 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 Switch on the |balloon-eval| functionality.
1094
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001095 *'balloonexpr'* *'bexpr'*
1096'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001097 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001098 {not in Vi}
1099 {only available when compiled with the |+balloon_eval|
1100 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001101 Expression for text to show in evaluation balloon. It is only used
1102 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001103
1104 v:beval_bufnr number of the buffer in which balloon is going to show
1105 v:beval_winnr number of the window
1106 v:beval_lnum line number
1107 v:beval_col column number (byte index)
1108 v:beval_text word under or after the mouse pointer
1109
1110 The evaluation of the expression must not have side effects!
1111 Example: >
1112 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001113 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001114 \', column ' . v:beval_col .
1115 \ ' of file ' . bufname(v:beval_bufnr) .
1116 \ ' on word "' . v:beval_text . '"'
1117 endfunction
1118 set bexpr=MyBalloonExpr()
1119 set ballooneval
1120<
1121 NOTE: The balloon is displayed only if the cursor is on a text
1122 character. If the result of evaluating 'balloonexpr' is not empty,
1123 Vim does not try to send a message to an external debugger (Netbeans
1124 or Sun Workshop).
1125
Bram Moolenaar30b65812012-07-12 22:01:11 +02001126 The expression will be evaluated in the |sandbox| when set from a
1127 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001128
1129 It is not allowed to change text or jump to another window while
1130 evaluating 'balloonexpr' |textlock|.
1131
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001132 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001133 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001134< When they are supported "\n" characters will start a new line. If the
1135 expression evaluates to a |List| this is equal to using each List item
1136 as a string and putting "\n" in between them.
1137
Bram Moolenaar165bc692015-07-21 17:53:25 +02001138 *'belloff'* *'bo'*
1139'belloff' 'bo' string (default "")
1140 global
1141 {not in Vi}
1142 Specifies for which events the bell will not be rung. It is a comma
1143 separated list of items. For each item that is present, the bell
1144 will be silenced. This is most useful to specify specific events in
1145 insert mode to be silenced.
1146
1147 item meaning when present ~
1148 all All events.
1149 backspace When hitting <BS> or <Del> and deleting results in an
1150 error.
1151 cursor Fail to move around using the cursor keys or
1152 <PageUp>/<PageDown> in |Insert-mode|.
1153 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1154 |i_CTRL-X_CTRL-T|.
1155 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1156 |i_CTRL-E|.
1157 ctrlg Unknown Char after <C-G> in Insert mode.
1158 error Other Error occurred (e.g. try to join last line)
1159 (mostly used in |Normal-mode| or |Cmdline-mode|).
1160 esc hitting <Esc> in |Normal-mode|.
1161 ex In |Visual-mode|, hitting |Q| results in an error.
1162 hangul Error occurred when using hangul input.
1163 insertmode Pressing <Esc> in 'insertmode'.
1164 lang Calling the beep module for Lua/Mzscheme/TCL.
1165 mess No output available for |g<|.
1166 showmatch Error occurred for 'showmatch' function.
1167 operator Empty region error |cpo-E|.
1168 register Unknown register after <C-R> in |Insert-mode|.
1169 shell Bell from shell output |:!|.
1170 spell Error happened on spell suggest.
1171 wildmode More matches in |cmdline-completion| available
1172 (depends on the 'wildmode' setting).
1173
1174 This is most useful, to fine tune when in insert mode the bell should
1175 be rung. For normal mode and ex commands, the bell is often rung to
1176 indicate that an error occurred. It can be silenced by adding the
1177 "error" keyword.
1178
Bram Moolenaar071d4272004-06-13 20:20:40 +00001179 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1180'binary' 'bin' boolean (default off)
1181 local to buffer
1182 {not in Vi}
1183 This option should be set before editing a binary file. You can also
1184 use the |-b| Vim argument. When this option is switched on a few
1185 options will be changed (also when it already was on):
1186 'textwidth' will be set to 0
1187 'wrapmargin' will be set to 0
1188 'modeline' will be off
1189 'expandtab' will be off
1190 Also, 'fileformat' and 'fileformats' options will not be used, the
1191 file is read and written like 'fileformat' was "unix" (a single <NL>
1192 separates lines).
1193 The 'fileencoding' and 'fileencodings' options will not be used, the
1194 file is read without conversion.
1195 NOTE: When you start editing a(nother) file while the 'bin' option is
1196 on, settings from autocommands may change the settings again (e.g.,
1197 'textwidth'), causing trouble when editing. You might want to set
1198 'bin' again when the file has been loaded.
1199 The previous values of these options are remembered and restored when
1200 'bin' is switched from on to off. Each buffer has its own set of
1201 saved option values.
1202 To edit a file with 'binary' set you can use the |++bin| argument.
1203 This avoids you have to do ":set bin", which would have effect for all
1204 files you edit.
1205 When writing a file the <EOL> for the last line is only written if
1206 there was one in the original file (normally Vim appends an <EOL> to
1207 the last line if there is none; this would make the file longer). See
1208 the 'endofline' option.
1209
1210 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1211'bioskey' 'biosk' boolean (default on)
1212 global
1213 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001214 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 better to detect CTRL-C, but only works for the console. When using a
1216 terminal over a serial port reset this option.
1217 Also see |'conskey'|.
1218
1219 *'bomb'* *'nobomb'*
1220'bomb' boolean (default off)
1221 local to buffer
1222 {not in Vi}
1223 {only available when compiled with the |+multi_byte|
1224 feature}
1225 When writing a file and the following conditions are met, a BOM (Byte
1226 Order Mark) is prepended to the file:
1227 - this option is on
1228 - the 'binary' option is off
1229 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1230 endian variants.
1231 Some applications use the BOM to recognize the encoding of the file.
1232 Often used for UCS-2 files on MS-Windows. For other applications it
1233 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001234 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1236 check for the presence of the BOM is done and 'bomb' set accordingly.
1237 Unless 'binary' is set, it is removed from the first line, so that you
1238 don't see it when editing. When you don't change the options, the BOM
1239 will be restored when writing the file.
1240
1241 *'breakat'* *'brk'*
1242'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1243 global
1244 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001245 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 feature}
1247 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001248 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1249 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001251 *'breakindent'* *'bri'*
1252'breakindent' 'bri' boolean (default off)
1253 local to window
1254 {not in Vi}
1255 {not available when compiled without the |+linebreak|
1256 feature}
1257 Every wrapped line will continue visually indented (same amount of
1258 space as the beginning of that line), thus preserving horizontal blocks
1259 of text.
1260
1261 *'breakindentopt'* *'briopt'*
1262'breakindentopt' 'briopt' string (default empty)
1263 local to window
1264 {not in Vi}
1265 {not available when compiled without the |+linebreak|
1266 feature}
1267 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001268 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001269 min:{n} Minimum text width that will be kept after
1270 applying 'breakindent', even if the resulting
1271 text should normally be narrower. This prevents
1272 text indented almost to the right window border
1273 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001274 shift:{n} After applying 'breakindent', the wrapped line's
1275 beginning will be shifted by the given number of
1276 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001277 indentation (negative) or emphasizing the line
1278 continuation (positive).
1279 sbr Display the 'showbreak' value before applying the
1280 additional indent.
1281 The default value for min is 20 and shift is 0.
1282
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001284'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001285 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001286 {not in Vi} {only for Motif, Athena, GTK, Mac and
1287 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001289 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001290 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291 buffer Use the directory of the related buffer.
1292 current Use the current directory.
1293 {path} Use the specified directory
1294
1295 *'bufhidden'* *'bh'*
1296'bufhidden' 'bh' string (default: "")
1297 local to buffer
1298 {not in Vi}
1299 {not available when compiled without the |+quickfix|
1300 feature}
1301 This option specifies what happens when a buffer is no longer
1302 displayed in a window:
1303 <empty> follow the global 'hidden' option
1304 hide hide the buffer (don't unload it), also when 'hidden'
1305 is not set
1306 unload unload the buffer, also when 'hidden' is set or using
1307 |:hide|
1308 delete delete the buffer from the buffer list, also when
1309 'hidden' is set or using |:hide|, like using
1310 |:bdelete|
1311 wipe wipe out the buffer from the buffer list, also when
1312 'hidden' is set or using |:hide|, like using
1313 |:bwipeout|
1314
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001315 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001316 are lost without a warning. Also, these values may break autocommands
1317 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 This option is used together with 'buftype' and 'swapfile' to specify
1319 special kinds of buffers. See |special-buffers|.
1320
1321 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1322'buflisted' 'bl' boolean (default: on)
1323 local to buffer
1324 {not in Vi}
1325 When this option is set, the buffer shows up in the buffer list. If
1326 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1327 This option is reset by Vim for buffers that are only used to remember
1328 a file name or marks. Vim sets it when starting to edit a buffer.
1329 But not when moving to a buffer with ":buffer".
1330
1331 *'buftype'* *'bt'* *E382*
1332'buftype' 'bt' string (default: "")
1333 local to buffer
1334 {not in Vi}
1335 {not available when compiled without the |+quickfix|
1336 feature}
1337 The value of this option specifies the type of a buffer:
1338 <empty> normal buffer
1339 nofile buffer which is not related to a file and will not be
1340 written
1341 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001342 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001343 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001344 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001346 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 help help buffer (you are not supposed to set this
1348 manually)
1349
1350 This option is used together with 'bufhidden' and 'swapfile' to
1351 specify special kinds of buffers. See |special-buffers|.
1352
1353 Be careful with changing this option, it can have many side effects!
1354
Bram Moolenaar280f1262006-01-30 00:14:18 +00001355 A "quickfix" buffer is only used for the error list and the location
1356 list. This value is set by the |:cwindow| and |:lwindow| commands and
1357 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358
1359 "nofile" and "nowrite" buffers are similar:
1360 both: The buffer is not to be written to disk, ":w" doesn't
1361 work (":w filename" does work though).
1362 both: The buffer is never considered to be |'modified'|.
1363 There is no warning when the changes will be lost, for
1364 example when you quit Vim.
1365 both: A swap file is only created when using too much memory
1366 (when 'swapfile' has been reset there is never a swap
1367 file).
1368 nofile only: The buffer name is fixed, it is not handled like a
1369 file name. It is not modified in response to a |:cd|
1370 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001371 both: When using ":e bufname" and already editing "bufname"
1372 the buffer is made empty and autocommands are
1373 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001374 *E676*
1375 "acwrite" implies that the buffer name is not related to a file, like
1376 "nofile", but it will be written. Thus, in contrast to "nofile" and
1377 "nowrite", ":w" does work and a modified buffer can't be abandoned
1378 without saving. For writing there must be matching |BufWriteCmd|,
1379 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380
1381 *'casemap'* *'cmp'*
1382'casemap' 'cmp' string (default: "internal,keepascii")
1383 global
1384 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001385 {only available when compiled with the |+multi_byte|
1386 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 Specifies details about changing the case of letters. It may contain
1388 these words, separated by a comma:
1389 internal Use internal case mapping functions, the current
1390 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001391 matters when 'encoding' is a Unicode encoding,
1392 "latin1" or "iso-8859-15". When "internal" is
1393 omitted, the towupper() and towlower() system library
1394 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001395 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1396 case mapping, the current locale is not effective.
1397 This probably only matters for Turkish.
1398
1399 *'cdpath'* *'cd'* *E344* *E346*
1400'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1401 global
1402 {not in Vi}
1403 {not available when compiled without the
1404 |+file_in_path| feature}
1405 This is a list of directories which will be searched when using the
1406 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001407 for has a relative path, not an absolute part starting with "/", "./"
1408 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 The 'cdpath' option's value has the same form and semantics as
1410 |'path'|. Also see |file-searching|.
1411 The default value is taken from $CDPATH, with a "," prepended to look
1412 in the current directory first.
1413 If the default value taken from $CDPATH is not what you want, include
1414 a modified version of the following command in your vimrc file to
1415 override it: >
1416 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1417< This option cannot be set from a |modeline| or in the |sandbox|, for
1418 security reasons.
1419 (parts of 'cdpath' can be passed to the shell to expand file names).
1420
1421 *'cedit'*
1422'cedit' string (Vi default: "", Vim default: CTRL-F)
1423 global
1424 {not in Vi}
1425 {not available when compiled without the |+vertsplit|
1426 feature}
1427 The key used in Command-line Mode to open the command-line window.
1428 The default is CTRL-F when 'compatible' is off.
1429 Only non-printable keys are allowed.
1430 The key can be specified as a single character, but it is difficult to
1431 type. The preferred way is to use the <> notation. Examples: >
1432 :set cedit=<C-Y>
1433 :set cedit=<Esc>
1434< |Nvi| also has this option, but it only uses the first character.
1435 See |cmdwin|.
1436
1437 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1438'charconvert' 'ccv' string (default "")
1439 global
1440 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001441 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001442 {not in Vi}
1443 An expression that is used for character encoding conversion. It is
1444 evaluated when a file that is to be read or has been written has a
1445 different encoding from what is desired.
1446 'charconvert' is not used when the internal iconv() function is
1447 supported and is able to do the conversion. Using iconv() is
1448 preferred, because it is much faster.
1449 'charconvert' is not used when reading stdin |--|, because there is no
1450 file to convert from. You will have to save the text in a file first.
1451 The expression must return zero or an empty string for success,
1452 non-zero for failure.
1453 The possible encoding names encountered are in 'encoding'.
1454 Additionally, names given in 'fileencodings' and 'fileencoding' are
1455 used.
1456 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1457 is done internally by Vim, 'charconvert' is not used for this.
1458 'charconvert' is also used to convert the viminfo file, if the 'c'
1459 flag is present in 'viminfo'. Also used for Unicode conversion.
1460 Example: >
1461 set charconvert=CharConvert()
1462 fun CharConvert()
1463 system("recode "
1464 \ . v:charconvert_from . ".." . v:charconvert_to
1465 \ . " <" . v:fname_in . " >" v:fname_out)
1466 return v:shell_error
1467 endfun
1468< The related Vim variables are:
1469 v:charconvert_from name of the current encoding
1470 v:charconvert_to name of the desired encoding
1471 v:fname_in name of the input file
1472 v:fname_out name of the output file
1473 Note that v:fname_in and v:fname_out will never be the same.
1474 Note that v:charconvert_from and v:charconvert_to may be different
1475 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1476 Encryption is not done by Vim when using 'charconvert'. If you want
1477 to encrypt the file after conversion, 'charconvert' should take care
1478 of this.
1479 This option cannot be set from a |modeline| or in the |sandbox|, for
1480 security reasons.
1481
1482 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1483'cindent' 'cin' boolean (default off)
1484 local to buffer
1485 {not in Vi}
1486 {not available when compiled without the |+cindent|
1487 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001488 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 that trigger reindenting in insert mode and 'cinoptions' to set your
1490 preferred indent style.
1491 If 'indentexpr' is not empty, it overrules 'cindent'.
1492 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1493 the "=" operator indents using this algorithm rather than calling an
1494 external program.
1495 See |C-indenting|.
1496 When you don't like the way 'cindent' works, try the 'smartindent'
1497 option or 'indentexpr'.
1498 This option is not used when 'paste' is set.
1499 NOTE: This option is reset when 'compatible' is set.
1500
1501 *'cinkeys'* *'cink'*
1502'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1503 local to buffer
1504 {not in Vi}
1505 {not available when compiled without the |+cindent|
1506 feature}
1507 A list of keys that, when typed in Insert mode, cause reindenting of
1508 the current line. Only used if 'cindent' is on and 'indentexpr' is
1509 empty.
1510 For the format of this option see |cinkeys-format|.
1511 See |C-indenting|.
1512
1513 *'cinoptions'* *'cino'*
1514'cinoptions' 'cino' string (default "")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+cindent|
1518 feature}
1519 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1520 program. See |cinoptions-values| for the values of this option, and
1521 |C-indenting| for info on C indenting in general.
1522
1523
1524 *'cinwords'* *'cinw'*
1525'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1526 local to buffer
1527 {not in Vi}
1528 {not available when compiled without both the
1529 |+cindent| and the |+smartindent| features}
1530 These keywords start an extra indent in the next line when
1531 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1532 an appropriate place (inside {}).
1533 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1534 matter, include the keyword both the uppercase and lowercase:
1535 "if,If,IF".
1536
1537 *'clipboard'* *'cb'*
1538'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1539 for X-windows, "" otherwise)
1540 global
1541 {not in Vi}
1542 {only in GUI versions or when the |+xterm_clipboard|
1543 feature is included}
1544 This option is a list of comma separated names.
1545 These names are recognized:
1546
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001547 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 unnamed When included, Vim will use the clipboard register '*'
1549 for all yank, delete, change and put operations which
1550 would normally go to the unnamed register. When a
1551 register is explicitly specified, it will always be
1552 used regardless of whether "unnamed" is in 'clipboard'
1553 or not. The clipboard register can always be
1554 explicitly accessed using the "* notation. Also see
1555 |gui-clipboard|.
1556
Bram Moolenaar30b65812012-07-12 22:01:11 +02001557 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001558 unnamedplus A variant of the "unnamed" flag which uses the
1559 clipboard register '+' (|quoteplus|) instead of
1560 register '*' for all yank, delete, change and put
1561 operations which would normally go to the unnamed
1562 register. When "unnamed" is also included to the
1563 option, yank operations (but not delete, change or
1564 put) will additionally copy the text into register
1565 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001566 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001567 Availability can be checked with: >
1568 if has('unnamedplus')
1569<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001570 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 autoselect Works like the 'a' flag in 'guioptions': If present,
1572 then whenever Visual mode is started, or the Visual
1573 area extended, Vim tries to become the owner of the
1574 windowing system's global selection or put the
1575 selected text on the clipboard used by the selection
1576 register "*. See |guioptions_a| and |quotestar| for
1577 details. When the GUI is active, the 'a' flag in
1578 'guioptions' is used, when the GUI is not active, this
1579 "autoselect" flag is used.
1580 Also applies to the modeless selection.
1581
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001582 *clipboard-autoselectplus*
1583 autoselectplus Like "autoselect" but using the + register instead of
1584 the * register. Compare to the 'P' flag in
1585 'guioptions'.
1586
1587 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001588 autoselectml Like "autoselect", but for the modeless selection
1589 only. Compare to the 'A' flag in 'guioptions'.
1590
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001591 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001592 html When the clipboard contains HTML, use this when
1593 pasting. When putting text on the clipboard, mark it
1594 as HTML. This works to copy rendered HTML from
1595 Firefox, paste it as raw HTML in Vim, select the HTML
1596 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001597 You probably want to add this only temporarily,
1598 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001599 Only supported for GTK version 2 and later.
1600 Only available with the |+multi_byte| feature.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001603 exclude:{pattern}
1604 Defines a pattern that is matched against the name of
1605 the terminal 'term'. If there is a match, no
1606 connection will be made to the X server. This is
1607 useful in this situation:
1608 - Running Vim in a console.
1609 - $DISPLAY is set to start applications on another
1610 display.
1611 - You do not want to connect to the X server in the
1612 console, but do want this in a terminal emulator.
1613 To never connect to the X server use: >
1614 exclude:.*
1615< This has the same effect as using the |-X| argument.
1616 Note that when there is no connection to the X server
1617 the window title won't be restored and the clipboard
1618 cannot be accessed.
1619 The value of 'magic' is ignored, {pattern} is
1620 interpreted as if 'magic' was on.
1621 The rest of the option value will be used for
1622 {pattern}, this must be the last entry.
1623
1624 *'cmdheight'* *'ch'*
1625'cmdheight' 'ch' number (default 1)
1626 global
1627 {not in Vi}
1628 Number of screen lines to use for the command-line. Helps avoiding
1629 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001630 The value of this option is stored with the tab page, so that each tab
1631 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632
1633 *'cmdwinheight'* *'cwh'*
1634'cmdwinheight' 'cwh' number (default 7)
1635 global
1636 {not in Vi}
1637 {not available when compiled without the |+vertsplit|
1638 feature}
1639 Number of screen lines to use for the command-line window. |cmdwin|
1640
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001641 *'colorcolumn'* *'cc'*
1642'colorcolumn' 'cc' string (default "")
1643 local to window
1644 {not in Vi}
1645 {not available when compiled without the |+syntax|
1646 feature}
1647 'colorcolumn' is a comma separated list of screen columns that are
1648 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1649 text. Will make screen redrawing slower.
1650 The screen column can be an absolute number, or a number preceded with
1651 '+' or '-', which is added to or subtracted from 'textwidth'. >
1652
1653 :set cc=+1 " highlight column after 'textwidth'
1654 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1655 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1656<
1657 When 'textwidth' is zero then the items with '-' and '+' are not used.
1658 A maximum of 256 columns are highlighted.
1659
Bram Moolenaar071d4272004-06-13 20:20:40 +00001660 *'columns'* *'co'* *E594*
1661'columns' 'co' number (default 80 or terminal width)
1662 global
1663 {not in Vi}
1664 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001665 initialization and does not have to be set by hand. Also see
1666 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 When Vim is running in the GUI or in a resizable window, setting this
1668 option will cause the window size to be changed. When you only want
1669 to use the size for the GUI, put the command in your |gvimrc| file.
1670 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001671 number of columns of the display, the display may be messed up. For
1672 the GUI it is always possible and Vim limits the number of columns to
1673 what fits on the screen. You can use this command to get the widest
1674 window possible: >
1675 :set columns=9999
1676< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677
1678 *'comments'* *'com'* *E524* *E525*
1679'comments' 'com' string (default
1680 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1681 local to buffer
1682 {not in Vi}
1683 {not available when compiled without the |+comments|
1684 feature}
1685 A comma separated list of strings that can start a comment line. See
1686 |format-comments|. See |option-backslash| about using backslashes to
1687 insert a space.
1688
1689 *'commentstring'* *'cms'* *E537*
1690'commentstring' 'cms' string (default "/*%s*/")
1691 local to buffer
1692 {not in Vi}
1693 {not available when compiled without the |+folding|
1694 feature}
1695 A template for a comment. The "%s" in the value is replaced with the
1696 comment text. Currently only used to add markers for folding, see
1697 |fold-marker|.
1698
1699 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001700'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1701 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 global
1703 {not in Vi}
1704 This option has the effect of making Vim either more Vi-compatible, or
1705 make Vim behave in a more useful way.
1706 This is a special kind of option, because when it's set or reset,
1707 other options are also changed as a side effect. CAREFUL: Setting or
1708 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001709 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 set this option in your vimrc file, you should probably put it at the
1711 very start.
1712 By default this option is on and the Vi defaults are used for the
1713 options. This default was chosen for those people who want to use Vim
1714 just like Vi, and don't even (want to) know about the 'compatible'
1715 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001716 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001717 this option is switched off, and all options that have not been
1718 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001721 happen for the system-wide vimrc or gvimrc file, nor for a file given
1722 with the |-u| argument). Also see |compatible-default| and
1723 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 You can also set this option with the "-C" argument, and reset it with
1725 "-N". See |-C| and |-N|.
1726 Switching this option off makes the Vim defaults be used for options
1727 that have a different Vi and Vim default value. See the options
1728 marked with a '+' below. Other options are not modified.
1729 At the moment this option is set, several other options will be set
1730 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001731 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 editing.
1733 See also 'cpoptions'.
1734
1735 option + set value effect ~
1736
1737 'allowrevins' off no CTRL-_ command
1738 'backupcopy' Unix: "yes" backup file is a copy
1739 others: "auto" copy or rename backup file
1740 'backspace' "" normal backspace
1741 'backup' off no backup file
1742 'cindent' off no C code indentation
1743 'cedit' + "" no key to open the |cmdwin|
1744 'cpoptions' + (all flags) Vi-compatible flags
1745 'cscopetag' off don't use cscope for ":tag"
1746 'cscopetagorder' 0 see |cscopetagorder|
1747 'cscopeverbose' off see |cscopeverbose|
1748 'digraph' off no digraphs
1749 'esckeys' + off no <Esc>-keys in Insert mode
1750 'expandtab' off tabs not expanded to spaces
1751 'fileformats' + "" no automatic file format detection,
1752 "dos,unix" except for DOS, Windows and OS/2
1753 'formatoptions' + "vt" Vi compatible formatting
1754 'gdefault' off no default 'g' flag for ":s"
1755 'history' + 0 no commandline history
1756 'hkmap' off no Hebrew keyboard mapping
1757 'hkmapp' off no phonetic Hebrew keyboard mapping
1758 'hlsearch' off no highlighting of search matches
1759 'incsearch' off no incremental searching
1760 'indentexpr' "" no indenting by expression
1761 'insertmode' off do not start in Insert mode
1762 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1763 characters and '_'
1764 'joinspaces' on insert 2 spaces after period
1765 'modeline' + off no modelines
1766 'more' + off no pauses in listings
1767 'revins' off no reverse insert
1768 'ruler' off no ruler
1769 'scrolljump' 1 no jump scroll
1770 'scrolloff' 0 no scroll offset
1771 'shiftround' off indent not rounded to shiftwidth
1772 'shortmess' + "" no shortening of messages
1773 'showcmd' + off command characters not shown
1774 'showmode' + off current mode not shown
1775 'smartcase' off no automatic ignore case switch
1776 'smartindent' off no smart indentation
1777 'smarttab' off no smart tab size
1778 'softtabstop' 0 tabs are always 'tabstop' positions
1779 'startofline' on goto startofline with some commands
1780 'tagrelative' + off tag file names are not relative
1781 'textauto' + off no automatic textmode detection
1782 'textwidth' 0 no automatic line wrap
1783 'tildeop' off tilde is not an operator
1784 'ttimeout' off no terminal timeout
1785 'whichwrap' + "" left-right movements don't wrap
1786 'wildchar' + CTRL-E only when the current value is <Tab>
1787 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001788 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001789
1790 *'complete'* *'cpt'* *E535*
1791'complete' 'cpt' string (default: ".,w,b,u,t,i")
1792 local to buffer
1793 {not in Vi}
1794 This option specifies how keyword completion |ins-completion| works
1795 when CTRL-P or CTRL-N are used. It is also used for whole-line
1796 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1797 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001798 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 w scan buffers from other windows
1800 b scan other loaded buffers that are in the buffer list
1801 u scan the unloaded buffers that are in the buffer list
1802 U scan the buffers that are not in the buffer list
1803 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001804 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 k{dict} scan the file {dict}. Several "k" flags can be given,
1806 patterns are valid too. For example: >
1807 :set cpt=k/usr/dict/*,k~/spanish
1808< s scan the files given with the 'thesaurus' option
1809 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1810 are valid too.
1811 i scan current and included files
1812 d scan current and included files for defined name or macro
1813 |i_CTRL-X_CTRL-D|
1814 ] tag completion
1815 t same as "]"
1816
1817 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1818 not executed, this may lead to unexpected completions from some files
1819 (gzipped files for example). Unloaded buffers are not scanned for
1820 whole-line completion.
1821
1822 The default is ".,w,b,u,t,i", which means to scan:
1823 1. the current buffer
1824 2. buffers in other windows
1825 3. other loaded buffers
1826 4. unloaded buffers
1827 5. tags
1828 6. included files
1829
1830 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001831 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1832 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001834 *'completefunc'* *'cfu'*
1835'completefunc' 'cfu' string (default: empty)
1836 local to buffer
1837 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001838 {not available when compiled without the |+eval|
1839 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001840 This option specifies a function to be used for Insert mode completion
1841 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001842 See |complete-functions| for an explanation of how the function is
1843 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001844 This option cannot be set from a |modeline| or in the |sandbox|, for
1845 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001846
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001847 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001848'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001849 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001850 {not available when compiled without the
1851 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001852 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001853 A comma separated list of options for Insert mode completion
1854 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001855
1856 menu Use a popup menu to show the possible completions. The
1857 menu is only shown when there is more than one match and
1858 sufficient colors are available. |ins-completion-menu|
1859
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001860 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001861 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001862 match, e.g., what file it comes from.
1863
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001864 longest Only insert the longest common text of the matches. If
1865 the menu is displayed you can use CTRL-L to add more
1866 characters. Whether case is ignored depends on the kind
1867 of completion. For buffer text the 'ignorecase' option is
1868 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001869
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001870 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001871 completion in the preview window. Only works in
1872 combination with "menu" or "menuone".
1873
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001874 noinsert Do not insert any text for a match until the user selects
1875 a match from the menu. Only works in combination with
1876 "menu" or "menuone". No effect if "longest" is present.
1877
1878 noselect Do not select a match in the menu, force the user to
1879 select one from the menu. Only works in combination with
1880 "menu" or "menuone".
1881
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001882
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001883 *'concealcursor'* *'cocu'*
1884'concealcursor' 'cocu' string (default: "")
1885 local to window
1886 {not in Vi}
1887 {not available when compiled without the |+conceal|
1888 feature}
1889 Sets the modes in which text in the cursor line can also be concealed.
1890 When the current mode is listed then concealing happens just like in
1891 other lines.
1892 n Normal mode
1893 v Visual mode
1894 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001895 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001896
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001897 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001898 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001899 are moving around text is concealed, but when starting to insert text
1900 or selecting a Visual area the concealed text is displayed, so that
1901 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001902 Keep in mind that the cursor position is not always where it's
1903 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001904
1905
1906'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001907 number (default 0)
1908 local to window
1909 {not in Vi}
1910 {not available when compiled without the |+conceal|
1911 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001912 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1913 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001914
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001915 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001916 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001917 1 Each block of concealed text is replaced with one
1918 character. If the syntax item does not have a custom
1919 replacement character defined (see |:syn-cchar|) the
1920 character defined in 'listchars' is used (default is a
1921 space).
1922 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001923 2 Concealed text is completely hidden unless it has a
1924 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001925 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001926 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001927
Bram Moolenaara7781e02010-07-19 20:13:22 +02001928 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001929 edit and copy the text. This can be changed with the 'concealcursor'
1930 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001931
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1933'confirm' 'cf' boolean (default off)
1934 global
1935 {not in Vi}
1936 When 'confirm' is on, certain operations that would normally
1937 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1938 instead raise a |dialog| asking if you wish to save the current
1939 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1940 If 'confirm' is off you can still activate confirmation for one
1941 command only (this is most useful in mappings) with the |:confirm|
1942 command.
1943 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1944
1945 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1946'conskey' 'consk' boolean (default off)
1947 global
1948 {not in Vi} {only for MS-DOS}
1949 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001950 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 three methods of console input are available:
1952 'conskey' 'bioskey' action ~
1953 on on or off direct console input
1954 off on BIOS
1955 off off STDIN
1956
1957 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1958'copyindent' 'ci' boolean (default off)
1959 local to buffer
1960 {not in Vi}
1961 Copy the structure of the existing lines indent when autoindenting a
1962 new line. Normally the new indent is reconstructed by a series of
1963 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1964 in which case only spaces are used). Enabling this option makes the
1965 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001966 existing line. 'expandtab' has no effect on these characters, a Tab
1967 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 line, the remaining space is filled in the normal manner.
1969 NOTE: 'copyindent' is reset when 'compatible' is set.
1970 Also see 'preserveindent'.
1971
1972 *'cpoptions'* *'cpo'*
1973'cpoptions' 'cpo' string (Vim default: "aABceFs",
1974 Vi default: all flags)
1975 global
1976 {not in Vi}
1977 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001978 this indicates Vi-compatible behavior. This is used for things where
1979 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 'cpoptions' stands for "compatible-options".
1981 Commas can be added for readability.
1982 To avoid problems with flags that are added in the future, use the
1983 "+=" and "-=" feature of ":set" |add-option-flags|.
1984 NOTE: This option is set to the Vi default value when 'compatible' is
1985 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001986 NOTE: This option is set to the POSIX default value at startup when
1987 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001988 variable exists |posix|. This means Vim tries to behave like the
1989 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990
1991 contains behavior ~
1992 *cpo-a*
1993 a When included, a ":read" command with a file name
1994 argument will set the alternate file name for the
1995 current window.
1996 *cpo-A*
1997 A When included, a ":write" command with a file name
1998 argument will set the alternate file name for the
1999 current window.
2000 *cpo-b*
2001 b "\|" in a ":map" command is recognized as the end of
2002 the map command. The '\' is included in the mapping,
2003 the text after the '|' is interpreted as the next
2004 command. Use a CTRL-V instead of a backslash to
2005 include the '|' in the mapping. Applies to all
2006 mapping, abbreviation, menu and autocmd commands.
2007 See also |map_bar|.
2008 *cpo-B*
2009 B A backslash has no special meaning in mappings,
2010 abbreviations and the "to" part of the menu commands.
2011 Remove this flag to be able to use a backslash like a
2012 CTRL-V. For example, the command ":map X \<Esc>"
2013 results in X being mapped to:
2014 'B' included: "\^[" (^[ is a real <Esc>)
2015 'B' excluded: "<Esc>" (5 characters)
2016 ('<' excluded in both cases)
2017 *cpo-c*
2018 c Searching continues at the end of any match at the
2019 cursor position, but not further than the start of the
2020 next line. When not present searching continues
2021 one character from the cursor position. With 'c'
2022 "abababababab" only gets three matches when repeating
2023 "/abab", without 'c' there are five matches.
2024 *cpo-C*
2025 C Do not concatenate sourced lines that start with a
2026 backslash. See |line-continuation|.
2027 *cpo-d*
2028 d Using "./" in the 'tags' option doesn't mean to use
2029 the tags file relative to the current file, but the
2030 tags file in the current directory.
2031 *cpo-D*
2032 D Can't use CTRL-K to enter a digraph after Normal mode
2033 commands with a character argument, like |r|, |f| and
2034 |t|.
2035 *cpo-e*
2036 e When executing a register with ":@r", always add a
2037 <CR> to the last line, also when the register is not
2038 linewise. If this flag is not present, the register
2039 is not linewise and the last line does not end in a
2040 <CR>, then the last line is put on the command-line
2041 and can be edited before hitting <CR>.
2042 *cpo-E*
2043 E It is an error when using "y", "d", "c", "g~", "gu" or
2044 "gU" on an Empty region. The operators only work when
2045 at least one character is to be operate on. Example:
2046 This makes "y0" fail in the first column.
2047 *cpo-f*
2048 f When included, a ":read" command with a file name
2049 argument will set the file name for the current buffer,
2050 if the current buffer doesn't have a file name yet.
2051 *cpo-F*
2052 F When included, a ":write" command with a file name
2053 argument will set the file name for the current
2054 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002055 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 *cpo-g*
2057 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002058 *cpo-H*
2059 H When using "I" on a line with only blanks, insert
2060 before the last blank. Without this flag insert after
2061 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 *cpo-i*
2063 i When included, interrupting the reading of a file will
2064 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002065 *cpo-I*
2066 I When moving the cursor up or down just after inserting
2067 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 *cpo-j*
2069 j When joining lines, only add two spaces after a '.',
2070 not after '!' or '?'. Also see 'joinspaces'.
2071 *cpo-J*
2072 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002073 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 white space.
2075 *cpo-k*
2076 k Disable the recognition of raw key codes in
2077 mappings, abbreviations, and the "to" part of menu
2078 commands. For example, if <Key> sends ^[OA (where ^[
2079 is <Esc>), the command ":map X ^[OA" results in X
2080 being mapped to:
2081 'k' included: "^[OA" (3 characters)
2082 'k' excluded: "<Key>" (one key code)
2083 Also see the '<' flag below.
2084 *cpo-K*
2085 K Don't wait for a key code to complete when it is
2086 halfway a mapping. This breaks mapping <F1><F1> when
2087 only part of the second <F1> has been read. It
2088 enables cancelling the mapping by typing <F1><Esc>.
2089 *cpo-l*
2090 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002091 literally, only "\]", "\^", "\-" and "\\" are special.
2092 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2094 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002095 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 *cpo-L*
2097 L When the 'list' option is set, 'wrapmargin',
2098 'textwidth', 'softtabstop' and Virtual Replace mode
2099 (see |gR|) count a <Tab> as two characters, instead of
2100 the normal behavior of a <Tab>.
2101 *cpo-m*
2102 m When included, a showmatch will always wait half a
2103 second. When not included, a showmatch will wait half
2104 a second or until a character is typed. |'showmatch'|
2105 *cpo-M*
2106 M When excluded, "%" matching will take backslashes into
2107 account. Thus in "( \( )" and "\( ( \)" the outer
2108 parenthesis match. When included "%" ignores
2109 backslashes, which is Vi compatible.
2110 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002111 n When included, the column used for 'number' and
2112 'relativenumber' will also be used for text of wrapped
2113 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 *cpo-o*
2115 o Line offset to search command is not remembered for
2116 next search.
2117 *cpo-O*
2118 O Don't complain if a file is being overwritten, even
2119 when it didn't exist when editing it. This is a
2120 protection against a file unexpectedly created by
2121 someone else. Vi didn't complain about this.
2122 *cpo-p*
2123 p Vi compatible Lisp indenting. When not present, a
2124 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002125 *cpo-P*
2126 P When included, a ":write" command that appends to a
2127 file will set the file name for the current buffer, if
2128 the current buffer doesn't have a file name yet and
2129 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002130 *cpo-q*
2131 q When joining multiple lines leave the cursor at the
2132 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-r*
2134 r Redo ("." command) uses "/" to repeat a search
2135 command, instead of the actually used search string.
2136 *cpo-R*
2137 R Remove marks from filtered lines. Without this flag
2138 marks are kept like |:keepmarks| was used.
2139 *cpo-s*
2140 s Set buffer options when entering the buffer for the
2141 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002142 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 set when the buffer is created.
2144 *cpo-S*
2145 S Set buffer options always when entering a buffer
2146 (except 'readonly', 'fileformat', 'filetype' and
2147 'syntax'). This is the (most) Vi compatible setting.
2148 The options are set to the values in the current
2149 buffer. When you change an option and go to another
2150 buffer, the value is copied. Effectively makes the
2151 buffer options global to all buffers.
2152
2153 's' 'S' copy buffer options
2154 no no when buffer created
2155 yes no when buffer first entered (default)
2156 X yes each time when buffer entered (vi comp.)
2157 *cpo-t*
2158 t Search pattern for the tag command is remembered for
2159 "n" command. Otherwise Vim only puts the pattern in
2160 the history for search pattern, but doesn't change the
2161 last used search pattern.
2162 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002163 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 *cpo-v*
2165 v Backspaced characters remain visible on the screen in
2166 Insert mode. Without this flag the characters are
2167 erased from the screen right away. With this flag the
2168 screen newly typed text overwrites backspaced
2169 characters.
2170 *cpo-w*
2171 w When using "cw" on a blank character, only change one
2172 character and not all blanks until the start of the
2173 next word.
2174 *cpo-W*
2175 W Don't overwrite a readonly file. When omitted, ":w!"
2176 overwrites a readonly file, if possible.
2177 *cpo-x*
2178 x <Esc> on the command-line executes the command-line.
2179 The default in Vim is to abandon the command-line,
2180 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002181 *cpo-X*
2182 X When using a count with "R" the replaced text is
2183 deleted only once. Also when repeating "R" with "."
2184 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 *cpo-y*
2186 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002187 *cpo-Z*
2188 Z When using "w!" while the 'readonly' option is set,
2189 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 *cpo-!*
2191 ! When redoing a filter command, use the last used
2192 external command, whatever it was. Otherwise the last
2193 used -filter- command is used.
2194 *cpo-$*
2195 $ When making a change to one line, don't redisplay the
2196 line, but put a '$' at the end of the changed text.
2197 The changed text will be overwritten when you type the
2198 new text. The line is redisplayed if you type any
2199 command that moves the cursor from the insertion
2200 point.
2201 *cpo-%*
2202 % Vi-compatible matching is done for the "%" command.
2203 Does not recognize "#if", "#endif", etc.
2204 Does not recognize "/*" and "*/".
2205 Parens inside single and double quotes are also
2206 counted, causing a string that contains a paren to
2207 disturb the matching. For example, in a line like
2208 "if (strcmp("foo(", s))" the first paren does not
2209 match the last one. When this flag is not included,
2210 parens inside single and double quotes are treated
2211 specially. When matching a paren outside of quotes,
2212 everything inside quotes is ignored. When matching a
2213 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002214 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002215 This flag is also used for other features, such as
2216 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002217 *cpo--*
2218 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002219 it would go above the first line or below the last
2220 line. Without it the cursor moves to the first or
2221 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002222 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002223 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002224 *cpo-+*
2225 + When included, a ":write file" command will reset the
2226 'modified' flag of the buffer, even though the buffer
2227 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002228 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229 * Use ":*" in the same way as ":@". When not included,
2230 ":*" is an alias for ":'<,'>", select the Visual area.
2231 *cpo-<*
2232 < Disable the recognition of special key codes in |<>|
2233 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002234 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 ":map X <Tab>" results in X being mapped to:
2236 '<' included: "<Tab>" (5 characters)
2237 '<' excluded: "^I" (^I is a real <Tab>)
2238 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002239 *cpo->*
2240 > When appending to a register, put a line break before
2241 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002242 *cpo-;*
2243 ; When using |,| or |;| to repeat the last |t| search
2244 and the cursor is right in front of the searched
2245 character, the cursor won't move. When not included,
2246 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002247 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002248
2249 POSIX flags. These are not included in the Vi default value, except
2250 when $VIM_POSIX was set on startup. |posix|
2251
2252 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002253 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002255 *cpo-&*
2256 & When ":preserve" was used keep the swap file when
2257 exiting normally while this buffer is still loaded.
2258 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002259 *cpo-\*
2260 \ Backslash in a [] range in a search pattern is taken
2261 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002262 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2263 '\' excluded: "/[ \-]" finds <Space> and '-'
2264 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002265 *cpo-/*
2266 / When "%" is used as the replacement string in a |:s|
2267 command, use the previous replacement string. |:s%|
2268 *cpo-{*
2269 { The |{| and |}| commands also stop at a "{" character
2270 at the start of a line.
2271 *cpo-.*
2272 . The ":chdir" and ":cd" commands fail if the current
2273 buffer is modified, unless ! is used. Vim doesn't
2274 need this, since it remembers the full path of an
2275 opened file.
2276 *cpo-bar*
2277 | The value of the $LINES and $COLUMNS environment
2278 variables overrule the terminal size values obtained
2279 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002280
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002282 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002283'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002284 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002285 {not in Vi}
2286 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002287 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002288 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002289 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002290 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002291 blowfish Blowfish method. Medium strong encryption but it has
2292 an implementation flaw. Requires Vim 7.3 or later,
2293 files can NOT be read by Vim 7.2 and older. This adds
2294 a "seed" to the file, every time you write the file
2295 the encrypted bytes will be different.
2296 *blowfish2*
2297 blowfish2 Blowfish method. Medium strong encryption. Requires
2298 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2299 and older. This adds a "seed" to the file, every time
2300 you write the file the encrypted bytes will be
2301 different. The whole undo file is encrypted, not just
2302 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002303
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002304 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002305 to the detected method of the file being read. Thus if you write it
2306 without changing 'cryptmethod' the same method will be used.
2307 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002308 explicitly write it, you don't get a warning unless there are other
2309 modifications. Also see |:X|.
2310
2311 When setting the global value to an empty string, it will end up with
2312 the value "zip". When setting the local value to an empty string the
2313 buffer will use the global value.
2314
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002315 When a new encryption method is added in a later version of Vim, and
2316 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002317 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002318
2319
Bram Moolenaar071d4272004-06-13 20:20:40 +00002320 *'cscopepathcomp'* *'cspc'*
2321'cscopepathcomp' 'cspc' number (default 0)
2322 global
2323 {not available when compiled without the |+cscope|
2324 feature}
2325 {not in Vi}
2326 Determines how many components of the path to show in a list of tags.
2327 See |cscopepathcomp|.
2328
2329 *'cscopeprg'* *'csprg'*
2330'cscopeprg' 'csprg' string (default "cscope")
2331 global
2332 {not available when compiled without the |+cscope|
2333 feature}
2334 {not in Vi}
2335 Specifies the command to execute cscope. See |cscopeprg|.
2336 This option cannot be set from a |modeline| or in the |sandbox|, for
2337 security reasons.
2338
2339 *'cscopequickfix'* *'csqf'*
2340'cscopequickfix' 'csqf' string (default "")
2341 global
2342 {not available when compiled without the |+cscope|
2343 or |+quickfix| features}
2344 {not in Vi}
2345 Specifies whether to use quickfix window to show cscope results.
2346 See |cscopequickfix|.
2347
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002348 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002349'cscoperelative' 'csre' boolean (default off)
2350 global
2351 {not available when compiled without the |+cscope|
2352 feature}
2353 {not in Vi}
2354 In the absence of a prefix (-P) for cscope. setting this option enables
2355 to use the basename of cscope.out path as the prefix.
2356 See |cscoperelative|.
2357
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2359'cscopetag' 'cst' boolean (default off)
2360 global
2361 {not available when compiled without the |+cscope|
2362 feature}
2363 {not in Vi}
2364 Use cscope for tag commands. See |cscope-options|.
2365 NOTE: This option is reset when 'compatible' is set.
2366
2367 *'cscopetagorder'* *'csto'*
2368'cscopetagorder' 'csto' number (default 0)
2369 global
2370 {not available when compiled without the |+cscope|
2371 feature}
2372 {not in Vi}
2373 Determines the order in which ":cstag" performs a search. See
2374 |cscopetagorder|.
2375 NOTE: This option is set to 0 when 'compatible' is set.
2376
2377 *'cscopeverbose'* *'csverb'*
2378 *'nocscopeverbose'* *'nocsverb'*
2379'cscopeverbose' 'csverb' boolean (default off)
2380 global
2381 {not available when compiled without the |+cscope|
2382 feature}
2383 {not in Vi}
2384 Give messages when adding a cscope database. See |cscopeverbose|.
2385 NOTE: This option is reset when 'compatible' is set.
2386
Bram Moolenaar860cae12010-06-05 23:22:07 +02002387 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2388'cursorbind' 'crb' boolean (default off)
2389 local to window
2390 {not in Vi}
2391 {not available when compiled without the |+cursorbind|
2392 feature}
2393 When this option is set, as the cursor in the current
2394 window moves other cursorbound windows (windows that also have
2395 this option set) move their cursors to the corresponding line and
2396 column. This option is useful for viewing the
2397 differences between two versions of a file (see 'diff'); in diff mode,
2398 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002399 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002400
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002401
2402 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2403'cursorcolumn' 'cuc' boolean (default off)
2404 local to window
2405 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002406 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002407 feature}
2408 Highlight the screen column of the cursor with CursorColumn
2409 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2410 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002411 If you only want the highlighting in the current window you can use
2412 these autocommands: >
2413 au WinLeave * set nocursorline nocursorcolumn
2414 au WinEnter * set cursorline cursorcolumn
2415<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002416
2417 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2418'cursorline' 'cul' boolean (default off)
2419 local to window
2420 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002421 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002422 feature}
2423 Highlight the screen line of the cursor with CursorLine
2424 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2425 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002426 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002427 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002428
2429
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 *'debug'*
2431'debug' string (default "")
2432 global
2433 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002434 These values can be used:
2435 msg Error messages that would otherwise be omitted will be given
2436 anyway.
2437 throw Error messages that would otherwise be omitted will be given
2438 anyway and also throw an exception and set |v:errmsg|.
2439 beep A message will be given when otherwise only a beep would be
2440 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002441 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002442 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2443 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444
2445 *'define'* *'def'*
2446'define' 'def' string (default "^\s*#\s*define")
2447 global or local to buffer |global-local|
2448 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 pattern, just like for the "/" command. This option is used for the
2451 commands like "[i" and "[d" |include-search|. The 'isident' option is
2452 used to recognize the defined name after the match:
2453 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2454 See |option-backslash| about inserting backslashes to include a space
2455 or backslash.
2456 The default value is for C programs. For C++ this value would be
2457 useful, to include const type declarations: >
2458 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2459< When using the ":set" command, you need to double the backslashes!
2460
2461 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2462'delcombine' 'deco' boolean (default off)
2463 global
2464 {not in Vi}
2465 {only available when compiled with the |+multi_byte|
2466 feature}
2467 If editing Unicode and this option is set, backspace and Normal mode
2468 "x" delete each combining character on its own. When it is off (the
2469 default) the character along with its combining characters are
2470 deleted.
2471 Note: When 'delcombine' is set "xx" may work different from "2x"!
2472
2473 This is useful for Arabic, Hebrew and many other languages where one
2474 may have combining characters overtop of base characters, and want
2475 to remove only the combining ones.
2476
2477 *'dictionary'* *'dict'*
2478'dictionary' 'dict' string (default "")
2479 global or local to buffer |global-local|
2480 {not in Vi}
2481 List of file names, separated by commas, that are used to lookup words
2482 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2483 contain a list of words. This can be one word per line, or several
2484 words per line, separated by non-keyword characters (white space is
2485 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002486 When this option is empty, or an entry "spell" is present, spell
2487 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002488 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 after a comma are ignored, otherwise spaces are included in the file
2490 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002491 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 Where to find a list of words?
2493 - On FreeBSD, there is the file "/usr/share/dict/words".
2494 - In the Simtel archive, look in the "msdos/linguist" directory.
2495 - In "miscfiles" of the GNU collection.
2496 The use of |:set+=| and |:set-=| is preferred when adding or removing
2497 directories from the list. This avoids problems when a future version
2498 uses another default.
2499 Backticks cannot be used in this option for security reasons.
2500
2501 *'diff'* *'nodiff'*
2502'diff' boolean (default off)
2503 local to window
2504 {not in Vi}
2505 {not available when compiled without the |+diff|
2506 feature}
2507 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002508 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509
2510 *'dex'* *'diffexpr'*
2511'diffexpr' 'dex' string (default "")
2512 global
2513 {not in Vi}
2514 {not available when compiled without the |+diff|
2515 feature}
2516 Expression which is evaluated to obtain an ed-style diff file from two
2517 versions of a file. See |diff-diffexpr|.
2518 This option cannot be set from a |modeline| or in the |sandbox|, for
2519 security reasons.
2520
2521 *'dip'* *'diffopt'*
2522'diffopt' 'dip' string (default "filler")
2523 global
2524 {not in Vi}
2525 {not available when compiled without the |+diff|
2526 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 All are optional. Items must be separated by a comma.
2529
2530 filler Show filler lines, to keep the text
2531 synchronized with a window that has inserted
2532 lines at the same position. Mostly useful
2533 when windows are side-by-side and 'scrollbind'
2534 is set.
2535
2536 context:{n} Use a context of {n} lines between a change
2537 and a fold that contains unchanged lines.
2538 When omitted a context of six lines is used.
2539 See |fold-diff|.
2540
2541 icase Ignore changes in case of text. "a" and "A"
2542 are considered the same. Adds the "-i" flag
2543 to the "diff" command if 'diffexpr' is empty.
2544
2545 iwhite Ignore changes in amount of white space. Adds
2546 the "-b" flag to the "diff" command if
2547 'diffexpr' is empty. Check the documentation
2548 of the "diff" command for what this does
2549 exactly. It should ignore adding trailing
2550 white space, but not leading white space.
2551
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002552 horizontal Start diff mode with horizontal splits (unless
2553 explicitly specified otherwise).
2554
2555 vertical Start diff mode with vertical splits (unless
2556 explicitly specified otherwise).
2557
2558 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2559 starting diff mode. Without this 2 is used.
2560
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 Examples: >
2562
2563 :set diffopt=filler,context:4
2564 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002565 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566<
2567 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2568'digraph' 'dg' boolean (default off)
2569 global
2570 {not in Vi}
2571 {not available when compiled without the |+digraphs|
2572 feature}
2573 Enable the entering of digraphs in Insert mode with {char1} <BS>
2574 {char2}. See |digraphs|.
2575 NOTE: This option is reset when 'compatible' is set.
2576
2577 *'directory'* *'dir'*
2578'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002579 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 for Unix: ".,~/tmp,/var/tmp,/tmp")
2581 global
2582 List of directory names for the swap file, separated with commas.
2583 - The swap file will be created in the first directory where this is
2584 possible.
2585 - Empty means that no swap file will be used (recovery is
2586 impossible!).
2587 - A directory "." means to put the swap file in the same directory as
2588 the edited file. On Unix, a dot is prepended to the file name, so
2589 it doesn't show in a directory listing. On MS-Windows the "hidden"
2590 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002591 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 put the swap file relative to where the edited file is. The leading
2593 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002594 - For Unix and Win32, if a directory ends in two path separators "//"
2595 or "\\", the swap file name will be built from the complete path to
2596 the file with all path separators substituted to percent '%' signs.
2597 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002598 On Win32, when a separating comma is following, you must use "//",
2599 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 - Spaces after the comma are ignored, other spaces are considered part
2601 of the directory name. To have a space at the start of a directory
2602 name, precede it with a backslash.
2603 - To include a comma in a directory name precede it with a backslash.
2604 - A directory name may end in an ':' or '/'.
2605 - Environment variables are expanded |:set_env|.
2606 - Careful with '\' characters, type one before a space, type two to
2607 get one in the option (see |option-backslash|), for example: >
2608 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2609< - For backwards compatibility with Vim version 3.0 a '>' at the start
2610 of the option is removed.
2611 Using "." first in the list is recommended. This means that editing
2612 the same file twice will result in a warning. Using "/tmp" on Unix is
2613 discouraged: When the system crashes you lose the swap file.
2614 "/var/tmp" is often not cleared when rebooting, thus is a better
2615 choice than "/tmp". But it can contain a lot of files, your swap
2616 files get lost in the crowd. That is why a "tmp" directory in your
2617 home directory is tried first.
2618 The use of |:set+=| and |:set-=| is preferred when adding or removing
2619 directories from the list. This avoids problems when a future version
2620 uses another default.
2621 This option cannot be set from a |modeline| or in the |sandbox|, for
2622 security reasons.
2623 {Vi: directory to put temp file in, defaults to "/tmp"}
2624
2625 *'display'* *'dy'*
2626'display' 'dy' string (default "")
2627 global
2628 {not in Vi}
2629 Change the way text is displayed. This is comma separated list of
2630 flags:
2631 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 last line that doesn't fit is replaced with "@" lines.
2634 uhex Show unprintable characters hexadecimal as <xx>
2635 instead of using ^C and ~C.
2636
2637 *'eadirection'* *'ead'*
2638'eadirection' 'ead' string (default "both")
2639 global
2640 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002641 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 feature}
2643 Tells when the 'equalalways' option applies:
2644 ver vertically, width of windows is not affected
2645 hor horizontally, height of windows is not affected
2646 both width and height of windows is affected
2647
2648 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2649'edcompatible' 'ed' boolean (default off)
2650 global
2651 Makes the 'g' and 'c' flags of the ":substitute" command to be
2652 toggled each time the flag is given. See |complex-change|. See
2653 also 'gdefault' option.
2654 Switching this option on is discouraged!
2655
2656 *'encoding'* *'enc'* *E543*
2657'encoding' 'enc' string (default: "latin1" or value from $LANG)
2658 global
2659 {only available when compiled with the |+multi_byte|
2660 feature}
2661 {not in Vi}
2662 Sets the character encoding used inside Vim. It applies to text in
2663 the buffers, registers, Strings in expressions, text stored in the
2664 viminfo file, etc. It sets the kind of characters which Vim can work
2665 with. See |encoding-names| for the possible values.
2666
2667 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002668 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002670 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
Bram Moolenaar865242e2010-07-14 21:12:05 +02002672 This option cannot be set from a |modeline|. It would most likely
2673 corrupt the text.
2674
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2676 "utf-8". Although care has been taken to allow different values of
2677 'encoding', "utf-8" is the natural choice for the environment and
2678 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002679 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 versions, and to avoid changing the encoding of newly created files
2681 without your knowledge (in case 'fileencodings' is empty).
2682
2683 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002684 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 iconv() or as specified with 'charconvert'.
2686
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002687 If you need to know whether 'encoding' is a multi-byte encoding, you
2688 can use: >
2689 if has("multi_byte_encoding")
2690<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 Normally 'encoding' will be equal to your current locale. This will
2692 be the default if Vim recognizes your environment settings. If
2693 'encoding' is not set to the current locale, 'termencoding' must be
2694 set to convert typed and displayed text. See |encoding-table|.
2695
2696 When you set this option, it fires the |EncodingChanged| autocommand
2697 event so that you can set up fonts if necessary.
2698
2699 When the option is set, the value is converted to lowercase. Thus
2700 you can set it with uppercase values too. Underscores are translated
2701 to '-' signs.
2702 When the encoding is recognized, it is changed to the standard name.
2703 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2704 "iso-8859-2" and "utf8" becomes "utf-8".
2705
2706 Note: "latin1" is also used when the encoding could not be detected.
2707 This only works when editing files in the same encoding! When the
2708 actual character set is not latin1, make sure 'fileencoding' and
2709 'fileencodings' are empty. When conversion is needed, switch to using
2710 utf-8.
2711
2712 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2713 You don't notice this while editing, but it does matter for the
2714 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2715 setting 'encoding' to one of these values instead of utf-8 only has
2716 effect for encoding used for files when 'fileencoding' is empty.
2717
Bram Moolenaar661b1822005-07-28 22:36:45 +00002718 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2719 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
2721 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2722'endofline' 'eol' boolean (default on)
2723 local to buffer
2724 {not in Vi}
2725 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002726 is on, or 'fixeol' option is off, no <EOL> will be written for the
2727 last line in the file. This option is automatically set or reset when
2728 starting to edit a new file, depending on whether file has an <EOL>
2729 for the last line in the file. Normally you don't have to set or
2730 reset this option.
2731 When 'binary' is off and 'fixeol' is on the value is not used when
2732 writing the file. When 'binary' is on or 'fixeol' is off it is used
2733 to remember the presence of a <EOL> for the last line in the file, so
2734 that when you write the file the situation from the original file can
2735 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736
2737 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2738'equalalways' 'ea' boolean (default on)
2739 global
2740 {not in Vi}
2741 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002742 splitting or closing a window. This also happens the moment the
2743 option is switched on. When off, splitting a window will reduce the
2744 size of the current window and leave the other windows the same. When
2745 closing a window the extra lines are given to the window next to it
2746 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 When mixing vertically and horizontally split windows, a minimal size
2748 is computed and some windows may be larger if there is room. The
2749 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002750 Changing the height and width of a window can be avoided by setting
2751 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002752 If a window size is specified when creating a new window sizes are
2753 currently not equalized (it's complicated, but may be implemented in
2754 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755
2756 *'equalprg'* *'ep'*
2757'equalprg' 'ep' string (default "")
2758 global or local to buffer |global-local|
2759 {not in Vi}
2760 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002761 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002762 or 'indentexpr'. When Vim was compiled without internal formatting,
2763 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002764 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 about including spaces and backslashes.
2766 This option cannot be set from a |modeline| or in the |sandbox|, for
2767 security reasons.
2768
2769 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2770'errorbells' 'eb' boolean (default off)
2771 global
2772 Ring the bell (beep or screen flash) for error messages. This only
2773 makes a difference for error messages, the bell will be used always
2774 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002775 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002776 screen flash or do nothing. See 'belloff' to finetune when to ring the
2777 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778
2779 *'errorfile'* *'ef'*
2780'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2781 others: "errors.err")
2782 global
2783 {not in Vi}
2784 {not available when compiled without the |+quickfix|
2785 feature}
2786 Name of the errorfile for the QuickFix mode (see |:cf|).
2787 When the "-q" command-line argument is used, 'errorfile' is set to the
2788 following argument. See |-q|.
2789 NOT used for the ":make" command. See 'makeef' for that.
2790 Environment variables are expanded |:set_env|.
2791 See |option-backslash| about including spaces and backslashes.
2792 This option cannot be set from a |modeline| or in the |sandbox|, for
2793 security reasons.
2794
2795 *'errorformat'* *'efm'*
2796'errorformat' 'efm' string (default is very long)
2797 global or local to buffer |global-local|
2798 {not in Vi}
2799 {not available when compiled without the |+quickfix|
2800 feature}
2801 Scanf-like description of the format for the lines in the error file
2802 (see |errorformat|).
2803
2804 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2805'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2806 global
2807 {not in Vi}
2808 Function keys that start with an <Esc> are recognized in Insert
2809 mode. When this option is off, the cursor and function keys cannot be
2810 used in Insert mode if they start with an <Esc>. The advantage of
2811 this is that the single <Esc> is recognized immediately, instead of
2812 after one second. Instead of resetting this option, you might want to
2813 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2814 when 'esckeys' is off, you can still map anything, but the cursor keys
2815 won't work by default.
2816 NOTE: This option is set to the Vi default value when 'compatible' is
2817 set and to the Vim default value when 'compatible' is reset.
2818
2819 *'eventignore'* *'ei'*
2820'eventignore' 'ei' string (default "")
2821 global
2822 {not in Vi}
2823 {not available when compiled without the |+autocmd|
2824 feature}
2825 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002826 When set to "all" or when "all" is one of the items, all autocommand
2827 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 Otherwise this is a comma separated list of event names. Example: >
2829 :set ei=WinEnter,WinLeave
2830<
2831 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2832'expandtab' 'et' boolean (default off)
2833 local to buffer
2834 {not in Vi}
2835 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002836 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2838 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002839 This option is reset when the 'paste' option is set and restored when
2840 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 NOTE: This option is reset when 'compatible' is set.
2842
2843 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2844'exrc' 'ex' boolean (default off)
2845 global
2846 {not in Vi}
2847 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2848 directory. If you switch this option on you should also consider
2849 setting the 'secure' option (see |initialization|). Using a local
2850 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2851 also see |.vimrc| and |gui-init|.
2852 This option cannot be set from a |modeline| or in the |sandbox|, for
2853 security reasons.
2854
2855 *'fileencoding'* *'fenc'* *E213*
2856'fileencoding' 'fenc' string (default: "")
2857 local to buffer
2858 {only available when compiled with the |+multi_byte|
2859 feature}
2860 {not in Vi}
2861 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002862
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002864 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 When 'fileencoding' is empty, the same value as 'encoding' will be
2866 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002867 Conversion will also be done when 'encoding' and 'fileencoding' are
2868 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2869 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002871 'encoding' is "utf-8" or another Unicode encoding, conversion
2872 is most likely done in a way that the reverse conversion
2873 results in the same text. When 'encoding' is not "utf-8" some
2874 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002875
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 See 'encoding' for the possible values. Additionally, values may be
2877 specified that can be handled by the converter, see
2878 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002879
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 When reading a file 'fileencoding' will be set from 'fileencodings'.
2881 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002882 'fileencoding', use the |++enc| argument. One exception: when
2883 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002884 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002885
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2887 When the option is set, the value is converted to lowercase. Thus
2888 you can set it with uppercase values too. '_' characters are
2889 replaced with '-'. If a name is recognized from the list for
2890 'encoding', it is replaced by the standard name. For example
2891 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002892
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 When this option is set, after starting to edit a file, the 'modified'
2894 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002895
2896 Keep in mind that changing 'fenc' from a modeline happens
2897 AFTER the text has been read, thus it applies to when the file will be
2898 written. If you do set 'fenc' in a modeline, you might want to set
2899 'nomodified' to avoid not being able to ":q".
2900
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 This option can not be changed when 'modifiable' is off.
2902
2903 *'fe'*
2904 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002905 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 old short name was 'fe', which is no longer used.
2907
2908 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002909'fileencodings' 'fencs' string (default: "ucs-bom",
2910 "ucs-bom,utf-8,default,latin1" when
2911 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 global
2913 {only available when compiled with the |+multi_byte|
2914 feature}
2915 {not in Vi}
2916 This is a list of character encodings considered when starting to edit
2917 an existing file. When a file is read, Vim tries to use the first
2918 mentioned character encoding. If an error is detected, the next one
2919 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002920 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 an empty string, which means the value of 'encoding' is used.
2922 WARNING: Conversion can cause loss of information! When
2923 'encoding' is "utf-8" (or one of the other Unicode variants)
2924 conversion is most likely done in a way that the reverse
2925 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002926 "utf-8" some non-ASCII characters may be lost! You can use
2927 the |++bad| argument to specify what is done with characters
2928 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 For an empty file or a file with only ASCII characters most encodings
2930 will work and the first entry of 'fileencodings' will be used (except
2931 "ucs-bom", which requires the BOM to be present). If you prefer
2932 another encoding use an BufReadPost autocommand event to test if your
2933 preferred encoding is to be used. Example: >
2934 au BufReadPost * if search('\S', 'w') == 0 |
2935 \ set fenc=iso-2022-jp | endif
2936< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2937 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002938 When the |++enc| argument is used then the value of 'fileencodings' is
2939 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002940 Note that 'fileencodings' is not used for a new file, the global value
2941 of 'fileencoding' is used instead. You can set it with: >
2942 :setglobal fenc=iso-8859-2
2943< This means that a non-existing file may get a different encoding than
2944 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 The special value "ucs-bom" can be used to check for a Unicode BOM
2946 (Byte Order Mark) at the start of the file. It must not be preceded
2947 by "utf-8" or another Unicode encoding for this to work properly.
2948 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2949 because Vim cannot detect an error, thus the encoding is always
2950 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002951 The special value "default" can be used for the encoding from the
2952 environment. This is the default value for 'encoding'. It is useful
2953 when 'encoding' is set to "utf-8" and your environment uses a
2954 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002955 When 'encoding' is "utf-8" and a file contains an illegal byte
2956 sequence it won't be recognized as UTF-8. You can use the |8g8|
2957 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 WRONG VALUES: WHAT'S WRONG:
2959 latin1,utf-8 "latin1" will always be used
2960 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2961 file
2962 cp1250,latin1 "cp1250" will always be used
2963 If 'fileencodings' is empty, 'fileencoding' is not modified.
2964 See 'fileencoding' for the possible values.
2965 Setting this option does not have an effect until the next time a file
2966 is read.
2967
2968 *'fileformat'* *'ff'*
2969'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2970 Unix default: "unix",
2971 Macintosh default: "mac")
2972 local to buffer
2973 {not in Vi}
2974 This gives the <EOL> of the current buffer, which is used for
2975 reading/writing the buffer from/to a file:
2976 dos <CR> <NL>
2977 unix <NL>
2978 mac <CR>
2979 When "dos" is used, CTRL-Z at the end of a file is ignored.
2980 See |file-formats| and |file-read|.
2981 For the character encoding of the file see 'fileencoding'.
2982 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002983 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984 This option is set automatically when starting to edit a file and
2985 'fileformats' is not empty and 'binary' is off.
2986 When this option is set, after starting to edit a file, the 'modified'
2987 option is set, because the file would be different when written.
2988 This option can not be changed when 'modifiable' is off.
2989 For backwards compatibility: When this option is set to "dos",
2990 'textmode' is set, otherwise 'textmode' is reset.
2991
2992 *'fileformats'* *'ffs'*
2993'fileformats' 'ffs' string (default:
2994 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2995 Vim Unix: "unix,dos",
2996 Vim Mac: "mac,unix,dos",
2997 Vi Cygwin: "unix,dos",
2998 Vi others: "")
2999 global
3000 {not in Vi}
3001 This gives the end-of-line (<EOL>) formats that will be tried when
3002 starting to edit a new buffer and when reading a file into an existing
3003 buffer:
3004 - When empty, the format defined with 'fileformat' will be used
3005 always. It is not set automatically.
3006 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003007 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 'fileformats' name will be used when a file is read into an existing
3009 buffer, no matter what 'fileformat' for that buffer is set to.
3010 - When more than one name is present, separated by commas, automatic
3011 <EOL> detection will be done when reading a file. When starting to
3012 edit a file, a check is done for the <EOL>:
3013 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3014 'fileformat' is set to "dos".
3015 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003016 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003018 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3019 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003020 This means that "mac" is only chosen when:
3021 "unix" is not present or no <NL> is found in the file, and
3022 "dos" is not present or no <CR><NL> is found in the file.
3023 Except: if "unix" was chosen, but there is a <CR> before
3024 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003025 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 4. If 'fileformat' is still not set, the first name from
3027 'fileformats' is used.
3028 When reading a file into an existing buffer, the same is done, but
3029 this happens like 'fileformat' has been set appropriately for that
3030 file only, the option is not changed.
3031 When 'binary' is set, the value of 'fileformats' is not used.
3032
Bram Moolenaar81af9252010-12-10 20:35:50 +01003033 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01003034 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003035
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3037 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3038 done:
3039 - When 'fileformats' is empty, there is no automatic detection. Dos
3040 format will be used.
3041 - When 'fileformats' is set to one or more names, automatic detection
3042 is done. This is based on the first <NL> in the file: If there is a
3043 <CR> in front of it, Dos format is used, otherwise Unix format is
3044 used.
3045 Also see |file-formats|.
3046 For backwards compatibility: When this option is set to an empty
3047 string or one format (no comma is included), 'textauto' is reset,
3048 otherwise 'textauto' is set.
3049 NOTE: This option is set to the Vi default value when 'compatible' is
3050 set and to the Vim default value when 'compatible' is reset.
3051
Bram Moolenaarbf884932013-04-05 22:26:15 +02003052 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3053'fileignorecase' 'fic' boolean (default on for systems where case in file
3054 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003055 global
3056 {not in Vi}
3057 When set case is ignored when using file names and directories.
3058 See 'wildignorecase' for only ignoring case when doing completion.
3059
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 *'filetype'* *'ft'*
3061'filetype' 'ft' string (default: "")
3062 local to buffer
3063 {not in Vi}
3064 {not available when compiled without the |+autocmd|
3065 feature}
3066 When this option is set, the FileType autocommand event is triggered.
3067 All autocommands that match with the value of this option will be
3068 executed. Thus the value of 'filetype' is used in place of the file
3069 name.
3070 Otherwise this option does not always reflect the current file type.
3071 This option is normally set when the file type is detected. To enable
3072 this use the ":filetype on" command. |:filetype|
3073 Setting this option to a different value is most useful in a modeline,
3074 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003075 Example, for in an IDL file:
3076 /* vim: set filetype=idl : */ ~
3077 |FileType| |filetypes|
3078 When a dot appears in the value then this separates two filetype
3079 names. Example:
3080 /* vim: set filetype=c.doxygen : */ ~
3081 This will use the "c" filetype first, then the "doxygen" filetype.
3082 This works both for filetype plugins and for syntax files. More than
3083 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 This option is not copied to another buffer, independent of the 's' or
3085 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003086 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
3088 *'fillchars'* *'fcs'*
3089'fillchars' 'fcs' string (default "vert:|,fold:-")
3090 global
3091 {not in Vi}
3092 {not available when compiled without the |+windows|
3093 and |+folding| features}
3094 Characters to fill the statuslines and vertical separators.
3095 It is a comma separated list of items:
3096
3097 item default Used for ~
3098 stl:c ' ' or '^' statusline of the current window
3099 stlnc:c ' ' or '-' statusline of the non-current windows
3100 vert:c '|' vertical separators |:vsplit|
3101 fold:c '-' filling 'foldtext'
3102 diff:c '-' deleted lines of the 'diff' option
3103
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003104 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 "stlnc" the space will be used when there is highlighting, '^' or '-'
3106 otherwise.
3107
3108 Example: >
3109 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3110< This is similar to the default, except that these characters will also
3111 be used when there is highlighting.
3112
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003113 for "stl" and "stlnc" only single-byte values are supported.
3114
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 The highlighting used for these items:
3116 item highlight group ~
3117 stl:c StatusLine |hl-StatusLine|
3118 stlnc:c StatusLineNC |hl-StatusLineNC|
3119 vert:c VertSplit |hl-VertSplit|
3120 fold:c Folded |hl-Folded|
3121 diff:c DiffDelete |hl-DiffDelete|
3122
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003123 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3124'fixendofline' 'fixeol' boolean (default on)
3125 local to buffer
3126 {not in Vi}
3127 When writing a file and this option is on, <EOL> at the end of file
3128 will be restored if missing. Turn this option off if you want to
3129 preserve the situation from the original file.
3130 When the 'binary' option is set the value of this option doesn't
3131 matter.
3132 See the 'endofline' option.
3133
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3135'fkmap' 'fk' boolean (default off) *E198*
3136 global
3137 {not in Vi}
3138 {only available when compiled with the |+rightleft|
3139 feature}
3140 When on, the keyboard is mapped for the Farsi character set.
3141 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003142 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143
3144 *'foldclose'* *'fcl'*
3145'foldclose' 'fcl' string (default "")
3146 global
3147 {not in Vi}
3148 {not available when compiled without the |+folding|
3149 feature}
3150 When set to "all", a fold is closed when the cursor isn't in it and
3151 its level is higher than 'foldlevel'. Useful if you want folds to
3152 automatically close when moving out of them.
3153
3154 *'foldcolumn'* *'fdc'*
3155'foldcolumn' 'fdc' number (default 0)
3156 local to window
3157 {not in Vi}
3158 {not available when compiled without the |+folding|
3159 feature}
3160 When non-zero, a column with the specified width is shown at the side
3161 of the window which indicates open and closed folds. The maximum
3162 value is 12.
3163 See |folding|.
3164
3165 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3166'foldenable' 'fen' boolean (default on)
3167 local to window
3168 {not in Vi}
3169 {not available when compiled without the |+folding|
3170 feature}
3171 When off, all folds are open. This option can be used to quickly
3172 switch between showing all text unfolded and viewing the text with
3173 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003174 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 'foldenable' is off.
3176 This option is set by commands that create a new fold or close a fold.
3177 See |folding|.
3178
3179 *'foldexpr'* *'fde'*
3180'foldexpr' 'fde' string (default: "0")
3181 local to window
3182 {not in Vi}
3183 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003184 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003185 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003186 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003187
Bram Moolenaar30b65812012-07-12 22:01:11 +02003188 The expression will be evaluated in the |sandbox| if set from a
3189 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003190 This option can't be set from a |modeline| when the 'diff' option is
3191 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003192
3193 It is not allowed to change text or jump to another window while
3194 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195
3196 *'foldignore'* *'fdi'*
3197'foldignore' 'fdi' string (default: "#")
3198 local to window
3199 {not in Vi}
3200 {not available when compiled without the |+folding|
3201 feature}
3202 Used only when 'foldmethod' is "indent". Lines starting with
3203 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003204 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 The default "#" works well for C programs. See |fold-indent|.
3206
3207 *'foldlevel'* *'fdl'*
3208'foldlevel' 'fdl' number (default: 0)
3209 local to window
3210 {not in Vi}
3211 {not available when compiled without the |+folding|
3212 feature}
3213 Sets the fold level: Folds with a higher level will be closed.
3214 Setting this option to zero will close all folds. Higher numbers will
3215 close fewer folds.
3216 This option is set by commands like |zm|, |zM| and |zR|.
3217 See |fold-foldlevel|.
3218
3219 *'foldlevelstart'* *'fdls'*
3220'foldlevelstart' 'fdls' number (default: -1)
3221 global
3222 {not in Vi}
3223 {not available when compiled without the |+folding|
3224 feature}
3225 Sets 'foldlevel' when starting to edit another buffer in a window.
3226 Useful to always start editing with all folds closed (value zero),
3227 some folds closed (one) or no folds closed (99).
3228 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003229 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 ignores this option and closes all folds.
3231 It is also done before BufReadPre autocommands, to allow an autocmd to
3232 overrule the 'foldlevel' value for specific files.
3233 When the value is negative, it is not used.
3234
3235 *'foldmarker'* *'fmr'* *E536*
3236'foldmarker' 'fmr' string (default: "{{{,}}}")
3237 local to window
3238 {not in Vi}
3239 {not available when compiled without the |+folding|
3240 feature}
3241 The start and end marker used when 'foldmethod' is "marker". There
3242 must be one comma, which separates the start and end marker. The
3243 marker is a literal string (a regular expression would be too slow).
3244 See |fold-marker|.
3245
3246 *'foldmethod'* *'fdm'*
3247'foldmethod' 'fdm' string (default: "manual")
3248 local to window
3249 {not in Vi}
3250 {not available when compiled without the |+folding|
3251 feature}
3252 The kind of folding used for the current window. Possible values:
3253 |fold-manual| manual Folds are created manually.
3254 |fold-indent| indent Lines with equal indent form a fold.
3255 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3256 |fold-marker| marker Markers are used to specify folds.
3257 |fold-syntax| syntax Syntax highlighting items specify folds.
3258 |fold-diff| diff Fold text that is not changed.
3259
3260 *'foldminlines'* *'fml'*
3261'foldminlines' 'fml' number (default: 1)
3262 local to window
3263 {not in Vi}
3264 {not available when compiled without the |+folding|
3265 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003266 Sets the number of screen lines above which a fold can be displayed
3267 closed. Also for manually closed folds. With the default value of
3268 one a fold can only be closed if it takes up two or more screen lines.
3269 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003270 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 "zc" to close a fold, which is displayed open because it's smaller
3272 than 'foldminlines', a following "zc" may close a containing fold.
3273
3274 *'foldnestmax'* *'fdn'*
3275'foldnestmax' 'fdn' number (default: 20)
3276 local to window
3277 {not in Vi}
3278 {not available when compiled without the |+folding|
3279 feature}
3280 Sets the maximum nesting of folds for the "indent" and "syntax"
3281 methods. This avoids that too many folds will be created. Using more
3282 than 20 doesn't work, because the internal limit is 20.
3283
3284 *'foldopen'* *'fdo'*
3285'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3286 search,tag,undo")
3287 global
3288 {not in Vi}
3289 {not available when compiled without the |+folding|
3290 feature}
3291 Specifies for which type of commands folds will be opened, if the
3292 command moves the cursor into a closed fold. It is a comma separated
3293 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003294 NOTE: When the command is part of a mapping this option is not used.
3295 Add the |zv| command to the mapping to get the same effect.
3296 (rationale: the mapping may want to control opening folds itself)
3297
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 item commands ~
3299 all any
3300 block "(", "{", "[[", "[{", etc.
3301 hor horizontal movements: "l", "w", "fx", etc.
3302 insert any command in Insert mode
3303 jump far jumps: "G", "gg", etc.
3304 mark jumping to a mark: "'m", CTRL-O, etc.
3305 percent "%"
3306 quickfix ":cn", ":crew", ":make", etc.
3307 search search for a pattern: "/", "n", "*", "gd", etc.
3308 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003309 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 tag jumping to a tag: ":ta", CTRL-T, etc.
3311 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 When a movement command is used for an operator (e.g., "dl" or "y%")
3313 this option is not used. This means the operator will include the
3314 whole closed fold.
3315 Note that vertical movements are not here, because it would make it
3316 very difficult to move onto a closed fold.
3317 In insert mode the folds containing the cursor will always be open
3318 when text is inserted.
3319 To close folds you can re-apply 'foldlevel' with the |zx| command or
3320 set the 'foldclose' option to "all".
3321
3322 *'foldtext'* *'fdt'*
3323'foldtext' 'fdt' string (default: "foldtext()")
3324 local to window
3325 {not in Vi}
3326 {not available when compiled without the |+folding|
3327 feature}
3328 An expression which is used to specify the text displayed for a closed
3329 fold. See |fold-foldtext|.
3330
Bram Moolenaar30b65812012-07-12 22:01:11 +02003331 The expression will be evaluated in the |sandbox| if set from a
3332 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003333
3334 It is not allowed to change text or jump to another window while
3335 evaluating 'foldtext' |textlock|.
3336
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 *'formatoptions'* *'fo'*
3338'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3339 local to buffer
3340 {not in Vi}
3341 This is a sequence of letters which describes how automatic
3342 formatting is to be done. See |fo-table|. When the 'paste' option is
3343 on, no formatting is done (like 'formatoptions' is empty). Commas can
3344 be inserted for readability.
3345 To avoid problems with flags that are added in the future, use the
3346 "+=" and "-=" feature of ":set" |add-option-flags|.
3347 NOTE: This option is set to the Vi default value when 'compatible' is
3348 set and to the Vim default value when 'compatible' is reset.
3349
Bram Moolenaar86b68352004-12-27 21:59:20 +00003350 *'formatlistpat'* *'flp'*
3351'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3352 local to buffer
3353 {not in Vi}
3354 A pattern that is used to recognize a list header. This is used for
3355 the "n" flag in 'formatoptions'.
3356 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003357 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003358 while still checking more characters. There must be a character
3359 following the pattern, when it matches the whole line it is handled
3360 like there is no match.
3361 The default recognizes a number, followed by an optional punctuation
3362 character and white space.
3363
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 *'formatprg'* *'fp'*
3365'formatprg' 'fp' string (default "")
3366 global
3367 {not in Vi}
3368 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003369 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003371 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003372 If the 'formatexpr' option is not empty it will be used instead.
3373 Otherwise, if 'formatprg' option is an empty string, the internal
3374 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003375 Environment variables are expanded |:set_env|. See |option-backslash|
3376 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003377 This option cannot be set from a |modeline| or in the |sandbox|, for
3378 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003380 *'formatexpr'* *'fex'*
3381'formatexpr' 'fex' string (default "")
3382 local to buffer
3383 {not in Vi}
3384 {not available when compiled without the |+eval|
3385 feature}
3386 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003387 operator or automatic formatting (see 'formatoptions'). When this
3388 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003389
3390 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003391 The |v:count| variable holds the number of lines to be formatted.
3392 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003393 inserted if the expression is being evaluated due to
3394 automatic formatting. This can be empty. Don't insert
3395 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003396
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003397 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003398 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003399< This will invoke the mylang#Format() function in the
3400 autoload/mylang.vim file in 'runtimepath'. |autoload|
3401
3402 The expression is also evaluated when 'textwidth' is set and adding
3403 text beyond that limit. This happens under the same conditions as
3404 when internal formatting is used. Make sure the cursor is kept in the
3405 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003406 return "i" or "R" in this situation.
3407
3408 When the expression evaluates to non-zero Vim will fall back to using
3409 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003410
Bram Moolenaar30b65812012-07-12 22:01:11 +02003411 The expression will be evaluated in the |sandbox| when set from a
3412 modeline, see |sandbox-option|. That stops the option from working,
3413 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003414
3415 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003416'fsync' 'fs' boolean (default on)
3417 global
3418 {not in Vi}
3419 When on, the library function fsync() will be called after writing a
3420 file. This will flush a file to disk, ensuring that it is safely
3421 written even on filesystems which do metadata-only journaling. This
3422 will force the harddrive to spin up on Linux systems running in laptop
3423 mode, so it may be undesirable in some situations. Be warned that
3424 turning this off increases the chances of data loss after a crash. On
3425 systems without an fsync() implementation, this variable is always
3426 off.
3427 Also see 'swapsync' for controlling fsync() on swap files.
3428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3430'gdefault' 'gd' boolean (default off)
3431 global
3432 {not in Vi}
3433 When on, the ":substitute" flag 'g' is default on. This means that
3434 all matches in a line are substituted instead of one. When a 'g' flag
3435 is given to a ":substitute" command, this will toggle the substitution
3436 of all or one match. See |complex-change|.
3437
3438 command 'gdefault' on 'gdefault' off ~
3439 :s/// subst. all subst. one
3440 :s///g subst. one subst. all
3441 :s///gg subst. all subst. one
3442
3443 NOTE: This option is reset when 'compatible' is set.
3444
3445 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003446'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 global
3448 {not in Vi}
3449 Format to recognize for the ":grep" command output.
3450 This is a scanf-like string that uses the same format as the
3451 'errorformat' option: see |errorformat|.
3452
3453 *'grepprg'* *'gp'*
3454'grepprg' 'gp' string (default "grep -n ",
3455 Unix: "grep -n $* /dev/null",
3456 Win32: "findstr /n" or "grep -n",
3457 VMS: "SEARCH/NUMBERS ")
3458 global or local to buffer |global-local|
3459 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003460 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 and '#' characters, which are expanded like when used in a command-
3462 line. The placeholder "$*" is allowed to specify where the arguments
3463 will be included. Environment variables are expanded |:set_env|. See
3464 |option-backslash| about including spaces and backslashes.
3465 When your "grep" accepts the "-H" argument, use this to make ":grep"
3466 also work well with a single file: >
3467 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003468< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003469 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3470 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003471 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 apply equally to 'grepprg'.
3473 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3474 otherwise it's "grep -n".
3475 This option cannot be set from a |modeline| or in the |sandbox|, for
3476 security reasons.
3477
3478 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3479'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3480 ve:ver35-Cursor,
3481 o:hor50-Cursor,
3482 i-ci:ver25-Cursor/lCursor,
3483 r-cr:hor20-Cursor/lCursor,
3484 sm:block-Cursor
3485 -blinkwait175-blinkoff150-blinkon175",
3486 for MS-DOS and Win32 console:
3487 "n-v-c:block,o:hor50,i-ci:hor15,
3488 r-cr:hor30,sm:block")
3489 global
3490 {not in Vi}
3491 {only available when compiled with GUI enabled, and
3492 for MS-DOS and Win32 console}
3493 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003494 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 the height of the cursor can be changed. This can be done by
3496 specifying a block cursor, or a percentage for a vertical or
3497 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003498 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3499 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003501 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 mode-list and an argument-list:
3503 mode-list:argument-list,mode-list:argument-list,..
3504 The mode-list is a dash separated list of these modes:
3505 n Normal mode
3506 v Visual mode
3507 ve Visual mode with 'selection' "exclusive" (same as 'v',
3508 if not specified)
3509 o Operator-pending mode
3510 i Insert mode
3511 r Replace mode
3512 c Command-line Normal (append) mode
3513 ci Command-line Insert mode
3514 cr Command-line Replace mode
3515 sm showmatch in Insert mode
3516 a all modes
3517 The argument-list is a dash separated list of these arguments:
3518 hor{N} horizontal bar, {N} percent of the character height
3519 ver{N} vertical bar, {N} percent of the character width
3520 block block cursor, fills the whole character
3521 [only one of the above three should be present]
3522 blinkwait{N} *cursor-blinking*
3523 blinkon{N}
3524 blinkoff{N}
3525 blink times for cursor: blinkwait is the delay before
3526 the cursor starts blinking, blinkon is the time that
3527 the cursor is shown and blinkoff is the time that the
3528 cursor is not shown. The times are in msec. When one
3529 of the numbers is zero, there is no blinking. The
3530 default is: "blinkwait700-blinkon400-blinkoff250".
3531 These numbers are used for a missing entry. This
3532 means that blinking is enabled by default. To switch
3533 blinking off you can use "blinkon0". The cursor only
3534 blinks when Vim is waiting for input, not while
3535 executing a command.
3536 To make the cursor blink in an xterm, see
3537 |xterm-blink|.
3538 {group-name}
3539 a highlight group name, that sets the color and font
3540 for the cursor
3541 {group-name}/{group-name}
3542 Two highlight group names, the first is used when
3543 no language mappings are used, the other when they
3544 are. |language-mapping|
3545
3546 Examples of parts:
3547 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3548 block cursor with colors from the "nCursor"
3549 highlight group
3550 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3551 In Insert and Command-line Insert mode, use a
3552 30% vertical bar cursor with colors from the
3553 "iCursor" highlight group. Blink a bit
3554 faster.
3555
3556 The 'a' mode is different. It will set the given argument-list for
3557 all modes. It does not reset anything to defaults. This can be used
3558 to do a common setting for all modes. For example, to switch off
3559 blinking: "a:blinkon0"
3560
3561 Examples of cursor highlighting: >
3562 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3563 :highlight Cursor gui=NONE guifg=bg guibg=fg
3564<
3565 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003566 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567'guifont' 'gfn' string (default "")
3568 global
3569 {not in Vi}
3570 {only available when compiled with GUI enabled}
3571 This is a list of fonts which will be used for the GUI version of Vim.
3572 In its simplest form the value is just one font name. When
3573 the font cannot be found you will get an error message. To try other
3574 font names a list can be specified, font names separated with commas.
3575 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003576
Bram Moolenaar05159a02005-02-26 23:04:13 +00003577 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3578 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003579
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 Spaces after a comma are ignored. To include a comma in a font name
3581 precede it with a backslash. Setting an option requires an extra
3582 backslash before a space and a backslash. See also
3583 |option-backslash|. For example: >
3584 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003585< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003587
3588 If none of the fonts can be loaded, Vim will keep the current setting.
3589 If an empty font list is given, Vim will try using other resource
3590 settings (for X, it will use the Vim.font resource), and finally it
3591 will try some builtin default which should always be there ("7x13" in
3592 the case of X). The font names given should be "normal" fonts. Vim
3593 will try to find the related bold and italic fonts.
3594
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003595 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003596 :set guifont=*
3597< will bring up a font requester, where you can pick the font you want.
3598
3599 The font name depends on the GUI used. See |setting-guifont| for a
3600 way to set 'guifont' for various systems.
3601
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 For the GTK+ 2 GUI the font name looks like this: >
3603 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003604< That's all. XLFDs are not used. For Chinese this is reported to work
3605 well: >
3606 if has("gui_gtk2")
3607 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3608 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3609 endif
3610<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003611 For Mac OSX you can use something like this: >
3612 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003613< Also see 'macatsui', it can help fix display problems.
3614 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003616 width). An exception is GTK 2: all fonts are accepted, but
3617 mono-spaced fonts look best.
3618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 To preview a font on X11, you might be able to use the "xfontsel"
3620 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003621
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 For the Win32 GUI *E244* *E245*
3623 - takes these options in the font name:
3624 hXX - height is XX (points, can be floating-point)
3625 wXX - width is XX (points, can be floating-point)
3626 b - bold
3627 i - italic
3628 u - underline
3629 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003630 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3632 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3633 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003634 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635
3636 Use a ':' to separate the options.
3637 - A '_' can be used in the place of a space, so you don't need to use
3638 backslashes to escape the spaces.
3639 - Examples: >
3640 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3641 :set guifont=Andale_Mono:h7.5:w4.5
3642< See also |font-sizes|.
3643
3644 *'guifontset'* *'gfs'*
3645 *E250* *E252* *E234* *E597* *E598*
3646'guifontset' 'gfs' string (default "")
3647 global
3648 {not in Vi}
3649 {only available when compiled with GUI enabled and
3650 with the |+xfontset| feature}
3651 {not available in the GTK+ 2 GUI}
3652 When not empty, specifies two (or more) fonts to be used. The first
3653 one for normal English, the second one for your special language. See
3654 |xfontset|.
3655 Setting this option also means that all font names will be handled as
3656 a fontset name. Also the ones used for the "font" argument of the
3657 |:highlight| command.
3658 The fonts must match with the current locale. If fonts for the
3659 character sets that the current locale uses are not included, setting
3660 'guifontset' will fail.
3661 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3662 the comma-separated names are alternative names, one of which will be
3663 used. In 'guifontset' the whole string is one fontset name,
3664 including the commas. It is not possible to specify alternative
3665 fontset names.
3666 This example works on many X11 systems: >
3667 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3668<
3669 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3670'guifontwide' 'gfw' string (default "")
3671 global
3672 {not in Vi}
3673 {only available when compiled with GUI enabled}
3674 When not empty, specifies a comma-separated list of fonts to be used
3675 for double-width characters. The first font that can be loaded is
3676 used.
3677 Note: The size of these fonts must be exactly twice as wide as the one
3678 specified with 'guifont' and the same height.
3679
3680 All GUI versions but GTK+ 2:
3681
3682 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3683 'guifontset' is empty or invalid.
3684 When 'guifont' is set and a valid font is found in it and
3685 'guifontwide' is empty Vim will attempt to find a matching
3686 double-width font and set 'guifontwide' to it.
3687
3688 GTK+ 2 GUI only: *guifontwide_gtk2*
3689
3690 If set and valid, 'guifontwide' is always used for double width
3691 characters, even if 'encoding' is not set to "utf-8".
3692 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003693 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 font for characters not available in 'guifont'. Thus you do not need
3695 to set 'guifontwide' at all unless you want to override the choice
3696 made by Pango/Xft.
3697
Bram Moolenaar0f272122013-01-23 18:37:40 +01003698 Windows +multibyte only: *guifontwide_win_mbyte*
3699
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003700 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003701
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 *'guiheadroom'* *'ghr'*
3703'guiheadroom' 'ghr' number (default 50)
3704 global
3705 {not in Vi} {only for GTK and X11 GUI}
3706 The number of pixels subtracted from the screen height when fitting
3707 the GUI window on the screen. Set this before the GUI is started,
3708 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003709 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 lines will be left for window decorations and other items on the
3711 screen. Set it to a negative value to allow windows taller than the
3712 screen.
3713
3714 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003715'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3716 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 global
3718 {not in Vi}
3719 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003720 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 sequence of letters which describes what components and options of the
3722 GUI should be used.
3723 To avoid problems with flags that are added in the future, use the
3724 "+=" and "-=" feature of ":set" |add-option-flags|.
3725
3726 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003727 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'a' Autoselect: If present, then whenever VISUAL mode is started,
3729 or the Visual area extended, Vim tries to become the owner of
3730 the windowing system's global selection. This means that the
3731 Visually highlighted text is available for pasting into other
3732 applications as well as into Vim itself. When the Visual mode
3733 ends, possibly due to an operation on the text, or when an
3734 application wants to paste the selection, the highlighted text
3735 is automatically yanked into the "* selection register.
3736 Thus the selection is still available for pasting into other
3737 applications after the VISUAL mode has ended.
3738 If not present, then Vim won't become the owner of the
3739 windowing system's global selection unless explicitly told to
3740 by a yank or delete operation for the "* register.
3741 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003742 *'go-P'*
3743 'P' Like autoselect but using the "+ register instead of the "*
3744 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003745 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003746 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 applies to the modeless selection.
3748
3749 'guioptions' autoselect Visual autoselect modeless ~
3750 "" - -
3751 "a" yes yes
3752 "A" - yes
3753 "aA" yes yes
3754
Bram Moolenaar02467872007-05-06 13:22:01 +00003755 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 'c' Use console dialogs instead of popup dialogs for simple
3757 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003758 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003759 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003760 'guitablabel' can be used to change the text in the labels.
3761 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003762 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003763 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003764 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 'f' Foreground: Don't use fork() to detach the GUI from the shell
3766 where it was started. Use this for programs that wait for the
3767 editor to finish (e.g., an e-mail program). Alternatively you
3768 can use "gvim -f" or ":gui -f" to start the GUI in the
3769 foreground. |gui-fork|
3770 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003771 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3774 corner of the window. It's black&white on non-GTK, because of
3775 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003776 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003778 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003779 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003781 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 file is sourced the system menu has already been loaded; the
3783 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003784 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 'g' Grey menu items: Make menu items that are not active grey. If
3786 'g' is not included inactive menu items are not shown at all.
3787 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003788 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 't' Include tearoff menu items. Currently only works for Win32,
3790 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003791 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003792 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003793 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003794 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003796 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 'R' Right-hand scrollbar is present when there is a vertically
3798 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003799 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003801 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'L' Left-hand scrollbar is present when there is a vertically
3803 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003804 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3806 the longest visible line, or on the cursor line if the 'h'
3807 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003808 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'h' Limit horizontal scrollbar size to the length of the cursor
3810 line. Reduces computations. |gui-horiz-scroll|
3811
3812 And yes, you may even have scrollbars on the left AND the right if
3813 you really want to :-). See |gui-scrollbars| for more information.
3814
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003815 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 'v' Use a vertical button layout for dialogs. When not included,
3817 a horizontal layout is preferred, but when it doesn't fit a
3818 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003819 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 'p' Use Pointer callbacks for X11 GUI. This is required for some
3821 window managers. If the cursor is not blinking or hollow at
3822 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003823 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003825 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003826 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827
Bram Moolenaar02467872007-05-06 13:22:01 +00003828
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 *'guipty'* *'noguipty'*
3830'guipty' boolean (default on)
3831 global
3832 {not in Vi}
3833 {only available when compiled with GUI enabled}
3834 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3835 I/O to/from shell commands. See |gui-pty|.
3836
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003837 *'guitablabel'* *'gtl'*
3838'guitablabel' 'gtl' string (default empty)
3839 global
3840 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003841 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003842 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003844 pages line. When empty and when the result is empty Vim will use a
3845 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003846
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003847 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003848 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003849
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 Only used when the GUI tab pages line is displayed. 'e' must be
3851 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3852 used.
3853
Bram Moolenaar57657d82006-04-21 22:12:41 +00003854 *'guitabtooltip'* *'gtt'*
3855'guitabtooltip' 'gtt' string (default empty)
3856 global
3857 {not in Vi}
3858 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003859 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003860 When nonempty describes the text to use in a tooltip for the GUI tab
3861 pages line. When empty Vim will use a default tooltip.
3862 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003863 You can include a line break. Simplest method is to use |:let|: >
3864 :let &guitabtooltip = "line one\nline two"
3865<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003866
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 *'helpfile'* *'hf'*
3868'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3869 (others) "$VIMRUNTIME/doc/help.txt")
3870 global
3871 {not in Vi}
3872 Name of the main help file. All distributed help files should be
3873 placed together in one directory. Additionally, all "doc" directories
3874 in 'runtimepath' will be used.
3875 Environment variables are expanded |:set_env|. For example:
3876 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 spaces and backslashes.
3879 This option cannot be set from a |modeline| or in the |sandbox|, for
3880 security reasons.
3881
3882 *'helpheight'* *'hh'*
3883'helpheight' 'hh' number (default 20)
3884 global
3885 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003886 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 feature}
3888 Minimal initial height of the help window when it is opened with the
3889 ":help" command. The initial height of the help window is half of the
3890 current window, or (when the 'ea' option is on) the same as other
3891 windows. When the height is less than 'helpheight', the height is
3892 set to 'helpheight'. Set to zero to disable.
3893
3894 *'helplang'* *'hlg'*
3895'helplang' 'hlg' string (default: messages language or empty)
3896 global
3897 {only available when compiled with the |+multi_lang|
3898 feature}
3899 {not in Vi}
3900 Comma separated list of languages. Vim will use the first language
3901 for which the desired help can be found. The English help will always
3902 be used as a last resort. You can add "en" to prefer English over
3903 another language, but that will only find tags that exist in that
3904 language and not in the English help.
3905 Example: >
3906 :set helplang=de,it
3907< This will first search German, then Italian and finally English help
3908 files.
3909 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3910 try to find the tag in the current language before using this option.
3911 See |help-translated|.
3912
3913 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3914'hidden' 'hid' boolean (default off)
3915 global
3916 {not in Vi}
3917 When off a buffer is unloaded when it is |abandon|ed. When on a
3918 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3919 displayed in another window, it does not become hidden, of course.
3920 The commands that move through the buffer list sometimes make a buffer
3921 hidden although the 'hidden' option is off: When the buffer is
3922 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003923 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003924 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 This option is set for one command with ":hide {command}" |:hide|.
3926 WARNING: It's easy to forget that you have changes in hidden buffers.
3927 Think twice when using ":q!" or ":qa!".
3928
3929 *'highlight'* *'hl'*
3930'highlight' 'hl' string (default (as a single string):
3931 "8:SpecialKey,@:NonText,d:Directory,
3932 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003933 M:ModeMsg,n:LineNr,N:CursorLineNr,
3934 r:Question,s:StatusLine,S:StatusLineNC,
3935 c:VertSplit, t:Title,v:Visual,
3936 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003937 f:Folded,F:FoldColumn,A:DiffAdd,
3938 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003939 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003940 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003941 +:Pmenu,=:PmenuSel,
3942 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 global
3944 {not in Vi}
3945 This option can be used to set highlighting mode for various
3946 occasions. It is a comma separated list of character pairs. The
3947 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003948 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3950 |hl-NonText| @ '~' and '@' at the end of the window and
3951 characters from 'showbreak'
3952 |hl-Directory| d directories in CTRL-D listing and other special
3953 things in listings
3954 |hl-ErrorMsg| e error messages
3955 h (obsolete, ignored)
3956 |hl-IncSearch| i 'incsearch' highlighting
3957 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3958 |hl-MoreMsg| m |more-prompt|
3959 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003960 |hl-LineNr| n line number for ":number" and ":#" commands, and
3961 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003962 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3963 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 |hl-Question| r |hit-enter| prompt and yes/no questions
3965 |hl-StatusLine| s status line of current window |status-line|
3966 |hl-StatusLineNC| S status lines of not-current windows
3967 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3968 |hl-VertSplit| c column used to separate vertically split windows
3969 |hl-Visual| v Visual mode
3970 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3971 Selection" Only X11 Gui's |gui-x11| and
3972 |xterm-clipboard|.
3973 |hl-WarningMsg| w warning messages
3974 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3975 |hl-Folded| f line used for closed folds
3976 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003977 |hl-DiffAdd| A added line in diff mode
3978 |hl-DiffChange| C changed line in diff mode
3979 |hl-DiffDelete| D deleted line in diff mode
3980 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003982 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003983 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003984 |hl-SpellRare| R rare word |spell|
3985 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003986 |hl-Conceal| - the placeholders used for concealed characters
3987 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003988 |hl-Pmenu| + popup menu normal line
3989 |hl-PmenuSel| = popup menu normal line
3990 |hl-PmenuSbar| x popup menu scrollbar
3991 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992
3993 The display modes are:
3994 r reverse (termcap entry "mr" and "me")
3995 i italic (termcap entry "ZH" and "ZR")
3996 b bold (termcap entry "md" and "me")
3997 s standout (termcap entry "so" and "se")
3998 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003999 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 n no highlighting
4001 - no highlighting
4002 : use a highlight group
4003 The default is used for occasions that are not included.
4004 If you want to change what the display modes do, see |dos-colors|
4005 for an example.
4006 When using the ':' display mode, this must be followed by the name of
4007 a highlight group. A highlight group can be used to define any type
4008 of highlighting, including using color. See |:highlight| on how to
4009 define one. The default uses a different group for each occasion.
4010 See |highlight-default| for the default highlight groups.
4011
4012 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4013'hlsearch' 'hls' boolean (default off)
4014 global
4015 {not in Vi}
4016 {not available when compiled without the
4017 |+extra_search| feature}
4018 When there is a previous search pattern, highlight all its matches.
4019 The type of highlighting used can be set with the 'l' occasion in the
4020 'highlight' option. This uses the "Search" highlight group by
4021 default. Note that only the matching text is highlighted, any offsets
4022 are not applied.
4023 See also: 'incsearch' and |:match|.
4024 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004025 off with |:nohlsearch|. This does not change the option value, as
4026 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004027 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 When the search pattern can match an end-of-line, Vim will try to
4029 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004030 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004032 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004033 You can specify whether the highlight status is restored on startup
4034 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 NOTE: This option is reset when 'compatible' is set.
4036
4037 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004038'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 global
4040 {not in Vi}
4041 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004042 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004044 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 NOTE: This option is set to the Vi default value when 'compatible' is
4046 set and to the Vim default value when 'compatible' is reset.
4047
4048 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4049'hkmap' 'hk' boolean (default off)
4050 global
4051 {not in Vi}
4052 {only available when compiled with the |+rightleft|
4053 feature}
4054 When on, the keyboard is mapped for the Hebrew character set.
4055 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4056 toggle this option. See |rileft.txt|.
4057 NOTE: This option is reset when 'compatible' is set.
4058
4059 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4060'hkmapp' 'hkp' boolean (default off)
4061 global
4062 {not in Vi}
4063 {only available when compiled with the |+rightleft|
4064 feature}
4065 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4066 This is useful if you have a non-Hebrew keyboard.
4067 See |rileft.txt|.
4068 NOTE: This option is reset when 'compatible' is set.
4069
4070 *'icon'* *'noicon'*
4071'icon' boolean (default off, on when title can be restored)
4072 global
4073 {not in Vi}
4074 {not available when compiled without the |+title|
4075 feature}
4076 When on, the icon text of the window will be set to the value of
4077 'iconstring' (if it is not empty), or to the name of the file
4078 currently being edited. Only the last part of the name is used.
4079 Overridden by the 'iconstring' option.
4080 Only works if the terminal supports setting window icons (currently
4081 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4082 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4083 builtin termcap).
4084 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004085 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004087 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088
4089 *'iconstring'*
4090'iconstring' string (default "")
4091 global
4092 {not in Vi}
4093 {not available when compiled without the |+title|
4094 feature}
4095 When this option is not empty, it will be used for the icon text of
4096 the window. This happens only when the 'icon' option is on.
4097 Only works if the terminal supports setting window icon text
4098 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4099 Does not work for MS Windows.
4100 When Vim was compiled with HAVE_X11 defined, the original icon will be
4101 restored if possible |X11|.
4102 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 'titlestring' for example settings.
4105 {not available when compiled without the |+statusline| feature}
4106
4107 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4108'ignorecase' 'ic' boolean (default off)
4109 global
4110 Ignore case in search patterns. Also used when searching in the tags
4111 file.
4112 Also see 'smartcase'.
4113 Can be overruled by using "\c" or "\C" in the pattern, see
4114 |/ignorecase|.
4115
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004116 *'imactivatefunc'* *'imaf'*
4117'imactivatefunc' 'imaf' string (default "")
4118 global
4119 {not in Vi}
4120 {only available when compiled with |+xim| and
4121 |+GUI_GTK|}
4122 This option specifies a function that will be called to
4123 activate/inactivate Input Method.
4124
4125 Example: >
4126 function ImActivateFunc(active)
4127 if a:active
4128 ... do something
4129 else
4130 ... do something
4131 endif
4132 " return value is not used
4133 endfunction
4134 set imactivatefunc=ImActivateFunc
4135<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 *'imactivatekey'* *'imak'*
4137'imactivatekey' 'imak' string (default "")
4138 global
4139 {not in Vi}
4140 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004141 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 Specifies the key that your Input Method in X-Windows uses for
4143 activation. When this is specified correctly, vim can fully control
4144 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4145 You can't use this option to change the activation key, the option
4146 tells Vim what the key is.
4147 Format:
4148 [MODIFIER_FLAG-]KEY_STRING
4149
4150 These characters can be used for MODIFIER_FLAG (case is ignored):
4151 S Shift key
4152 L Lock key
4153 C Control key
4154 1 Mod1 key
4155 2 Mod2 key
4156 3 Mod3 key
4157 4 Mod4 key
4158 5 Mod5 key
4159 Combinations are allowed, for example "S-C-space" or "SC-space" are
4160 both shift+ctrl+space.
4161 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4162
4163 Example: >
4164 :set imactivatekey=S-space
4165< "S-space" means shift+space. This is the activation key for kinput2 +
4166 canna (Japanese), and ami (Korean).
4167
4168 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4169'imcmdline' 'imc' boolean (default off)
4170 global
4171 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004172 {only available when compiled with the |+xim|,
4173 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 When set the Input Method is always on when starting to edit a command
4175 line, unless entering a search pattern (see 'imsearch' for that).
4176 Setting this option is useful when your input method allows entering
4177 English characters directly, e.g., when it's used to type accented
4178 characters with dead keys.
4179
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004180 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4182 global
4183 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004184 {only available when compiled with the |+xim|,
4185 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 When set the Input Method is never used. This is useful to disable
4187 the IM when it doesn't work properly.
4188 Currently this option is on by default for SGI/IRIX machines. This
4189 may change in later releases.
4190
4191 *'iminsert'* *'imi'*
4192'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4193 local to buffer
4194 {not in Vi}
4195 Specifies whether :lmap or an Input Method (IM) is to be used in
4196 Insert mode. Valid values:
4197 0 :lmap is off and IM is off
4198 1 :lmap is ON and IM is off
4199 2 :lmap is off and IM is ON
4200 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4201 or |global-ime|.
4202 To always reset the option to zero when leaving Insert mode with <Esc>
4203 this can be used: >
4204 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4205< This makes :lmap and IM turn off automatically when leaving Insert
4206 mode.
4207 Note that this option changes when using CTRL-^ in Insert mode
4208 |i_CTRL-^|.
4209 The value is set to 1 when setting 'keymap' to a valid keymap name.
4210 It is also used for the argument of commands like "r" and "f".
4211 The value 0 may not work correctly with Athena and Motif with some XIM
4212 methods. Use 'imdisable' to disable XIM then.
4213
4214 *'imsearch'* *'ims'*
4215'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4216 local to buffer
4217 {not in Vi}
4218 Specifies whether :lmap or an Input Method (IM) is to be used when
4219 entering a search pattern. Valid values:
4220 -1 the value of 'iminsert' is used, makes it look like
4221 'iminsert' is also used when typing a search pattern
4222 0 :lmap is off and IM is off
4223 1 :lmap is ON and IM is off
4224 2 :lmap is off and IM is ON
4225 Note that this option changes when using CTRL-^ in Command-line mode
4226 |c_CTRL-^|.
4227 The value is set to 1 when it is not -1 and setting the 'keymap'
4228 option to a valid keymap name.
4229 The value 0 may not work correctly with Athena and Motif with some XIM
4230 methods. Use 'imdisable' to disable XIM then.
4231
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004232 *'imstatusfunc'* *'imsf'*
4233'imstatusfunc' 'imsf' string (default "")
4234 global
4235 {not in Vi}
4236 {only available when compiled with |+xim| and
4237 |+GUI_GTK|}
4238 This option specifies a function that is called to obtain the status
4239 of Input Method. It must return a positive number when IME is active.
4240
4241 Example: >
4242 function ImStatusFunc()
4243 let is_active = ...do something
4244 return is_active ? 1 : 0
4245 endfunction
4246 set imstatusfunc=ImStatusFunc
4247<
4248 NOTE: This function is invoked very often. Keep it fast.
4249
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 *'include'* *'inc'*
4251'include' 'inc' string (default "^\s*#\s*include")
4252 global or local to buffer |global-local|
4253 {not in Vi}
4254 {not available when compiled without the
4255 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004256 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 pattern, just like for the "/" command (See |pattern|). The default
4258 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004259 "]I", "[d", etc.
4260 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004261 comes after the matched pattern. But if "\zs" appears in the pattern
4262 then the text matched from "\zs" to the end, or until "\ze" if it
4263 appears, is used as the file name. Use this to include characters
4264 that are not in 'isfname', such as a space. You can then use
4265 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004266 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267
4268 *'includeexpr'* *'inex'*
4269'includeexpr' 'inex' string (default "")
4270 local to buffer
4271 {not in Vi}
4272 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004273 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004275 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 :set includeexpr=substitute(v:fname,'\\.','/','g')
4277< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004280 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 Also used for |<cfile>|.
4282
Bram Moolenaar30b65812012-07-12 22:01:11 +02004283 The expression will be evaluated in the |sandbox| when set from a
4284 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004285
4286 It is not allowed to change text or jump to another window while
4287 evaluating 'includeexpr' |textlock|.
4288
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4290'incsearch' 'is' boolean (default off)
4291 global
4292 {not in Vi}
4293 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004294 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004295 While typing a search command, show where the pattern, as it was typed
4296 so far, matches. The matched string is highlighted. If the pattern
4297 is invalid or not found, nothing is shown. The screen will be updated
4298 often, this is only useful on fast terminals.
4299 Note that the match will be shown, but the cursor will return to its
4300 original position when no match is found and when pressing <Esc>. You
4301 still need to finish the search command with <Enter> to move the
4302 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004303 When compiled with the |+reltime| feature Vim only searches for about
4304 half a second. With a complicated pattern and/or a lot of text the
4305 match may not be found. This is to avoid that Vim hangs while you
4306 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004307 The highlighting can be set with the 'i' flag in 'highlight'.
4308 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004309 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004310 to the command line. If 'ignorecase' and 'smartcase' are set and the
4311 command line has no uppercase characters, the added character is
4312 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004313 CTRL-R CTRL-W can be used to add the word at the end of the current
4314 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 NOTE: This option is reset when 'compatible' is set.
4316
4317 *'indentexpr'* *'inde'*
4318'indentexpr' 'inde' string (default "")
4319 local to buffer
4320 {not in Vi}
4321 {not available when compiled without the |+cindent|
4322 or |+eval| features}
4323 Expression which is evaluated to obtain the proper indent for a line.
4324 It is used when a new line is created, for the |=| operator and
4325 in Insert mode as specified with the 'indentkeys' option.
4326 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004327 'smartindent' indenting. When 'lisp' is set, this option is
4328 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 When 'paste' is set this option is not used for indenting.
4330 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004331 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 when the expression is evaluated (but it may be moved around).
4333 The expression must return the number of spaces worth of indent. It
4334 can return "-1" to keep the current indent (this means 'autoindent' is
4335 used for the indent).
4336 Functions useful for computing the indent are |indent()|, |cindent()|
4337 and |lispindent()|.
4338 The evaluation of the expression must not have side effects! It must
4339 not change the text, jump to another window, etc. Afterwards the
4340 cursor position is always restored, thus the cursor may be moved.
4341 Normally this option would be set to call a function: >
4342 :set indentexpr=GetMyIndent()
4343< Error messages will be suppressed, unless the 'debug' option contains
4344 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004345 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 NOTE: This option is made empty when 'compatible' is set.
4347
Bram Moolenaar30b65812012-07-12 22:01:11 +02004348 The expression will be evaluated in the |sandbox| when set from a
4349 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004350
4351 It is not allowed to change text or jump to another window while
4352 evaluating 'indentexpr' |textlock|.
4353
4354
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 *'indentkeys'* *'indk'*
4356'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4357 local to buffer
4358 {not in Vi}
4359 {not available when compiled without the |+cindent|
4360 feature}
4361 A list of keys that, when typed in Insert mode, cause reindenting of
4362 the current line. Only happens if 'indentexpr' isn't empty.
4363 The format is identical to 'cinkeys', see |indentkeys-format|.
4364 See |C-indenting| and |indent-expression|.
4365
4366 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4367'infercase' 'inf' boolean (default off)
4368 local to buffer
4369 {not in Vi}
4370 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004371 'ignorecase' is also on, the case of the match is adjusted depending
4372 on the typed text. If the typed text contains a lowercase letter
4373 where the match has an upper case letter, the completed part is made
4374 lowercase. If the typed text has no lowercase letters and the match
4375 has a lowercase letter where the typed text has an uppercase letter,
4376 and there is a letter before it, the completed part is made uppercase.
4377 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378
4379 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4380'insertmode' 'im' boolean (default off)
4381 global
4382 {not in Vi}
4383 Makes Vim work in a way that Insert mode is the default mode. Useful
4384 if you want to use Vim as a modeless editor. Used for |evim|.
4385 These Insert mode commands will be useful:
4386 - Use the cursor keys to move around.
4387 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4388 this is a mapping, it is executed as if 'insertmode' was off.
4389 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004391 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4392 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393
4394 These items change when 'insertmode' is set:
4395 - when starting to edit of a file, Vim goes to Insert mode.
4396 - <Esc> in Insert mode is a no-op and beeps.
4397 - <Esc> in Normal mode makes Vim go to Insert mode.
4398 - CTRL-L in Insert mode is a command, it is not inserted.
4399 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4400 However, when <Esc> is used inside a mapping, it behaves like
4401 'insertmode' was not set. This was done to be able to use the same
4402 mappings with 'insertmode' set or not set.
4403 When executing commands with |:normal| 'insertmode' is not used.
4404
4405 NOTE: This option is reset when 'compatible' is set.
4406
4407 *'isfname'* *'isf'*
4408'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4409 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4410 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4411 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4412 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4413 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4414 global
4415 {not in Vi}
4416 The characters specified by this option are included in file names and
4417 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004418 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 Multi-byte characters 256 and above are always included, only the
4420 characters up to 255 are specified with this option.
4421 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004422 Think twice before adding white space to this option. Although a
4423 space may appear inside a file name, the effect will be that Vim
4424 doesn't know where a file name starts or ends when doing completion.
4425 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426
4427 Note that on systems using a backslash as path separator, Vim tries to
4428 do its best to make it work as you would expect. That is a bit
4429 tricky, since Vi originally used the backslash to escape special
4430 characters. Vim will not remove a backslash in front of a normal file
4431 name character on these systems, but it will on Unix and alikes. The
4432 '&' and '^' are not included by default, because these are special for
4433 cmd.exe.
4434
4435 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004436 Each part can be a single character number or a range. A range is two
4437 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 decimal number between 0 and 255 or the ASCII character itself (does
4439 not work for digits). Example:
4440 "_,-,128-140,#-43" (include '_' and '-' and the range
4441 128 to 140 and '#' to 43)
4442 If a part starts with '^', the following character number or range
4443 will be excluded from the option. The option is interpreted from left
4444 to right. Put the excluded character after the range where it is
4445 included. To include '^' itself use it as the last character of the
4446 option or the end of a range. Example:
4447 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4448 If the character is '@', all characters where isalpha() returns TRUE
4449 are included. Normally these are the characters a to z and A to Z,
4450 plus accented characters. To include '@' itself use "@-@". Examples:
4451 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004452 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 "a-z,A-Z,@-@" All letters plus the '@' character.
4454 A comma can be included by using it where a character number is
4455 expected. Example:
4456 "48-57,,,_" Digits, comma and underscore.
4457 A comma can be excluded by prepending a '^'. Example:
4458 " -~,^,,9" All characters from space to '~', excluding
4459 comma, plus <Tab>.
4460 See |option-backslash| about including spaces and backslashes.
4461
4462 *'isident'* *'isi'*
4463'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4464 "@,48-57,_,128-167,224-235"
4465 otherwise: "@,48-57,_,192-255")
4466 global
4467 {not in Vi}
4468 The characters given by this option are included in identifiers.
4469 Identifiers are used in recognizing environment variables and after a
4470 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004471 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 option.
4473 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004474 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4476
4477 *'iskeyword'* *'isk'*
4478'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4479 "@,48-57,_,128-167,224-235"
4480 otherwise: "@,48-57,_,192-255"
4481 Vi default: "@,48-57,_")
4482 local to buffer
4483 {not in Vi}
4484 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004485 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 'isfname' for a description of the format of this option. For C
4487 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4488 For a help file it is set to all non-blank printable characters except
4489 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4490 command).
4491 When the 'lisp' option is on the '-' character is always included.
4492 NOTE: This option is set to the Vi default value when 'compatible' is
4493 set and to the Vim default value when 'compatible' is reset.
4494
4495 *'isprint'* *'isp'*
4496'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4497 "@,~-255"; otherwise: "@,161-255")
4498 global
4499 {not in Vi}
4500 The characters given by this option are displayed directly on the
4501 screen. It is also used for "\p" in a |pattern|. The characters from
4502 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4503 even when they are not included in 'isprint' or excluded. See
4504 'isfname' for a description of the format of this option.
4505
4506 Non-printable characters are displayed with two characters:
4507 0 - 31 "^@" - "^_"
4508 32 - 126 always single characters
4509 127 "^?"
4510 128 - 159 "~@" - "~_"
4511 160 - 254 "| " - "|~"
4512 255 "~?"
4513 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4514 displayed as <xx>, with the hexadecimal value of the byte.
4515 When 'display' contains "uhex" all unprintable characters are
4516 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004517 The SpecialKey highlighting will be used for unprintable characters.
4518 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519
4520 Multi-byte characters 256 and above are always included, only the
4521 characters up to 255 are specified with this option. When a character
4522 is printable but it is not available in the current font, a
4523 replacement character will be shown.
4524 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4525 There is no option to specify these characters.
4526
4527 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4528'joinspaces' 'js' boolean (default on)
4529 global
4530 {not in Vi}
4531 Insert two spaces after a '.', '?' and '!' with a join command.
4532 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4533 Otherwise only one space is inserted.
4534 NOTE: This option is set when 'compatible' is set.
4535
4536 *'key'*
4537'key' string (default "")
4538 local to buffer
4539 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004540 {only available when compiled with the |+cryptv|
4541 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004543 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004544 Careful: Do not set the key value by hand, someone might see the typed
4545 key. Use the |:X| command. But you can make 'key' empty: >
4546 :set key=
4547< It is not possible to get the value of this option with ":set key" or
4548 "echo &key". This is to avoid showing it to someone who shouldn't
4549 know. It also means you cannot see it yourself once you have set it,
4550 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004551 You can use "&key" in an expression to detect whether encryption is
4552 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553
4554 *'keymap'* *'kmp'* *E544*
4555'keymap' 'kmp' string (default "")
4556 local to buffer
4557 {not in Vi}
4558 {only available when compiled with the |+keymap|
4559 feature}
4560 Name of a keyboard mapping. See |mbyte-keymap|.
4561 Setting this option to a valid keymap name has the side effect of
4562 setting 'iminsert' to one, so that the keymap becomes effective.
4563 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004564 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565
4566 *'keymodel'* *'km'*
4567'keymodel' 'km' string (default "")
4568 global
4569 {not in Vi}
4570 List of comma separated words, which enable special things that keys
4571 can do. These values can be used:
4572 startsel Using a shifted special key starts selection (either
4573 Select mode or Visual mode, depending on "key" being
4574 present in 'selectmode').
4575 stopsel Using a not-shifted special key stops selection.
4576 Special keys in this context are the cursor keys, <End>, <Home>,
4577 <PageUp> and <PageDown>.
4578 The 'keymodel' option is set by the |:behave| command.
4579
4580 *'keywordprg'* *'kp'*
4581'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4582 OS/2: "view /", VMS: "help")
4583 global or local to buffer |global-local|
4584 {not in Vi}
4585 Program to use for the |K| command. Environment variables are
4586 expanded |:set_env|. ":help" may be used to access the Vim internal
4587 help. (Note that previously setting the global option to the empty
4588 value did this, which is now deprecated.)
4589 When "man" is used, Vim will automatically translate a count for the
4590 "K" command to a section number. Also for "man -s", in which case the
4591 "-s" is removed when there is no count.
4592 See |option-backslash| about including spaces and backslashes.
4593 Example: >
4594 :set keywordprg=man\ -s
4595< This option cannot be set from a |modeline| or in the |sandbox|, for
4596 security reasons.
4597
4598 *'langmap'* *'lmap'* *E357* *E358*
4599'langmap' 'lmap' string (default "")
4600 global
4601 {not in Vi}
4602 {only available when compiled with the |+langmap|
4603 feature}
4604 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004605 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 inserted directly. When in command mode the 'langmap' option takes
4607 care of translating these special characters to the original meaning
4608 of the key. This means you don't have to change the keyboard mode to
4609 be able to execute Normal mode commands.
4610 This is the opposite of the 'keymap' option, where characters are
4611 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004612 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4613 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004614 This option cannot be set from a |modeline| or in the |sandbox|, for
4615 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004617 Example (for Greek, in UTF-8): *greek* >
4618 :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 +00004619< Example (exchanges meaning of z and y for commands): >
4620 :set langmap=zy,yz,ZY,YZ
4621<
4622 The 'langmap' option is a list of parts, separated with commas. Each
4623 part can be in one of two forms:
4624 1. A list of pairs. Each pair is a "from" character immediately
4625 followed by the "to" character. Examples: "aA", "aAbBcC".
4626 2. A list of "from" characters, a semi-colon and a list of "to"
4627 characters. Example: "abc;ABC"
4628 Example: "aA,fgh;FGH,cCdDeE"
4629 Special characters need to be preceded with a backslash. These are
4630 ";", ',' and backslash itself.
4631
4632 This will allow you to activate vim actions without having to switch
4633 back and forth between the languages. Your language characters will
4634 be understood as normal vim English characters (according to the
4635 langmap mappings) in the following cases:
4636 o Normal/Visual mode (commands, buffer/register names, user mappings)
4637 o Insert/Replace Mode: Register names after CTRL-R
4638 o Insert/Replace Mode: Mappings
4639 Characters entered in Command-line mode will NOT be affected by
4640 this option. Note that this option can be changed at any time
4641 allowing to switch between mappings for different languages/encodings.
4642 Use a mapping to avoid having to type it each time!
4643
4644 *'langmenu'* *'lm'*
4645'langmenu' 'lm' string (default "")
4646 global
4647 {not in Vi}
4648 {only available when compiled with the |+menu| and
4649 |+multi_lang| features}
4650 Language to use for menu translation. Tells which file is loaded
4651 from the "lang" directory in 'runtimepath': >
4652 "lang/menu_" . &langmenu . ".vim"
4653< (without the spaces). For example, to always use the Dutch menus, no
4654 matter what $LANG is set to: >
4655 :set langmenu=nl_NL.ISO_8859-1
4656< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004657 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 If your $LANG is set to a non-English language but you do want to use
4659 the English menus: >
4660 :set langmenu=none
4661< This option must be set before loading menus, switching on filetype
4662 detection or syntax highlighting. Once the menus are defined setting
4663 this option has no effect. But you could do this: >
4664 :source $VIMRUNTIME/delmenu.vim
4665 :set langmenu=de_DE.ISO_8859-1
4666 :source $VIMRUNTIME/menu.vim
4667< Warning: This deletes all menus that you defined yourself!
4668
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004669 *'langnoremap'* *'lnr'*
4670'langnoremap' 'lnr' boolean (default off)
4671 global
4672 {not in Vi}
4673 {only available when compiled with the |+langmap|
4674 feature}
4675 When on, setting 'langmap' does not apply to characters resulting from
4676 a mapping. This basically means, if you noticed that setting
4677 'langmap' disables some of your mappings, try setting this option.
4678 This option defaults to off for backwards compatibility. Set it on if
4679 that works for you to avoid mappings to break.
4680
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 *'laststatus'* *'ls'*
4682'laststatus' 'ls' number (default 1)
4683 global
4684 {not in Vi}
4685 The value of this option influences when the last window will have a
4686 status line:
4687 0: never
4688 1: only if there are at least two windows
4689 2: always
4690 The screen looks nicer with a status line if you have several
4691 windows, but it takes another screen line. |status-line|
4692
4693 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4694'lazyredraw' 'lz' boolean (default off)
4695 global
4696 {not in Vi}
4697 When this option is set, the screen will not be redrawn while
4698 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004699 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 update use |:redraw|.
4701
4702 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4703'linebreak' 'lbr' boolean (default off)
4704 local to window
4705 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004706 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004708 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 than at the last character that fits on the screen. Unlike
4710 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004711 it only affects the way the file is displayed, not its contents.
4712 If 'breakindent' is set, line is visually indented. Then, the value
4713 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004714 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 Note that <Tab> characters after an <EOL> are mostly not displayed
4716 with the right amount of white space.
4717
4718 *'lines'* *E593*
4719'lines' number (default 24 or terminal height)
4720 global
4721 Number of lines of the Vim window.
4722 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004723 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 When Vim is running in the GUI or in a resizable window, setting this
4725 option will cause the window size to be changed. When you only want
4726 to use the size for the GUI, put the command in your |gvimrc| file.
4727 Vim limits the number of lines to what fits on the screen. You can
4728 use this command to get the tallest window possible: >
4729 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004730< Minimum value is 2, maximum value is 1000.
4731 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 When you set this option and Vim is unable to change the physical
4733 number of lines of the display, the display may be messed up.
4734
4735 *'linespace'* *'lsp'*
4736'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4737 global
4738 {not in Vi}
4739 {only in the GUI}
4740 Number of pixel lines inserted between characters. Useful if the font
4741 uses the full character cell height, making lines touch each other.
4742 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004743 With some fonts there can be too much room between lines (to have
4744 space for ascents and descents). Then it makes sense to set
4745 'linespace' to a negative value. This may cause display problems
4746 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
4748 *'lisp'* *'nolisp'*
4749'lisp' boolean (default off)
4750 local to buffer
4751 {not available when compiled without the |+lispindent|
4752 feature}
4753 Lisp mode: When <Enter> is typed in insert mode set the indent for
4754 the next line to Lisp standards (well, sort of). Also happens with
4755 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4756 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4757 better. Also see 'lispwords'.
4758 The '-' character is included in keyword characters. Redefines the
4759 "=" operator to use this same indentation algorithm rather than
4760 calling an external program if 'equalprg' is empty.
4761 This option is not used when 'paste' is set.
4762 {Vi: Does it a little bit differently}
4763
4764 *'lispwords'* *'lw'*
4765'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004766 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 {not in Vi}
4768 {not available when compiled without the |+lispindent|
4769 feature}
4770 Comma separated list of words that influence the Lisp indenting.
4771 |'lisp'|
4772
4773 *'list'* *'nolist'*
4774'list' boolean (default off)
4775 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004776 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4777 line. Useful to see the difference between tabs and spaces and for
4778 trailing blanks. Further changed by the 'listchars' option.
4779
4780 The cursor is displayed at the start of the space a Tab character
4781 occupies, not at the end as usual in Normal mode. To get this cursor
4782 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004783 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004784<
4785 Note that list mode will also affect formatting (set with 'textwidth'
4786 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 changing the way tabs are displayed.
4788
4789 *'listchars'* *'lcs'*
4790'listchars' 'lcs' string (default "eol:$")
4791 global
4792 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004793 Strings to use in 'list' mode and for the |:list| command. It is a
4794 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004795 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 eol:c Character to show at the end of each line. When
4797 omitted, there is no extra character at the end of the
4798 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004799 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004800 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004802 fill the space that the tab normally occupies.
4803 "tab:>-" will show a tab that takes four spaces as
4804 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004805 *lcs-space*
4806 space:c Character to show for a space. When omitted, spaces
4807 are left blank.
4808 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004809 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004810 trailing spaces are blank. Overrides the "space"
4811 setting for trailing spaces.
4812 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 extends:c Character to show in the last column, when 'wrap' is
4814 off and the line continues beyond the right of the
4815 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004816 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 precedes:c Character to show in the first column, when 'wrap'
4818 is off and there is text preceding the character
4819 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004820 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004821 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004822 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004823 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004824 nbsp:c Character to show for a non-breakable space character
4825 (0xA0 (160 decimal) and U+202F). Left blank when
4826 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004828 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004830 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831
4832 Examples: >
4833 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004834 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 :set lcs=extends:>,precedes:<
4836< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004837 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004838 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839
4840 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4841'loadplugins' 'lpl' boolean (default on)
4842 global
4843 {not in Vi}
4844 When on the plugin scripts are loaded when starting up |load-plugins|.
4845 This option can be reset in your |vimrc| file to disable the loading
4846 of plugins.
4847 Note that using the "-u NONE" and "--noplugin" command line arguments
4848 reset this option. |-u| |--noplugin|
4849
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004850 *'macatsui'* *'nomacatsui'*
4851'macatsui' boolean (default on)
4852 global
4853 {only available in Mac GUI version}
4854 This is a workaround for when drawing doesn't work properly. When set
4855 and compiled with multi-byte support ATSUI text drawing is used. When
4856 not set ATSUI text drawing is not used. Switch this option off when
4857 you experience drawing problems. In a future version the problems may
4858 be solved and this option becomes obsolete. Therefore use this method
4859 to unset it: >
4860 if exists('&macatsui')
4861 set nomacatsui
4862 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004863< Another option to check if you have drawing problems is
4864 'termencoding'.
4865
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 *'magic'* *'nomagic'*
4867'magic' boolean (default on)
4868 global
4869 Changes the special characters that can be used in search patterns.
4870 See |pattern|.
4871 NOTE: To avoid portability problems with using patterns, always keep
4872 this option at the default "on". Only switch it off when working with
4873 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004874 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875
4876 *'makeef'* *'mef'*
4877'makeef' 'mef' string (default: "")
4878 global
4879 {not in Vi}
4880 {not available when compiled without the |+quickfix|
4881 feature}
4882 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4883 and the |:grep| command.
4884 When it is empty, an internally generated temp file will be used.
4885 When "##" is included, it is replaced by a number to make the name
4886 unique. This makes sure that the ":make" command doesn't overwrite an
4887 existing file.
4888 NOT used for the ":cf" command. See 'errorfile' for that.
4889 Environment variables are expanded |:set_env|.
4890 See |option-backslash| about including spaces and backslashes.
4891 This option cannot be set from a |modeline| or in the |sandbox|, for
4892 security reasons.
4893
4894 *'makeprg'* *'mp'*
4895'makeprg' 'mp' string (default "make", VMS: "MMS")
4896 global or local to buffer |global-local|
4897 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004898 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004899 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4900 which are expanded to the current and alternate file name. Use |::S|
4901 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004902 Environment variables are expanded |:set_env|. See |option-backslash|
4903 about including spaces and backslashes.
4904 Note that a '|' must be escaped twice: once for ":set" and once for
4905 the interpretation of a command. When you use a filter called
4906 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 :set makeprg=gmake\ \\\|\ myfilter
4908< The placeholder "$*" can be given (even multiple times) to specify
4909 where the arguments will be included, for example: >
4910 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4911< This option cannot be set from a |modeline| or in the |sandbox|, for
4912 security reasons.
4913
4914 *'matchpairs'* *'mps'*
4915'matchpairs' 'mps' string (default "(:),{:},[:]")
4916 local to buffer
4917 {not in Vi}
4918 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004919 other.
4920 Only character pairs are allowed that are different, thus you cannot
4921 jump between two double quotes.
4922 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004923 The pairs must be separated by a comma. Example for including '<' and
4924 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 :set mps+=<:>
4926
4927< A more exotic example, to jump between the '=' and ';' in an
4928 assignment, useful for languages like C and Java: >
4929 :au FileType c,cpp,java set mps+==:;
4930
4931< For a more advanced way of using "%", see the matchit.vim plugin in
4932 the $VIMRUNTIME/macros directory. |add-local-help|
4933
4934 *'matchtime'* *'mat'*
4935'matchtime' 'mat' number (default 5)
4936 global
4937 {not in Vi}{in Nvi}
4938 Tenths of a second to show the matching paren, when 'showmatch' is
4939 set. Note that this is not in milliseconds, like other options that
4940 set a time. This is to be compatible with Nvi.
4941
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004942 *'maxcombine'* *'mco'*
4943'maxcombine' 'mco' number (default 2)
4944 global
4945 {not in Vi}
4946 {only available when compiled with the |+multi_byte|
4947 feature}
4948 The maximum number of combining characters supported for displaying.
4949 Only used when 'encoding' is "utf-8".
4950 The default is OK for most languages. Hebrew may require 4.
4951 Maximum value is 6.
4952 Even when this option is set to 2 you can still edit text with more
4953 combining characters, you just can't see them. Use |g8| or |ga|.
4954 See |mbyte-combining|.
4955
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 *'maxfuncdepth'* *'mfd'*
4957'maxfuncdepth' 'mfd' number (default 100)
4958 global
4959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004960 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004961 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962 Maximum depth of function calls for user functions. This normally
4963 catches endless recursion. When using a recursive function with
4964 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4965 more memory, there is the danger of failing when memory is exhausted.
4966 See also |:function|.
4967
4968 *'maxmapdepth'* *'mmd'* *E223*
4969'maxmapdepth' 'mmd' number (default 1000)
4970 global
4971 {not in Vi}
4972 Maximum number of times a mapping is done without resulting in a
4973 character to be used. This normally catches endless mappings, like
4974 ":map x y" with ":map y x". It still does not catch ":map g wg",
4975 because the 'w' is used before the next mapping is done. See also
4976 |key-mapping|.
4977
4978 *'maxmem'* *'mm'*
4979'maxmem' 'mm' number (default between 256 to 5120 (system
4980 dependent) or half the amount of memory
4981 available)
4982 global
4983 {not in Vi}
4984 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4985 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004986 other memory to be freed. The maximum usable value is about 2000000.
4987 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004989 *'maxmempattern'* *'mmp'*
4990'maxmempattern' 'mmp' number (default 1000)
4991 global
4992 {not in Vi}
4993 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004994 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004995 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004996 When Vim runs into the limit it gives an error message and mostly
4997 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004998 Running into the limit often means that the pattern is very
4999 inefficient or too complex. This may already happen with the pattern
5000 "\(.\)*" on a very long line. ".*" works much better.
5001 Vim may run out of memory before hitting the 'maxmempattern' limit.
5002
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 *'maxmemtot'* *'mmt'*
5004'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5005 dependent) or half the amount of memory
5006 available)
5007 global
5008 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005009 Maximum amount of memory in Kbyte to use for all buffers together.
5010 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
5011 without a limit. On 64 bit machines higher values might work. But
5012 hey, do you really need more than 2 Gbyte for text editing?
5013 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014
5015 *'menuitems'* *'mis'*
5016'menuitems' 'mis' number (default 25)
5017 global
5018 {not in Vi}
5019 {not available when compiled without the |+menu|
5020 feature}
5021 Maximum number of items to use in a menu. Used for menus that are
5022 generated from a list of items, e.g., the Buffers menu. Changing this
5023 option has no direct effect, the menu must be refreshed first.
5024
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005025 *'mkspellmem'* *'msm'*
5026'mkspellmem' 'msm' string (default "460000,2000,500")
5027 global
5028 {not in Vi}
5029 {not available when compiled without the |+syntax|
5030 feature}
5031 Parameters for |:mkspell|. This tunes when to start compressing the
5032 word tree. Compression can be slow when there are many words, but
5033 it's needed to avoid running out of memory. The amount of memory used
5034 per word depends very much on how similar the words are, that's why
5035 this tuning is complicated.
5036
5037 There are three numbers, separated by commas:
5038 {start},{inc},{added}
5039
5040 For most languages the uncompressed word tree fits in memory. {start}
5041 gives the amount of memory in Kbyte that can be used before any
5042 compression is done. It should be a bit smaller than the amount of
5043 memory that is available to Vim.
5044
5045 When going over the {start} limit the {inc} number specifies the
5046 amount of memory in Kbyte that can be allocated before another
5047 compression is done. A low number means compression is done after
5048 less words are added, which is slow. A high number means more memory
5049 will be allocated.
5050
5051 After doing compression, {added} times 1024 words can be added before
5052 the {inc} limit is ignored and compression is done when any extra
5053 amount of memory is needed. A low number means there is a smaller
5054 chance of hitting the {inc} limit, less memory is used but it's
5055 slower.
5056
5057 The languages for which these numbers are important are Italian and
5058 Hungarian. The default works for when you have about 512 Mbyte. If
5059 you have 1 Gbyte you could use: >
5060 :set mkspellmem=900000,3000,800
5061< If you have less than 512 Mbyte |:mkspell| may fail for some
5062 languages, no matter what you set 'mkspellmem' to.
5063
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005065'modeline' 'ml' boolean (Vim default: on (off for root),
5066 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 local to buffer
5068 *'modelines'* *'mls'*
5069'modelines' 'mls' number (default 5)
5070 global
5071 {not in Vi}
5072 If 'modeline' is on 'modelines' gives the number of lines that is
5073 checked for set commands. If 'modeline' is off or 'modelines' is zero
5074 no lines are checked. See |modeline|.
5075 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5076 set and to the Vim default value when 'compatible' is reset.
5077
5078 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5079'modifiable' 'ma' boolean (default on)
5080 local to buffer
5081 {not in Vi} *E21*
5082 When off the buffer contents cannot be changed. The 'fileformat' and
5083 'fileencoding' options also can't be changed.
5084 Can be reset with the |-M| command line argument.
5085
5086 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5087'modified' 'mod' boolean (default off)
5088 local to buffer
5089 {not in Vi}
5090 When on, the buffer is considered to be modified. This option is set
5091 when:
5092 1. A change was made to the text since it was last written. Using the
5093 |undo| command to go back to the original text will reset the
5094 option. But undoing changes that were made before writing the
5095 buffer will set the option again, since the text is different from
5096 when it was written.
5097 2. 'fileformat' or 'fileencoding' is different from its original
5098 value. The original value is set when the buffer is read or
5099 written. A ":set nomodified" command also resets the original
5100 values to the current values and the 'modified' option will be
5101 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005102 This option is not set when a change is made to the buffer as the
5103 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5104 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5105 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5107 will be ignored.
5108
5109 *'more'* *'nomore'*
5110'more' boolean (Vim default: on, Vi default: off)
5111 global
5112 {not in Vi}
5113 When on, listings pause when the whole screen is filled. You will get
5114 the |more-prompt|. When this option is off there are no pauses, the
5115 listing continues until finished.
5116 NOTE: This option is set to the Vi default value when 'compatible' is
5117 set and to the Vim default value when 'compatible' is reset.
5118
5119 *'mouse'* *E538*
5120'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5121 global
5122 {not in Vi}
5123 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005124 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5125 sysmouse and Linux console with gpm). For using the mouse in the
5126 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 The mouse can be enabled for different modes:
5128 n Normal mode
5129 v Visual mode
5130 i Insert mode
5131 c Command-line mode
5132 h all previous modes when editing a help file
5133 a all previous modes
5134 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005135 Normally you would enable the mouse in all four modes with: >
5136 :set mouse=a
5137< When the mouse is not enabled, the GUI will still use the mouse for
5138 modeless selection. This doesn't move the text cursor.
5139
5140 See |mouse-using|. Also see |'clipboard'|.
5141
5142 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005143 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 the mouse buttons can still be used by keeping the shift key pressed.
5145 Also see the 'clipboard' option.
5146
5147 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5148'mousefocus' 'mousef' boolean (default off)
5149 global
5150 {not in Vi}
5151 {only works in the GUI}
5152 The window that the mouse pointer is on is automatically activated.
5153 When changing the window layout or window focus in another way, the
5154 mouse pointer is moved to the window with keyboard focus. Off is the
5155 default because it makes using the pull down menus a little goofy, as
5156 a pointer transit may activate a window unintentionally.
5157
5158 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5159'mousehide' 'mh' boolean (default on)
5160 global
5161 {not in Vi}
5162 {only works in the GUI}
5163 When on, the mouse pointer is hidden when characters are typed.
5164 The mouse pointer is restored when the mouse is moved.
5165
5166 *'mousemodel'* *'mousem'*
5167'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5168 global
5169 {not in Vi}
5170 Sets the model to use for the mouse. The name mostly specifies what
5171 the right mouse button is used for:
5172 extend Right mouse button extends a selection. This works
5173 like in an xterm.
5174 popup Right mouse button pops up a menu. The shifted left
5175 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005176 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 popup_setpos Like "popup", but the cursor will be moved to the
5178 position where the mouse was clicked, and thus the
5179 selected operation will act upon the clicked object.
5180 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005181 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 course, that right clicking outside a selection will
5183 end Visual mode.
5184 Overview of what button does what for each model:
5185 mouse extend popup(_setpos) ~
5186 left click place cursor place cursor
5187 left drag start selection start selection
5188 shift-left search word extend selection
5189 right click extend selection popup menu (place cursor)
5190 right drag extend selection -
5191 middle click paste paste
5192
5193 In the "popup" model the right mouse button produces a pop-up menu.
5194 You need to define this first, see |popup-menu|.
5195
5196 Note that you can further refine the meaning of buttons with mappings.
5197 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5198 selection (because that's handled in the GUI code directly).
5199
5200 The 'mousemodel' option is set by the |:behave| command.
5201
5202 *'mouseshape'* *'mouses'* *E547*
5203'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005204 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 global
5206 {not in Vi}
5207 {only available when compiled with the |+mouseshape|
5208 feature}
5209 This option tells Vim what the mouse pointer should look like in
5210 different modes. The option is a comma separated list of parts, much
5211 like used for 'guicursor'. Each part consist of a mode/location-list
5212 and an argument-list:
5213 mode-list:shape,mode-list:shape,..
5214 The mode-list is a dash separated list of these modes/locations:
5215 In a normal window: ~
5216 n Normal mode
5217 v Visual mode
5218 ve Visual mode with 'selection' "exclusive" (same as 'v',
5219 if not specified)
5220 o Operator-pending mode
5221 i Insert mode
5222 r Replace mode
5223
5224 Others: ~
5225 c appending to the command-line
5226 ci inserting in the command-line
5227 cr replacing in the command-line
5228 m at the 'Hit ENTER' or 'More' prompts
5229 ml idem, but cursor in the last line
5230 e any mode, pointer below last window
5231 s any mode, pointer on a status line
5232 sd any mode, while dragging a status line
5233 vs any mode, pointer on a vertical separator line
5234 vd any mode, while dragging a vertical separator line
5235 a everywhere
5236
5237 The shape is one of the following:
5238 avail name looks like ~
5239 w x arrow Normal mouse pointer
5240 w x blank no pointer at all (use with care!)
5241 w x beam I-beam
5242 w x updown up-down sizing arrows
5243 w x leftright left-right sizing arrows
5244 w x busy The system's usual busy pointer
5245 w x no The system's usual 'no input' pointer
5246 x udsizing indicates up-down resizing
5247 x lrsizing indicates left-right resizing
5248 x crosshair like a big thin +
5249 x hand1 black hand
5250 x hand2 white hand
5251 x pencil what you write with
5252 x question big ?
5253 x rightup-arrow arrow pointing right-up
5254 w x up-arrow arrow pointing up
5255 x <number> any X11 pointer number (see X11/cursorfont.h)
5256
5257 The "avail" column contains a 'w' if the shape is available for Win32,
5258 x for X11.
5259 Any modes not specified or shapes not available use the normal mouse
5260 pointer.
5261
5262 Example: >
5263 :set mouseshape=s:udsizing,m:no
5264< will make the mouse turn to a sizing arrow over the status lines and
5265 indicate no input when the hit-enter prompt is displayed (since
5266 clicking the mouse has no effect in this state.)
5267
5268 *'mousetime'* *'mouset'*
5269'mousetime' 'mouset' number (default 500)
5270 global
5271 {not in Vi}
5272 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5273 time in msec between two mouse clicks for the second click to be
5274 recognized as a multi click.
5275
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005276 *'mzquantum'* *'mzq'*
5277'mzquantum' 'mzq' number (default 100)
5278 global
5279 {not in Vi}
5280 {not available when compiled without the |+mzscheme|
5281 feature}
5282 The number of milliseconds between polls for MzScheme threads.
5283 Negative or zero value means no thread scheduling.
5284
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 *'nrformats'* *'nf'*
5286'nrformats' 'nf' string (default "octal,hex")
5287 local to buffer
5288 {not in Vi}
5289 This defines what bases Vim will consider for numbers when using the
5290 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5291 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005292 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005294 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005295 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005297 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 considered to be hexadecimal. Example: Using CTRL-X on
5299 "0x100" results in "0x0ff".
5300 Numbers which simply begin with a digit in the range 1-9 are always
5301 considered decimal. This also happens for numbers that are not
5302 recognized as octal or hex.
5303
5304 *'number'* *'nu'* *'nonumber'* *'nonu'*
5305'number' 'nu' boolean (default off)
5306 local to window
5307 Print the line number in front of each line. When the 'n' option is
5308 excluded from 'cpoptions' a wrapped line will not use the column of
5309 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005310 The 'numberwidth' option can be used to set the room used for the line
5311 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 When a long, wrapped line doesn't start with the first character, '-'
5313 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005314 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5315 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005316 *number_relativenumber*
5317 The 'relativenumber' option changes the displayed number to be
5318 relative to the cursor. Together with 'number' there are these
5319 four combinations (cursor in line 3):
5320
5321 'nonu' 'nu' 'nonu' 'nu'
5322 'nornu' 'nornu' 'rnu' 'rnu'
5323
5324 |apple | 1 apple | 2 apple | 2 apple
5325 |pear | 2 pear | 1 pear | 1 pear
5326 |nobody | 3 nobody | 0 nobody |3 nobody
5327 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005329 *'numberwidth'* *'nuw'*
5330'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5331 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005332 {not in Vi}
5333 {only available when compiled with the |+linebreak|
5334 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005335 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005336 when the 'number' or 'relativenumber' option is set or printing lines
5337 with a line number. Since one space is always between the number and
5338 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005339 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005340 fit the highest line number in the buffer respectively the number of
5341 rows in the window, depending on whether 'number' or 'relativenumber'
5342 is set. Thus with the Vim default of 4 there is room for a line number
5343 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005344 The minimum value is 1, the maximum value is 10.
5345 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5346
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005347 *'omnifunc'* *'ofu'*
5348'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005349 local to buffer
5350 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005351 {not available when compiled without the |+eval|
5352 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005353 This option specifies a function to be used for Insert mode omni
5354 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005355 See |complete-functions| for an explanation of how the function is
5356 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005357 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005358 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005359 This option cannot be set from a |modeline| or in the |sandbox|, for
5360 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005361
5362
Bram Moolenaar02467872007-05-06 13:22:01 +00005363 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005364'opendevice' 'odev' boolean (default off)
5365 global
5366 {not in Vi}
5367 {only for MS-DOS, MS-Windows and OS/2}
5368 Enable reading and writing from devices. This may get Vim stuck on a
5369 device that can be opened but doesn't actually do the I/O. Therefore
5370 it is off by default.
5371 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5372 result in editing a device.
5373
5374
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005375 *'operatorfunc'* *'opfunc'*
5376'operatorfunc' 'opfunc' string (default: empty)
5377 global
5378 {not in Vi}
5379 This option specifies a function to be called by the |g@| operator.
5380 See |:map-operator| for more info and an example.
5381
5382 This option cannot be set from a |modeline| or in the |sandbox|, for
5383 security reasons.
5384
5385
Bram Moolenaar251e1912011-06-19 05:09:16 +02005386 *'osfiletype'* *'oft'*
5387'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 local to buffer
5389 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005390 This option was supported on RISC OS, which has been removed.
5391
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392
5393 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005394'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 global
5396 Specifies the nroff macros that separate paragraphs. These are pairs
5397 of two letters (see |object-motions|).
5398
5399 *'paste'* *'nopaste'*
5400'paste' boolean (default off)
5401 global
5402 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005403 Put Vim in Paste mode. This is useful if you want to cut or copy
5404 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 unexpected effects.
5406 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005407 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 knows about pasting and will mostly do the right thing without 'paste'
5409 being set. The same is true for a terminal where Vim handles the
5410 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005411 This option is reset when starting the GUI. Thus if you set it in
5412 your .vimrc it will work in a terminal, but not in the GUI. Setting
5413 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5414 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 When the 'paste' option is switched on (also when it was already on):
5416 - mapping in Insert mode and Command-line mode is disabled
5417 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005419 - 'expandtab' is reset
5420 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005421 - 'revins' is reset
5422 - 'ruler' is reset
5423 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005424 - 'smartindent' is reset
5425 - 'smarttab' is reset
5426 - 'softtabstop' is set to 0
5427 - 'textwidth' is set to 0
5428 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005431 - 'indentexpr'
5432 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 NOTE: When you start editing another file while the 'paste' option is
5434 on, settings from the modelines or autocommands may change the
5435 settings again, causing trouble when pasting text. You might want to
5436 set the 'paste' option again.
5437 When the 'paste' option is reset the mentioned options are restored to
5438 the value before the moment 'paste' was switched from off to on.
5439 Resetting 'paste' before ever setting it does not have any effect.
5440 Since mapping doesn't work while 'paste' is active, you need to use
5441 the 'pastetoggle' option to toggle the 'paste' option with some key.
5442
5443 *'pastetoggle'* *'pt'*
5444'pastetoggle' 'pt' string (default "")
5445 global
5446 {not in Vi}
5447 When non-empty, specifies the key sequence that toggles the 'paste'
5448 option. This is like specifying a mapping: >
5449 :map {keys} :set invpaste<CR>
5450< Where {keys} is the value of 'pastetoggle'.
5451 The difference is that it will work even when 'paste' is set.
5452 'pastetoggle' works in Insert mode and Normal mode, but not in
5453 Command-line mode.
5454 Mappings are checked first, thus overrule 'pastetoggle'. However,
5455 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5456 this: >
5457 :map <F10> :set paste<CR>
5458 :map <F11> :set nopaste<CR>
5459 :imap <F10> <C-O>:set paste<CR>
5460 :imap <F11> <nop>
5461 :set pastetoggle=<F11>
5462< This will make <F10> start paste mode and <F11> stop paste mode.
5463 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5464 mode everything is inserted literally, except the 'pastetoggle' key
5465 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005466 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467
5468 *'pex'* *'patchexpr'*
5469'patchexpr' 'pex' string (default "")
5470 global
5471 {not in Vi}
5472 {not available when compiled without the |+diff|
5473 feature}
5474 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005475 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476
Bram Moolenaardbc28022014-07-26 13:40:44 +02005477 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478'patchmode' 'pm' string (default "")
5479 global
5480 {not in Vi}
5481 When non-empty the oldest version of a file is kept. This can be used
5482 to keep the original version of a file if you are changing files in a
5483 source distribution. Only the first time that a file is written a
5484 copy of the original file will be kept. The name of the copy is the
5485 name of the original file with the string in the 'patchmode' option
5486 appended. This option should start with a dot. Use a string like
5487 ".org". 'backupdir' must not be empty for this to work (Detail: The
5488 backup file is renamed to the patchmode file after the new file has
5489 been successfully written, that's why it must be possible to write a
5490 backup file). If there was no file to be backed up, an empty file is
5491 created.
5492 When the 'backupskip' pattern matches, a patchmode file is not made.
5493 Using 'patchmode' for compressed files appends the extension at the
5494 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5495 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005496 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005498 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499'path' 'pa' string (default on Unix: ".,/usr/include,,"
5500 on OS/2: ".,/emx/include,,"
5501 other systems: ".,,")
5502 global or local to buffer |global-local|
5503 {not in Vi}
5504 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005505 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5506 provided that the file being searched for has a relative path (not
5507 starting with "/", "./" or "../"). The directories in the 'path'
5508 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 - Use commas to separate directory names: >
5510 :set path=.,/usr/local/include,/usr/include
5511< - Spaces can also be used to separate directory names (for backwards
5512 compatibility with version 3.0). To have a space in a directory
5513 name, precede it with an extra backslash, and escape the space: >
5514 :set path=.,/dir/with\\\ space
5515< - To include a comma in a directory name precede it with an extra
5516 backslash: >
5517 :set path=.,/dir/with\\,comma
5518< - To search relative to the directory of the current file, use: >
5519 :set path=.
5520< - To search in the current directory use an empty string between two
5521 commas: >
5522 :set path=,,
5523< - A directory name may end in a ':' or '/'.
5524 - Environment variables are expanded |:set_env|.
5525 - When using |netrw.vim| URLs can be used. For example, adding
5526 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005527 - Search upwards and downwards in a directory tree using "*", "**" and
5528 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 {not available when compiled without the |+path_extra| feature}
5530 - Careful with '\' characters, type two to get one in the option: >
5531 :set path=.,c:\\include
5532< Or just use '/' instead: >
5533 :set path=.,c:/include
5534< Don't forget "." or files won't even be found in the same directory as
5535 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005536 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 it is something like 256 or 1024 characters.
5538 You can check if all the include files are found, using the value of
5539 'path', see |:checkpath|.
5540 The use of |:set+=| and |:set-=| is preferred when adding or removing
5541 directories from the list. This avoids problems when a future version
5542 uses another default. To remove the current directory use: >
5543 :set path-=
5544< To add the current directory use: >
5545 :set path+=
5546< To use an environment variable, you probably need to replace the
5547 separator. Here is an example to append $INCL, in which directory
5548 names are separated with a semi-colon: >
5549 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5550< Replace the ';' with a ':' or whatever separator is used. Note that
5551 this doesn't work when $INCL contains a comma or white space.
5552
5553 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5554'preserveindent' 'pi' boolean (default off)
5555 local to buffer
5556 {not in Vi}
5557 When changing the indent of the current line, preserve as much of the
5558 indent structure as possible. Normally the indent is replaced by a
5559 series of tabs followed by spaces as required (unless |'expandtab'| is
5560 enabled, in which case only spaces are used). Enabling this option
5561 means the indent will preserve as many existing characters as possible
5562 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005563 'expandtab' does not apply to the preserved white space, a Tab remains
5564 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 NOTE: When using ">>" multiple times the resulting indent is a mix of
5566 tabs and spaces. You might not like this.
5567 NOTE: 'preserveindent' is reset when 'compatible' is set.
5568 Also see 'copyindent'.
5569 Use |:retab| to clean up white space.
5570
5571 *'previewheight'* *'pvh'*
5572'previewheight' 'pvh' number (default 12)
5573 global
5574 {not in Vi}
5575 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005576 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 Default height for a preview window. Used for |:ptag| and associated
5578 commands. Used for |CTRL-W_}| when no count is given.
5579
5580 *'previewwindow'* *'nopreviewwindow'*
5581 *'pvw'* *'nopvw'* *E590*
5582'previewwindow' 'pvw' boolean (default off)
5583 local to window
5584 {not in Vi}
5585 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005586 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005587 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 set. It's normally not set directly, but by using one of the commands
5589 |:ptag|, |:pedit|, etc.
5590
5591 *'printdevice'* *'pdev'*
5592'printdevice' 'pdev' string (default empty)
5593 global
5594 {not in Vi}
5595 {only available when compiled with the |+printer|
5596 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005597 The name of the printer to be used for |:hardcopy|.
5598 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005599 This option cannot be set from a |modeline| or in the |sandbox|, for
5600 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005601
Bram Moolenaar8299df92004-07-10 09:47:34 +00005602 *'printencoding'* *'penc'*
5603'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 global
5605 {not in Vi}
5606 {only available when compiled with the |+printer|
5607 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005608 Sets the character encoding used when printing.
5609 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610
5611 *'printexpr'* *'pexpr'*
5612'printexpr' 'pexpr' String (default: see below)
5613 global
5614 {not in Vi}
5615 {only available when compiled with the |+printer|
5616 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005617 Expression used to print the PostScript produced with |:hardcopy|.
5618 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619
Bram Moolenaar8299df92004-07-10 09:47:34 +00005620 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621'printfont' 'pfn' string (default "courier")
5622 global
5623 {not in Vi}
5624 {only available when compiled with the |+printer|
5625 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005626 The name of the font that will be used for |:hardcopy|.
5627 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628
5629 *'printheader'* *'pheader'*
5630'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5631 global
5632 {not in Vi}
5633 {only available when compiled with the |+printer|
5634 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005635 The format of the header produced in |:hardcopy| output.
5636 See |pheader-option|.
5637
5638 *'printmbcharset'* *'pmbcs'*
5639'printmbcharset' 'pmbcs' string (default "")
5640 global
5641 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005642 {only available when compiled with the |+printer|,
5643 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005644 The CJK character set to be used for CJK output from |:hardcopy|.
5645 See |pmbcs-option|.
5646
5647 *'printmbfont'* *'pmbfn'*
5648'printmbfont' 'pmbfn' string (default "")
5649 global
5650 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005651 {only available when compiled with the |+printer|,
5652 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005653 List of font names to be used for CJK output from |:hardcopy|.
5654 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655
5656 *'printoptions'* *'popt'*
5657'printoptions' 'popt' string (default "")
5658 global
5659 {not in Vi}
5660 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005661 List of items that control the format of the output of |:hardcopy|.
5662 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005664 *'prompt'* *'noprompt'*
5665'prompt' boolean (default on)
5666 global
5667 When on a ":" prompt is used in Ex mode.
5668
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005669 *'pumheight'* *'ph'*
5670'pumheight' 'ph' number (default 0)
5671 global
5672 {not available when compiled without the
5673 |+insert_expand| feature}
5674 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005675 Determines the maximum number of items to show in the popup menu for
5676 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005677 |ins-completion-menu|.
5678
5679
Bram Moolenaar677ee682005-01-27 14:41:15 +00005680 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005681'quoteescape' 'qe' string (default "\")
5682 local to buffer
5683 {not in Vi}
5684 The characters that are used to escape quotes in a string. Used for
5685 objects like a', a" and a` |a'|.
5686 When one of the characters in this option is found inside a string,
5687 the following character will be skipped. The default value makes the
5688 text "foo\"bar\\" considered to be one string.
5689
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5691'readonly' 'ro' boolean (default off)
5692 local to buffer
5693 If on, writes fail unless you use a '!'. Protects you from
5694 accidentally overwriting a file. Default on when Vim is started
5695 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005696 When using ":w!" the 'readonly' option is reset for the current
5697 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005699 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005701 *'redrawtime'* *'rdt'*
5702'redrawtime' 'rdt' number (default 2000)
5703 global
5704 {not in Vi}
5705 {only available when compiled with the |+reltime|
5706 feature}
5707 The time in milliseconds for redrawing the display. This applies to
5708 searching for patterns for 'hlsearch' and |:match| highlighting.
5709 When redrawing takes more than this many milliseconds no further
5710 matches will be highlighted. This is used to avoid that Vim hangs
5711 when using a very complicated pattern.
5712
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005713 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005714'regexpengine' 're' number (default 0)
5715 global
5716 {not in Vi}
5717 This selects the default regexp engine. |two-engines|
5718 The possible values are:
5719 0 automatic selection
5720 1 old engine
5721 2 NFA engine
5722 Note that when using the NFA engine and the pattern contains something
5723 that is not supported the pattern will not match. This is only useful
5724 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005725 Using automatic selection enables Vim to switch the engine, if the
5726 default engine becomes too costly. E.g., when the NFA engine uses too
5727 many states. This should prevent Vim from hanging on a combination of
5728 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005729
Bram Moolenaar64486672010-05-16 15:46:46 +02005730 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5731'relativenumber' 'rnu' boolean (default off)
5732 local to window
5733 {not in Vi}
5734 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005735 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005736 precede some vertical motion commands (e.g. j k + -) with, without
5737 having to calculate it yourself. Especially useful in combination with
5738 other commands (e.g. y d c < > gq gw =).
5739 When the 'n' option is excluded from 'cpoptions' a wrapped
5740 line will not use the column of line numbers (this is the default when
5741 'compatible' isn't set).
5742 The 'numberwidth' option can be used to set the room used for the line
5743 number.
5744 When a long, wrapped line doesn't start with the first character, '-'
5745 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005746 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5747 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005748
5749 The number in front of the cursor line also depends on the value of
5750 'number', see |number_relativenumber| for all combinations of the two
5751 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005752
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 *'remap'* *'noremap'*
5754'remap' boolean (default on)
5755 global
5756 Allows for mappings to work recursively. If you do not want this for
5757 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005758 NOTE: To avoid portability problems with Vim scripts, always keep
5759 this option at the default "on". Only switch it off when working with
5760 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005762 *'renderoptions'* *'rop'*
5763'renderoptions' 'rop' string (default: empty)
5764 global
5765 {not in Vi}
5766 {only available when compiled with GUI and DIRECTX on
5767 MS-Windows}
5768 Select a text renderer and set its options. The options depend on the
5769 renderer.
5770
5771 Syntax: >
5772 set rop=type:{renderer}(,{name}:{value})*
5773<
5774 Currently, only one optional renderer is available.
5775
5776 render behavior ~
5777 directx Vim will draw text using DirectX (DirectWrite). It makes
5778 drawn glyphs more beautiful than default GDI.
5779 It requires 'encoding' is "utf-8", and only works on
5780 MS-Windows Vista or newer version.
5781
5782 Options:
5783 name meaning type value ~
5784 gamma gamma float 1.0 - 2.2 (maybe)
5785 contrast enhancedContrast float (unknown)
5786 level clearTypeLevel float (unknown)
5787 geom pixelGeometry int 0 - 2 (see below)
5788 renmode renderingMode int 0 - 6 (see below)
5789 taamode textAntialiasMode int 0 - 3 (see below)
5790
5791 See this URL for detail:
5792 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5793
5794 For geom: structure of a device pixel.
5795 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5796 1 - DWRITE_PIXEL_GEOMETRY_RGB
5797 2 - DWRITE_PIXEL_GEOMETRY_BGR
5798
5799 See this URL for detail:
5800 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5801
5802 For renmode: method of rendering glyphs.
5803 0 - DWRITE_RENDERING_MODE_DEFAULT
5804 1 - DWRITE_RENDERING_MODE_ALIASED
5805 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5806 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5807 4 - DWRITE_RENDERING_MODE_NATURAL
5808 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5809 6 - DWRITE_RENDERING_MODE_OUTLINE
5810
5811 See this URL for detail:
5812 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5813
5814 For taamode: antialiasing mode used for drawing text.
5815 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5816 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5817 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5818 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5819
5820 See this URL for detail:
5821 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5822
5823 Example: >
5824 set encoding=utf-8
5825 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5826 set rop=type:directx
5827<
5828 If select a raster font (Courier, Terminal or FixedSys) to
5829 'guifont', it fallbacks to be drawn by GDI automatically.
5830
5831 Other render types are currently not supported.
5832
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 *'report'*
5834'report' number (default 2)
5835 global
5836 Threshold for reporting number of lines changed. When the number of
5837 changed lines is more than 'report' a message will be given for most
5838 ":" commands. If you want it always, set 'report' to 0.
5839 For the ":substitute" command the number of substitutions is used
5840 instead of the number of lines.
5841
5842 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5843'restorescreen' 'rs' boolean (default on)
5844 global
5845 {not in Vi} {only in Windows 95/NT console version}
5846 When set, the screen contents is restored when exiting Vim. This also
5847 happens when executing external commands.
5848
5849 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5850 options in your .vimrc. To disable restoring:
5851 set t_ti= t_te=
5852 To enable restoring (for an xterm):
5853 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5854 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5855
5856 *'revins'* *'ri'* *'norevins'* *'nori'*
5857'revins' 'ri' boolean (default off)
5858 global
5859 {not in Vi}
5860 {only available when compiled with the |+rightleft|
5861 feature}
5862 Inserting characters in Insert mode will work backwards. See "typing
5863 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5864 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02005865 NOTE: This option is reset when 'compatible' is set.
5866 This option is reset when 'paste' is set and restored when 'paste' is
5867 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868
5869 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5870'rightleft' 'rl' boolean (default off)
5871 local to window
5872 {not in Vi}
5873 {only available when compiled with the |+rightleft|
5874 feature}
5875 When on, display orientation becomes right-to-left, i.e., characters
5876 that are stored in the file appear from the right to the left.
5877 Using this option, it is possible to edit files for languages that
5878 are written from the right to the left such as Hebrew and Arabic.
5879 This option is per window, so it is possible to edit mixed files
5880 simultaneously, or to view the same file in both ways (this is
5881 useful whenever you have a mixed text file with both right-to-left
5882 and left-to-right strings so that both sets are displayed properly
5883 in different windows). Also see |rileft.txt|.
5884
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005885 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886'rightleftcmd' 'rlc' string (default "search")
5887 local to window
5888 {not in Vi}
5889 {only available when compiled with the |+rightleft|
5890 feature}
5891 Each word in this option enables the command line editing to work in
5892 right-to-left mode for a group of commands:
5893
5894 search "/" and "?" commands
5895
5896 This is useful for languages such as Hebrew, Arabic and Farsi.
5897 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5898
5899 *'ruler'* *'ru'* *'noruler'* *'noru'*
5900'ruler' 'ru' boolean (default off)
5901 global
5902 {not in Vi}
5903 {not available when compiled without the
5904 |+cmdline_info| feature}
5905 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005906 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 text in the file is shown on the far right:
5908 Top first line is visible
5909 Bot last line is visible
5910 All first and last line are visible
5911 45% relative position in the file
5912 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005913 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005915 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 this option takes precedence over 'ruler' and 'rulerformat'
5917 If the number of characters displayed is different from the number of
5918 bytes in the text (e.g., for a TAB or a multi-byte character), both
5919 the text column (byte number) and the screen column are shown,
5920 separated with a dash.
5921 For an empty line "0-1" is shown.
5922 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02005923 This option is reset when 'paste' is set and restored when 'paste' is
5924 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 If you don't want to see the ruler all the time but want to know where
5926 you are, use "g CTRL-G" |g_CTRL-G|.
5927 NOTE: This option is reset when 'compatible' is set.
5928
5929 *'rulerformat'* *'ruf'*
5930'rulerformat' 'ruf' string (default empty)
5931 global
5932 {not in Vi}
5933 {not available when compiled without the |+statusline|
5934 feature}
5935 When this option is not empty, it determines the content of the ruler
5936 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005937 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 The default ruler width is 17 characters. To make the ruler 15
5939 characters wide, put "%15(" at the start and "%)" at the end.
5940 Example: >
5941 :set rulerformat=%15(%c%V\ %p%%%)
5942<
5943 *'runtimepath'* *'rtp'* *vimfiles*
5944'runtimepath' 'rtp' string (default:
5945 Unix: "$HOME/.vim,
5946 $VIM/vimfiles,
5947 $VIMRUNTIME,
5948 $VIM/vimfiles/after,
5949 $HOME/.vim/after"
5950 Amiga: "home:vimfiles,
5951 $VIM/vimfiles,
5952 $VIMRUNTIME,
5953 $VIM/vimfiles/after,
5954 home:vimfiles/after"
5955 PC, OS/2: "$HOME/vimfiles,
5956 $VIM/vimfiles,
5957 $VIMRUNTIME,
5958 $VIM/vimfiles/after,
5959 $HOME/vimfiles/after"
5960 Macintosh: "$VIM:vimfiles,
5961 $VIMRUNTIME,
5962 $VIM:vimfiles:after"
5963 RISC-OS: "Choices:vimfiles,
5964 $VIMRUNTIME,
5965 Choices:vimfiles/after"
5966 VMS: "sys$login:vimfiles,
5967 $VIM/vimfiles,
5968 $VIMRUNTIME,
5969 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005970 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 global
5972 {not in Vi}
5973 This is a list of directories which will be searched for runtime
5974 files:
5975 filetype.vim filetypes by file name |new-filetype|
5976 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005977 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 colors/ color scheme files |:colorscheme|
5979 compiler/ compiler files |:compiler|
5980 doc/ documentation |write-local-help|
5981 ftplugin/ filetype plugins |write-filetype-plugin|
5982 indent/ indent scripts |indent-expression|
5983 keymap/ key mapping files |mbyte-keymap|
5984 lang/ menu translations |:menutrans|
5985 menu.vim GUI menus |menu.vim|
5986 plugin/ plugin scripts |write-plugin|
5987 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005988 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 syntax/ syntax files |mysyntaxfile|
5990 tutor/ files for vimtutor |tutor|
5991
5992 And any other file searched for with the |:runtime| command.
5993
5994 The defaults for most systems are setup to search five locations:
5995 1. In your home directory, for your personal preferences.
5996 2. In a system-wide Vim directory, for preferences from the system
5997 administrator.
5998 3. In $VIMRUNTIME, for files distributed with Vim.
5999 *after-directory*
6000 4. In the "after" directory in the system-wide Vim directory. This is
6001 for the system administrator to overrule or add to the distributed
6002 defaults (rarely needed)
6003 5. In the "after" directory in your home directory. This is for
6004 personal preferences to overrule or add to the distributed defaults
6005 or system-wide settings (rarely needed).
6006
6007 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6008 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006009 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 wildcards.
6011 See |:runtime|.
6012 Example: >
6013 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6014< This will use the directory "~/vimruntime" first (containing your
6015 personal Vim runtime files), then "/mygroup/vim" (shared between a
6016 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6017 files).
6018 You probably should always include $VIMRUNTIME somewhere, to use the
6019 distributed runtime files. You can put a directory before $VIMRUNTIME
6020 to find files which replace a distributed runtime files. You can put
6021 a directory after $VIMRUNTIME to find files which add to distributed
6022 runtime files.
6023 This option cannot be set from a |modeline| or in the |sandbox|, for
6024 security reasons.
6025
6026 *'scroll'* *'scr'*
6027'scroll' 'scr' number (default: half the window height)
6028 local to window
6029 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6030 set to half the number of lines in the window when the window size
6031 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006032 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6034 the number of screen lines instead of file lines, makes a difference
6035 when lines wrap}
6036
6037 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6038'scrollbind' 'scb' boolean (default off)
6039 local to window
6040 {not in Vi}
6041 {not available when compiled without the |+scrollbind|
6042 feature}
6043 See also |scroll-binding|. When this option is set, the current
6044 window scrolls as other scrollbind windows (windows that also have
6045 this option set) scroll. This option is useful for viewing the
6046 differences between two versions of a file, see 'diff'.
6047 See |'scrollopt'| for options that determine how this option should be
6048 interpreted.
6049 This option is mostly reset when splitting a window to edit another
6050 file. This means that ":split | edit file" results in two windows
6051 with scroll-binding, but ":split file" does not.
6052
6053 *'scrolljump'* *'sj'*
6054'scrolljump' 'sj' number (default 1)
6055 global
6056 {not in Vi}
6057 Minimal number of lines to scroll when the cursor gets off the
6058 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6059 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006060 When set to a negative number from -1 to -100 this is used as the
6061 percentage of the window height. Thus -50 scrolls half the window
6062 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 NOTE: This option is set to 1 when 'compatible' is set.
6064
6065 *'scrolloff'* *'so'*
6066'scrolloff' 'so' number (default 0)
6067 global
6068 {not in Vi}
6069 Minimal number of screen lines to keep above and below the cursor.
6070 This will make some context visible around where you are working. If
6071 you set it to a very large value (999) the cursor line will always be
6072 in the middle of the window (except at the start or end of the file or
6073 when long lines wrap).
6074 For scrolling horizontally see 'sidescrolloff'.
6075 NOTE: This option is set to 0 when 'compatible' is set.
6076
6077 *'scrollopt'* *'sbo'*
6078'scrollopt' 'sbo' string (default "ver,jump")
6079 global
6080 {not available when compiled without the |+scrollbind|
6081 feature}
6082 {not in Vi}
6083 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006084 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6085 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 The following words are available:
6087 ver Bind vertical scrolling for 'scrollbind' windows
6088 hor Bind horizontal scrolling for 'scrollbind' windows
6089 jump Applies to the offset between two windows for vertical
6090 scrolling. This offset is the difference in the first
6091 displayed line of the bound windows. When moving
6092 around in a window, another 'scrollbind' window may
6093 reach a position before the start or after the end of
6094 the buffer. The offset is not changed though, when
6095 moving back the 'scrollbind' window will try to scroll
6096 to the desired position when possible.
6097 When now making that window the current one, two
6098 things can be done with the relative offset:
6099 1. When "jump" is not included, the relative offset is
6100 adjusted for the scroll position in the new current
6101 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006102 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 2. When "jump" is included, the other windows are
6104 scrolled to keep the same relative offset. When
6105 going back to the other window, it still uses the
6106 same relative offset.
6107 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006108 When 'diff' mode is active there always is vertical scroll binding,
6109 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110
6111 *'sections'* *'sect'*
6112'sections' 'sect' string (default "SHNHH HUnhsh")
6113 global
6114 Specifies the nroff macros that separate sections. These are pairs of
6115 two letters (See |object-motions|). The default makes a section start
6116 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6117
6118 *'secure'* *'nosecure'* *E523*
6119'secure' boolean (default off)
6120 global
6121 {not in Vi}
6122 When on, ":autocmd", shell and write commands are not allowed in
6123 ".vimrc" and ".exrc" in the current directory and map commands are
6124 displayed. Switch it off only if you know that you will not run into
6125 problems, or when the 'exrc' option is off. On Unix this option is
6126 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006127 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 'secure' at the end of your ~/.vimrc then.
6129 This option cannot be set from a |modeline| or in the |sandbox|, for
6130 security reasons.
6131
6132 *'selection'* *'sel'*
6133'selection' 'sel' string (default "inclusive")
6134 global
6135 {not in Vi}
6136 This option defines the behavior of the selection. It is only used
6137 in Visual and Select mode.
6138 Possible values:
6139 value past line inclusive ~
6140 old no yes
6141 inclusive yes yes
6142 exclusive yes no
6143 "past line" means that the cursor is allowed to be positioned one
6144 character past the line.
6145 "inclusive" means that the last character of the selection is included
6146 in an operation. For example, when "x" is used to delete the
6147 selection.
6148 Note that when "exclusive" is used and selecting from the end
6149 backwards, you cannot include the last character of a line, when
6150 starting in Normal mode and 'virtualedit' empty.
6151
6152 The 'selection' option is set by the |:behave| command.
6153
6154 *'selectmode'* *'slm'*
6155'selectmode' 'slm' string (default "")
6156 global
6157 {not in Vi}
6158 This is a comma separated list of words, which specifies when to start
6159 Select mode instead of Visual mode, when a selection is started.
6160 Possible values:
6161 mouse when using the mouse
6162 key when using shifted special keys
6163 cmd when using "v", "V" or CTRL-V
6164 See |Select-mode|.
6165 The 'selectmode' option is set by the |:behave| command.
6166
6167 *'sessionoptions'* *'ssop'*
6168'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006169 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006170 global
6171 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006172 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 feature}
6174 Changes the effect of the |:mksession| command. It is a comma
6175 separated list of words. Each word enables saving and restoring
6176 something:
6177 word save and restore ~
6178 blank empty windows
6179 buffers hidden and unloaded buffers, not just those in windows
6180 curdir the current directory
6181 folds manually created folds, opened/closed folds and local
6182 fold options
6183 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006184 and contain at least one lowercase letter. Only
6185 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 help the help window
6187 localoptions options and mappings local to a window or buffer (not
6188 global values for local options)
6189 options all options and mappings (also global values for local
6190 options)
6191 resize size of the Vim window: 'lines' and 'columns'
6192 sesdir the directory in which the session file is located
6193 will become the current directory (useful with
6194 projects accessed over a network from different
6195 systems)
6196 slash backslashes in file names replaced with forward
6197 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006198 tabpages all tab pages; without this only the current tab page
6199 is restored, so that you can make a session for each
6200 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 unix with Unix end-of-line format (single <NL>), even when
6202 on Windows or DOS
6203 winpos position of the whole Vim window
6204 winsize window sizes
6205
6206 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006207 When neither "curdir" nor "sesdir" is included, file names are stored
6208 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 "slash" and "unix" are useful on Windows when sharing session files
6210 with Unix. The Unix version of Vim cannot source dos format scripts,
6211 but the Windows version of Vim can source unix format scripts.
6212
6213 *'shell'* *'sh'* *E91*
6214'shell' 'sh' string (default $SHELL or "sh",
6215 MS-DOS and Win32: "command.com" or
6216 "cmd.exe", OS/2: "cmd")
6217 global
6218 Name of the shell to use for ! and :! commands. When changing the
6219 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6220 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006221 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 See |option-backslash| about including spaces and backslashes.
6223 Environment variables are expanded |:set_env|.
6224 If the name of the shell contains a space, you might need to enclose
6225 it in quotes. Example: >
6226 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6227< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006228 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 "-f" is not inside the quotes, because it is not part of the command
6230 name. And Vim automagically recognizes the backslashes that are path
6231 separators.
6232 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6233 variable to change the way external commands are executed. See the
6234 libc.inf file of DJGPP.
6235 Under MS-Windows, when the executable ends in ".com" it must be
6236 included. Thus setting the shell to "command.com" or "4dos.com"
6237 works, but "command" and "4dos" do not work for all commands (e.g.,
6238 filtering).
6239 For unknown reasons, when using "4dos.com" the current directory is
6240 changed to "C:\". To avoid this set 'shell' like this: >
6241 :set shell=command.com\ /c\ 4dos
6242< This option cannot be set from a |modeline| or in the |sandbox|, for
6243 security reasons.
6244
6245 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006246'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006247 MS-DOS and Win32, when 'shell' does not
6248 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 global
6250 {not in Vi}
6251 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6252 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6253 systems, the default is set according to the value of 'shell', to
6254 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006255 OS/2 (EMX figures this out itself).
6256 On Unix it can have more than one flag. Each white space separated
6257 part is passed as an argument to the shell command.
6258 See |option-backslash| about including spaces and backslashes.
6259 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 This option cannot be set from a |modeline| or in the |sandbox|, for
6261 security reasons.
6262
6263 *'shellpipe'* *'sp'*
6264'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6265 global
6266 {not in Vi}
6267 {not available when compiled without the |+quickfix|
6268 feature}
6269 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006270 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 including spaces and backslashes.
6272 The name of the temporary file can be represented by "%s" if necessary
6273 (the file name is appended automatically if no %s appears in the value
6274 of this option).
6275 For the Amiga and MS-DOS the default is ">". The output is directly
6276 saved in a file and not echoed to the screen.
6277 For Unix the default it "| tee". The stdout of the compiler is saved
6278 in a file and echoed to the screen. If the 'shell' option is "csh" or
6279 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006280 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6281 default becomes "2>&1| tee". This means that stderr is also included.
6282 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6283 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 The initialization of this option is done after reading the ".vimrc"
6285 and the other initializations, so that when the 'shell' option is set
6286 there, the 'shellpipe' option changes automatically, unless it was
6287 explicitly set before.
6288 When 'shellpipe' is set to an empty string, no redirection of the
6289 ":make" output will be done. This is useful if you use a 'makeprg'
6290 that writes to 'makeef' by itself. If you want no piping, but do
6291 want to include the 'makeef', set 'shellpipe' to a single space.
6292 Don't forget to precede the space with a backslash: ":set sp=\ ".
6293 In the future pipes may be used for filtering and this option will
6294 become obsolete (at least for Unix).
6295 This option cannot be set from a |modeline| or in the |sandbox|, for
6296 security reasons.
6297
6298 *'shellquote'* *'shq'*
6299'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6300 contains "sh" somewhere: "\"")
6301 global
6302 {not in Vi}
6303 Quoting character(s), put around the command passed to the shell, for
6304 the "!" and ":!" commands. The redirection is kept outside of the
6305 quoting. See 'shellxquote' to include the redirection. It's
6306 probably not useful to set both options.
6307 This is an empty string by default. Only known to be useful for
6308 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6309 or bash, where it should be "\"". The default is adjusted according
6310 the value of 'shell', to reduce the need to set this option by the
6311 user. See |dos-shell|.
6312 This option cannot be set from a |modeline| or in the |sandbox|, for
6313 security reasons.
6314
6315 *'shellredir'* *'srr'*
6316'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6317 global
6318 {not in Vi}
6319 String to be used to put the output of a filter command in a temporary
6320 file. See also |:!|. See |option-backslash| about including spaces
6321 and backslashes.
6322 The name of the temporary file can be represented by "%s" if necessary
6323 (the file name is appended automatically if no %s appears in the value
6324 of this option).
6325 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6326 or "zsh" during initializations, the default becomes ">&". If the
6327 'shell' option is "sh", "ksh" or "bash" the default becomes
6328 ">%s 2>&1". This means that stderr is also included.
6329 For Win32, the Unix checks are done and additionally "cmd" is checked
6330 for, which makes the default ">%s 2>&1". Also, the same names with
6331 ".exe" appended are checked for.
6332 The initialization of this option is done after reading the ".vimrc"
6333 and the other initializations, so that when the 'shell' option is set
6334 there, the 'shellredir' option changes automatically unless it was
6335 explicitly set before.
6336 In the future pipes may be used for filtering and this option will
6337 become obsolete (at least for Unix).
6338 This option cannot be set from a |modeline| or in the |sandbox|, for
6339 security reasons.
6340
6341 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6342'shellslash' 'ssl' boolean (default off)
6343 global
6344 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6345 When set, a forward slash is used when expanding file names. This is
6346 useful when a Unix-like shell is used instead of command.com or
6347 cmd.exe. Backward slashes can still be typed, but they are changed to
6348 forward slashes by Vim.
6349 Note that setting or resetting this option has no effect for some
6350 existing file names, thus this option needs to be set before opening
6351 any file for best results. This might change in the future.
6352 'shellslash' only works when a backslash can be used as a path
6353 separator. To test if this is so use: >
6354 if exists('+shellslash')
6355<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006356 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6357'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6358 global
6359 {not in Vi}
6360 When on, use temp files for shell commands. When off use a pipe.
6361 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006362 Currently a pipe is only supported on Unix and MS-Windows 2K and
6363 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006364 :if has("filterpipe")
6365< The advantage of using a pipe is that nobody can read the temp file
6366 and the 'shell' command does not need to support redirection.
6367 The advantage of using a temp file is that the file type and encoding
6368 can be detected.
6369 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6370 |FilterWritePost| autocommands event are not triggered when
6371 'shelltemp' is off.
6372
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 *'shelltype'* *'st'*
6374'shelltype' 'st' number (default 0)
6375 global
6376 {not in Vi} {only for the Amiga}
6377 On the Amiga this option influences the way how the commands work
6378 which use a shell.
6379 0 and 1: always use the shell
6380 2 and 3: use the shell only to filter lines
6381 4 and 5: use shell only for ':sh' command
6382 When not using the shell, the command is executed directly.
6383
6384 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6385 1 and 3: use "shell cmd" to start external commands
6386
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006387 *'shellxescape'* *'sxe'*
6388'shellxescape' 'sxe' string (default: "";
6389 for MS-DOS and MS-Windows: "\"&|<>()@^")
6390 global
6391 {not in Vi}
6392 When 'shellxquote' is set to "(" then the characters listed in this
6393 option will be escaped with a '^' character. This makes it possible
6394 to execute most external commands with cmd.exe.
6395
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 *'shellxquote'* *'sxq'*
6397'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006398 for Win32, when 'shell' is cmd.exe: "("
6399 for Win32, when 'shell' contains "sh"
6400 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 for Unix, when using system(): "\"")
6402 global
6403 {not in Vi}
6404 Quoting character(s), put around the command passed to the shell, for
6405 the "!" and ":!" commands. Includes the redirection. See
6406 'shellquote' to exclude the redirection. It's probably not useful
6407 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006408 When the value is '(' then ')' is appended. When the value is '"('
6409 then ')"' is appended.
6410 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006411 This is an empty string by default on most systems, but is known to be
6412 useful for on Win32 version, either for cmd.exe which automatically
6413 strips off the first and last quote on a command, or 3rd-party shells
6414 such as the MKS Korn Shell or bash, where it should be "\"". The
6415 default is adjusted according the value of 'shell', to reduce the need
6416 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006417 This option cannot be set from a |modeline| or in the |sandbox|, for
6418 security reasons.
6419
6420 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6421'shiftround' 'sr' boolean (default off)
6422 global
6423 {not in Vi}
6424 Round indent to multiple of 'shiftwidth'. Applies to > and <
6425 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6426 a multiple of 'shiftwidth' (this is Vi compatible).
6427 NOTE: This option is reset when 'compatible' is set.
6428
6429 *'shiftwidth'* *'sw'*
6430'shiftwidth' 'sw' number (default 8)
6431 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006432 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006434 When zero the 'ts' value will be used. Use the |shiftwidth()|
6435 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436
6437 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006438'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6439 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 global
6441 {not in Vi}
6442 This option helps to avoid all the |hit-enter| prompts caused by file
6443 messages, for example with CTRL-G, and to avoid some other messages.
6444 It is a list of flags:
6445 flag meaning when present ~
6446 f use "(3 of 5)" instead of "(file 3 of 5)"
6447 i use "[noeol]" instead of "[Incomplete last line]"
6448 l use "999L, 888C" instead of "999 lines, 888 characters"
6449 m use "[+]" instead of "[Modified]"
6450 n use "[New]" instead of "[New File]"
6451 r use "[RO]" instead of "[readonly]"
6452 w use "[w]" instead of "written" for file write message
6453 and "[a]" instead of "appended" for ':w >> file' command
6454 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6455 "[unix format]" and "[mac]" instead of "[mac format]".
6456 a all of the above abbreviations
6457
6458 o overwrite message for writing a file with subsequent message
6459 for reading a file (useful for ":wn" or when 'autowrite' on)
6460 O message for reading a file overwrites any previous message.
6461 Also for quickfix message (e.g., ":cn").
6462 s don't give "search hit BOTTOM, continuing at TOP" or "search
6463 hit TOP, continuing at BOTTOM" messages
6464 t truncate file message at the start if it is too long to fit
6465 on the command-line, "<" will appear in the left most column.
6466 Ignored in Ex mode.
6467 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006468 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 Ignored in Ex mode.
6470 W don't give "written" or "[w]" when writing a file
6471 A don't give the "ATTENTION" message when an existing swap file
6472 is found.
6473 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006474 c don't give |ins-completion-menu| messages. For example,
6475 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6476 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477
6478 This gives you the opportunity to avoid that a change between buffers
6479 requires you to hit <Enter>, but still gives as useful a message as
6480 possible for the space available. To get the whole message that you
6481 would have got with 'shm' empty, use ":file!"
6482 Useful values:
6483 shm= No abbreviation of message.
6484 shm=a Abbreviation, but no loss of information.
6485 shm=at Abbreviation, and truncate message when necessary.
6486
6487 NOTE: This option is set to the Vi default value when 'compatible' is
6488 set and to the Vim default value when 'compatible' is reset.
6489
6490 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6491'shortname' 'sn' boolean (default off)
6492 local to buffer
6493 {not in Vi, not in MS-DOS versions}
6494 Filenames are assumed to be 8 characters plus one extension of 3
6495 characters. Multiple dots in file names are not allowed. When this
6496 option is on, dots in file names are replaced with underscores when
6497 adding an extension (".~" or ".swp"). This option is not available
6498 for MS-DOS, because then it would always be on. This option is useful
6499 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6500 or crossdos. When running the Win32 GUI version under Win32s, this
6501 option is always on by default.
6502
6503 *'showbreak'* *'sbr'* *E595*
6504'showbreak' 'sbr' string (default "")
6505 global
6506 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006507 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 feature}
6509 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006510 values are "> " or "+++ ": >
6511 :set showbreak=>\
6512< Note the backslash to escape the trailing space. It's easier like
6513 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006514 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006515< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 comma (in a future version the comma might be used to separate the
6517 part that is shown at the end and at the start of a line).
6518 The characters are highlighted according to the '@' flag in
6519 'highlight'.
6520 Note that tabs after the showbreak will be displayed differently.
6521 If you want the 'showbreak' to appear in between line numbers, add the
6522 "n" flag to 'cpoptions'.
6523
6524 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6525'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6526 off)
6527 global
6528 {not in Vi}
6529 {not available when compiled without the
6530 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006531 Show (partial) command in the last line of the screen. Set this
6532 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 In Visual mode the size of the selected area is shown:
6534 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006535 If the number of bytes is different it is also displayed: "2-6"
6536 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006538 - When selecting a block, the size in screen characters:
6539 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 NOTE: This option is set to the Vi default value when 'compatible' is
6541 set and to the Vim default value when 'compatible' is reset.
6542
6543 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6544'showfulltag' 'sft' boolean (default off)
6545 global
6546 {not in Vi}
6547 When completing a word in insert mode (see |ins-completion|) from the
6548 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006549 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 matched a C function, you can see a template for what arguments are
6551 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006552 Note that this doesn't work well together with having "longest" in
6553 'completeopt', because the completion from the search pattern may not
6554 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555
6556 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6557'showmatch' 'sm' boolean (default off)
6558 global
6559 When a bracket is inserted, briefly jump to the matching one. The
6560 jump is only done if the match can be seen on the screen. The time to
6561 show the match can be set with 'matchtime'.
6562 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006563 seen or not).
6564 This option is reset when 'paste' is set and restored when 'paste' is
6565 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 When the 'm' flag is not included in 'cpoptions', typing a character
6567 will immediately move the cursor back to where it belongs.
6568 See the "sm" field in 'guicursor' for setting the cursor shape and
6569 blinking when showing the match.
6570 The 'matchpairs' option can be used to specify the characters to show
6571 matches for. 'rightleft' and 'revins' are used to look for opposite
6572 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006573 Also see the matchparen plugin for highlighting the match when moving
6574 around |pi_paren.txt|.
6575 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576
6577 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6578'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6579 global
6580 If in Insert, Replace or Visual mode put a message on the last line.
6581 Use the 'M' flag in 'highlight' to set the type of highlighting for
6582 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006583 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 doesn't mean XIM is really active, especially when 'imactivatekey' is
6585 not set.
6586 NOTE: This option is set to the Vi default value when 'compatible' is
6587 set and to the Vim default value when 'compatible' is reset.
6588
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006589 *'showtabline'* *'stal'*
6590'showtabline' 'stal' number (default 1)
6591 global
6592 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006593 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006594 feature}
6595 The value of this option specifies when the line with tab page labels
6596 will be displayed:
6597 0: never
6598 1: only if there are at least two tab pages
6599 2: always
6600 This is both for the GUI and non-GUI implementation of the tab pages
6601 line.
6602 See |tab-page| for more information about tab pages.
6603
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 *'sidescroll'* *'ss'*
6605'sidescroll' 'ss' number (default 0)
6606 global
6607 {not in Vi}
6608 The minimal number of columns to scroll horizontally. Used only when
6609 the 'wrap' option is off and the cursor is moved off of the screen.
6610 When it is zero the cursor will be put in the middle of the screen.
6611 When using a slow terminal set it to a large number or 0. When using
6612 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6613 commands.
6614
6615 *'sidescrolloff'* *'siso'*
6616'sidescrolloff' 'siso' number (default 0)
6617 global
6618 {not in Vi}
6619 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006620 right of the cursor if 'nowrap' is set. Setting this option to a
6621 value greater than 0 while having |'sidescroll'| also at a non-zero
6622 value makes some context visible in the line you are scrolling in
6623 horizontally (except at beginning of the line). Setting this option
6624 to a large value (like 999) has the effect of keeping the cursor
6625 horizontally centered in the window, as long as one does not come too
6626 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 NOTE: This option is set to 0 when 'compatible' is set.
6628
6629 Example: Try this together with 'sidescroll' and 'listchars' as
6630 in the following example to never allow the cursor to move
6631 onto the "extends" character:
6632
6633 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6634 :set sidescrolloff=1
6635
6636
6637 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6638'smartcase' 'scs' boolean (default off)
6639 global
6640 {not in Vi}
6641 Override the 'ignorecase' option if the search pattern contains upper
6642 case characters. Only used when the search pattern is typed and
6643 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006644 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6646 recalling the search pattern from history and hitting <Enter>.
6647 NOTE: This option is reset when 'compatible' is set.
6648
6649 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6650'smartindent' 'si' boolean (default off)
6651 local to buffer
6652 {not in Vi}
6653 {not available when compiled without the
6654 |+smartindent| feature}
6655 Do smart autoindenting when starting a new line. Works for C-like
6656 programs, but can also be used for other languages. 'cindent' does
6657 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006658 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006659 setting 'si' has no effect. 'indentexpr' is a more advanced
6660 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 Normally 'autoindent' should also be on when using 'smartindent'.
6662 An indent is automatically inserted:
6663 - After a line ending in '{'.
6664 - After a line starting with a keyword from 'cinwords'.
6665 - Before a line starting with '}' (only with the "O" command).
6666 When typing '}' as the first character in a new line, that line is
6667 given the same indent as the matching '{'.
6668 When typing '#' as the first character in a new line, the indent for
6669 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006670 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6672 When using the ">>" command, lines starting with '#' are not shifted
6673 right.
Bram Moolenaarca635012015-09-25 20:34:21 +02006674 NOTE: 'smartindent' is reset when 'compatible' is set.
6675 This option is reset when 'paste' is set and restored when 'paste' is
6676 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677
6678 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6679'smarttab' 'sta' boolean (default off)
6680 global
6681 {not in Vi}
6682 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006683 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6684 <BS> will delete a 'shiftwidth' worth of space at the start of the
6685 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006686 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006687 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6688 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006689 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006691 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006692 This option is reset when 'paste' is set and restored when 'paste' is
6693 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 NOTE: This option is reset when 'compatible' is set.
6695
6696 *'softtabstop'* *'sts'*
6697'softtabstop' 'sts' number (default 0)
6698 local to buffer
6699 {not in Vi}
6700 Number of spaces that a <Tab> counts for while performing editing
6701 operations, like inserting a <Tab> or using <BS>. It "feels" like
6702 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6703 used. This is useful to keep the 'ts' setting at its standard value
6704 of 8, while being able to edit like it is set to 'sts'. However,
6705 commands like "x" still work on the actual characters.
6706 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006707 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006708 'softtabstop' is set to 0 when the 'paste' option is set and restored
6709 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6711 spaces is minimized by using <Tab>s.
6712 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6713 set.
6714 NOTE: This option is set to 0 when 'compatible' is set.
6715
Bram Moolenaar217ad922005-03-20 22:37:15 +00006716 *'spell'* *'nospell'*
6717'spell' boolean (default off)
6718 local to window
6719 {not in Vi}
6720 {not available when compiled without the |+syntax|
6721 feature}
6722 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006723 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006724
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006725 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006726'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006727 local to buffer
6728 {not in Vi}
6729 {not available when compiled without the |+syntax|
6730 feature}
6731 Pattern to locate the end of a sentence. The following word will be
6732 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006733 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006734 When this check is not wanted make this option empty.
6735 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006736 Be careful with special characters, see |option-backslash| about
6737 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006738 To set this option automatically depending on the language, see
6739 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006740
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006741 *'spellfile'* *'spf'*
6742'spellfile' 'spf' string (default empty)
6743 local to buffer
6744 {not in Vi}
6745 {not available when compiled without the |+syntax|
6746 feature}
6747 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006748 commands. It must end in ".{encoding}.add". You need to include the
6749 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006750 *E765*
6751 It may also be a comma separated list of names. A count before the
6752 |zg| and |zw| commands can be used to access each. This allows using
6753 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006754 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006755 you: Using the first directory in 'runtimepath' that is writable. If
6756 there is no "spell" directory yet it will be created. For the file
6757 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006758 ignoring the region.
6759 The resulting ".spl" file will be used for spell checking, it does not
6760 have to appear in 'spelllang'.
6761 Normally one file is used for all regions, but you can add the region
6762 name if you want to. However, it will then only be used when
6763 'spellfile' is set to it, for entries in 'spelllang' only files
6764 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006765 This option cannot be set from a |modeline| or in the |sandbox|, for
6766 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006767
Bram Moolenaar217ad922005-03-20 22:37:15 +00006768 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006769'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006770 local to buffer
6771 {not in Vi}
6772 {not available when compiled without the |+syntax|
6773 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006774 A comma separated list of word list names. When the 'spell' option is
6775 on spellchecking will be done for these languages. Example: >
6776 set spelllang=en_us,nl,medical
6777< This means US English, Dutch and medical words are recognized. Words
6778 that are not recognized will be highlighted.
6779 The word list name must not include a comma or dot. Using a dash is
6780 recommended to separate the two letter language name from a
6781 specification. Thus "en-rare" is used for rare English words.
6782 A region name must come last and have the form "_xx", where "xx" is
6783 the two-letter, lower case region name. You can use more than one
6784 region by listing them: "en_us,en_ca" supports both US and Canadian
6785 English, but not words specific for Australia, New Zealand or Great
6786 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006787 If the name "cjk" is included East Asian characters are excluded from
6788 spell checking. This is useful when editing text that also has Asian
6789 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006790 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006791 As a special case the name of a .spl file can be given as-is. The
6792 first "_xx" in the name is removed and used as the region name
6793 (_xx is an underscore, two letters and followed by a non-letter).
6794 This is mainly for testing purposes. You must make sure the correct
6795 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006796 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006797 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6798 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006799 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006800
Bram Moolenaar98692072006-02-04 00:57:42 +00006801 If the |spellfile.vim| plugin is active and you use a language name
6802 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6803 will ask you if you want to download the file.
6804
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006805 After this option has been set successfully, Vim will source the files
6806 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006807 up to the first comma, dot or underscore.
6808 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006809
6810
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006811 *'spellsuggest'* *'sps'*
6812'spellsuggest' 'sps' string (default "best")
6813 global
6814 {not in Vi}
6815 {not available when compiled without the |+syntax|
6816 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006817 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006818 the |spellsuggest()| function. This is a comma-separated list of
6819 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006820
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006821 best Internal method that works best for English. Finds
6822 changes like "fast" and uses a bit of sound-a-like
6823 scoring to improve the ordering.
6824
6825 double Internal method that uses two methods and mixes the
6826 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006827 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006828 word. That only works when the language specifies
6829 sound folding. Can be slow and doesn't always give
6830 better results.
6831
6832 fast Internal method that only checks for simple changes:
6833 character inserts/deletes/swaps. Works well for
6834 simple typing mistakes.
6835
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006836 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006837 Not used for |spellsuggest()|. The number of
6838 suggestions is never more than the value of 'lines'
6839 minus two.
6840
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006841 file:{filename} Read file {filename}, which must have two columns,
6842 separated by a slash. The first column contains the
6843 bad word, the second column the suggested good word.
6844 Example:
6845 theribal/terrible ~
6846 Use this for common mistakes that do not appear at the
6847 top of the suggestion list with the internal methods.
6848 Lines without a slash are ignored, use this for
6849 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006850 The word in the second column must be correct,
6851 otherwise it will not be used. Add the word to an
6852 ".add" file if it is currently flagged as a spelling
6853 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006854 The file is used for all languages.
6855
6856 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6857 trouble with spaces. |v:val| holds the badly spelled
6858 word. The expression must evaluate to a List of
6859 Lists, each with a suggestion and a score.
6860 Example:
6861 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006862 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006863 internal methods use. A lower score is better.
6864 This may invoke |spellsuggest()| if you temporarily
6865 set 'spellsuggest' to exclude the "expr:" part.
6866 Errors are silently ignored, unless you set the
6867 'verbose' option to a non-zero value.
6868
6869 Only one of "best", "double" or "fast" may be used. The others may
6870 appear several times in any order. Example: >
6871 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6872<
6873 This option cannot be set from a |modeline| or in the |sandbox|, for
6874 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006875
6876
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6878'splitbelow' 'sb' boolean (default off)
6879 global
6880 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006881 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 feature}
6883 When on, splitting a window will put the new window below the current
6884 one. |:split|
6885
6886 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6887'splitright' 'spr' boolean (default off)
6888 global
6889 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006890 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 feature}
6892 When on, splitting a window will put the new window right of the
6893 current one. |:vsplit|
6894
6895 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6896'startofline' 'sol' boolean (default on)
6897 global
6898 {not in Vi}
6899 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006900 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006901 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006902 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 with a linewise operator, with "%" with a count and to buffer changing
6904 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6905 only has a line number, e.g., ":25" or ":+".
6906 In case of buffer changing commands the cursor is placed at the column
6907 where it was the last time the buffer was edited.
6908 NOTE: This option is set when 'compatible' is set.
6909
Bram Moolenaar00654022011-02-25 14:42:19 +01006910 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006912 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 {not in Vi}
6914 {not available when compiled without the |+statusline|
6915 feature}
6916 When nonempty, this option determines the content of the status line.
6917 Also see |status-line|.
6918
6919 The option consists of printf style '%' items interspersed with
6920 normal text. Each status line item is of the form:
6921 %-0{minwid}.{maxwid}{item}
6922 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006923 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924
Bram Moolenaar238a5642006-02-21 22:12:05 +00006925 When the option starts with "%!" then it is used as an expression,
6926 evaluated and the result is used as the option value. Example: >
6927 :set statusline=%!MyStatusLine()
6928< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006929 Note that the "%!" expression is evaluated in the context of the
6930 current window and buffer, while %{} items are evaluated in the
6931 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006932
6933 When there is error while evaluating the option then it will be made
6934 empty to avoid further errors. Otherwise screen updating would loop.
6935
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 Note that the only effect of 'ruler' when this option is set (and
6937 'laststatus' is 2) is controlling the output of |CTRL-G|.
6938
6939 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006940 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006942 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 minwid Minimum width of the item, padding as set by '-' & '0'.
6944 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006945 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 on the left for text items. Numeric items will be
6947 shifted down to maxwid-2 digits followed by '>'number
6948 where number is the amount of missing digits, much like
6949 an exponential notation.
6950 item A one letter code as described below.
6951
6952 Following is a description of the possible statusline items. The
6953 second character in "item" is the type:
6954 N for number
6955 S for string
6956 F for flags as described below
6957 - not applicable
6958
6959 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006960 f S Path to the file in the buffer, as typed or relative to current
6961 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 F S Full path to the file in the buffer.
6963 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006964 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006966 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006968 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006970 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006972 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006973 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6974 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006975 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6977 being used: "<keymap>"
6978 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006979 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006980 B N As above, in hexadecimal.
6981 o N Byte number in file of byte under cursor, first byte is 1.
6982 Mnemonic: Offset from start of file (with one added)
6983 {not available when compiled without |+byte_offset| feature}
6984 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006985 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 l N Line number.
6987 L N Number of lines in buffer.
6988 c N Column number.
6989 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006990 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 p N Percentage through file in lines as in |CTRL-G|.
6992 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006993 percentage described for 'ruler'. Always 3 in length, unless
6994 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006995 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006996 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006997 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006998 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006999 ( - Start of item group. Can be used for setting the width and
7000 alignment of a section. Must be followed by %) somewhere.
7001 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007002 T N For 'tabline': start of tab page N label. Use %T after the last
7003 label. This information is used for mouse clicks.
7004 X N For 'tabline': start of close tab N label. Use %X after the
7005 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7006 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007007 < - Where to truncate line if too long. Default is at the start.
7008 No width fields allowed.
7009 = - Separation point between left and right aligned items.
7010 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007011 # - Set highlight group. The name must follow and then a # again.
7012 Thus use %#HLname# for highlight group HLname. The same
7013 highlighting is used, also for the statusline of non-current
7014 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007016 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007017 The difference between User{N} and StatusLine will be applied
7018 to StatusLineNC for the statusline of non-current windows.
7019 The number N must be between 1 and 9. See |hl-User1..9|
7020
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007021 When displaying a flag, Vim removes the leading comma, if any, when
7022 that flag comes right after plaintext. This will make a nice display
7023 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024
Bram Moolenaar582fd852005-03-28 20:58:01 +00007025 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 not set) and a minwid is not set for the group, the whole group will
7027 become empty. This will make a group like the following disappear
7028 completely from the statusline when none of the flags are set. >
7029 :set statusline=...%(\ [%M%R%H]%)...
7030<
7031 Beware that an expression is evaluated each and every time the status
7032 line is displayed. The current buffer and current window will be set
7033 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007034 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007036 real current buffer.
7037
Bram Moolenaar30b65812012-07-12 22:01:11 +02007038 The 'statusline' option will be evaluated in the |sandbox| if set from
7039 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007040
7041 It is not allowed to change text or jump to another window while
7042 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043
7044 If the statusline is not updated when you want it (e.g., after setting
7045 a variable that's used in an expression), you can force an update by
7046 setting an option without changing its value. Example: >
7047 :let &ro = &ro
7048
7049< A result of all digits is regarded a number for display purposes.
7050 Otherwise the result is taken as flag text and applied to the rules
7051 described above.
7052
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007053 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007054 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7055 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7056
7057 Examples:
7058 Emulate standard status line with 'ruler' set >
7059 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7060< Similar, but add ASCII value of char under the cursor (like "ga") >
7061 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7062< Display byte count and byte value, modified flag in red. >
7063 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7064 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7065< Display a ,GZ flag if a compressed file is loaded >
7066 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7067< In the |:autocmd|'s: >
7068 :let b:gzflag = 1
7069< And: >
7070 :unlet b:gzflag
7071< And define this function: >
7072 :function VarExists(var, val)
7073 : if exists(a:var) | return a:val | else | return '' | endif
7074 :endfunction
7075<
7076 *'suffixes'* *'su'*
7077'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7078 global
7079 {not in Vi}
7080 Files with these suffixes get a lower priority when multiple files
7081 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007082 suffixes. Spaces after the comma are ignored. A dot is also seen as
7083 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 separator, precede it with a backslash (see |option-backslash| about
7085 including spaces and backslashes).
7086 See 'wildignore' for completely ignoring files.
7087 The use of |:set+=| and |:set-=| is preferred when adding or removing
7088 suffixes from the list. This avoids problems when a future version
7089 uses another default.
7090
7091 *'suffixesadd'* *'sua'*
7092'suffixesadd' 'sua' string (default "")
7093 local to buffer
7094 {not in Vi}
7095 {not available when compiled without the
7096 |+file_in_path| feature}
7097 Comma separated list of suffixes, which are used when searching for a
7098 file for the "gf", "[I", etc. commands. Example: >
7099 :set suffixesadd=.java
7100<
7101 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7102'swapfile' 'swf' boolean (default on)
7103 local to buffer
7104 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007105 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 swapfile is not wanted for a specific buffer. For example, with
7107 confidential information that even root must not be able to access.
7108 Careful: All text will be in memory:
7109 - Don't use this for big files.
7110 - Recovery will be impossible!
7111 A swapfile will only be present when |'updatecount'| is non-zero and
7112 'swapfile' is set.
7113 When 'swapfile' is reset, the swap file for the current buffer is
7114 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7115 non-zero, a swap file is immediately created.
7116 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007117 If you want to open a new buffer without creating a swap file for it,
7118 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119
7120 This option is used together with 'bufhidden' and 'buftype' to
7121 specify special kinds of buffers. See |special-buffers|.
7122
7123 *'swapsync'* *'sws'*
7124'swapsync' 'sws' string (default "fsync")
7125 global
7126 {not in Vi}
7127 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007128 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 When this option is empty parts of the swap file may be in memory and
7130 not written to disk. When the system crashes you may lose more work.
7131 On Unix the system does a sync now and then without Vim asking for it,
7132 so the disadvantage of setting this option off is small. On some
7133 systems the swap file will not be written at all. For a unix system
7134 setting it to "sync" will use the sync() call instead of the default
7135 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007136 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007137
7138 *'switchbuf'* *'swb'*
7139'switchbuf' 'swb' string (default "")
7140 global
7141 {not in Vi}
7142 This option controls the behavior when switching between buffers.
7143 Possible values (comma separated list):
7144 useopen If included, jump to the first open window that
7145 contains the specified buffer (if there is one).
7146 Otherwise: Do not examine other windows.
7147 This setting is checked with |quickfix| commands, when
7148 jumping to errors (":cc", ":cn", "cp", etc.). It is
7149 also used in all buffer related split commands, for
7150 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007151 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007152 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007154 a buffer for a |quickfix| command that display errors.
7155 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007156 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007157 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007158 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007160 *'synmaxcol'* *'smc'*
7161'synmaxcol' 'smc' number (default 3000)
7162 local to buffer
7163 {not in Vi}
7164 {not available when compiled without the |+syntax|
7165 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007166 Maximum column in which to search for syntax items. In long lines the
7167 text after this column is not highlighted and following lines may not
7168 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007169 This helps to avoid very slow redrawing for an XML file that is one
7170 long line.
7171 Set to zero to remove the limit.
7172
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 *'syntax'* *'syn'*
7174'syntax' 'syn' string (default empty)
7175 local to buffer
7176 {not in Vi}
7177 {not available when compiled without the |+syntax|
7178 feature}
7179 When this option is set, the syntax with this name is loaded, unless
7180 syntax highlighting has been switched off with ":syntax off".
7181 Otherwise this option does not always reflect the current syntax (the
7182 b:current_syntax variable does).
7183 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007184 not automatically recognized. Example, in an IDL file:
7185 /* vim: set syntax=idl : */ ~
7186 When a dot appears in the value then this separates two filetype
7187 names. Example:
7188 /* vim: set syntax=c.doxygen : */ ~
7189 This will use the "c" syntax first, then the "doxygen" syntax.
7190 Note that the second one must be prepared to be loaded as an addition,
7191 otherwise it will be skipped. More than one dot may appear.
7192 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 :set syntax=OFF
7194< To switch syntax highlighting on according to the current value of the
7195 'filetype' option: >
7196 :set syntax=ON
7197< What actually happens when setting the 'syntax' option is that the
7198 Syntax autocommand event is triggered with the value as argument.
7199 This option is not copied to another buffer, independent of the 's' or
7200 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007201 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007203 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007204'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007205 global
7206 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007207 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007208 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007209 When nonempty, this option determines the content of the tab pages
7210 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007211 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007212
7213 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007214 option and only when there is no GUI tab line. When 'e' is in
7215 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007216 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007217
7218 The value is evaluated like with 'statusline'. You can use
7219 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007220 the text to be displayed. Use "%1T" for the first label, "%2T" for
7221 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007222
7223 Keep in mind that only one of the tab pages is the current one, others
7224 are invisible and you can't jump to their windows.
7225
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007226
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007227 *'tabpagemax'* *'tpm'*
7228'tabpagemax' 'tpm' number (default 10)
7229 global
7230 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007231 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007232 feature}
7233 Maximum number of tab pages to be opened by the |-p| command line
7234 argument or the ":tab all" command. |tabpage|
7235
7236
7237 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238'tabstop' 'ts' number (default 8)
7239 local to buffer
7240 Number of spaces that a <Tab> in the file counts for. Also see
7241 |:retab| command, and 'softtabstop' option.
7242
7243 Note: Setting 'tabstop' to any other value than 8 can make your file
7244 appear wrong in many places (e.g., when printing it).
7245
7246 There are four main ways to use tabs in Vim:
7247 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7248 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007249 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 behave like a tab appears every 4 (or 3) characters.
7251 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7252 'expandtab'. This way you will always insert spaces. The
7253 formatting will never be messed up when 'tabstop' is changed.
7254 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007255 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 works when using Vim to edit the file.
7257 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7258 'noexpandtab'. This should then work (for initial indents only)
7259 for any tabstop setting that people use. It might be nice to have
7260 tabs after the first non-blank inserted as spaces if you do this
7261 though. Otherwise aligned comments will be wrong when 'tabstop' is
7262 changed.
7263
7264 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7265'tagbsearch' 'tbs' boolean (default on)
7266 global
7267 {not in Vi}
7268 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007269 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 searching makes searching for a tag a LOT faster, but a linear search
7271 will find more tags if the tags file wasn't properly sorted.
7272 Vim normally assumes that your tags files are sorted, or indicate that
7273 they are not sorted. Only when this is not the case does the
7274 'tagbsearch' option need to be switched off.
7275
7276 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007277 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 certain files, or retry all files with a linear search. When
7279 'tagbsearch' is off, only a linear search is done.
7280
7281 Linear searching is done anyway, for one file, when Vim finds a line
7282 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007283 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284< [The whitespace before and after the '0' must be a single <Tab>]
7285
7286 When a binary search was done and no match was found in any of the
7287 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7288 instead of a normal tag name, a retry is done with a linear search.
7289 Tags in unsorted tags files, and matches with different case will only
7290 be found in the retry.
7291
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007292 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007293 linear search can be avoided for the 'ignorecase' case. Use a value
7294 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7295 case-fold sorted with the -f switch to "sort" in most unices, as in
7296 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007297 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7298 for this as well. Note that case must be folded to uppercase for this
7299 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300
7301 When 'tagbsearch' is off, tags searching is slower when a full match
7302 exists, but faster when no full match exists. Tags in unsorted tags
7303 files may only be found with 'tagbsearch' off.
7304 When the tags file is not sorted, or sorted in a wrong way (not on
7305 ASCII byte value), 'tagbsearch' should be off, or the line given above
7306 must be included in the tags file.
7307 This option doesn't affect commands that find all matching tags (e.g.,
7308 command-line completion and ":help").
7309 {Vi: always uses binary search in some versions}
7310
7311 *'taglength'* *'tl'*
7312'taglength' 'tl' number (default 0)
7313 global
7314 If non-zero, tags are significant up to this number of characters.
7315
7316 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7317'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7318 global
7319 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007320 If on and using a tags file in another directory, file names in that
7321 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007322 NOTE: This option is set to the Vi default value when 'compatible' is
7323 set and to the Vim default value when 'compatible' is reset.
7324
7325 *'tags'* *'tag'* *E433*
7326'tags' 'tag' string (default "./tags,tags", when compiled with
7327 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7328 global or local to buffer |global-local|
7329 Filenames for the tag command, separated by spaces or commas. To
7330 include a space or comma in a file name, precede it with a backslash
7331 (see |option-backslash| about including spaces and backslashes).
7332 When a file name starts with "./", the '.' is replaced with the path
7333 of the current file. But only when the 'd' flag is not included in
7334 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7335 |tags-option|.
7336 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007337 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7338 find all files named "tags" below "/lib". The filename itself cannot
7339 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7340 files called "tags?". {not available when compiled without the
7341 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007342 The |tagfiles()| function can be used to get a list of the file names
7343 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7345 files are also supported. They are automatically recognized. The
7346 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7347 differences are ignored (MS-Windows). |emacs-tags|
7348 The use of |:set+=| and |:set-=| is preferred when adding or removing
7349 file names from the list. This avoids problems when a future version
7350 uses another default.
7351 {Vi: default is "tags /usr/lib/tags"}
7352
7353 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7354'tagstack' 'tgst' boolean (default on)
7355 global
7356 {not in all versions of Vi}
7357 When on, the |tagstack| is used normally. When off, a ":tag" or
7358 ":tselect" command with an argument will not push the tag onto the
7359 tagstack. A following ":tag" without an argument, a ":pop" command or
7360 any other command that uses the tagstack will use the unmodified
7361 tagstack, but does change the pointer to the active entry.
7362 Resetting this option is useful when using a ":tag" command in a
7363 mapping which should not change the tagstack.
7364
7365 *'term'* *E529* *E530* *E531*
7366'term' string (default is $TERM, if that fails:
7367 in the GUI: "builtin_gui"
7368 on Amiga: "amiga"
7369 on BeOS: "beos-ansi"
7370 on Mac: "mac-ansi"
7371 on MiNT: "vt52"
7372 on MS-DOS: "pcterm"
7373 on OS/2: "os2ansi"
7374 on Unix: "ansi"
7375 on VMS: "ansi"
7376 on Win 32: "win32")
7377 global
7378 Name of the terminal. Used for choosing the terminal control
7379 characters. Environment variables are expanded |:set_env|.
7380 For example: >
7381 :set term=$TERM
7382< See |termcap|.
7383
7384 *'termbidi'* *'tbidi'*
7385 *'notermbidi'* *'notbidi'*
7386'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7387 global
7388 {not in Vi}
7389 {only available when compiled with the |+arabic|
7390 feature}
7391 The terminal is in charge of Bi-directionality of text (as specified
7392 by Unicode). The terminal is also expected to do the required shaping
7393 that some languages (such as Arabic) require.
7394 Setting this option implies that 'rightleft' will not be set when
7395 'arabic' is set and the value of 'arabicshape' will be ignored.
7396 Note that setting 'termbidi' has the immediate effect that
7397 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7398 This option is reset when the GUI is started.
7399 For further details see |arabic.txt|.
7400
7401 *'termencoding'* *'tenc'*
7402'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7403 Macintosh GUI: "macroman")
7404 global
7405 {only available when compiled with the |+multi_byte|
7406 feature}
7407 {not in Vi}
7408 Encoding used for the terminal. This specifies what character
7409 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007410 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007411 display). Except for the Mac when 'macatsui' is off, then
7412 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007413 *E617*
7414 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7415 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7416 Any attempts to set a different value will be rejected, and an error
7417 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007418 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 because the Win32 system always passes Unicode characters.
7420 When empty, the same encoding is used as for the 'encoding' option.
7421 This is the normal value.
7422 Not all combinations for 'termencoding' and 'encoding' are valid. See
7423 |encoding-table|.
7424 The value for this option must be supported by internal conversions or
7425 iconv(). When this is not possible no conversion will be done and you
7426 will probably experience problems with non-ASCII characters.
7427 Example: You are working with the locale set to euc-jp (Japanese) and
7428 want to edit a UTF-8 file: >
7429 :let &termencoding = &encoding
7430 :set encoding=utf-8
7431< You need to do this when your system has no locale support for UTF-8.
7432
7433 *'terse'* *'noterse'*
7434'terse' boolean (default off)
7435 global
7436 When set: Add 's' flag to 'shortmess' option (this makes the message
7437 for a search that hits the start or end of the file not being
7438 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7439 shortens a lot of messages}
7440
7441 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7442'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7443 global
7444 {not in Vi}
7445 This option is obsolete. Use 'fileformats'.
7446 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7447 set to the default value for the current system. When 'textauto' is
7448 reset, 'fileformats' is made empty.
7449 NOTE: This option is set to the Vi default value when 'compatible' is
7450 set and to the Vim default value when 'compatible' is reset.
7451
7452 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7453'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7454 others: default off)
7455 local to buffer
7456 {not in Vi}
7457 This option is obsolete. Use 'fileformat'.
7458 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7459 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7460 "unix".
7461
7462 *'textwidth'* *'tw'*
7463'textwidth' 'tw' number (default 0)
7464 local to buffer
7465 {not in Vi}
7466 Maximum width of text that is being inserted. A longer line will be
7467 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007468 this.
7469 'textwidth' is set to 0 when the 'paste' option is set and restored
7470 when 'paste' is reset.
7471 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007473 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 NOTE: This option is set to 0 when 'compatible' is set.
7475
7476 *'thesaurus'* *'tsr'*
7477'thesaurus' 'tsr' string (default "")
7478 global or local to buffer |global-local|
7479 {not in Vi}
7480 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007481 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 the file should contain words with similar meaning, separated by
7483 non-keyword characters (white space is preferred). Maximum line
7484 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007485 To obtain a file to be used here, check out this ftp site:
7486 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007487 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 after a comma are ignored, otherwise spaces are included in the file
7489 name. See |option-backslash| about using backslashes.
7490 The use of |:set+=| and |:set-=| is preferred when adding or removing
7491 directories from the list. This avoids problems when a future version
7492 uses another default.
7493 Backticks cannot be used in this option for security reasons.
7494
7495 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7496'tildeop' 'top' boolean (default off)
7497 global
7498 {not in Vi}
7499 When on: The tilde command "~" behaves like an operator.
7500 NOTE: This option is reset when 'compatible' is set.
7501
7502 *'timeout'* *'to'* *'notimeout'* *'noto'*
7503'timeout' 'to' boolean (default on)
7504 global
7505 *'ttimeout'* *'nottimeout'*
7506'ttimeout' boolean (default off)
7507 global
7508 {not in Vi}
7509 These two options together determine the behavior when part of a
7510 mapped key sequence or keyboard code has been received:
7511
7512 'timeout' 'ttimeout' action ~
7513 off off do not time out
7514 on on or off time out on :mappings and key codes
7515 off on time out on key codes
7516
7517 If both options are off, Vim will wait until either the complete
7518 mapping or key sequence has been received, or it is clear that there
7519 is no mapping or key sequence for the received characters. For
7520 example: if you have mapped "vl" and Vim has received 'v', the next
7521 character is needed to see if the 'v' is followed by an 'l'.
7522 When one of the options is on, Vim will wait for about 1 second for
7523 the next character to arrive. After that the already received
7524 characters are interpreted as single characters. The waiting time can
7525 be changed with the 'timeoutlen' option.
7526 On slow terminals or very busy systems timing out may cause
7527 malfunctioning cursor keys. If both options are off, Vim waits
7528 forever after an entered <Esc> if there are key codes that start
7529 with <Esc>. You will have to type <Esc> twice. If you do not have
7530 problems with key codes, but would like to have :mapped key
7531 sequences not timing out in 1 second, set the 'ttimeout' option and
7532 reset the 'timeout' option.
7533
7534 NOTE: 'ttimeout' is reset when 'compatible' is set.
7535
7536 *'timeoutlen'* *'tm'*
7537'timeoutlen' 'tm' number (default 1000)
7538 global
7539 {not in all versions of Vi}
7540 *'ttimeoutlen'* *'ttm'*
7541'ttimeoutlen' 'ttm' number (default -1)
7542 global
7543 {not in Vi}
7544 The time in milliseconds that is waited for a key code or mapped key
7545 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7546 when part of a command has been typed.
7547 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7548 different timeout value for key codes is desired set 'ttimeoutlen' to
7549 a non-negative number.
7550
7551 ttimeoutlen mapping delay key code delay ~
7552 < 0 'timeoutlen' 'timeoutlen'
7553 >= 0 'timeoutlen' 'ttimeoutlen'
7554
7555 The timeout only happens when the 'timeout' and 'ttimeout' options
7556 tell so. A useful setting would be >
7557 :set timeout timeoutlen=3000 ttimeoutlen=100
7558< (time out on mapping after three seconds, time out on key codes after
7559 a tenth of a second).
7560
7561 *'title'* *'notitle'*
7562'title' boolean (default off, on when title can be restored)
7563 global
7564 {not in Vi}
7565 {not available when compiled without the |+title|
7566 feature}
7567 When on, the title of the window will be set to the value of
7568 'titlestring' (if it is not empty), or to:
7569 filename [+=-] (path) - VIM
7570 Where:
7571 filename the name of the file being edited
7572 - indicates the file cannot be modified, 'ma' off
7573 + indicates the file was modified
7574 = indicates the file is read-only
7575 =+ indicates the file is read-only and modified
7576 (path) is the path of the file being edited
7577 - VIM the server name |v:servername| or "VIM"
7578 Only works if the terminal supports setting window titles
7579 (currently Amiga console, Win32 console, all GUI versions and
7580 terminals with a non- empty 't_ts' option - these are Unix xterm and
7581 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7582 *X11*
7583 When Vim was compiled with HAVE_X11 defined, the original title will
7584 be restored if possible. The output of ":version" will include "+X11"
7585 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7586 works for the icon name |'icon'|.
7587 But: When Vim was started with the |-X| argument, restoring the title
7588 will not work (except in the GUI).
7589 If the title cannot be restored, it is set to the value of 'titleold'.
7590 You might want to restore the title outside of Vim then.
7591 When using an xterm from a remote machine you can use this command:
7592 rsh machine_name xterm -display $DISPLAY &
7593 then the WINDOWID environment variable should be inherited and the
7594 title of the window should change back to what it should be after
7595 exiting Vim.
7596
7597 *'titlelen'*
7598'titlelen' number (default 85)
7599 global
7600 {not in Vi}
7601 {not available when compiled without the |+title|
7602 feature}
7603 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007604 title. When the title is longer, only the end of the path name is
7605 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 Using a percentage makes this adapt to the width of the window. But
7607 it won't work perfectly, because the actual number of characters
7608 available also depends on the font used and other things in the title
7609 bar. When 'titlelen' is zero the full path is used. Otherwise,
7610 values from 1 to 30000 percent can be used.
7611 'titlelen' is also used for the 'titlestring' option.
7612
7613 *'titleold'*
7614'titleold' string (default "Thanks for flying Vim")
7615 global
7616 {not in Vi}
7617 {only available when compiled with the |+title|
7618 feature}
7619 This option will be used for the window title when exiting Vim if the
7620 original title cannot be restored. Only happens if 'title' is on or
7621 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007622 This option cannot be set from a |modeline| or in the |sandbox|, for
7623 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 *'titlestring'*
7625'titlestring' string (default "")
7626 global
7627 {not in Vi}
7628 {not available when compiled without the |+title|
7629 feature}
7630 When this option is not empty, it will be used for the title of the
7631 window. This happens only when the 'title' option is on.
7632 Only works if the terminal supports setting window titles (currently
7633 Amiga console, Win32 console, all GUI versions and terminals with a
7634 non-empty 't_ts' option).
7635 When Vim was compiled with HAVE_X11 defined, the original title will
7636 be restored if possible |X11|.
7637 When this option contains printf-style '%' items, they will be
7638 expanded according to the rules used for 'statusline'.
7639 Example: >
7640 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7641 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7642< The value of 'titlelen' is used to align items in the middle or right
7643 of the available space.
7644 Some people prefer to have the file name first: >
7645 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7646< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007647 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 separating space only when needed.
7649 NOTE: Use of special characters in 'titlestring' may cause the display
7650 to be garbled (e.g., when it contains a CR or NL character).
7651 {not available when compiled without the |+statusline| feature}
7652
7653 *'toolbar'* *'tb'*
7654'toolbar' 'tb' string (default "icons,tooltips")
7655 global
7656 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7657 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007658 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 possible values are:
7660 icons Toolbar buttons are shown with icons.
7661 text Toolbar buttons shown with text.
7662 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007663 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 tooltips Tooltips are active for toolbar buttons.
7665 Tooltips refer to the popup help text which appears after the mouse
7666 cursor is placed over a toolbar button for a brief moment.
7667
7668 If you want the toolbar to be shown with icons as well as text, do the
7669 following: >
7670 :set tb=icons,text
7671< Motif and Athena cannot display icons and text at the same time. They
7672 will show icons if both are requested.
7673
7674 If none of the strings specified in 'toolbar' are valid or if
7675 'toolbar' is empty, this option is ignored. If you want to disable
7676 the toolbar, you need to set the 'guioptions' option. For example: >
7677 :set guioptions-=T
7678< Also see |gui-toolbar|.
7679
7680 *'toolbariconsize'* *'tbis'*
7681'toolbariconsize' 'tbis' string (default "small")
7682 global
7683 {not in Vi}
7684 {only in the GTK+ 2 GUI}
7685 Controls the size of toolbar icons. The possible values are:
7686 tiny Use tiny toolbar icons.
7687 small Use small toolbar icons (default).
7688 medium Use medium-sized toolbar icons.
7689 large Use large toolbar icons.
7690 The exact dimensions in pixels of the various icon sizes depend on
7691 the current theme. Common dimensions are large=32x32, medium=24x24,
7692 small=20x20 and tiny=16x16.
7693
7694 If 'toolbariconsize' is empty, the global default size as determined
7695 by user preferences or the current theme is used.
7696
7697 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7698'ttybuiltin' 'tbi' boolean (default on)
7699 global
7700 {not in Vi}
7701 When on, the builtin termcaps are searched before the external ones.
7702 When off the builtin termcaps are searched after the external ones.
7703 When this option is changed, you should set the 'term' option next for
7704 the change to take effect, for example: >
7705 :set notbi term=$TERM
7706< See also |termcap|.
7707 Rationale: The default for this option is "on", because the builtin
7708 termcap entries are generally better (many systems contain faulty
7709 xterm entries...).
7710
7711 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7712'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7713 sun-cmd, screen, rxvt, dtterm or
7714 iris-ansi; also on when running Vim in
7715 a DOS console)
7716 global
7717 {not in Vi}
7718 Indicates a fast terminal connection. More characters will be sent to
7719 the screen for redrawing, instead of using insert/delete line
7720 commands. Improves smoothness of redrawing when there are multiple
7721 windows and the terminal does not support a scrolling region.
7722 Also enables the extra writing of characters at the end of each screen
7723 line for lines that wrap. This helps when using copy/paste with the
7724 mouse in an xterm and other terminals.
7725
7726 *'ttymouse'* *'ttym'*
7727'ttymouse' 'ttym' string (default depends on 'term')
7728 global
7729 {not in Vi}
7730 {only in Unix and VMS, doesn't work in the GUI; not
7731 available when compiled without |+mouse|}
7732 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007733 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 *xterm-mouse*
7735 xterm xterm-like mouse handling. The mouse generates
7736 "<Esc>[Mscr", where "scr" is three bytes:
7737 "s" = button state
7738 "c" = column plus 33
7739 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007740 This only works up to 223 columns! See "dec",
7741 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 xterm2 Works like "xterm", but with the xterm reporting the
7743 mouse position while the mouse is dragged. This works
7744 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007745 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 work. See below for how Vim detects this
7747 automatically.
7748 *netterm-mouse*
7749 netterm NetTerm mouse handling. The mouse generates
7750 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7751 for the row and column.
7752 *dec-mouse*
7753 dec DEC terminal mouse handling. The mouse generates a
7754 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007755 This is also available for an Xterm, if it was
7756 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 *jsbterm-mouse*
7758 jsbterm JSB term mouse handling.
7759 *pterm-mouse*
7760 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007761 *urxvt-mouse*
7762 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007763 The mouse works only if the terminal supports this
7764 encoding style, but it does not have 223 columns limit
7765 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007766 *sgr-mouse*
7767 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007768 mouse reporting. The mouse works even in columns
7769 beyond 223. This option is backward compatible with
7770 "xterm2" because it can also decode "xterm2" style
7771 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772
7773 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007774 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7775 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007776 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7777 recognized, if enabled at compile time. DEC terminal mouse codes
7778 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007779 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7780 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007781 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007782 set to a name that starts with "xterm", "mlterm", or "screen", and
7783 'ttymouse' is not set already.
7784 Additionally, if vim is compiled with the |+termresponse| feature and
7785 |t_RV| is set to the escape sequence to request the xterm version
7786 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007788 from 95 to 276. The "sgr" value will be set if the xterm version is
7789 277 or highter.
7790 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7791 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007792 :set t_RV=
7793<
7794 *'ttyscroll'* *'tsl'*
7795'ttyscroll' 'tsl' number (default 999)
7796 global
7797 Maximum number of lines to scroll the screen. If there are more lines
7798 to scroll the window is redrawn. For terminals where scrolling is
7799 very slow and redrawing is not slow this can be set to a small number,
7800 e.g., 3, to speed up displaying.
7801
7802 *'ttytype'* *'tty'*
7803'ttytype' 'tty' string (default from $TERM)
7804 global
7805 Alias for 'term', see above.
7806
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007807 *'undodir'* *'udir'*
7808'undodir' 'udir' string (default ".")
7809 global
7810 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007811 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007812 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007813 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007814 "." means using the directory of the file. The undo file name for
7815 "file.txt" is ".file.txt.un~".
7816 For other directories the file name is the full path of the edited
7817 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007818 When writing: The first directory that exists is used. "." always
7819 works, no directories after "." will be used for writing.
7820 When reading all entries are tried to find an undo file. The first
7821 undo file that exists is used. When it cannot be read an error is
7822 given, no further entry is used.
7823 See |undo-persistence|.
7824
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007825 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007826'undofile' 'udf' boolean (default off)
7827 local to buffer
7828 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007829 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007830 When on, Vim automatically saves undo history to an undo file when
7831 writing a buffer to a file, and restores undo history from the same
7832 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007833 The directory where the undo file is stored is specified by 'undodir'.
7834 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007835 The undo file is not read when 'undoreload' causes the buffer from
7836 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007837 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007838
Bram Moolenaar071d4272004-06-13 20:20:40 +00007839 *'undolevels'* *'ul'*
7840'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7841 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007842 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 {not in Vi}
7844 Maximum number of changes that can be undone. Since undo information
7845 is kept in memory, higher numbers will cause more memory to be used
7846 (nevertheless, a single change can use an unlimited amount of memory).
7847 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7848 itself: >
7849 set ul=0
7850< But you can also get Vi compatibility by including the 'u' flag in
7851 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007852 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007853 Set to -1 for no undo at all. You might want to do this only for the
7854 current buffer: >
7855 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007857
7858 The local value is set to -123456 when the global value is to be used.
7859
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007860 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007862 *'undoreload'* *'ur'*
7863'undoreload' 'ur' number (default 10000)
7864 global
7865 {not in Vi}
7866 Save the whole buffer for undo when reloading it. This applies to the
7867 ":e!" command and reloading for when the buffer changed outside of
7868 Vim. |FileChangedShell|
7869 The save only happens when this options is negative or when the number
7870 of lines is smaller than the value of this option.
7871 Set this option to zero to disable undo for a reload.
7872
7873 When saving undo for a reload, any undo file is not read.
7874
7875 Note that this causes the whole buffer to be stored in memory. Set
7876 this option to a lower value if you run out of memory.
7877
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 *'updatecount'* *'uc'*
7879'updatecount' 'uc' number (default: 200)
7880 global
7881 {not in Vi}
7882 After typing this many characters the swap file will be written to
7883 disk. When zero, no swap file will be created at all (see chapter on
7884 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7885 Vim with the "-n" option, see |startup|. When editing in readonly
7886 mode this option will be initialized to 10000.
7887 The swapfile can be disabled per buffer with |'swapfile'|.
7888 When 'updatecount' is set from zero to non-zero, swap files are
7889 created for all buffers that have 'swapfile' set. When 'updatecount'
7890 is set to zero, existing swap files are not deleted.
7891 Also see |'swapsync'|.
7892 This option has no meaning in buffers where |'buftype'| is "nofile"
7893 or "nowrite".
7894
7895 *'updatetime'* *'ut'*
7896'updatetime' 'ut' number (default 4000)
7897 global
7898 {not in Vi}
7899 If this many milliseconds nothing is typed the swap file will be
7900 written to disk (see |crash-recovery|). Also used for the
7901 |CursorHold| autocommand event.
7902
7903 *'verbose'* *'vbs'*
7904'verbose' 'vbs' number (default 0)
7905 global
7906 {not in Vi, although some versions have a boolean
7907 verbose option}
7908 When bigger than zero, Vim will give messages about what it is doing.
7909 Currently, these messages are given:
7910 >= 1 When the viminfo file is read or written.
7911 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007912 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 >= 8 Files for which a group of autocommands is executed.
7914 >= 9 Every executed autocommand.
7915 >= 12 Every executed function.
7916 >= 13 When an exception is thrown, caught, finished, or discarded.
7917 >= 14 Anything pending in a ":finally" clause.
7918 >= 15 Every executed Ex command (truncated at 200 characters).
7919
7920 This option can also be set with the "-V" argument. See |-V|.
7921 This option is also set by the |:verbose| command.
7922
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007923 When the 'verbosefile' option is set then the verbose messages are not
7924 displayed.
7925
7926 *'verbosefile'* *'vfile'*
7927'verbosefile' 'vfile' string (default empty)
7928 global
7929 {not in Vi}
7930 When not empty all messages are written in a file with this name.
7931 When the file exists messages are appended.
7932 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007933 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007934 Setting 'verbosefile' to a new value is like making it empty first.
7935 The difference with |:redir| is that verbose messages are not
7936 displayed when 'verbosefile' is set.
7937
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 *'viewdir'* *'vdir'*
7939'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7940 "$VIM/vimfiles/view",
7941 for Unix: "~/.vim/view",
7942 for Macintosh: "$VIM:vimfiles:view"
7943 for VMS: "sys$login:vimfiles/view"
7944 for RiscOS: "Choices:vimfiles/view")
7945 global
7946 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007947 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007948 feature}
7949 Name of the directory where to store files for |:mkview|.
7950 This option cannot be set from a |modeline| or in the |sandbox|, for
7951 security reasons.
7952
7953 *'viewoptions'* *'vop'*
7954'viewoptions' 'vop' string (default: "folds,options,cursor")
7955 global
7956 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007957 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 feature}
7959 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007960 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 word save and restore ~
7962 cursor cursor position in file and in window
7963 folds manually created folds, opened/closed folds and local
7964 fold options
7965 options options and mappings local to a window or buffer (not
7966 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007967 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 slash backslashes in file names replaced with forward
7969 slashes
7970 unix with Unix end-of-line format (single <NL>), even when
7971 on Windows or DOS
7972
7973 "slash" and "unix" are useful on Windows when sharing view files
7974 with Unix. The Unix version of Vim cannot source dos format scripts,
7975 but the Windows version of Vim can source unix format scripts.
7976
7977 *'viminfo'* *'vi'* *E526* *E527* *E528*
7978'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007979 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7980 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7981 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 global
7983 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007984 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007985 feature}
7986 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007987 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 separated list of parameters, each consisting of a single character
7989 identifying the particular parameter, followed by a number or string
7990 which specifies the value of that parameter. If a particular
7991 character is left out, then the default value is used for that
7992 parameter. The following is a list of the identifying characters and
7993 the effect of their value.
7994 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007995 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996 ! When included, save and restore global variables that start
7997 with an uppercase letter, and don't contain a lowercase
7998 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007999 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008000 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008001 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 " Maximum number of lines saved for each register. Old name of
8003 the '<' item, with the disadvantage that you need to put a
8004 backslash before the ", otherwise it will be recognized as the
8005 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008006 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 % When included, save and restore the buffer list. If Vim is
8008 started with a file name argument, the buffer list is not
8009 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008010 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 without a file name and buffers for help files are not written
8012 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008013 When followed by a number, the number specifies the maximum
8014 number of buffers that are stored. Without a number all
8015 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008016 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 ' Maximum number of previously edited files for which the marks
8018 are remembered. This parameter must always be included when
8019 'viminfo' is non-empty.
8020 Including this item also means that the |jumplist| and the
8021 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008022 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008024 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 patterns are also saved. When not included, the value of
8026 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008027 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008029 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008030 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 < Maximum number of lines saved for each register. If zero then
8032 registers are not saved. When not included, all lines are
8033 saved. '"' is the old name for this item.
8034 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008035 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008037 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008038 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 c When included, convert the text in the viminfo file from the
8040 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008041 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008042 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 f Whether file marks need to be stored. If zero, file marks ('0
8044 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008045 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008047 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 h Disable the effect of 'hlsearch' when loading the viminfo
8049 file. When not included, it depends on whether ":nohlsearch"
8050 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008051 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 n Name of the viminfo file. The name must immediately follow
8053 the 'n'. Must be the last one! If the "-i" argument was
8054 given when starting Vim, that file name overrides the one
8055 given here with 'viminfo'. Environment variables are expanded
8056 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008057 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008058 r Removable media. The argument is a string (up to the next
8059 ','). This parameter can be given several times. Each
8060 specifies the start of a path for which no marks will be
8061 stored. This is to avoid removable media. For MS-DOS you
8062 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8063 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8064 ignored. Maximum length of each 'r' argument is 50
8065 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008066 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 s Maximum size of an item in Kbyte. If zero then registers are
8068 not saved. Currently only applies to registers. The default
8069 "s10" will exclude registers with more than 10 Kbyte of text.
8070 Also see the '<' item above: line count limit.
8071
8072 Example: >
8073 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8074<
8075 '50 Marks will be remembered for the last 50 files you
8076 edited.
8077 <1000 Contents of registers (up to 1000 lines each) will be
8078 remembered.
8079 s100 Registers with more than 100 Kbyte text are skipped.
8080 :0 Command-line history will not be saved.
8081 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8082 no / Since '/' is not specified, the default will be used,
8083 that is, save all of the search history, and also the
8084 previous search and substitute patterns.
8085 no % The buffer list will not be saved nor read back.
8086 no h 'hlsearch' highlighting will be restored.
8087
8088 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8089 load the contents of the file, this is not done automatically.
8090
8091 This option cannot be set from a |modeline| or in the |sandbox|, for
8092 security reasons.
8093
8094 *'virtualedit'* *'ve'*
8095'virtualedit' 've' string (default "")
8096 global
8097 {not in Vi}
8098 {not available when compiled without the
8099 |+virtualedit| feature}
8100 A comma separated list of these words:
8101 block Allow virtual editing in Visual block mode.
8102 insert Allow virtual editing in Insert mode.
8103 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008104 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008105
Bram Moolenaar071d4272004-06-13 20:20:40 +00008106 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008107 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 of the line. Useful for selecting a rectangle in Visual mode and
8109 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008110 "onemore" is not the same, it will only allow moving the cursor just
8111 after the last character of the line. This makes some commands more
8112 consistent. Previously the cursor was always past the end of the line
8113 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008114 break some plugins or Vim scripts. For example because |l| can move
8115 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008116 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008117 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008118 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008119 It doesn't make sense to combine "all" with "onemore", but you will
8120 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121
8122 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8123'visualbell' 'vb' boolean (default off)
8124 global
8125 {not in Vi}
8126 Use visual bell instead of beeping. The terminal code to display the
8127 visual bell is given with 't_vb'. When no beep or flash is wanted,
8128 use ":set vb t_vb=".
8129 Note: When the GUI starts, 't_vb' is reset to its default value. You
8130 might want to set it again in your |gvimrc|.
8131 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8132 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8133 where 40 is the time in msec.
8134 Does not work on the Amiga, you always get a screen flash.
8135 Also see 'errorbells'.
8136
8137 *'warn'* *'nowarn'*
8138'warn' boolean (default on)
8139 global
8140 Give a warning message when a shell command is used while the buffer
8141 has been changed.
8142
8143 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8144'weirdinvert' 'wiv' boolean (default off)
8145 global
8146 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008147 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 It is provided for backwards compatibility with version 4.x.
8149 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8150 vice versa. Has no effect when the GUI is running.
8151
8152 *'whichwrap'* *'ww'*
8153'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8154 global
8155 {not in Vi}
8156 Allow specified keys that move the cursor left/right to move to the
8157 previous/next line when the cursor is on the first/last character in
8158 the line. Concatenate characters to allow this for these keys:
8159 char key mode ~
8160 b <BS> Normal and Visual
8161 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008162 h "h" Normal and Visual (not recommended)
8163 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008164 < <Left> Normal and Visual
8165 > <Right> Normal and Visual
8166 ~ "~" Normal
8167 [ <Left> Insert and Replace
8168 ] <Right> Insert and Replace
8169 For example: >
8170 :set ww=<,>,[,]
8171< allows wrap only when cursor keys are used.
8172 When the movement keys are used in combination with a delete or change
8173 operator, the <EOL> also counts for a character. This makes "3h"
8174 different from "3dh" when the cursor crosses the end of a line. This
8175 is also true for "x" and "X", because they do the same as "dl" and
8176 "dh". If you use this, you may also want to use the mapping
8177 ":map <BS> X" to make backspace delete the character in front of the
8178 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008179 When 'l' is included and it is used after an operator at the end of a
8180 line then it will not move to the next line. This makes "dl", "cl",
8181 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 NOTE: This option is set to the Vi default value when 'compatible' is
8183 set and to the Vim default value when 'compatible' is reset.
8184
8185 *'wildchar'* *'wc'*
8186'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8187 global
8188 {not in Vi}
8189 Character you have to type to start wildcard expansion in the
8190 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008191 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 The character is not recognized when used inside a macro. See
8193 'wildcharm' for that.
8194 Although 'wc' is a number option, you can set it to a special key: >
8195 :set wc=<Esc>
8196< NOTE: This option is set to the Vi default value when 'compatible' is
8197 set and to the Vim default value when 'compatible' is reset.
8198
8199 *'wildcharm'* *'wcm'*
8200'wildcharm' 'wcm' number (default: none (0))
8201 global
8202 {not in Vi}
8203 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008204 recognized when used inside a macro. You can find "spare" command-line
8205 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206 you'll never actually type 'wildcharm', just use it in mappings that
8207 automatically invoke completion mode, e.g.: >
8208 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008209 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008210< Then after typing :ss you can use CTRL-P & CTRL-N.
8211
8212 *'wildignore'* *'wig'*
8213'wildignore' 'wig' string (default "")
8214 global
8215 {not in Vi}
8216 {not available when compiled without the |+wildignore|
8217 feature}
8218 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008219 patterns is ignored when expanding |wildcards|, completing file or
8220 directory names, and influences the result of |expand()|, |glob()| and
8221 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8223 Also see 'suffixes'.
8224 Example: >
8225 :set wildignore=*.o,*.obj
8226< The use of |:set+=| and |:set-=| is preferred when adding or removing
8227 a pattern from the list. This avoids problems when a future version
8228 uses another default.
8229
Bram Moolenaar94950a92010-12-02 16:01:29 +01008230
Bram Moolenaar81af9252010-12-10 20:35:50 +01008231 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008232'wildignorecase' 'wic' boolean (default off)
8233 global
8234 {not in Vi}
8235 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008236 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008237 Does not apply when the shell is used to expand wildcards, which
8238 happens when there are special characters.
8239
8240
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8242'wildmenu' 'wmnu' boolean (default off)
8243 global
8244 {not in Vi}
8245 {not available if compiled without the |+wildmenu|
8246 feature}
8247 When 'wildmenu' is on, command-line completion operates in an enhanced
8248 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8249 the possible matches are shown just above the command line, with the
8250 first match highlighted (overwriting the status line, if there is
8251 one). Keys that show the previous/next match, such as <Tab> or
8252 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8253 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8254 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008255 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008256 If there are more matches than can fit in the line, a ">" is shown on
8257 the right and/or a "<" is shown on the left. The status line scrolls
8258 as needed.
8259 The "wildmenu" mode is abandoned when a key is hit that is not used
8260 for selecting a completion.
8261 While the "wildmenu" is active the following keys have special
8262 meanings:
8263
8264 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8265 <Down> - in filename/menu name completion: move into a
8266 subdirectory or submenu.
8267 <CR> - in menu completion, when the cursor is just after a
8268 dot: move into a submenu.
8269 <Up> - in filename/menu name completion: move up into
8270 parent directory or parent menu.
8271
8272 This makes the menus accessible from the console |console-menus|.
8273
8274 If you prefer the <Left> and <Right> keys to move the cursor instead
8275 of selecting a different match, use this: >
8276 :cnoremap <Left> <Space><BS><Left>
8277 :cnoremap <Right> <Space><BS><Right>
8278<
8279 The "WildMenu" highlighting is used for displaying the current match
8280 |hl-WildMenu|.
8281
8282 *'wildmode'* *'wim'*
8283'wildmode' 'wim' string (Vim default: "full")
8284 global
8285 {not in Vi}
8286 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008287 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008288 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008289 first part specifies the behavior for the first use of 'wildchar',
8290 The second part for the second use, etc.
8291 These are the possible values for each part:
8292 "" Complete only the first match.
8293 "full" Complete the next full match. After the last match,
8294 the original string is used and then the first match
8295 again.
8296 "longest" Complete till longest common string. If this doesn't
8297 result in a longer string, use the next part.
8298 "longest:full" Like "longest", but also start 'wildmenu' if it is
8299 enabled.
8300 "list" When more than one match, list all matches.
8301 "list:full" When more than one match, list all matches and
8302 complete first match.
8303 "list:longest" When more than one match, list all matches and
8304 complete till longest common string.
8305 When there is only a single match, it is fully completed in all cases.
8306
8307 Examples: >
8308 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008309< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 :set wildmode=longest,full
8311< Complete longest common string, then each full match >
8312 :set wildmode=list:full
8313< List all matches and complete each full match >
8314 :set wildmode=list,full
8315< List all matches without completing, then each full match >
8316 :set wildmode=longest,list
8317< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008318 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008320 *'wildoptions'* *'wop'*
8321'wildoptions' 'wop' string (default "")
8322 global
8323 {not in Vi}
8324 {not available when compiled without the |+wildignore|
8325 feature}
8326 A list of words that change how command line completion is done.
8327 Currently only one word is allowed:
8328 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008329 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008330 is displayed per line. Often used tag kinds are:
8331 d #define
8332 f function
8333 Also see |cmdline-completion|.
8334
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 *'winaltkeys'* *'wak'*
8336'winaltkeys' 'wak' string (default "menu")
8337 global
8338 {not in Vi}
8339 {only used in Win32, Motif, GTK and Photon GUI}
8340 Some GUI versions allow the access to menu entries by using the ALT
8341 key in combination with a character that appears underlined in the
8342 menu. This conflicts with the use of the ALT key for mappings and
8343 entering special characters. This option tells what to do:
8344 no Don't use ALT keys for menus. ALT key combinations can be
8345 mapped, but there is no automatic handling. This can then be
8346 done with the |:simalt| command.
8347 yes ALT key handling is done by the windowing system. ALT key
8348 combinations cannot be mapped.
8349 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008350 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008351 keys can be mapped.
8352 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8353 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008354 This option is not used for <F10>; on Win32 and with GTK <F10> will
8355 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008356
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008357 *'window'* *'wi'*
8358'window' 'wi' number (default screen height - 1)
8359 global
8360 Window height. Do not confuse this with the height of the Vim window,
8361 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008362 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8363 value is smaller than 'lines' minus one. The screen will scroll
8364 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008365 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8366 in a much smarter way, taking care of wrapping lines.
8367 When resizing the Vim window, the value is smaller than 1 or more than
8368 or equal to 'lines' it will be set to 'lines' minus 1.
8369 {Vi also uses the option to specify the number of displayed lines}
8370
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 *'winheight'* *'wh'* *E591*
8372'winheight' 'wh' number (default 1)
8373 global
8374 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008375 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 feature}
8377 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008378 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008379 focus goes to a window that is smaller, its size is increased, at the
8380 cost of the height of other windows.
8381 Set 'winheight' to a small number for normal editing.
8382 Set it to 999 to make the current window fill most of the screen.
8383 Other windows will be only 'winminheight' high. This has the drawback
8384 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8385 to create only two windows, set the option after startup is done,
8386 using the |VimEnter| event: >
8387 au VimEnter * set winheight=999
8388< Minimum value is 1.
8389 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 height of the current window.
8391 'winheight' applies to the current window. Use 'winminheight' to set
8392 the minimal height for other windows.
8393
8394 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8395'winfixheight' 'wfh' boolean (default off)
8396 local to window
8397 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008398 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 feature}
8400 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008401 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8402 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 The height may be changed anyway when running out of room.
8404
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008405 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8406'winfixwidth' 'wfw' boolean (default off)
8407 local to window
8408 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008409 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008410 feature}
8411 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008412 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008413 The width may be changed anyway when running out of room.
8414
Bram Moolenaar071d4272004-06-13 20:20:40 +00008415 *'winminheight'* *'wmh'*
8416'winminheight' 'wmh' number (default 1)
8417 global
8418 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008419 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420 feature}
8421 The minimal height of a window, when it's not the current window.
8422 This is a hard minimum, windows will never become smaller.
8423 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8424 status bar) if necessary. They will return to at least one line when
8425 they become active (since the cursor has to have somewhere to go.)
8426 Use 'winheight' to set the minimal height of the current window.
8427 This option is only checked when making a window smaller. Don't use a
8428 large number, it will cause errors when opening more than a few
8429 windows. A value of 0 to 3 is reasonable.
8430
8431 *'winminwidth'* *'wmw'*
8432'winminwidth' 'wmw' number (default 1)
8433 global
8434 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008435 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008436 feature}
8437 The minimal width of a window, when it's not the current window.
8438 This is a hard minimum, windows will never become smaller.
8439 When set to zero, windows may be "squashed" to zero columns (i.e. just
8440 a vertical separator) if necessary. They will return to at least one
8441 line when they become active (since the cursor has to have somewhere
8442 to go.)
8443 Use 'winwidth' to set the minimal width of the current window.
8444 This option is only checked when making a window smaller. Don't use a
8445 large number, it will cause errors when opening more than a few
8446 windows. A value of 0 to 12 is reasonable.
8447
8448 *'winwidth'* *'wiw'* *E592*
8449'winwidth' 'wiw' number (default 20)
8450 global
8451 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008452 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 feature}
8454 Minimal number of columns for the current window. This is not a hard
8455 minimum, Vim will use fewer columns if there is not enough room. If
8456 the current window is smaller, its size is increased, at the cost of
8457 the width of other windows. Set it to 999 to make the current window
8458 always fill the screen. Set it to a small number for normal editing.
8459 The width is not adjusted after one of the commands to change the
8460 width of the current window.
8461 'winwidth' applies to the current window. Use 'winminwidth' to set
8462 the minimal width for other windows.
8463
8464 *'wrap'* *'nowrap'*
8465'wrap' boolean (default on)
8466 local to window
8467 {not in Vi}
8468 This option changes how text is displayed. It doesn't change the text
8469 in the buffer, see 'textwidth' for that.
8470 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008471 displaying continues on the next line. When off lines will not wrap
8472 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 moved to a part that is not shown, the screen will scroll
8474 horizontally.
8475 The line will be broken in the middle of a word if necessary. See
8476 'linebreak' to get the break at a word boundary.
8477 To make scrolling horizontally a bit more useful, try this: >
8478 :set sidescroll=5
8479 :set listchars+=precedes:<,extends:>
8480< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008481 This option can't be set from a |modeline| when the 'diff' option is
8482 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483
8484 *'wrapmargin'* *'wm'*
8485'wrapmargin' 'wm' number (default 0)
8486 local to buffer
8487 Number of characters from the right window border where wrapping
8488 starts. When typing text beyond this limit, an <EOL> will be inserted
8489 and inserting continues on the next line.
8490 Options that add a margin, such as 'number' and 'foldcolumn', cause
8491 the text width to be further reduced. This is Vi compatible.
8492 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008493 This option is set to 0 when 'paste' is set and restored when 'paste'
8494 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8496 and less usefully}
8497
8498 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8499'wrapscan' 'ws' boolean (default on) *E384* *E385*
8500 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008501 Searches wrap around the end of the file. Also applies to |]s| and
8502 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503
8504 *'write'* *'nowrite'*
8505'write' boolean (default on)
8506 global
8507 {not in Vi}
8508 Allows writing files. When not set, writing a file is not allowed.
8509 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008510 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008511 argument. Filtering text is still possible, even though this requires
8512 writing a temporary file.
8513
8514 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8515'writeany' 'wa' boolean (default off)
8516 global
8517 Allows writing to any file with no need for "!" override.
8518
8519 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8520'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8521 otherwise)
8522 global
8523 {not in Vi}
8524 Make a backup before overwriting a file. The backup is removed after
8525 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008526 also on.
8527 WARNING: Switching this option off means that when Vim fails to write
8528 your buffer correctly and then, for whatever reason, Vim exits, you
8529 lose both the original file and what you were writing. Only reset
8530 this option if your file system is almost full and it makes the write
8531 fail (and make sure not to exit Vim until the write was successful).
8532 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008533 When the 'backupskip' pattern matches, a backup is not made anyway.
8534 NOTE: This option is set to the default value when 'compatible' is
8535 set.
8536
8537 *'writedelay'* *'wd'*
8538'writedelay' 'wd' number (default 0)
8539 global
8540 {not in Vi}
8541 The number of microseconds to wait for each character sent to the
8542 screen. When non-zero, characters are sent to the terminal one by
8543 one. For MS-DOS pcterm this does not work. For debugging purposes.
8544
8545 vim:tw=78:ts=8:ft=help:norl: