blob: b7b66495e1bce72766fd5479e16558f050debf4f [file] [log] [blame]
Bram Moolenaar4b60a6c2013-11-14 05:48:46 +01001*options.txt* For Vim version 7.4. Last change: 2013 Nov 12
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200280You will get back the 'list' value as it was the last time you edited "one".
281The options local to a window are remembered for each buffer. This also
282happens when the buffer is not loaded, but they are lost when the buffer is
283wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284
285 *:setl* *:setlocal*
286:setl[ocal] ... Like ":set" but set only the value local to the
287 current buffer or window. Not all options have a
288 local value. If the option does not have a local
289 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200290 With the "all" argument: display local values for all
291 local options.
292 Without argument: Display local values for all local
293 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000295 local value. For a global/local boolean option, when
296 the global value is being used, "--" is displayed
297 before the option name.
298 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299 shown (but that might change in the future).
300 {not in Vi}
301
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000302:setl[ocal] {option}< Set the local value of {option} to its global value by
303 copying the value.
304 {not in Vi}
305
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100306:se[t] {option}< For |global-local| options: Remove the local value of
307 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 {not in Vi}
309
310 *:setg* *:setglobal*
311:setg[lobal] ... Like ":set" but set only the global value for a local
312 option without changing the local value.
313 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200314 With the "all" argument: display global values for all
315 local options.
316 Without argument: display global values for all local
317 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 {not in Vi}
319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
349This only works for a string option. For a boolean option you need to use the
350"<" flag, like this: >
351 :setlocal autoread<
352Note that for non-boolean options using "<" copies the global value to the
353local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000354when the global value changes later). You can also use: >
355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
365:setf[iletype] {filetype} *:setf* *:setfiletype*
366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
375 {not in Vi}
376
Bram Moolenaard58e9292011-02-09 17:07:58 +0100377 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
379:opt[ions] Open a window for viewing and setting all options.
380 Options are grouped by function.
381 Offers short help for each option. Hit <CR> on the
382 short help to open a help window with more help for
383 the option.
384 Modify the value of the option and hit <CR> on the
385 "set" line to set the new value. For window and
386 buffer specific options, the last accessed window is
387 used to set the option value in, unless this is a help
388 window, in which case the window below help window is
389 used (skipping the option-window).
390 {not available when compiled without the |+eval| or
391 |+autocmd| features}
392
393 *$HOME*
394Using "~" is like using "$HOME", but it is only recognized at the start of an
395option and after a space or comma.
396
397On Unix systems "~user" can be used too. It is replaced by the home directory
398of user "user". Example: >
399 :set path=~mool/include,/usr/include,.
400
401On Unix systems the form "${HOME}" can be used too. The name between {} can
402contain non-id characters then. Note that if you want to use this for the
403"gf" command, you need to add the '{' and '}' characters to 'isfname'.
404
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100405On MS-Windows, if $HOME is not defined as an environment variable, then
406at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
407
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408NOTE: expanding environment variables and "~/" is only done with the ":set"
409command, not when assigning a value to an option with ":let".
410
411
412Note the maximum length of an expanded option is limited. How much depends on
413the system, mostly it is something like 256 or 1024 characters.
414
415 *:fix* *:fixdel*
416:fix[del] Set the value of 't_kD':
417 't_kb' is 't_kD' becomes ~
418 CTRL-? CTRL-H
419 not CTRL-? CTRL-?
420
421 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
422
423 If your delete key terminal code is wrong, but the
424 code for backspace is alright, you can put this in
425 your .vimrc: >
426 :fixdel
427< This works no matter what the actual code for
428 backspace is.
429
430 If the backspace key terminal code is wrong you can
431 use this: >
432 :if &term == "termname"
433 : set t_kb=^V<BS>
434 : fixdel
435 :endif
436< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000437 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 with your terminal name.
439
440 If your <Delete> key sends a strange key sequence (not
441 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
442 :if &term == "termname"
443 : set t_kD=^V<Delete>
444 :endif
445< Where "^V" is CTRL-V and "<Delete>" is the delete key
446 (don't type eight characters!). Replace "termname"
447 with your terminal name.
448
449 *Linux-backspace*
450 Note about Linux: By default the backspace key
451 produces CTRL-?, which is wrong. You can fix it by
452 putting this line in your rc.local: >
453 echo "keycode 14 = BackSpace" | loadkeys
454<
455 *NetBSD-backspace*
456 Note about NetBSD: If your backspace doesn't produce
457 the right code, try this: >
458 xmodmap -e "keycode 22 = BackSpace"
459< If this works, add this in your .Xmodmap file: >
460 keysym 22 = BackSpace
461< You need to restart for this to take effect.
462
463==============================================================================
4642. Automatically setting options *auto-setting*
465
466Besides changing options with the ":set" command, there are three alternatives
467to set options automatically for one or more files:
468
4691. When starting Vim initializations are read from various places. See
470 |initialization|. Most of them are performed for all editing sessions,
471 and some of them depend on the directory where Vim is started.
472 You can create an initialization file with |:mkvimrc|, |:mkview| and
473 |:mksession|.
4742. If you start editing a new file, the automatic commands are executed.
475 This can be used to set options for files matching a particular pattern and
476 many other things. See |autocommand|.
4773. If you start editing a new file, and the 'modeline' option is on, a
478 number of lines at the beginning and end of the file are checked for
479 modelines. This is explained here.
480
481 *modeline* *vim:* *vi:* *ex:* *E520*
482There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200483 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200485[text] any text or empty
486{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200487{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200488[white] optional white space
489{options} a list of option settings, separated with white space
490 or ':', where each part between ':' is the argument
491 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000494 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496
497The second form (this is compatible with some versions of Vi):
498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
503{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
504[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200505se[t] the string "set " or "se " (note the space); When
506 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507{options} a list of options, separated with white space, which
508 is the argument for a ":set" command
509: a colon
510[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000513 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
517chance that a normal word like "lex:" is caught. There is one exception:
518"vi:" and "vim:" can also be at the start of the line (for compatibility with
519version 3.0). Using "ex:" at the start of the line will be ignored (this
520could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522 *modeline-local*
523The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000524buffer and window that contain the file. Although it's possible to set global
525options from a modeline, this is unusual. If you have two windows open and
526the files in it set the same global option to a different value, the result
527depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000529When editing a file that was already loaded, only the window-local options
530from the modeline are used. Thus if you manually changed a buffer-local
531option after opening the file, it won't be changed if you edit the same buffer
532in another window. But window-local options will be set.
533
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 *modeline-version*
535If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200536number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 vim{vers}: version {vers} or later
538 vim<{vers}: version before {vers}
539 vim={vers}: version {vers}
540 vim>{vers}: version after {vers}
541{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542For example, to use a modeline only for Vim 6.0 and later:
543 /* vim600: set foldmethod=marker: */ ~
544To use a modeline for Vim before version 5.7:
545 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546There can be no blanks between "vim" and the ":".
547
548
549The number of lines that are checked can be set with the 'modelines' option.
550If 'modeline' is off or 'modelines' is 0 no lines are checked.
551
552Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000553like:
554 /* vi:ts=4: */ ~
555will give an error message for the trailing "*/". This line is OK:
556 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558If an error is detected the rest of the line is skipped.
559
560If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561backslash in front of the ':' will be removed. Example:
562 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563This sets the 'dir' option to "c:\tmp". Only a single backslash before the
564':' is removed. Thus to include "\:" you have to specify "\\:".
565
566No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000567might create a Trojan horse text file with modelines). And not all options
568can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000569|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000570causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
571are wrapped unexpectedly. So disable modelines before editing untrusted text.
572The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574Hint: If you would like to do something else than setting an option, you could
575define an autocommand that checks the file for a specific string. For
576example: >
577 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
578And define a function SetVar() that does something with the line containing
579"VAR".
580
581==============================================================================
5823. Options summary *option-summary*
583
584In the list below all the options are mentioned with their full name and with
585an abbreviation if there is one. Both forms may be used.
586
587In this document when a boolean option is "set" that means that ":set option"
588is entered. When an option is "reset", ":set nooption" is used.
589
590For some options there are two default values: The "Vim default", which is
591used when 'compatible' is not set, and the "Vi default", which is used when
592'compatible' is set.
593
594Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000595are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596different value in each window. For example the 'list' option can be set in
597one window and reset in another for the same text, giving both types of view
598at the same time. There are a few options that are specific to a certain
599file. These can have a different value for each file or buffer. For example
600the 'textwidth' option can be 78 for a normal text file and 0 for a C
601program.
602
603 global one option for all buffers and windows
604 local to window each window has its own copy of this option
605 local to buffer each buffer has its own copy of this option
606
607When creating a new window the option values from the currently active window
608are used as a default value for the window-specific options. For the
609buffer-specific options this depends on the 's' and 'S' flags in the
610'cpoptions' option. If 's' is included (which is the default) the values for
611buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000612first entered. If 'S' is present the options are copied each time the buffer
613is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614present, the options are copied from the currently active buffer when the
615buffer is created.
616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000619Not all options are supported in all versions. This depends on the supported
620features and sometimes on the system. A remark about this is in curly braces
621below. When an option is not supported it may still be set without getting an
622error, this is called a hidden option. You can't get the value of a hidden
623option though, it is not stored.
624
625To test if option "foo" can be used with ":set" use something like this: >
626 if exists('&foo')
627This also returns true for a hidden option. To test if option "foo" is really
628supported use something like this: >
629 if exists('+foo')
630<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 *E355*
632A jump table for the options with a short description can be found at |Q_op|.
633
634 *'aleph'* *'al'* *aleph* *Aleph*
635'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
636 global
637 {not in Vi}
638 {only available when compiled with the |+rightleft|
639 feature}
640 The ASCII code for the first letter of the Hebrew alphabet. The
641 routine that maps the keyboard in Hebrew mode, both in Insert mode
642 (when hkmap is set) and on the command-line (when hitting CTRL-_)
643 outputs the Hebrew characters in the range [aleph..aleph+26].
644 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
645 See |rileft.txt|.
646
647 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
648'allowrevins' 'ari' boolean (default off)
649 global
650 {not in Vi}
651 {only available when compiled with the |+rightleft|
652 feature}
653 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
654 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
655 into reverse Insert mode, and don't know how to get out. See
656 'revins'.
657 NOTE: This option is reset when 'compatible' is set.
658
659 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
660'altkeymap' 'akm' boolean (default off)
661 global
662 {not in Vi}
663 {only available when compiled with the |+farsi|
664 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 the keyboard map between Farsi and English, when 'allowrevins' set.
667
Bram Moolenaar582fd852005-03-28 20:58:01 +0000668 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 is useful to start the Vim in native mode i.e. English (left-to-right
670 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000671 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672
673 *'ambiwidth'* *'ambw'*
674'ambiwidth' 'ambw' string (default: "single")
675 global
676 {not in Vi}
677 {only available when compiled with the |+multi_byte|
678 feature}
679 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
680 Tells Vim what to do with characters with East Asian Width Class
681 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
682 letters, Cyrillic letters).
683
684 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000685 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 expected by most users.
687 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200688 *E834* *E835*
689 The value "double" cannot be used if 'listchars' or 'fillchars'
690 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691
692 There are a number of CJK fonts for which the width of glyphs for
693 those characters are solely based on how many octets they take in
694 legacy/traditional CJK encodings. In those encodings, Euro,
695 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000698 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 Vim is running inside a terminal (emulators) that uses a CJK font
700 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
701 this option should be set to "double" to match the width perceived
702 by Vim with the width of glyphs in the font. Perhaps it also has
703 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
704 when the system locale is set to one of CJK locales. See Unicode
705 Standard Annex #11 (http://www.unicode.org/reports/tr11).
706
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100707 Vim may set this option automatically at startup time when Vim is
708 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200709 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100710
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
712'antialias' 'anti' boolean (default: off)
713 global
714 {not in Vi}
715 {only available when compiled with GUI enabled
716 on Mac OS X}
717 This option only has an effect in the GUI version of Vim on Mac OS X
718 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
719 which can be easier to read at certain sizes on certain displays.
720 Setting this option can sometimes cause problems if 'guifont' is set
721 to its default (empty string).
722
723 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
724'autochdir' 'acd' boolean (default off)
725 global
726 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200727 {only available when compiled with it, use
728 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000729 When on, Vim will change the current working directory whenever you
730 open a file, switch buffers, delete a buffer or open/close a window.
731 It will change to the directory containing the file which was opened
732 or selected.
733 This option is provided for backward compatibility with the Vim
734 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000735 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
738'arabic' 'arab' boolean (default off)
739 local to window
740 {not in Vi}
741 {only available when compiled with the |+arabic|
742 feature}
743 This option can be set to start editing Arabic text.
744 Setting this option will:
745 - Set the 'rightleft' option, unless 'termbidi' is set.
746 - Set the 'arabicshape' option, unless 'termbidi' is set.
747 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
748 between typing English and Arabic key mapping.
749 - Set the 'delcombine' option
750 Note that 'encoding' must be "utf-8" for working with Arabic text.
751
752 Resetting this option will:
753 - Reset the 'rightleft' option.
754 - Disable the use of 'keymap' (without changing its value).
755 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200756 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 Also see |arabic.txt|.
758
759 *'arabicshape'* *'arshape'*
760 *'noarabicshape'* *'noarshape'*
761'arabicshape' 'arshape' boolean (default on)
762 global
763 {not in Vi}
764 {only available when compiled with the |+arabic|
765 feature}
766 When on and 'termbidi' is off, the required visual character
767 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200768 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 one which encompasses:
770 a) the changing/morphing of characters based on their location
771 within a word (initial, medial, final and stand-alone).
772 b) the enabling of the ability to compose characters
773 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100774 When disabled the display shows each character's true stand-alone
775 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 Arabic is a complex language which requires other settings, for
777 further details see |arabic.txt|.
778
779 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
780'autoindent' 'ai' boolean (default off)
781 local to buffer
782 Copy indent from current line when starting a new line (typing <CR>
783 in Insert mode or when using the "o" or "O" command). If you do not
784 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000785 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
786 to another line has the same effect, unless the 'I' flag is included
787 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000788 When autoindent is on, formatting (with the "gq" command or when you
789 reach 'textwidth' in Insert mode) uses the indentation of the first
790 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 When 'smartindent' or 'cindent' is on the indent is changed in
792 a different way.
793 The 'autoindent' option is reset when the 'paste' option is set.
794 {small difference from Vi: After the indent is deleted when typing
795 <Esc> or <CR>, the cursor position when moving up or down is after the
796 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
797
798 *'autoread'* *'ar'* *'noautoread'* *'noar'*
799'autoread' 'ar' boolean (default off)
800 global or local to buffer |global-local|
801 {not in Vi}
802 When a file has been detected to have been changed outside of Vim and
803 it has not been changed inside of Vim, automatically read it again.
804 When the file has been deleted this is not done. |timestamp|
805 If this option has a local value, use this command to switch back to
806 using the global value: >
807 :set autoread<
808<
809 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
810'autowrite' 'aw' boolean (default off)
811 global
812 Write the contents of the file, if it has been modified, on each
813 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000814 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
816 Note that for some commands the 'autowrite' option is not used, see
817 'autowriteall' for that.
818
819 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
820'autowriteall' 'awa' boolean (default off)
821 global
822 {not in Vi}
823 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
824 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
825 Setting this option also implies that Vim behaves like 'autowrite' has
826 been set.
827
828 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200829'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 global
831 {not in Vi}
832 When set to "dark", Vim will try to use colors that look good on a
833 dark background. When set to "light", Vim will try to use colors that
834 look good on a light background. Any other value is illegal.
835 Vim tries to set the default value according to the terminal used.
836 This will not always be correct.
837 Setting this option does not change the background color, it tells Vim
838 what the background color looks like. For changing the background
839 color, see |:hi-normal|.
840
841 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000842 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000843 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 setting 'background' will cause the color scheme to be reloaded. If
846 the color scheme adjusts to the value of 'background' this will work.
847 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100848 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849
850 When setting 'background' to the default value with: >
851 :set background&
852< Vim will guess the value. In the GUI this should work correctly,
853 in other cases Vim might not be able to guess the right value.
854
855 When starting the GUI, the default value for 'background' will be
856 "light". When the value is not set in the .gvimrc, and Vim detects
857 that the background is actually quite dark, 'background' is set to
858 "dark". But this happens only AFTER the .gvimrc file has been read
859 (because the window needs to be opened to find the actual background
860 color). To get around this, force the GUI window to be opened by
861 putting a ":gui" command in the .gvimrc file, before where the value
862 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200863
864 For MS-DOS, Windows and OS/2 the default is "dark".
865 For other systems "dark" is used when 'term' is "linux",
866 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
867 background. Otherwise the default is "light".
868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 Normally this option would be set in the .vimrc file. Possibly
870 depending on the terminal name. Example: >
871 :if &term == "pcterm"
872 : set background=dark
873 :endif
874< When this option is set, the default settings for the highlight groups
875 will change. To use other settings, place ":highlight" commands AFTER
876 the setting of the 'background' option.
877 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
878 to select the colors for syntax highlighting. After changing this
879 option, you must load syntax.vim again to see the result. This can be
880 done with ":syntax on".
881
882 *'backspace'* *'bs'*
883'backspace' 'bs' string (default "")
884 global
885 {not in Vi}
886 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
887 mode. This is a list of items, separated by commas. Each item allows
888 a way to backspace over something:
889 value effect ~
890 indent allow backspacing over autoindent
891 eol allow backspacing over line breaks (join lines)
892 start allow backspacing over the start of insert; CTRL-W and CTRL-U
893 stop once at the start of insert.
894
895 When the value is empty, Vi compatible backspacing is used.
896
897 For backwards compatibility with version 5.4 and earlier:
898 value effect ~
899 0 same as ":set backspace=" (Vi compatible)
900 1 same as ":set backspace=indent,eol"
901 2 same as ":set backspace=indent,eol,start"
902
903 See |:fixdel| if your <BS> or <Del> key does not do what you want.
904 NOTE: This option is set to "" when 'compatible' is set.
905
906 *'backup'* *'bk'* *'nobackup'* *'nobk'*
907'backup' 'bk' boolean (default off)
908 global
909 {not in Vi}
910 Make a backup before overwriting a file. Leave it around after the
911 file has been successfully written. If you do not want to keep the
912 backup file, but you do want a backup while the file is being
913 written, reset this option and set the 'writebackup' option (this is
914 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000915 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 |backup-table| for more explanations.
917 When the 'backupskip' pattern matches, a backup is not made anyway.
918 When 'patchmode' is set, the backup may be renamed to become the
919 oldest version of a file.
920 NOTE: This option is reset when 'compatible' is set.
921
922 *'backupcopy'* *'bkc'*
923'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
924 global
925 {not in Vi}
926 When writing a file and a backup is made, this option tells how it's
927 done. This is a comma separated list of words.
928
929 The main values are:
930 "yes" make a copy of the file and overwrite the original one
931 "no" rename the file and write a new one
932 "auto" one of the previous, what works best
933
934 Extra values that can be combined with the ones above are:
935 "breaksymlink" always break symlinks when writing
936 "breakhardlink" always break hardlinks when writing
937
938 Making a copy and overwriting the original file:
939 - Takes extra time to copy the file.
940 + When the file has special attributes, is a (hard/symbolic) link or
941 has a resource fork, all this is preserved.
942 - When the file is a link the backup will have the name of the link,
943 not of the real file.
944
945 Renaming the file and writing a new one:
946 + It's fast.
947 - Sometimes not all attributes of the file can be copied to the new
948 file.
949 - When the file is a link the new file will not be a link.
950
951 The "auto" value is the middle way: When Vim sees that renaming file
952 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000953 the file is not a link) that is used. When problems are expected, a
954 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 The "breaksymlink" and "breakhardlink" values can be used in
957 combination with any of "yes", "no" and "auto". When included, they
958 force Vim to always break either symbolic or hard links by doing
959 exactly what the "no" option does, renaming the original file to
960 become the backup and writing a new file in its place. This can be
961 useful for example in source trees where all the files are symbolic or
962 hard links and any changes should stay in the local source tree, not
963 be propagated back to the original source.
964 *crontab*
965 One situation where "no" and "auto" will cause problems: A program
966 that opens a file, invokes Vim to edit that file, and then tests if
967 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000968 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 example.
970
971 When a copy is made, the original file is truncated and then filled
972 with the new text. This means that protection bits, owner and
973 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000974 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 group of the backup is set to the group of the original file. If this
976 fails, the protection bits for the group are made the same as for
977 others.
978
979 When the file is renamed this is the other way around: The backup has
980 the same attributes of the original file, and the newly written file
981 is owned by the current user. When the file was a (hard/symbolic)
982 link, the new file will not! That's why the "auto" value doesn't
983 rename when the file is a link. The owner and group of the newly
984 written file will be set to the same ones as the original file, but
985 the system may refuse to do this. In that case the "auto" value will
986 again not rename the file.
987
988 *'backupdir'* *'bdir'*
989'backupdir' 'bdir' string (default for Amiga: ".,t:",
990 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
991 for Unix: ".,~/tmp,~/")
992 global
993 {not in Vi}
994 List of directories for the backup file, separated with commas.
995 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100996 where this is possible. The directory must exist, Vim will not
997 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100998 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 impossible!). Writing may fail because of this.
1000 - A directory "." means to put the backup file in the same directory
1001 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001002 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 put the backup file relative to where the edited file is. The
1004 leading "." is replaced with the path name of the edited file.
1005 ("." inside a directory name has no special meaning).
1006 - Spaces after the comma are ignored, other spaces are considered part
1007 of the directory name. To have a space at the start of a directory
1008 name, precede it with a backslash.
1009 - To include a comma in a directory name precede it with a backslash.
1010 - A directory name may end in an '/'.
1011 - Environment variables are expanded |:set_env|.
1012 - Careful with '\' characters, type one before a space, type two to
1013 get one in the option (see |option-backslash|), for example: >
1014 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1015< - For backwards compatibility with Vim version 3.0 a '>' at the start
1016 of the option is removed.
1017 See also 'backup' and 'writebackup' options.
1018 If you want to hide your backup files on Unix, consider this value: >
1019 :set backupdir=./.backup,~/.backup,.,/tmp
1020< You must create a ".backup" directory in each directory and in your
1021 home directory for this to work properly.
1022 The use of |:set+=| and |:set-=| is preferred when adding or removing
1023 directories from the list. This avoids problems when a future version
1024 uses another default.
1025 This option cannot be set from a |modeline| or in the |sandbox|, for
1026 security reasons.
1027
1028 *'backupext'* *'bex'* *E589*
1029'backupext' 'bex' string (default "~", for VMS: "_")
1030 global
1031 {not in Vi}
1032 String which is appended to a file name to make the name of the
1033 backup file. The default is quite unusual, because this avoids
1034 accidentally overwriting existing files with a backup file. You might
1035 prefer using ".bak", but make sure that you don't have files with
1036 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001037 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001039 If you like to keep a lot of backups, you could use a BufWritePre
1040 autocommand to change 'backupext' just before writing the file to
1041 include a timestamp. >
1042 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1043< Use 'backupdir' to put the backup in a different directory.
1044
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 *'backupskip'* *'bsk'*
1046'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1047 global
1048 {not in Vi}
1049 {not available when compiled without the |+wildignore|
1050 feature}
1051 A list of file patterns. When one of the patterns matches with the
1052 name of the file which is written, no backup file is created. Both
1053 the specified file name and the full path name of the file are used.
1054 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1055 Watch out for special characters, see |option-backslash|.
1056 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001057 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001058
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001059 WARNING: Not having a backup file means that when Vim fails to write
1060 your buffer correctly and then, for whatever reason, Vim exits, you
1061 lose both the original file and what you were writing. Only disable
1062 backups if you don't care about losing the file.
1063
Bram Moolenaar02467872007-05-06 13:22:01 +00001064 Note that environment variables are not expanded. If you want to use
1065 $HOME you must expand it explicitly, e.g.: >
1066 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1067
1068< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001069 backup would be made by renaming the original file crontab won't see
1070 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
1072 *'balloondelay'* *'bdlay'*
1073'balloondelay' 'bdlay' number (default: 600)
1074 global
1075 {not in Vi}
1076 {only available when compiled with the |+balloon_eval|
1077 feature}
1078 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1079
1080 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1081'ballooneval' 'beval' boolean (default off)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001085 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 Switch on the |balloon-eval| functionality.
1087
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001088 *'balloonexpr'* *'bexpr'*
1089'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001090 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
1093 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001094 Expression for text to show in evaluation balloon. It is only used
1095 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096
1097 v:beval_bufnr number of the buffer in which balloon is going to show
1098 v:beval_winnr number of the window
1099 v:beval_lnum line number
1100 v:beval_col column number (byte index)
1101 v:beval_text word under or after the mouse pointer
1102
1103 The evaluation of the expression must not have side effects!
1104 Example: >
1105 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001106 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 \', column ' . v:beval_col .
1108 \ ' of file ' . bufname(v:beval_bufnr) .
1109 \ ' on word "' . v:beval_text . '"'
1110 endfunction
1111 set bexpr=MyBalloonExpr()
1112 set ballooneval
1113<
1114 NOTE: The balloon is displayed only if the cursor is on a text
1115 character. If the result of evaluating 'balloonexpr' is not empty,
1116 Vim does not try to send a message to an external debugger (Netbeans
1117 or Sun Workshop).
1118
Bram Moolenaar30b65812012-07-12 22:01:11 +02001119 The expression will be evaluated in the |sandbox| when set from a
1120 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001121
1122 It is not allowed to change text or jump to another window while
1123 evaluating 'balloonexpr' |textlock|.
1124
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001125 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001126 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001127< When they are supported "\n" characters will start a new line. If the
1128 expression evaluates to a |List| this is equal to using each List item
1129 as a string and putting "\n" in between them.
1130
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1132'binary' 'bin' boolean (default off)
1133 local to buffer
1134 {not in Vi}
1135 This option should be set before editing a binary file. You can also
1136 use the |-b| Vim argument. When this option is switched on a few
1137 options will be changed (also when it already was on):
1138 'textwidth' will be set to 0
1139 'wrapmargin' will be set to 0
1140 'modeline' will be off
1141 'expandtab' will be off
1142 Also, 'fileformat' and 'fileformats' options will not be used, the
1143 file is read and written like 'fileformat' was "unix" (a single <NL>
1144 separates lines).
1145 The 'fileencoding' and 'fileencodings' options will not be used, the
1146 file is read without conversion.
1147 NOTE: When you start editing a(nother) file while the 'bin' option is
1148 on, settings from autocommands may change the settings again (e.g.,
1149 'textwidth'), causing trouble when editing. You might want to set
1150 'bin' again when the file has been loaded.
1151 The previous values of these options are remembered and restored when
1152 'bin' is switched from on to off. Each buffer has its own set of
1153 saved option values.
1154 To edit a file with 'binary' set you can use the |++bin| argument.
1155 This avoids you have to do ":set bin", which would have effect for all
1156 files you edit.
1157 When writing a file the <EOL> for the last line is only written if
1158 there was one in the original file (normally Vim appends an <EOL> to
1159 the last line if there is none; this would make the file longer). See
1160 the 'endofline' option.
1161
1162 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1163'bioskey' 'biosk' boolean (default on)
1164 global
1165 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 better to detect CTRL-C, but only works for the console. When using a
1168 terminal over a serial port reset this option.
1169 Also see |'conskey'|.
1170
1171 *'bomb'* *'nobomb'*
1172'bomb' boolean (default off)
1173 local to buffer
1174 {not in Vi}
1175 {only available when compiled with the |+multi_byte|
1176 feature}
1177 When writing a file and the following conditions are met, a BOM (Byte
1178 Order Mark) is prepended to the file:
1179 - this option is on
1180 - the 'binary' option is off
1181 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1182 endian variants.
1183 Some applications use the BOM to recognize the encoding of the file.
1184 Often used for UCS-2 files on MS-Windows. For other applications it
1185 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001186 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1188 check for the presence of the BOM is done and 'bomb' set accordingly.
1189 Unless 'binary' is set, it is removed from the first line, so that you
1190 don't see it when editing. When you don't change the options, the BOM
1191 will be restored when writing the file.
1192
1193 *'breakat'* *'brk'*
1194'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1195 global
1196 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001197 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 feature}
1199 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001200 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1201 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
1203 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001204'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001206 {not in Vi} {only for Motif, Athena, GTK, Mac and
1207 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001209 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001210 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211 buffer Use the directory of the related buffer.
1212 current Use the current directory.
1213 {path} Use the specified directory
1214
1215 *'bufhidden'* *'bh'*
1216'bufhidden' 'bh' string (default: "")
1217 local to buffer
1218 {not in Vi}
1219 {not available when compiled without the |+quickfix|
1220 feature}
1221 This option specifies what happens when a buffer is no longer
1222 displayed in a window:
1223 <empty> follow the global 'hidden' option
1224 hide hide the buffer (don't unload it), also when 'hidden'
1225 is not set
1226 unload unload the buffer, also when 'hidden' is set or using
1227 |:hide|
1228 delete delete the buffer from the buffer list, also when
1229 'hidden' is set or using |:hide|, like using
1230 |:bdelete|
1231 wipe wipe out the buffer from the buffer list, also when
1232 'hidden' is set or using |:hide|, like using
1233 |:bwipeout|
1234
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001235 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001236 are lost without a warning. Also, these values may break autocommands
1237 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001238 This option is used together with 'buftype' and 'swapfile' to specify
1239 special kinds of buffers. See |special-buffers|.
1240
1241 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1242'buflisted' 'bl' boolean (default: on)
1243 local to buffer
1244 {not in Vi}
1245 When this option is set, the buffer shows up in the buffer list. If
1246 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1247 This option is reset by Vim for buffers that are only used to remember
1248 a file name or marks. Vim sets it when starting to edit a buffer.
1249 But not when moving to a buffer with ":buffer".
1250
1251 *'buftype'* *'bt'* *E382*
1252'buftype' 'bt' string (default: "")
1253 local to buffer
1254 {not in Vi}
1255 {not available when compiled without the |+quickfix|
1256 feature}
1257 The value of this option specifies the type of a buffer:
1258 <empty> normal buffer
1259 nofile buffer which is not related to a file and will not be
1260 written
1261 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001262 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001263 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001264 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001266 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 help help buffer (you are not supposed to set this
1268 manually)
1269
1270 This option is used together with 'bufhidden' and 'swapfile' to
1271 specify special kinds of buffers. See |special-buffers|.
1272
1273 Be careful with changing this option, it can have many side effects!
1274
Bram Moolenaar280f1262006-01-30 00:14:18 +00001275 A "quickfix" buffer is only used for the error list and the location
1276 list. This value is set by the |:cwindow| and |:lwindow| commands and
1277 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
1279 "nofile" and "nowrite" buffers are similar:
1280 both: The buffer is not to be written to disk, ":w" doesn't
1281 work (":w filename" does work though).
1282 both: The buffer is never considered to be |'modified'|.
1283 There is no warning when the changes will be lost, for
1284 example when you quit Vim.
1285 both: A swap file is only created when using too much memory
1286 (when 'swapfile' has been reset there is never a swap
1287 file).
1288 nofile only: The buffer name is fixed, it is not handled like a
1289 file name. It is not modified in response to a |:cd|
1290 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001291 *E676*
1292 "acwrite" implies that the buffer name is not related to a file, like
1293 "nofile", but it will be written. Thus, in contrast to "nofile" and
1294 "nowrite", ":w" does work and a modified buffer can't be abandoned
1295 without saving. For writing there must be matching |BufWriteCmd|,
1296 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297
1298 *'casemap'* *'cmp'*
1299'casemap' 'cmp' string (default: "internal,keepascii")
1300 global
1301 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001302 {only available when compiled with the |+multi_byte|
1303 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 Specifies details about changing the case of letters. It may contain
1305 these words, separated by a comma:
1306 internal Use internal case mapping functions, the current
1307 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001308 matters when 'encoding' is a Unicode encoding,
1309 "latin1" or "iso-8859-15". When "internal" is
1310 omitted, the towupper() and towlower() system library
1311 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1313 case mapping, the current locale is not effective.
1314 This probably only matters for Turkish.
1315
1316 *'cdpath'* *'cd'* *E344* *E346*
1317'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1318 global
1319 {not in Vi}
1320 {not available when compiled without the
1321 |+file_in_path| feature}
1322 This is a list of directories which will be searched when using the
1323 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001324 for has a relative path, not an absolute part starting with "/", "./"
1325 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 The 'cdpath' option's value has the same form and semantics as
1327 |'path'|. Also see |file-searching|.
1328 The default value is taken from $CDPATH, with a "," prepended to look
1329 in the current directory first.
1330 If the default value taken from $CDPATH is not what you want, include
1331 a modified version of the following command in your vimrc file to
1332 override it: >
1333 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1334< This option cannot be set from a |modeline| or in the |sandbox|, for
1335 security reasons.
1336 (parts of 'cdpath' can be passed to the shell to expand file names).
1337
1338 *'cedit'*
1339'cedit' string (Vi default: "", Vim default: CTRL-F)
1340 global
1341 {not in Vi}
1342 {not available when compiled without the |+vertsplit|
1343 feature}
1344 The key used in Command-line Mode to open the command-line window.
1345 The default is CTRL-F when 'compatible' is off.
1346 Only non-printable keys are allowed.
1347 The key can be specified as a single character, but it is difficult to
1348 type. The preferred way is to use the <> notation. Examples: >
1349 :set cedit=<C-Y>
1350 :set cedit=<Esc>
1351< |Nvi| also has this option, but it only uses the first character.
1352 See |cmdwin|.
1353
1354 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1355'charconvert' 'ccv' string (default "")
1356 global
1357 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001358 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001359 {not in Vi}
1360 An expression that is used for character encoding conversion. It is
1361 evaluated when a file that is to be read or has been written has a
1362 different encoding from what is desired.
1363 'charconvert' is not used when the internal iconv() function is
1364 supported and is able to do the conversion. Using iconv() is
1365 preferred, because it is much faster.
1366 'charconvert' is not used when reading stdin |--|, because there is no
1367 file to convert from. You will have to save the text in a file first.
1368 The expression must return zero or an empty string for success,
1369 non-zero for failure.
1370 The possible encoding names encountered are in 'encoding'.
1371 Additionally, names given in 'fileencodings' and 'fileencoding' are
1372 used.
1373 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1374 is done internally by Vim, 'charconvert' is not used for this.
1375 'charconvert' is also used to convert the viminfo file, if the 'c'
1376 flag is present in 'viminfo'. Also used for Unicode conversion.
1377 Example: >
1378 set charconvert=CharConvert()
1379 fun CharConvert()
1380 system("recode "
1381 \ . v:charconvert_from . ".." . v:charconvert_to
1382 \ . " <" . v:fname_in . " >" v:fname_out)
1383 return v:shell_error
1384 endfun
1385< The related Vim variables are:
1386 v:charconvert_from name of the current encoding
1387 v:charconvert_to name of the desired encoding
1388 v:fname_in name of the input file
1389 v:fname_out name of the output file
1390 Note that v:fname_in and v:fname_out will never be the same.
1391 Note that v:charconvert_from and v:charconvert_to may be different
1392 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1393 Encryption is not done by Vim when using 'charconvert'. If you want
1394 to encrypt the file after conversion, 'charconvert' should take care
1395 of this.
1396 This option cannot be set from a |modeline| or in the |sandbox|, for
1397 security reasons.
1398
1399 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1400'cindent' 'cin' boolean (default off)
1401 local to buffer
1402 {not in Vi}
1403 {not available when compiled without the |+cindent|
1404 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001405 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406 that trigger reindenting in insert mode and 'cinoptions' to set your
1407 preferred indent style.
1408 If 'indentexpr' is not empty, it overrules 'cindent'.
1409 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1410 the "=" operator indents using this algorithm rather than calling an
1411 external program.
1412 See |C-indenting|.
1413 When you don't like the way 'cindent' works, try the 'smartindent'
1414 option or 'indentexpr'.
1415 This option is not used when 'paste' is set.
1416 NOTE: This option is reset when 'compatible' is set.
1417
1418 *'cinkeys'* *'cink'*
1419'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1420 local to buffer
1421 {not in Vi}
1422 {not available when compiled without the |+cindent|
1423 feature}
1424 A list of keys that, when typed in Insert mode, cause reindenting of
1425 the current line. Only used if 'cindent' is on and 'indentexpr' is
1426 empty.
1427 For the format of this option see |cinkeys-format|.
1428 See |C-indenting|.
1429
1430 *'cinoptions'* *'cino'*
1431'cinoptions' 'cino' string (default "")
1432 local to buffer
1433 {not in Vi}
1434 {not available when compiled without the |+cindent|
1435 feature}
1436 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1437 program. See |cinoptions-values| for the values of this option, and
1438 |C-indenting| for info on C indenting in general.
1439
1440
1441 *'cinwords'* *'cinw'*
1442'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1443 local to buffer
1444 {not in Vi}
1445 {not available when compiled without both the
1446 |+cindent| and the |+smartindent| features}
1447 These keywords start an extra indent in the next line when
1448 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1449 an appropriate place (inside {}).
1450 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1451 matter, include the keyword both the uppercase and lowercase:
1452 "if,If,IF".
1453
1454 *'clipboard'* *'cb'*
1455'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1456 for X-windows, "" otherwise)
1457 global
1458 {not in Vi}
1459 {only in GUI versions or when the |+xterm_clipboard|
1460 feature is included}
1461 This option is a list of comma separated names.
1462 These names are recognized:
1463
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001464 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 unnamed When included, Vim will use the clipboard register '*'
1466 for all yank, delete, change and put operations which
1467 would normally go to the unnamed register. When a
1468 register is explicitly specified, it will always be
1469 used regardless of whether "unnamed" is in 'clipboard'
1470 or not. The clipboard register can always be
1471 explicitly accessed using the "* notation. Also see
1472 |gui-clipboard|.
1473
Bram Moolenaar30b65812012-07-12 22:01:11 +02001474 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001475 unnamedplus A variant of the "unnamed" flag which uses the
1476 clipboard register '+' (|quoteplus|) instead of
1477 register '*' for all yank, delete, change and put
1478 operations which would normally go to the unnamed
1479 register. When "unnamed" is also included to the
1480 option, yank operations (but not delete, change or
1481 put) will additionally copy the text into register
1482 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001483 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001484 Availability can be checked with: >
1485 if has('unnamedplus')
1486<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001487 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 autoselect Works like the 'a' flag in 'guioptions': If present,
1489 then whenever Visual mode is started, or the Visual
1490 area extended, Vim tries to become the owner of the
1491 windowing system's global selection or put the
1492 selected text on the clipboard used by the selection
1493 register "*. See |guioptions_a| and |quotestar| for
1494 details. When the GUI is active, the 'a' flag in
1495 'guioptions' is used, when the GUI is not active, this
1496 "autoselect" flag is used.
1497 Also applies to the modeless selection.
1498
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001499 *clipboard-autoselectplus*
1500 autoselectplus Like "autoselect" but using the + register instead of
1501 the * register. Compare to the 'P' flag in
1502 'guioptions'.
1503
1504 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001505 autoselectml Like "autoselect", but for the modeless selection
1506 only. Compare to the 'A' flag in 'guioptions'.
1507
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001508 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001509 html When the clipboard contains HTML, use this when
1510 pasting. When putting text on the clipboard, mark it
1511 as HTML. This works to copy rendered HTML from
1512 Firefox, paste it as raw HTML in Vim, select the HTML
1513 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001514 You probably want to add this only temporarily,
1515 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001516 Only supported for GTK version 2 and later.
1517 Only available with the |+multi_byte| feature.
1518
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001519 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 exclude:{pattern}
1521 Defines a pattern that is matched against the name of
1522 the terminal 'term'. If there is a match, no
1523 connection will be made to the X server. This is
1524 useful in this situation:
1525 - Running Vim in a console.
1526 - $DISPLAY is set to start applications on another
1527 display.
1528 - You do not want to connect to the X server in the
1529 console, but do want this in a terminal emulator.
1530 To never connect to the X server use: >
1531 exclude:.*
1532< This has the same effect as using the |-X| argument.
1533 Note that when there is no connection to the X server
1534 the window title won't be restored and the clipboard
1535 cannot be accessed.
1536 The value of 'magic' is ignored, {pattern} is
1537 interpreted as if 'magic' was on.
1538 The rest of the option value will be used for
1539 {pattern}, this must be the last entry.
1540
1541 *'cmdheight'* *'ch'*
1542'cmdheight' 'ch' number (default 1)
1543 global
1544 {not in Vi}
1545 Number of screen lines to use for the command-line. Helps avoiding
1546 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001547 The value of this option is stored with the tab page, so that each tab
1548 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549
1550 *'cmdwinheight'* *'cwh'*
1551'cmdwinheight' 'cwh' number (default 7)
1552 global
1553 {not in Vi}
1554 {not available when compiled without the |+vertsplit|
1555 feature}
1556 Number of screen lines to use for the command-line window. |cmdwin|
1557
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001558 *'colorcolumn'* *'cc'*
1559'colorcolumn' 'cc' string (default "")
1560 local to window
1561 {not in Vi}
1562 {not available when compiled without the |+syntax|
1563 feature}
1564 'colorcolumn' is a comma separated list of screen columns that are
1565 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1566 text. Will make screen redrawing slower.
1567 The screen column can be an absolute number, or a number preceded with
1568 '+' or '-', which is added to or subtracted from 'textwidth'. >
1569
1570 :set cc=+1 " highlight column after 'textwidth'
1571 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1572 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1573<
1574 When 'textwidth' is zero then the items with '-' and '+' are not used.
1575 A maximum of 256 columns are highlighted.
1576
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 *'columns'* *'co'* *E594*
1578'columns' 'co' number (default 80 or terminal width)
1579 global
1580 {not in Vi}
1581 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001582 initialization and does not have to be set by hand. Also see
1583 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 When Vim is running in the GUI or in a resizable window, setting this
1585 option will cause the window size to be changed. When you only want
1586 to use the size for the GUI, put the command in your |gvimrc| file.
1587 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001588 number of columns of the display, the display may be messed up. For
1589 the GUI it is always possible and Vim limits the number of columns to
1590 what fits on the screen. You can use this command to get the widest
1591 window possible: >
1592 :set columns=9999
1593< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
1595 *'comments'* *'com'* *E524* *E525*
1596'comments' 'com' string (default
1597 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1598 local to buffer
1599 {not in Vi}
1600 {not available when compiled without the |+comments|
1601 feature}
1602 A comma separated list of strings that can start a comment line. See
1603 |format-comments|. See |option-backslash| about using backslashes to
1604 insert a space.
1605
1606 *'commentstring'* *'cms'* *E537*
1607'commentstring' 'cms' string (default "/*%s*/")
1608 local to buffer
1609 {not in Vi}
1610 {not available when compiled without the |+folding|
1611 feature}
1612 A template for a comment. The "%s" in the value is replaced with the
1613 comment text. Currently only used to add markers for folding, see
1614 |fold-marker|.
1615
1616 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001617'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1618 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 global
1620 {not in Vi}
1621 This option has the effect of making Vim either more Vi-compatible, or
1622 make Vim behave in a more useful way.
1623 This is a special kind of option, because when it's set or reset,
1624 other options are also changed as a side effect. CAREFUL: Setting or
1625 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001626 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 set this option in your vimrc file, you should probably put it at the
1628 very start.
1629 By default this option is on and the Vi defaults are used for the
1630 options. This default was chosen for those people who want to use Vim
1631 just like Vi, and don't even (want to) know about the 'compatible'
1632 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001633 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001634 this option is switched off, and all options that have not been
1635 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001636 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001637 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001638 happen for the system-wide vimrc or gvimrc file, nor for a file given
1639 with the |-u| argument). Also see |compatible-default| and
1640 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 You can also set this option with the "-C" argument, and reset it with
1642 "-N". See |-C| and |-N|.
1643 Switching this option off makes the Vim defaults be used for options
1644 that have a different Vi and Vim default value. See the options
1645 marked with a '+' below. Other options are not modified.
1646 At the moment this option is set, several other options will be set
1647 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001648 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 editing.
1650 See also 'cpoptions'.
1651
1652 option + set value effect ~
1653
1654 'allowrevins' off no CTRL-_ command
1655 'backupcopy' Unix: "yes" backup file is a copy
1656 others: "auto" copy or rename backup file
1657 'backspace' "" normal backspace
1658 'backup' off no backup file
1659 'cindent' off no C code indentation
1660 'cedit' + "" no key to open the |cmdwin|
1661 'cpoptions' + (all flags) Vi-compatible flags
1662 'cscopetag' off don't use cscope for ":tag"
1663 'cscopetagorder' 0 see |cscopetagorder|
1664 'cscopeverbose' off see |cscopeverbose|
1665 'digraph' off no digraphs
1666 'esckeys' + off no <Esc>-keys in Insert mode
1667 'expandtab' off tabs not expanded to spaces
1668 'fileformats' + "" no automatic file format detection,
1669 "dos,unix" except for DOS, Windows and OS/2
1670 'formatoptions' + "vt" Vi compatible formatting
1671 'gdefault' off no default 'g' flag for ":s"
1672 'history' + 0 no commandline history
1673 'hkmap' off no Hebrew keyboard mapping
1674 'hkmapp' off no phonetic Hebrew keyboard mapping
1675 'hlsearch' off no highlighting of search matches
1676 'incsearch' off no incremental searching
1677 'indentexpr' "" no indenting by expression
1678 'insertmode' off do not start in Insert mode
1679 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1680 characters and '_'
1681 'joinspaces' on insert 2 spaces after period
1682 'modeline' + off no modelines
1683 'more' + off no pauses in listings
1684 'revins' off no reverse insert
1685 'ruler' off no ruler
1686 'scrolljump' 1 no jump scroll
1687 'scrolloff' 0 no scroll offset
1688 'shiftround' off indent not rounded to shiftwidth
1689 'shortmess' + "" no shortening of messages
1690 'showcmd' + off command characters not shown
1691 'showmode' + off current mode not shown
1692 'smartcase' off no automatic ignore case switch
1693 'smartindent' off no smart indentation
1694 'smarttab' off no smart tab size
1695 'softtabstop' 0 tabs are always 'tabstop' positions
1696 'startofline' on goto startofline with some commands
1697 'tagrelative' + off tag file names are not relative
1698 'textauto' + off no automatic textmode detection
1699 'textwidth' 0 no automatic line wrap
1700 'tildeop' off tilde is not an operator
1701 'ttimeout' off no terminal timeout
1702 'whichwrap' + "" left-right movements don't wrap
1703 'wildchar' + CTRL-E only when the current value is <Tab>
1704 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001705 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706
1707 *'complete'* *'cpt'* *E535*
1708'complete' 'cpt' string (default: ".,w,b,u,t,i")
1709 local to buffer
1710 {not in Vi}
1711 This option specifies how keyword completion |ins-completion| works
1712 when CTRL-P or CTRL-N are used. It is also used for whole-line
1713 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1714 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001715 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 w scan buffers from other windows
1717 b scan other loaded buffers that are in the buffer list
1718 u scan the unloaded buffers that are in the buffer list
1719 U scan the buffers that are not in the buffer list
1720 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001721 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 k{dict} scan the file {dict}. Several "k" flags can be given,
1723 patterns are valid too. For example: >
1724 :set cpt=k/usr/dict/*,k~/spanish
1725< s scan the files given with the 'thesaurus' option
1726 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1727 are valid too.
1728 i scan current and included files
1729 d scan current and included files for defined name or macro
1730 |i_CTRL-X_CTRL-D|
1731 ] tag completion
1732 t same as "]"
1733
1734 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1735 not executed, this may lead to unexpected completions from some files
1736 (gzipped files for example). Unloaded buffers are not scanned for
1737 whole-line completion.
1738
1739 The default is ".,w,b,u,t,i", which means to scan:
1740 1. the current buffer
1741 2. buffers in other windows
1742 3. other loaded buffers
1743 4. unloaded buffers
1744 5. tags
1745 6. included files
1746
1747 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001748 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1749 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001751 *'completefunc'* *'cfu'*
1752'completefunc' 'cfu' string (default: empty)
1753 local to buffer
1754 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001755 {not available when compiled without the |+eval|
1756 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001757 This option specifies a function to be used for Insert mode completion
1758 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001759 See |complete-functions| for an explanation of how the function is
1760 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001761 This option cannot be set from a |modeline| or in the |sandbox|, for
1762 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001763
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001764 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001765'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001766 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001767 {not available when compiled without the
1768 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001769 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001770 A comma separated list of options for Insert mode completion
1771 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001772
1773 menu Use a popup menu to show the possible completions. The
1774 menu is only shown when there is more than one match and
1775 sufficient colors are available. |ins-completion-menu|
1776
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001777 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001778 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001779 match, e.g., what file it comes from.
1780
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001781 longest Only insert the longest common text of the matches. If
1782 the menu is displayed you can use CTRL-L to add more
1783 characters. Whether case is ignored depends on the kind
1784 of completion. For buffer text the 'ignorecase' option is
1785 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001786
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001787 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001788 completion in the preview window. Only works in
1789 combination with "menu" or "menuone".
1790
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001791
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001792 *'concealcursor'* *'cocu'*
1793'concealcursor' 'cocu' string (default: "")
1794 local to window
1795 {not in Vi}
1796 {not available when compiled without the |+conceal|
1797 feature}
1798 Sets the modes in which text in the cursor line can also be concealed.
1799 When the current mode is listed then concealing happens just like in
1800 other lines.
1801 n Normal mode
1802 v Visual mode
1803 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001804 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001805
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001806 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001807 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001808 are moving around text is concealed, but when starting to insert text
1809 or selecting a Visual area the concealed text is displayed, so that
1810 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001811 Keep in mind that the cursor position is not always where it's
1812 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001813
1814
1815'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001816 number (default 0)
1817 local to window
1818 {not in Vi}
1819 {not available when compiled without the |+conceal|
1820 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001821 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1822 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001823
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001824 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001825 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001826 1 Each block of concealed text is replaced with one
1827 character. If the syntax item does not have a custom
1828 replacement character defined (see |:syn-cchar|) the
1829 character defined in 'listchars' is used (default is a
1830 space).
1831 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001832 2 Concealed text is completely hidden unless it has a
1833 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001834 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001835 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001836
Bram Moolenaara7781e02010-07-19 20:13:22 +02001837 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001838 edit and copy the text. This can be changed with the 'concealcursor'
1839 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001840
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1842'confirm' 'cf' boolean (default off)
1843 global
1844 {not in Vi}
1845 When 'confirm' is on, certain operations that would normally
1846 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1847 instead raise a |dialog| asking if you wish to save the current
1848 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1849 If 'confirm' is off you can still activate confirmation for one
1850 command only (this is most useful in mappings) with the |:confirm|
1851 command.
1852 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1853
1854 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1855'conskey' 'consk' boolean (default off)
1856 global
1857 {not in Vi} {only for MS-DOS}
1858 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001859 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 three methods of console input are available:
1861 'conskey' 'bioskey' action ~
1862 on on or off direct console input
1863 off on BIOS
1864 off off STDIN
1865
1866 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1867'copyindent' 'ci' boolean (default off)
1868 local to buffer
1869 {not in Vi}
1870 Copy the structure of the existing lines indent when autoindenting a
1871 new line. Normally the new indent is reconstructed by a series of
1872 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1873 in which case only spaces are used). Enabling this option makes the
1874 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001875 existing line. 'expandtab' has no effect on these characters, a Tab
1876 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 line, the remaining space is filled in the normal manner.
1878 NOTE: 'copyindent' is reset when 'compatible' is set.
1879 Also see 'preserveindent'.
1880
1881 *'cpoptions'* *'cpo'*
1882'cpoptions' 'cpo' string (Vim default: "aABceFs",
1883 Vi default: all flags)
1884 global
1885 {not in Vi}
1886 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001887 this indicates Vi-compatible behavior. This is used for things where
1888 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 'cpoptions' stands for "compatible-options".
1890 Commas can be added for readability.
1891 To avoid problems with flags that are added in the future, use the
1892 "+=" and "-=" feature of ":set" |add-option-flags|.
1893 NOTE: This option is set to the Vi default value when 'compatible' is
1894 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001895 NOTE: This option is set to the POSIX default value at startup when
1896 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001897 variable exists |posix|. This means Vim tries to behave like the
1898 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899
1900 contains behavior ~
1901 *cpo-a*
1902 a When included, a ":read" command with a file name
1903 argument will set the alternate file name for the
1904 current window.
1905 *cpo-A*
1906 A When included, a ":write" command with a file name
1907 argument will set the alternate file name for the
1908 current window.
1909 *cpo-b*
1910 b "\|" in a ":map" command is recognized as the end of
1911 the map command. The '\' is included in the mapping,
1912 the text after the '|' is interpreted as the next
1913 command. Use a CTRL-V instead of a backslash to
1914 include the '|' in the mapping. Applies to all
1915 mapping, abbreviation, menu and autocmd commands.
1916 See also |map_bar|.
1917 *cpo-B*
1918 B A backslash has no special meaning in mappings,
1919 abbreviations and the "to" part of the menu commands.
1920 Remove this flag to be able to use a backslash like a
1921 CTRL-V. For example, the command ":map X \<Esc>"
1922 results in X being mapped to:
1923 'B' included: "\^[" (^[ is a real <Esc>)
1924 'B' excluded: "<Esc>" (5 characters)
1925 ('<' excluded in both cases)
1926 *cpo-c*
1927 c Searching continues at the end of any match at the
1928 cursor position, but not further than the start of the
1929 next line. When not present searching continues
1930 one character from the cursor position. With 'c'
1931 "abababababab" only gets three matches when repeating
1932 "/abab", without 'c' there are five matches.
1933 *cpo-C*
1934 C Do not concatenate sourced lines that start with a
1935 backslash. See |line-continuation|.
1936 *cpo-d*
1937 d Using "./" in the 'tags' option doesn't mean to use
1938 the tags file relative to the current file, but the
1939 tags file in the current directory.
1940 *cpo-D*
1941 D Can't use CTRL-K to enter a digraph after Normal mode
1942 commands with a character argument, like |r|, |f| and
1943 |t|.
1944 *cpo-e*
1945 e When executing a register with ":@r", always add a
1946 <CR> to the last line, also when the register is not
1947 linewise. If this flag is not present, the register
1948 is not linewise and the last line does not end in a
1949 <CR>, then the last line is put on the command-line
1950 and can be edited before hitting <CR>.
1951 *cpo-E*
1952 E It is an error when using "y", "d", "c", "g~", "gu" or
1953 "gU" on an Empty region. The operators only work when
1954 at least one character is to be operate on. Example:
1955 This makes "y0" fail in the first column.
1956 *cpo-f*
1957 f When included, a ":read" command with a file name
1958 argument will set the file name for the current buffer,
1959 if the current buffer doesn't have a file name yet.
1960 *cpo-F*
1961 F When included, a ":write" command with a file name
1962 argument will set the file name for the current
1963 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001964 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 *cpo-g*
1966 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001967 *cpo-H*
1968 H When using "I" on a line with only blanks, insert
1969 before the last blank. Without this flag insert after
1970 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 *cpo-i*
1972 i When included, interrupting the reading of a file will
1973 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001974 *cpo-I*
1975 I When moving the cursor up or down just after inserting
1976 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 *cpo-j*
1978 j When joining lines, only add two spaces after a '.',
1979 not after '!' or '?'. Also see 'joinspaces'.
1980 *cpo-J*
1981 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001982 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 white space.
1984 *cpo-k*
1985 k Disable the recognition of raw key codes in
1986 mappings, abbreviations, and the "to" part of menu
1987 commands. For example, if <Key> sends ^[OA (where ^[
1988 is <Esc>), the command ":map X ^[OA" results in X
1989 being mapped to:
1990 'k' included: "^[OA" (3 characters)
1991 'k' excluded: "<Key>" (one key code)
1992 Also see the '<' flag below.
1993 *cpo-K*
1994 K Don't wait for a key code to complete when it is
1995 halfway a mapping. This breaks mapping <F1><F1> when
1996 only part of the second <F1> has been read. It
1997 enables cancelling the mapping by typing <F1><Esc>.
1998 *cpo-l*
1999 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002000 literally, only "\]", "\^", "\-" and "\\" are special.
2001 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2003 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002004 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 *cpo-L*
2006 L When the 'list' option is set, 'wrapmargin',
2007 'textwidth', 'softtabstop' and Virtual Replace mode
2008 (see |gR|) count a <Tab> as two characters, instead of
2009 the normal behavior of a <Tab>.
2010 *cpo-m*
2011 m When included, a showmatch will always wait half a
2012 second. When not included, a showmatch will wait half
2013 a second or until a character is typed. |'showmatch'|
2014 *cpo-M*
2015 M When excluded, "%" matching will take backslashes into
2016 account. Thus in "( \( )" and "\( ( \)" the outer
2017 parenthesis match. When included "%" ignores
2018 backslashes, which is Vi compatible.
2019 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002020 n When included, the column used for 'number' and
2021 'relativenumber' will also be used for text of wrapped
2022 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 *cpo-o*
2024 o Line offset to search command is not remembered for
2025 next search.
2026 *cpo-O*
2027 O Don't complain if a file is being overwritten, even
2028 when it didn't exist when editing it. This is a
2029 protection against a file unexpectedly created by
2030 someone else. Vi didn't complain about this.
2031 *cpo-p*
2032 p Vi compatible Lisp indenting. When not present, a
2033 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002034 *cpo-P*
2035 P When included, a ":write" command that appends to a
2036 file will set the file name for the current buffer, if
2037 the current buffer doesn't have a file name yet and
2038 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002039 *cpo-q*
2040 q When joining multiple lines leave the cursor at the
2041 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042 *cpo-r*
2043 r Redo ("." command) uses "/" to repeat a search
2044 command, instead of the actually used search string.
2045 *cpo-R*
2046 R Remove marks from filtered lines. Without this flag
2047 marks are kept like |:keepmarks| was used.
2048 *cpo-s*
2049 s Set buffer options when entering the buffer for the
2050 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002051 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 set when the buffer is created.
2053 *cpo-S*
2054 S Set buffer options always when entering a buffer
2055 (except 'readonly', 'fileformat', 'filetype' and
2056 'syntax'). This is the (most) Vi compatible setting.
2057 The options are set to the values in the current
2058 buffer. When you change an option and go to another
2059 buffer, the value is copied. Effectively makes the
2060 buffer options global to all buffers.
2061
2062 's' 'S' copy buffer options
2063 no no when buffer created
2064 yes no when buffer first entered (default)
2065 X yes each time when buffer entered (vi comp.)
2066 *cpo-t*
2067 t Search pattern for the tag command is remembered for
2068 "n" command. Otherwise Vim only puts the pattern in
2069 the history for search pattern, but doesn't change the
2070 last used search pattern.
2071 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002072 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 *cpo-v*
2074 v Backspaced characters remain visible on the screen in
2075 Insert mode. Without this flag the characters are
2076 erased from the screen right away. With this flag the
2077 screen newly typed text overwrites backspaced
2078 characters.
2079 *cpo-w*
2080 w When using "cw" on a blank character, only change one
2081 character and not all blanks until the start of the
2082 next word.
2083 *cpo-W*
2084 W Don't overwrite a readonly file. When omitted, ":w!"
2085 overwrites a readonly file, if possible.
2086 *cpo-x*
2087 x <Esc> on the command-line executes the command-line.
2088 The default in Vim is to abandon the command-line,
2089 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002090 *cpo-X*
2091 X When using a count with "R" the replaced text is
2092 deleted only once. Also when repeating "R" with "."
2093 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 *cpo-y*
2095 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002096 *cpo-Z*
2097 Z When using "w!" while the 'readonly' option is set,
2098 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 *cpo-!*
2100 ! When redoing a filter command, use the last used
2101 external command, whatever it was. Otherwise the last
2102 used -filter- command is used.
2103 *cpo-$*
2104 $ When making a change to one line, don't redisplay the
2105 line, but put a '$' at the end of the changed text.
2106 The changed text will be overwritten when you type the
2107 new text. The line is redisplayed if you type any
2108 command that moves the cursor from the insertion
2109 point.
2110 *cpo-%*
2111 % Vi-compatible matching is done for the "%" command.
2112 Does not recognize "#if", "#endif", etc.
2113 Does not recognize "/*" and "*/".
2114 Parens inside single and double quotes are also
2115 counted, causing a string that contains a paren to
2116 disturb the matching. For example, in a line like
2117 "if (strcmp("foo(", s))" the first paren does not
2118 match the last one. When this flag is not included,
2119 parens inside single and double quotes are treated
2120 specially. When matching a paren outside of quotes,
2121 everything inside quotes is ignored. When matching a
2122 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002123 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002124 This flag is also used for other features, such as
2125 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002126 *cpo--*
2127 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002128 it would go above the first line or below the last
2129 line. Without it the cursor moves to the first or
2130 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002131 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002132 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002133 *cpo-+*
2134 + When included, a ":write file" command will reset the
2135 'modified' flag of the buffer, even though the buffer
2136 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002137 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 * Use ":*" in the same way as ":@". When not included,
2139 ":*" is an alias for ":'<,'>", select the Visual area.
2140 *cpo-<*
2141 < Disable the recognition of special key codes in |<>|
2142 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002143 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 ":map X <Tab>" results in X being mapped to:
2145 '<' included: "<Tab>" (5 characters)
2146 '<' excluded: "^I" (^I is a real <Tab>)
2147 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002148 *cpo->*
2149 > When appending to a register, put a line break before
2150 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002151 *cpo-;*
2152 ; When using |,| or |;| to repeat the last |t| search
2153 and the cursor is right in front of the searched
2154 character, the cursor won't move. When not included,
2155 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002156 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002157
2158 POSIX flags. These are not included in the Vi default value, except
2159 when $VIM_POSIX was set on startup. |posix|
2160
2161 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002162 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002163 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002164 *cpo-&*
2165 & When ":preserve" was used keep the swap file when
2166 exiting normally while this buffer is still loaded.
2167 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002168 *cpo-\*
2169 \ Backslash in a [] range in a search pattern is taken
2170 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002171 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2172 '\' excluded: "/[ \-]" finds <Space> and '-'
2173 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002174 *cpo-/*
2175 / When "%" is used as the replacement string in a |:s|
2176 command, use the previous replacement string. |:s%|
2177 *cpo-{*
2178 { The |{| and |}| commands also stop at a "{" character
2179 at the start of a line.
2180 *cpo-.*
2181 . The ":chdir" and ":cd" commands fail if the current
2182 buffer is modified, unless ! is used. Vim doesn't
2183 need this, since it remembers the full path of an
2184 opened file.
2185 *cpo-bar*
2186 | The value of the $LINES and $COLUMNS environment
2187 variables overrule the terminal size values obtained
2188 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002189
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002191 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002192'cryptmethod' string (default "zip")
2193 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002194 {not in Vi}
2195 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002196 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002197 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002198 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002199 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002200 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002201 or later, files can NOT be read by Vim 7.2 and older.
2202 This adds a "seed" to the file, every time you write
2203 the file the encrypted bytes will be different.
2204
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002205 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002206 to the detected method of the file being read. Thus if you write it
2207 without changing 'cryptmethod' the same method will be used.
2208 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002209 explicitly write it, you don't get a warning unless there are other
2210 modifications. Also see |:X|.
2211
2212 When setting the global value to an empty string, it will end up with
2213 the value "zip". When setting the local value to an empty string the
2214 buffer will use the global value.
2215
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002216 When a new encryption method is added in a later version of Vim, and
2217 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002218 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002219
2220
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 *'cscopepathcomp'* *'cspc'*
2222'cscopepathcomp' 'cspc' number (default 0)
2223 global
2224 {not available when compiled without the |+cscope|
2225 feature}
2226 {not in Vi}
2227 Determines how many components of the path to show in a list of tags.
2228 See |cscopepathcomp|.
2229
2230 *'cscopeprg'* *'csprg'*
2231'cscopeprg' 'csprg' string (default "cscope")
2232 global
2233 {not available when compiled without the |+cscope|
2234 feature}
2235 {not in Vi}
2236 Specifies the command to execute cscope. See |cscopeprg|.
2237 This option cannot be set from a |modeline| or in the |sandbox|, for
2238 security reasons.
2239
2240 *'cscopequickfix'* *'csqf'*
2241'cscopequickfix' 'csqf' string (default "")
2242 global
2243 {not available when compiled without the |+cscope|
2244 or |+quickfix| features}
2245 {not in Vi}
2246 Specifies whether to use quickfix window to show cscope results.
2247 See |cscopequickfix|.
2248
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002249 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002250'cscoperelative' 'csre' boolean (default off)
2251 global
2252 {not available when compiled without the |+cscope|
2253 feature}
2254 {not in Vi}
2255 In the absence of a prefix (-P) for cscope. setting this option enables
2256 to use the basename of cscope.out path as the prefix.
2257 See |cscoperelative|.
2258
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2260'cscopetag' 'cst' boolean (default off)
2261 global
2262 {not available when compiled without the |+cscope|
2263 feature}
2264 {not in Vi}
2265 Use cscope for tag commands. See |cscope-options|.
2266 NOTE: This option is reset when 'compatible' is set.
2267
2268 *'cscopetagorder'* *'csto'*
2269'cscopetagorder' 'csto' number (default 0)
2270 global
2271 {not available when compiled without the |+cscope|
2272 feature}
2273 {not in Vi}
2274 Determines the order in which ":cstag" performs a search. See
2275 |cscopetagorder|.
2276 NOTE: This option is set to 0 when 'compatible' is set.
2277
2278 *'cscopeverbose'* *'csverb'*
2279 *'nocscopeverbose'* *'nocsverb'*
2280'cscopeverbose' 'csverb' boolean (default off)
2281 global
2282 {not available when compiled without the |+cscope|
2283 feature}
2284 {not in Vi}
2285 Give messages when adding a cscope database. See |cscopeverbose|.
2286 NOTE: This option is reset when 'compatible' is set.
2287
Bram Moolenaar860cae12010-06-05 23:22:07 +02002288 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2289'cursorbind' 'crb' boolean (default off)
2290 local to window
2291 {not in Vi}
2292 {not available when compiled without the |+cursorbind|
2293 feature}
2294 When this option is set, as the cursor in the current
2295 window moves other cursorbound windows (windows that also have
2296 this option set) move their cursors to the corresponding line and
2297 column. This option is useful for viewing the
2298 differences between two versions of a file (see 'diff'); in diff mode,
2299 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002300 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002301
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002302
2303 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2304'cursorcolumn' 'cuc' boolean (default off)
2305 local to window
2306 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002307 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002308 feature}
2309 Highlight the screen column of the cursor with CursorColumn
2310 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2311 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002312 If you only want the highlighting in the current window you can use
2313 these autocommands: >
2314 au WinLeave * set nocursorline nocursorcolumn
2315 au WinEnter * set cursorline cursorcolumn
2316<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002317
2318 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2319'cursorline' 'cul' boolean (default off)
2320 local to window
2321 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002322 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002323 feature}
2324 Highlight the screen line of the cursor with CursorLine
2325 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2326 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002327 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002328 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002329
2330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 *'debug'*
2332'debug' string (default "")
2333 global
2334 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002335 These values can be used:
2336 msg Error messages that would otherwise be omitted will be given
2337 anyway.
2338 throw Error messages that would otherwise be omitted will be given
2339 anyway and also throw an exception and set |v:errmsg|.
2340 beep A message will be given when otherwise only a beep would be
2341 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002342 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002343 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2344 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345
2346 *'define'* *'def'*
2347'define' 'def' string (default "^\s*#\s*define")
2348 global or local to buffer |global-local|
2349 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002350 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 pattern, just like for the "/" command. This option is used for the
2352 commands like "[i" and "[d" |include-search|. The 'isident' option is
2353 used to recognize the defined name after the match:
2354 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2355 See |option-backslash| about inserting backslashes to include a space
2356 or backslash.
2357 The default value is for C programs. For C++ this value would be
2358 useful, to include const type declarations: >
2359 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2360< When using the ":set" command, you need to double the backslashes!
2361
2362 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2363'delcombine' 'deco' boolean (default off)
2364 global
2365 {not in Vi}
2366 {only available when compiled with the |+multi_byte|
2367 feature}
2368 If editing Unicode and this option is set, backspace and Normal mode
2369 "x" delete each combining character on its own. When it is off (the
2370 default) the character along with its combining characters are
2371 deleted.
2372 Note: When 'delcombine' is set "xx" may work different from "2x"!
2373
2374 This is useful for Arabic, Hebrew and many other languages where one
2375 may have combining characters overtop of base characters, and want
2376 to remove only the combining ones.
2377
2378 *'dictionary'* *'dict'*
2379'dictionary' 'dict' string (default "")
2380 global or local to buffer |global-local|
2381 {not in Vi}
2382 List of file names, separated by commas, that are used to lookup words
2383 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2384 contain a list of words. This can be one word per line, or several
2385 words per line, separated by non-keyword characters (white space is
2386 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002387 When this option is empty, or an entry "spell" is present, spell
2388 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002389 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 after a comma are ignored, otherwise spaces are included in the file
2391 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002392 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 Where to find a list of words?
2394 - On FreeBSD, there is the file "/usr/share/dict/words".
2395 - In the Simtel archive, look in the "msdos/linguist" directory.
2396 - In "miscfiles" of the GNU collection.
2397 The use of |:set+=| and |:set-=| is preferred when adding or removing
2398 directories from the list. This avoids problems when a future version
2399 uses another default.
2400 Backticks cannot be used in this option for security reasons.
2401
2402 *'diff'* *'nodiff'*
2403'diff' boolean (default off)
2404 local to window
2405 {not in Vi}
2406 {not available when compiled without the |+diff|
2407 feature}
2408 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002409 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410
2411 *'dex'* *'diffexpr'*
2412'diffexpr' 'dex' string (default "")
2413 global
2414 {not in Vi}
2415 {not available when compiled without the |+diff|
2416 feature}
2417 Expression which is evaluated to obtain an ed-style diff file from two
2418 versions of a file. See |diff-diffexpr|.
2419 This option cannot be set from a |modeline| or in the |sandbox|, for
2420 security reasons.
2421
2422 *'dip'* *'diffopt'*
2423'diffopt' 'dip' string (default "filler")
2424 global
2425 {not in Vi}
2426 {not available when compiled without the |+diff|
2427 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 All are optional. Items must be separated by a comma.
2430
2431 filler Show filler lines, to keep the text
2432 synchronized with a window that has inserted
2433 lines at the same position. Mostly useful
2434 when windows are side-by-side and 'scrollbind'
2435 is set.
2436
2437 context:{n} Use a context of {n} lines between a change
2438 and a fold that contains unchanged lines.
2439 When omitted a context of six lines is used.
2440 See |fold-diff|.
2441
2442 icase Ignore changes in case of text. "a" and "A"
2443 are considered the same. Adds the "-i" flag
2444 to the "diff" command if 'diffexpr' is empty.
2445
2446 iwhite Ignore changes in amount of white space. Adds
2447 the "-b" flag to the "diff" command if
2448 'diffexpr' is empty. Check the documentation
2449 of the "diff" command for what this does
2450 exactly. It should ignore adding trailing
2451 white space, but not leading white space.
2452
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002453 horizontal Start diff mode with horizontal splits (unless
2454 explicitly specified otherwise).
2455
2456 vertical Start diff mode with vertical splits (unless
2457 explicitly specified otherwise).
2458
2459 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2460 starting diff mode. Without this 2 is used.
2461
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 Examples: >
2463
2464 :set diffopt=filler,context:4
2465 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002466 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467<
2468 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2469'digraph' 'dg' boolean (default off)
2470 global
2471 {not in Vi}
2472 {not available when compiled without the |+digraphs|
2473 feature}
2474 Enable the entering of digraphs in Insert mode with {char1} <BS>
2475 {char2}. See |digraphs|.
2476 NOTE: This option is reset when 'compatible' is set.
2477
2478 *'directory'* *'dir'*
2479'directory' 'dir' string (default for Amiga: ".,t:",
2480 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2481 for Unix: ".,~/tmp,/var/tmp,/tmp")
2482 global
2483 List of directory names for the swap file, separated with commas.
2484 - The swap file will be created in the first directory where this is
2485 possible.
2486 - Empty means that no swap file will be used (recovery is
2487 impossible!).
2488 - A directory "." means to put the swap file in the same directory as
2489 the edited file. On Unix, a dot is prepended to the file name, so
2490 it doesn't show in a directory listing. On MS-Windows the "hidden"
2491 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002492 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 put the swap file relative to where the edited file is. The leading
2494 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002495 - For Unix and Win32, if a directory ends in two path separators "//"
2496 or "\\", the swap file name will be built from the complete path to
2497 the file with all path separators substituted to percent '%' signs.
2498 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002499 On Win32, when a separating comma is following, you must use "//",
2500 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 - Spaces after the comma are ignored, other spaces are considered part
2502 of the directory name. To have a space at the start of a directory
2503 name, precede it with a backslash.
2504 - To include a comma in a directory name precede it with a backslash.
2505 - A directory name may end in an ':' or '/'.
2506 - Environment variables are expanded |:set_env|.
2507 - Careful with '\' characters, type one before a space, type two to
2508 get one in the option (see |option-backslash|), for example: >
2509 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2510< - For backwards compatibility with Vim version 3.0 a '>' at the start
2511 of the option is removed.
2512 Using "." first in the list is recommended. This means that editing
2513 the same file twice will result in a warning. Using "/tmp" on Unix is
2514 discouraged: When the system crashes you lose the swap file.
2515 "/var/tmp" is often not cleared when rebooting, thus is a better
2516 choice than "/tmp". But it can contain a lot of files, your swap
2517 files get lost in the crowd. That is why a "tmp" directory in your
2518 home directory is tried first.
2519 The use of |:set+=| and |:set-=| is preferred when adding or removing
2520 directories from the list. This avoids problems when a future version
2521 uses another default.
2522 This option cannot be set from a |modeline| or in the |sandbox|, for
2523 security reasons.
2524 {Vi: directory to put temp file in, defaults to "/tmp"}
2525
2526 *'display'* *'dy'*
2527'display' 'dy' string (default "")
2528 global
2529 {not in Vi}
2530 Change the way text is displayed. This is comma separated list of
2531 flags:
2532 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 last line that doesn't fit is replaced with "@" lines.
2535 uhex Show unprintable characters hexadecimal as <xx>
2536 instead of using ^C and ~C.
2537
2538 *'eadirection'* *'ead'*
2539'eadirection' 'ead' string (default "both")
2540 global
2541 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002542 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 feature}
2544 Tells when the 'equalalways' option applies:
2545 ver vertically, width of windows is not affected
2546 hor horizontally, height of windows is not affected
2547 both width and height of windows is affected
2548
2549 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2550'edcompatible' 'ed' boolean (default off)
2551 global
2552 Makes the 'g' and 'c' flags of the ":substitute" command to be
2553 toggled each time the flag is given. See |complex-change|. See
2554 also 'gdefault' option.
2555 Switching this option on is discouraged!
2556
2557 *'encoding'* *'enc'* *E543*
2558'encoding' 'enc' string (default: "latin1" or value from $LANG)
2559 global
2560 {only available when compiled with the |+multi_byte|
2561 feature}
2562 {not in Vi}
2563 Sets the character encoding used inside Vim. It applies to text in
2564 the buffers, registers, Strings in expressions, text stored in the
2565 viminfo file, etc. It sets the kind of characters which Vim can work
2566 with. See |encoding-names| for the possible values.
2567
2568 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002569 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002571 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572
Bram Moolenaar865242e2010-07-14 21:12:05 +02002573 This option cannot be set from a |modeline|. It would most likely
2574 corrupt the text.
2575
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2577 "utf-8". Although care has been taken to allow different values of
2578 'encoding', "utf-8" is the natural choice for the environment and
2579 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 versions, and to avoid changing the encoding of newly created files
2582 without your knowledge (in case 'fileencodings' is empty).
2583
2584 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002585 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 iconv() or as specified with 'charconvert'.
2587
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002588 If you need to know whether 'encoding' is a multi-byte encoding, you
2589 can use: >
2590 if has("multi_byte_encoding")
2591<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 Normally 'encoding' will be equal to your current locale. This will
2593 be the default if Vim recognizes your environment settings. If
2594 'encoding' is not set to the current locale, 'termencoding' must be
2595 set to convert typed and displayed text. See |encoding-table|.
2596
2597 When you set this option, it fires the |EncodingChanged| autocommand
2598 event so that you can set up fonts if necessary.
2599
2600 When the option is set, the value is converted to lowercase. Thus
2601 you can set it with uppercase values too. Underscores are translated
2602 to '-' signs.
2603 When the encoding is recognized, it is changed to the standard name.
2604 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2605 "iso-8859-2" and "utf8" becomes "utf-8".
2606
2607 Note: "latin1" is also used when the encoding could not be detected.
2608 This only works when editing files in the same encoding! When the
2609 actual character set is not latin1, make sure 'fileencoding' and
2610 'fileencodings' are empty. When conversion is needed, switch to using
2611 utf-8.
2612
2613 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2614 You don't notice this while editing, but it does matter for the
2615 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2616 setting 'encoding' to one of these values instead of utf-8 only has
2617 effect for encoding used for files when 'fileencoding' is empty.
2618
Bram Moolenaar661b1822005-07-28 22:36:45 +00002619 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2620 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621
2622 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2623'endofline' 'eol' boolean (default on)
2624 local to buffer
2625 {not in Vi}
2626 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002627 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 option is automatically set when starting to edit a new file, unless
2629 the file does not have an <EOL> for the last line in the file, in
2630 which case it is reset. Normally you don't have to set or reset this
2631 option. When 'binary' is off the value is not used when writing the
2632 file. When 'binary' is on it is used to remember the presence of a
2633 <EOL> for the last line in the file, so that when you write the file
2634 the situation from the original file can be kept. But you can change
2635 it if you want to.
2636
2637 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2638'equalalways' 'ea' boolean (default on)
2639 global
2640 {not in Vi}
2641 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002642 splitting or closing a window. This also happens the moment the
2643 option is switched on. When off, splitting a window will reduce the
2644 size of the current window and leave the other windows the same. When
2645 closing a window the extra lines are given to the window next to it
2646 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 When mixing vertically and horizontally split windows, a minimal size
2648 is computed and some windows may be larger if there is room. The
2649 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002650 Changing the height and width of a window can be avoided by setting
2651 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002652 If a window size is specified when creating a new window sizes are
2653 currently not equalized (it's complicated, but may be implemented in
2654 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002655
2656 *'equalprg'* *'ep'*
2657'equalprg' 'ep' string (default "")
2658 global or local to buffer |global-local|
2659 {not in Vi}
2660 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002661 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002662 or 'indentexpr'. When Vim was compiled without internal formatting,
2663 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002664 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 about including spaces and backslashes.
2666 This option cannot be set from a |modeline| or in the |sandbox|, for
2667 security reasons.
2668
2669 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2670'errorbells' 'eb' boolean (default off)
2671 global
2672 Ring the bell (beep or screen flash) for error messages. This only
2673 makes a difference for error messages, the bell will be used always
2674 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002675 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 screen flash or do nothing.
2677
2678 *'errorfile'* *'ef'*
2679'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2680 others: "errors.err")
2681 global
2682 {not in Vi}
2683 {not available when compiled without the |+quickfix|
2684 feature}
2685 Name of the errorfile for the QuickFix mode (see |:cf|).
2686 When the "-q" command-line argument is used, 'errorfile' is set to the
2687 following argument. See |-q|.
2688 NOT used for the ":make" command. See 'makeef' for that.
2689 Environment variables are expanded |:set_env|.
2690 See |option-backslash| about including spaces and backslashes.
2691 This option cannot be set from a |modeline| or in the |sandbox|, for
2692 security reasons.
2693
2694 *'errorformat'* *'efm'*
2695'errorformat' 'efm' string (default is very long)
2696 global or local to buffer |global-local|
2697 {not in Vi}
2698 {not available when compiled without the |+quickfix|
2699 feature}
2700 Scanf-like description of the format for the lines in the error file
2701 (see |errorformat|).
2702
2703 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2704'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2705 global
2706 {not in Vi}
2707 Function keys that start with an <Esc> are recognized in Insert
2708 mode. When this option is off, the cursor and function keys cannot be
2709 used in Insert mode if they start with an <Esc>. The advantage of
2710 this is that the single <Esc> is recognized immediately, instead of
2711 after one second. Instead of resetting this option, you might want to
2712 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2713 when 'esckeys' is off, you can still map anything, but the cursor keys
2714 won't work by default.
2715 NOTE: This option is set to the Vi default value when 'compatible' is
2716 set and to the Vim default value when 'compatible' is reset.
2717
2718 *'eventignore'* *'ei'*
2719'eventignore' 'ei' string (default "")
2720 global
2721 {not in Vi}
2722 {not available when compiled without the |+autocmd|
2723 feature}
2724 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002725 When set to "all" or when "all" is one of the items, all autocommand
2726 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 Otherwise this is a comma separated list of event names. Example: >
2728 :set ei=WinEnter,WinLeave
2729<
2730 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2731'expandtab' 'et' boolean (default off)
2732 local to buffer
2733 {not in Vi}
2734 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002735 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2737 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2738 NOTE: This option is reset when 'compatible' is set.
2739
2740 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2741'exrc' 'ex' boolean (default off)
2742 global
2743 {not in Vi}
2744 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2745 directory. If you switch this option on you should also consider
2746 setting the 'secure' option (see |initialization|). Using a local
2747 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2748 also see |.vimrc| and |gui-init|.
2749 This option cannot be set from a |modeline| or in the |sandbox|, for
2750 security reasons.
2751
2752 *'fileencoding'* *'fenc'* *E213*
2753'fileencoding' 'fenc' string (default: "")
2754 local to buffer
2755 {only available when compiled with the |+multi_byte|
2756 feature}
2757 {not in Vi}
2758 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002759
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002761 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 When 'fileencoding' is empty, the same value as 'encoding' will be
2763 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002764 Conversion will also be done when 'encoding' and 'fileencoding' are
2765 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2766 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002768 'encoding' is "utf-8" or another Unicode encoding, conversion
2769 is most likely done in a way that the reverse conversion
2770 results in the same text. When 'encoding' is not "utf-8" some
2771 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002772
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 See 'encoding' for the possible values. Additionally, values may be
2774 specified that can be handled by the converter, see
2775 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002776
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 When reading a file 'fileencoding' will be set from 'fileencodings'.
2778 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002779 'fileencoding', use the |++enc| argument. One exception: when
2780 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002781 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002782
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2784 When the option is set, the value is converted to lowercase. Thus
2785 you can set it with uppercase values too. '_' characters are
2786 replaced with '-'. If a name is recognized from the list for
2787 'encoding', it is replaced by the standard name. For example
2788 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002789
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 When this option is set, after starting to edit a file, the 'modified'
2791 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002792
2793 Keep in mind that changing 'fenc' from a modeline happens
2794 AFTER the text has been read, thus it applies to when the file will be
2795 written. If you do set 'fenc' in a modeline, you might want to set
2796 'nomodified' to avoid not being able to ":q".
2797
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 This option can not be changed when 'modifiable' is off.
2799
2800 *'fe'*
2801 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002802 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 old short name was 'fe', which is no longer used.
2804
2805 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002806'fileencodings' 'fencs' string (default: "ucs-bom",
2807 "ucs-bom,utf-8,default,latin1" when
2808 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 global
2810 {only available when compiled with the |+multi_byte|
2811 feature}
2812 {not in Vi}
2813 This is a list of character encodings considered when starting to edit
2814 an existing file. When a file is read, Vim tries to use the first
2815 mentioned character encoding. If an error is detected, the next one
2816 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002817 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 an empty string, which means the value of 'encoding' is used.
2819 WARNING: Conversion can cause loss of information! When
2820 'encoding' is "utf-8" (or one of the other Unicode variants)
2821 conversion is most likely done in a way that the reverse
2822 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002823 "utf-8" some non-ASCII characters may be lost! You can use
2824 the |++bad| argument to specify what is done with characters
2825 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 For an empty file or a file with only ASCII characters most encodings
2827 will work and the first entry of 'fileencodings' will be used (except
2828 "ucs-bom", which requires the BOM to be present). If you prefer
2829 another encoding use an BufReadPost autocommand event to test if your
2830 preferred encoding is to be used. Example: >
2831 au BufReadPost * if search('\S', 'w') == 0 |
2832 \ set fenc=iso-2022-jp | endif
2833< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2834 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002835 When the |++enc| argument is used then the value of 'fileencodings' is
2836 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002837 Note that 'fileencodings' is not used for a new file, the global value
2838 of 'fileencoding' is used instead. You can set it with: >
2839 :setglobal fenc=iso-8859-2
2840< This means that a non-existing file may get a different encoding than
2841 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 The special value "ucs-bom" can be used to check for a Unicode BOM
2843 (Byte Order Mark) at the start of the file. It must not be preceded
2844 by "utf-8" or another Unicode encoding for this to work properly.
2845 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2846 because Vim cannot detect an error, thus the encoding is always
2847 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002848 The special value "default" can be used for the encoding from the
2849 environment. This is the default value for 'encoding'. It is useful
2850 when 'encoding' is set to "utf-8" and your environment uses a
2851 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002852 When 'encoding' is "utf-8" and a file contains an illegal byte
2853 sequence it won't be recognized as UTF-8. You can use the |8g8|
2854 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 WRONG VALUES: WHAT'S WRONG:
2856 latin1,utf-8 "latin1" will always be used
2857 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2858 file
2859 cp1250,latin1 "cp1250" will always be used
2860 If 'fileencodings' is empty, 'fileencoding' is not modified.
2861 See 'fileencoding' for the possible values.
2862 Setting this option does not have an effect until the next time a file
2863 is read.
2864
2865 *'fileformat'* *'ff'*
2866'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2867 Unix default: "unix",
2868 Macintosh default: "mac")
2869 local to buffer
2870 {not in Vi}
2871 This gives the <EOL> of the current buffer, which is used for
2872 reading/writing the buffer from/to a file:
2873 dos <CR> <NL>
2874 unix <NL>
2875 mac <CR>
2876 When "dos" is used, CTRL-Z at the end of a file is ignored.
2877 See |file-formats| and |file-read|.
2878 For the character encoding of the file see 'fileencoding'.
2879 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002880 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 This option is set automatically when starting to edit a file and
2882 'fileformats' is not empty and 'binary' is off.
2883 When this option is set, after starting to edit a file, the 'modified'
2884 option is set, because the file would be different when written.
2885 This option can not be changed when 'modifiable' is off.
2886 For backwards compatibility: When this option is set to "dos",
2887 'textmode' is set, otherwise 'textmode' is reset.
2888
2889 *'fileformats'* *'ffs'*
2890'fileformats' 'ffs' string (default:
2891 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2892 Vim Unix: "unix,dos",
2893 Vim Mac: "mac,unix,dos",
2894 Vi Cygwin: "unix,dos",
2895 Vi others: "")
2896 global
2897 {not in Vi}
2898 This gives the end-of-line (<EOL>) formats that will be tried when
2899 starting to edit a new buffer and when reading a file into an existing
2900 buffer:
2901 - When empty, the format defined with 'fileformat' will be used
2902 always. It is not set automatically.
2903 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002904 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 'fileformats' name will be used when a file is read into an existing
2906 buffer, no matter what 'fileformat' for that buffer is set to.
2907 - When more than one name is present, separated by commas, automatic
2908 <EOL> detection will be done when reading a file. When starting to
2909 edit a file, a check is done for the <EOL>:
2910 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2911 'fileformat' is set to "dos".
2912 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002915 3. If 'fileformat' has not yet been set, and if 'fileformats'
2916 includes "mac", 'fileformat' is set to "mac".
2917 This means that "mac" is only chosen when:
2918 "unix" is not present or no <NL> is found in the file, and
2919 "dos" is not present or no <CR><NL> is found in the file.
2920 Except: if "unix" was chosen, but there is a <CR> before
2921 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002922 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 4. If 'fileformat' is still not set, the first name from
2924 'fileformats' is used.
2925 When reading a file into an existing buffer, the same is done, but
2926 this happens like 'fileformat' has been set appropriately for that
2927 file only, the option is not changed.
2928 When 'binary' is set, the value of 'fileformats' is not used.
2929
Bram Moolenaar81af9252010-12-10 20:35:50 +01002930 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002931 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002932
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2934 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2935 done:
2936 - When 'fileformats' is empty, there is no automatic detection. Dos
2937 format will be used.
2938 - When 'fileformats' is set to one or more names, automatic detection
2939 is done. This is based on the first <NL> in the file: If there is a
2940 <CR> in front of it, Dos format is used, otherwise Unix format is
2941 used.
2942 Also see |file-formats|.
2943 For backwards compatibility: When this option is set to an empty
2944 string or one format (no comma is included), 'textauto' is reset,
2945 otherwise 'textauto' is set.
2946 NOTE: This option is set to the Vi default value when 'compatible' is
2947 set and to the Vim default value when 'compatible' is reset.
2948
Bram Moolenaarbf884932013-04-05 22:26:15 +02002949 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2950'fileignorecase' 'fic' boolean (default on for systems where case in file
2951 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002952 global
2953 {not in Vi}
2954 When set case is ignored when using file names and directories.
2955 See 'wildignorecase' for only ignoring case when doing completion.
2956
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 *'filetype'* *'ft'*
2958'filetype' 'ft' string (default: "")
2959 local to buffer
2960 {not in Vi}
2961 {not available when compiled without the |+autocmd|
2962 feature}
2963 When this option is set, the FileType autocommand event is triggered.
2964 All autocommands that match with the value of this option will be
2965 executed. Thus the value of 'filetype' is used in place of the file
2966 name.
2967 Otherwise this option does not always reflect the current file type.
2968 This option is normally set when the file type is detected. To enable
2969 this use the ":filetype on" command. |:filetype|
2970 Setting this option to a different value is most useful in a modeline,
2971 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002972 Example, for in an IDL file:
2973 /* vim: set filetype=idl : */ ~
2974 |FileType| |filetypes|
2975 When a dot appears in the value then this separates two filetype
2976 names. Example:
2977 /* vim: set filetype=c.doxygen : */ ~
2978 This will use the "c" filetype first, then the "doxygen" filetype.
2979 This works both for filetype plugins and for syntax files. More than
2980 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 This option is not copied to another buffer, independent of the 's' or
2982 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002983 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002984
2985 *'fillchars'* *'fcs'*
2986'fillchars' 'fcs' string (default "vert:|,fold:-")
2987 global
2988 {not in Vi}
2989 {not available when compiled without the |+windows|
2990 and |+folding| features}
2991 Characters to fill the statuslines and vertical separators.
2992 It is a comma separated list of items:
2993
2994 item default Used for ~
2995 stl:c ' ' or '^' statusline of the current window
2996 stlnc:c ' ' or '-' statusline of the non-current windows
2997 vert:c '|' vertical separators |:vsplit|
2998 fold:c '-' filling 'foldtext'
2999 diff:c '-' deleted lines of the 'diff' option
3000
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003001 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 "stlnc" the space will be used when there is highlighting, '^' or '-'
3003 otherwise.
3004
3005 Example: >
3006 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3007< This is similar to the default, except that these characters will also
3008 be used when there is highlighting.
3009
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003010 for "stl" and "stlnc" only single-byte values are supported.
3011
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 The highlighting used for these items:
3013 item highlight group ~
3014 stl:c StatusLine |hl-StatusLine|
3015 stlnc:c StatusLineNC |hl-StatusLineNC|
3016 vert:c VertSplit |hl-VertSplit|
3017 fold:c Folded |hl-Folded|
3018 diff:c DiffDelete |hl-DiffDelete|
3019
3020 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3021'fkmap' 'fk' boolean (default off) *E198*
3022 global
3023 {not in Vi}
3024 {only available when compiled with the |+rightleft|
3025 feature}
3026 When on, the keyboard is mapped for the Farsi character set.
3027 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003028 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029
3030 *'foldclose'* *'fcl'*
3031'foldclose' 'fcl' string (default "")
3032 global
3033 {not in Vi}
3034 {not available when compiled without the |+folding|
3035 feature}
3036 When set to "all", a fold is closed when the cursor isn't in it and
3037 its level is higher than 'foldlevel'. Useful if you want folds to
3038 automatically close when moving out of them.
3039
3040 *'foldcolumn'* *'fdc'*
3041'foldcolumn' 'fdc' number (default 0)
3042 local to window
3043 {not in Vi}
3044 {not available when compiled without the |+folding|
3045 feature}
3046 When non-zero, a column with the specified width is shown at the side
3047 of the window which indicates open and closed folds. The maximum
3048 value is 12.
3049 See |folding|.
3050
3051 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3052'foldenable' 'fen' boolean (default on)
3053 local to window
3054 {not in Vi}
3055 {not available when compiled without the |+folding|
3056 feature}
3057 When off, all folds are open. This option can be used to quickly
3058 switch between showing all text unfolded and viewing the text with
3059 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003060 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 'foldenable' is off.
3062 This option is set by commands that create a new fold or close a fold.
3063 See |folding|.
3064
3065 *'foldexpr'* *'fde'*
3066'foldexpr' 'fde' string (default: "0")
3067 local to window
3068 {not in Vi}
3069 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003070 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003072 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003073
Bram Moolenaar30b65812012-07-12 22:01:11 +02003074 The expression will be evaluated in the |sandbox| if set from a
3075 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003076 This option can't be set from a |modeline| when the 'diff' option is
3077 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003078
3079 It is not allowed to change text or jump to another window while
3080 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081
3082 *'foldignore'* *'fdi'*
3083'foldignore' 'fdi' string (default: "#")
3084 local to window
3085 {not in Vi}
3086 {not available when compiled without the |+folding|
3087 feature}
3088 Used only when 'foldmethod' is "indent". Lines starting with
3089 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003090 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 The default "#" works well for C programs. See |fold-indent|.
3092
3093 *'foldlevel'* *'fdl'*
3094'foldlevel' 'fdl' number (default: 0)
3095 local to window
3096 {not in Vi}
3097 {not available when compiled without the |+folding|
3098 feature}
3099 Sets the fold level: Folds with a higher level will be closed.
3100 Setting this option to zero will close all folds. Higher numbers will
3101 close fewer folds.
3102 This option is set by commands like |zm|, |zM| and |zR|.
3103 See |fold-foldlevel|.
3104
3105 *'foldlevelstart'* *'fdls'*
3106'foldlevelstart' 'fdls' number (default: -1)
3107 global
3108 {not in Vi}
3109 {not available when compiled without the |+folding|
3110 feature}
3111 Sets 'foldlevel' when starting to edit another buffer in a window.
3112 Useful to always start editing with all folds closed (value zero),
3113 some folds closed (one) or no folds closed (99).
3114 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003115 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 ignores this option and closes all folds.
3117 It is also done before BufReadPre autocommands, to allow an autocmd to
3118 overrule the 'foldlevel' value for specific files.
3119 When the value is negative, it is not used.
3120
3121 *'foldmarker'* *'fmr'* *E536*
3122'foldmarker' 'fmr' string (default: "{{{,}}}")
3123 local to window
3124 {not in Vi}
3125 {not available when compiled without the |+folding|
3126 feature}
3127 The start and end marker used when 'foldmethod' is "marker". There
3128 must be one comma, which separates the start and end marker. The
3129 marker is a literal string (a regular expression would be too slow).
3130 See |fold-marker|.
3131
3132 *'foldmethod'* *'fdm'*
3133'foldmethod' 'fdm' string (default: "manual")
3134 local to window
3135 {not in Vi}
3136 {not available when compiled without the |+folding|
3137 feature}
3138 The kind of folding used for the current window. Possible values:
3139 |fold-manual| manual Folds are created manually.
3140 |fold-indent| indent Lines with equal indent form a fold.
3141 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3142 |fold-marker| marker Markers are used to specify folds.
3143 |fold-syntax| syntax Syntax highlighting items specify folds.
3144 |fold-diff| diff Fold text that is not changed.
3145
3146 *'foldminlines'* *'fml'*
3147'foldminlines' 'fml' number (default: 1)
3148 local to window
3149 {not in Vi}
3150 {not available when compiled without the |+folding|
3151 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003152 Sets the number of screen lines above which a fold can be displayed
3153 closed. Also for manually closed folds. With the default value of
3154 one a fold can only be closed if it takes up two or more screen lines.
3155 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003156 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 "zc" to close a fold, which is displayed open because it's smaller
3158 than 'foldminlines', a following "zc" may close a containing fold.
3159
3160 *'foldnestmax'* *'fdn'*
3161'foldnestmax' 'fdn' number (default: 20)
3162 local to window
3163 {not in Vi}
3164 {not available when compiled without the |+folding|
3165 feature}
3166 Sets the maximum nesting of folds for the "indent" and "syntax"
3167 methods. This avoids that too many folds will be created. Using more
3168 than 20 doesn't work, because the internal limit is 20.
3169
3170 *'foldopen'* *'fdo'*
3171'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3172 search,tag,undo")
3173 global
3174 {not in Vi}
3175 {not available when compiled without the |+folding|
3176 feature}
3177 Specifies for which type of commands folds will be opened, if the
3178 command moves the cursor into a closed fold. It is a comma separated
3179 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003180 NOTE: When the command is part of a mapping this option is not used.
3181 Add the |zv| command to the mapping to get the same effect.
3182 (rationale: the mapping may want to control opening folds itself)
3183
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 item commands ~
3185 all any
3186 block "(", "{", "[[", "[{", etc.
3187 hor horizontal movements: "l", "w", "fx", etc.
3188 insert any command in Insert mode
3189 jump far jumps: "G", "gg", etc.
3190 mark jumping to a mark: "'m", CTRL-O, etc.
3191 percent "%"
3192 quickfix ":cn", ":crew", ":make", etc.
3193 search search for a pattern: "/", "n", "*", "gd", etc.
3194 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003195 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 tag jumping to a tag: ":ta", CTRL-T, etc.
3197 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198 When a movement command is used for an operator (e.g., "dl" or "y%")
3199 this option is not used. This means the operator will include the
3200 whole closed fold.
3201 Note that vertical movements are not here, because it would make it
3202 very difficult to move onto a closed fold.
3203 In insert mode the folds containing the cursor will always be open
3204 when text is inserted.
3205 To close folds you can re-apply 'foldlevel' with the |zx| command or
3206 set the 'foldclose' option to "all".
3207
3208 *'foldtext'* *'fdt'*
3209'foldtext' 'fdt' string (default: "foldtext()")
3210 local to window
3211 {not in Vi}
3212 {not available when compiled without the |+folding|
3213 feature}
3214 An expression which is used to specify the text displayed for a closed
3215 fold. See |fold-foldtext|.
3216
Bram Moolenaar30b65812012-07-12 22:01:11 +02003217 The expression will be evaluated in the |sandbox| if set from a
3218 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003219
3220 It is not allowed to change text or jump to another window while
3221 evaluating 'foldtext' |textlock|.
3222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 *'formatoptions'* *'fo'*
3224'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3225 local to buffer
3226 {not in Vi}
3227 This is a sequence of letters which describes how automatic
3228 formatting is to be done. See |fo-table|. When the 'paste' option is
3229 on, no formatting is done (like 'formatoptions' is empty). Commas can
3230 be inserted for readability.
3231 To avoid problems with flags that are added in the future, use the
3232 "+=" and "-=" feature of ":set" |add-option-flags|.
3233 NOTE: This option is set to the Vi default value when 'compatible' is
3234 set and to the Vim default value when 'compatible' is reset.
3235
Bram Moolenaar86b68352004-12-27 21:59:20 +00003236 *'formatlistpat'* *'flp'*
3237'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3238 local to buffer
3239 {not in Vi}
3240 A pattern that is used to recognize a list header. This is used for
3241 the "n" flag in 'formatoptions'.
3242 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003243 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003244 while still checking more characters. There must be a character
3245 following the pattern, when it matches the whole line it is handled
3246 like there is no match.
3247 The default recognizes a number, followed by an optional punctuation
3248 character and white space.
3249
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 *'formatprg'* *'fp'*
3251'formatprg' 'fp' string (default "")
3252 global
3253 {not in Vi}
3254 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003255 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003257 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003258 If the 'formatexpr' option is not empty it will be used instead.
3259 Otherwise, if 'formatprg' option is an empty string, the internal
3260 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003261 Environment variables are expanded |:set_env|. See |option-backslash|
3262 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003263 This option cannot be set from a |modeline| or in the |sandbox|, for
3264 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003266 *'formatexpr'* *'fex'*
3267'formatexpr' 'fex' string (default "")
3268 local to buffer
3269 {not in Vi}
3270 {not available when compiled without the |+eval|
3271 feature}
3272 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003273 operator or automatic formatting (see 'formatoptions'). When this
3274 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003275
3276 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003277 The |v:count| variable holds the number of lines to be formatted.
3278 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003279 inserted if the expression is being evaluated due to
3280 automatic formatting. This can be empty. Don't insert
3281 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003282
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003283 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003284 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003285< This will invoke the mylang#Format() function in the
3286 autoload/mylang.vim file in 'runtimepath'. |autoload|
3287
3288 The expression is also evaluated when 'textwidth' is set and adding
3289 text beyond that limit. This happens under the same conditions as
3290 when internal formatting is used. Make sure the cursor is kept in the
3291 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003292 return "i" or "R" in this situation.
3293
3294 When the expression evaluates to non-zero Vim will fall back to using
3295 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003296
Bram Moolenaar30b65812012-07-12 22:01:11 +02003297 The expression will be evaluated in the |sandbox| when set from a
3298 modeline, see |sandbox-option|. That stops the option from working,
3299 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003300
3301 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003302'fsync' 'fs' boolean (default on)
3303 global
3304 {not in Vi}
3305 When on, the library function fsync() will be called after writing a
3306 file. This will flush a file to disk, ensuring that it is safely
3307 written even on filesystems which do metadata-only journaling. This
3308 will force the harddrive to spin up on Linux systems running in laptop
3309 mode, so it may be undesirable in some situations. Be warned that
3310 turning this off increases the chances of data loss after a crash. On
3311 systems without an fsync() implementation, this variable is always
3312 off.
3313 Also see 'swapsync' for controlling fsync() on swap files.
3314
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3316'gdefault' 'gd' boolean (default off)
3317 global
3318 {not in Vi}
3319 When on, the ":substitute" flag 'g' is default on. This means that
3320 all matches in a line are substituted instead of one. When a 'g' flag
3321 is given to a ":substitute" command, this will toggle the substitution
3322 of all or one match. See |complex-change|.
3323
3324 command 'gdefault' on 'gdefault' off ~
3325 :s/// subst. all subst. one
3326 :s///g subst. one subst. all
3327 :s///gg subst. all subst. one
3328
3329 NOTE: This option is reset when 'compatible' is set.
3330
3331 *'grepformat'* *'gfm'*
3332'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3333 global
3334 {not in Vi}
3335 Format to recognize for the ":grep" command output.
3336 This is a scanf-like string that uses the same format as the
3337 'errorformat' option: see |errorformat|.
3338
3339 *'grepprg'* *'gp'*
3340'grepprg' 'gp' string (default "grep -n ",
3341 Unix: "grep -n $* /dev/null",
3342 Win32: "findstr /n" or "grep -n",
3343 VMS: "SEARCH/NUMBERS ")
3344 global or local to buffer |global-local|
3345 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003346 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003347 and '#' characters, which are expanded like when used in a command-
3348 line. The placeholder "$*" is allowed to specify where the arguments
3349 will be included. Environment variables are expanded |:set_env|. See
3350 |option-backslash| about including spaces and backslashes.
3351 When your "grep" accepts the "-H" argument, use this to make ":grep"
3352 also work well with a single file: >
3353 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003354< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003355 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3356 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003357 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 apply equally to 'grepprg'.
3359 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3360 otherwise it's "grep -n".
3361 This option cannot be set from a |modeline| or in the |sandbox|, for
3362 security reasons.
3363
3364 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3365'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3366 ve:ver35-Cursor,
3367 o:hor50-Cursor,
3368 i-ci:ver25-Cursor/lCursor,
3369 r-cr:hor20-Cursor/lCursor,
3370 sm:block-Cursor
3371 -blinkwait175-blinkoff150-blinkon175",
3372 for MS-DOS and Win32 console:
3373 "n-v-c:block,o:hor50,i-ci:hor15,
3374 r-cr:hor30,sm:block")
3375 global
3376 {not in Vi}
3377 {only available when compiled with GUI enabled, and
3378 for MS-DOS and Win32 console}
3379 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003380 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 the height of the cursor can be changed. This can be done by
3382 specifying a block cursor, or a percentage for a vertical or
3383 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003384 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003386 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 mode-list and an argument-list:
3388 mode-list:argument-list,mode-list:argument-list,..
3389 The mode-list is a dash separated list of these modes:
3390 n Normal mode
3391 v Visual mode
3392 ve Visual mode with 'selection' "exclusive" (same as 'v',
3393 if not specified)
3394 o Operator-pending mode
3395 i Insert mode
3396 r Replace mode
3397 c Command-line Normal (append) mode
3398 ci Command-line Insert mode
3399 cr Command-line Replace mode
3400 sm showmatch in Insert mode
3401 a all modes
3402 The argument-list is a dash separated list of these arguments:
3403 hor{N} horizontal bar, {N} percent of the character height
3404 ver{N} vertical bar, {N} percent of the character width
3405 block block cursor, fills the whole character
3406 [only one of the above three should be present]
3407 blinkwait{N} *cursor-blinking*
3408 blinkon{N}
3409 blinkoff{N}
3410 blink times for cursor: blinkwait is the delay before
3411 the cursor starts blinking, blinkon is the time that
3412 the cursor is shown and blinkoff is the time that the
3413 cursor is not shown. The times are in msec. When one
3414 of the numbers is zero, there is no blinking. The
3415 default is: "blinkwait700-blinkon400-blinkoff250".
3416 These numbers are used for a missing entry. This
3417 means that blinking is enabled by default. To switch
3418 blinking off you can use "blinkon0". The cursor only
3419 blinks when Vim is waiting for input, not while
3420 executing a command.
3421 To make the cursor blink in an xterm, see
3422 |xterm-blink|.
3423 {group-name}
3424 a highlight group name, that sets the color and font
3425 for the cursor
3426 {group-name}/{group-name}
3427 Two highlight group names, the first is used when
3428 no language mappings are used, the other when they
3429 are. |language-mapping|
3430
3431 Examples of parts:
3432 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3433 block cursor with colors from the "nCursor"
3434 highlight group
3435 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3436 In Insert and Command-line Insert mode, use a
3437 30% vertical bar cursor with colors from the
3438 "iCursor" highlight group. Blink a bit
3439 faster.
3440
3441 The 'a' mode is different. It will set the given argument-list for
3442 all modes. It does not reset anything to defaults. This can be used
3443 to do a common setting for all modes. For example, to switch off
3444 blinking: "a:blinkon0"
3445
3446 Examples of cursor highlighting: >
3447 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3448 :highlight Cursor gui=NONE guifg=bg guibg=fg
3449<
3450 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003451 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452'guifont' 'gfn' string (default "")
3453 global
3454 {not in Vi}
3455 {only available when compiled with GUI enabled}
3456 This is a list of fonts which will be used for the GUI version of Vim.
3457 In its simplest form the value is just one font name. When
3458 the font cannot be found you will get an error message. To try other
3459 font names a list can be specified, font names separated with commas.
3460 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003461
Bram Moolenaar05159a02005-02-26 23:04:13 +00003462 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3463 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003464
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 Spaces after a comma are ignored. To include a comma in a font name
3466 precede it with a backslash. Setting an option requires an extra
3467 backslash before a space and a backslash. See also
3468 |option-backslash|. For example: >
3469 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003470< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003472
3473 If none of the fonts can be loaded, Vim will keep the current setting.
3474 If an empty font list is given, Vim will try using other resource
3475 settings (for X, it will use the Vim.font resource), and finally it
3476 will try some builtin default which should always be there ("7x13" in
3477 the case of X). The font names given should be "normal" fonts. Vim
3478 will try to find the related bold and italic fonts.
3479
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003480 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003481 :set guifont=*
3482< will bring up a font requester, where you can pick the font you want.
3483
3484 The font name depends on the GUI used. See |setting-guifont| for a
3485 way to set 'guifont' for various systems.
3486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 For the GTK+ 2 GUI the font name looks like this: >
3488 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003489< That's all. XLFDs are not used. For Chinese this is reported to work
3490 well: >
3491 if has("gui_gtk2")
3492 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3493 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3494 endif
3495<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003496 For Mac OSX you can use something like this: >
3497 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003498< Also see 'macatsui', it can help fix display problems.
3499 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003501 width). An exception is GTK 2: all fonts are accepted, but
3502 mono-spaced fonts look best.
3503
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 To preview a font on X11, you might be able to use the "xfontsel"
3505 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003506
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 For the Win32 GUI *E244* *E245*
3508 - takes these options in the font name:
3509 hXX - height is XX (points, can be floating-point)
3510 wXX - width is XX (points, can be floating-point)
3511 b - bold
3512 i - italic
3513 u - underline
3514 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003515 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3517 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3518 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003519 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520
3521 Use a ':' to separate the options.
3522 - A '_' can be used in the place of a space, so you don't need to use
3523 backslashes to escape the spaces.
3524 - Examples: >
3525 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3526 :set guifont=Andale_Mono:h7.5:w4.5
3527< See also |font-sizes|.
3528
3529 *'guifontset'* *'gfs'*
3530 *E250* *E252* *E234* *E597* *E598*
3531'guifontset' 'gfs' string (default "")
3532 global
3533 {not in Vi}
3534 {only available when compiled with GUI enabled and
3535 with the |+xfontset| feature}
3536 {not available in the GTK+ 2 GUI}
3537 When not empty, specifies two (or more) fonts to be used. The first
3538 one for normal English, the second one for your special language. See
3539 |xfontset|.
3540 Setting this option also means that all font names will be handled as
3541 a fontset name. Also the ones used for the "font" argument of the
3542 |:highlight| command.
3543 The fonts must match with the current locale. If fonts for the
3544 character sets that the current locale uses are not included, setting
3545 'guifontset' will fail.
3546 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3547 the comma-separated names are alternative names, one of which will be
3548 used. In 'guifontset' the whole string is one fontset name,
3549 including the commas. It is not possible to specify alternative
3550 fontset names.
3551 This example works on many X11 systems: >
3552 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3553<
3554 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3555'guifontwide' 'gfw' string (default "")
3556 global
3557 {not in Vi}
3558 {only available when compiled with GUI enabled}
3559 When not empty, specifies a comma-separated list of fonts to be used
3560 for double-width characters. The first font that can be loaded is
3561 used.
3562 Note: The size of these fonts must be exactly twice as wide as the one
3563 specified with 'guifont' and the same height.
3564
3565 All GUI versions but GTK+ 2:
3566
3567 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3568 'guifontset' is empty or invalid.
3569 When 'guifont' is set and a valid font is found in it and
3570 'guifontwide' is empty Vim will attempt to find a matching
3571 double-width font and set 'guifontwide' to it.
3572
3573 GTK+ 2 GUI only: *guifontwide_gtk2*
3574
3575 If set and valid, 'guifontwide' is always used for double width
3576 characters, even if 'encoding' is not set to "utf-8".
3577 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003578 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 font for characters not available in 'guifont'. Thus you do not need
3580 to set 'guifontwide' at all unless you want to override the choice
3581 made by Pango/Xft.
3582
Bram Moolenaar0f272122013-01-23 18:37:40 +01003583 Windows +multibyte only: *guifontwide_win_mbyte*
3584
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003585 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003586
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 *'guiheadroom'* *'ghr'*
3588'guiheadroom' 'ghr' number (default 50)
3589 global
3590 {not in Vi} {only for GTK and X11 GUI}
3591 The number of pixels subtracted from the screen height when fitting
3592 the GUI window on the screen. Set this before the GUI is started,
3593 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003594 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 lines will be left for window decorations and other items on the
3596 screen. Set it to a negative value to allow windows taller than the
3597 screen.
3598
3599 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003600'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3601 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 global
3603 {not in Vi}
3604 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003605 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 sequence of letters which describes what components and options of the
3607 GUI should be used.
3608 To avoid problems with flags that are added in the future, use the
3609 "+=" and "-=" feature of ":set" |add-option-flags|.
3610
3611 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003612 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 'a' Autoselect: If present, then whenever VISUAL mode is started,
3614 or the Visual area extended, Vim tries to become the owner of
3615 the windowing system's global selection. This means that the
3616 Visually highlighted text is available for pasting into other
3617 applications as well as into Vim itself. When the Visual mode
3618 ends, possibly due to an operation on the text, or when an
3619 application wants to paste the selection, the highlighted text
3620 is automatically yanked into the "* selection register.
3621 Thus the selection is still available for pasting into other
3622 applications after the VISUAL mode has ended.
3623 If not present, then Vim won't become the owner of the
3624 windowing system's global selection unless explicitly told to
3625 by a yank or delete operation for the "* register.
3626 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003627 *'go-P'*
3628 'P' Like autoselect but using the "+ register instead of the "*
3629 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003630 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003631 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 applies to the modeless selection.
3633
3634 'guioptions' autoselect Visual autoselect modeless ~
3635 "" - -
3636 "a" yes yes
3637 "A" - yes
3638 "aA" yes yes
3639
Bram Moolenaar02467872007-05-06 13:22:01 +00003640 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 'c' Use console dialogs instead of popup dialogs for simple
3642 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003643 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003644 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003645 'guitablabel' can be used to change the text in the labels.
3646 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003647 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003648 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003649 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 'f' Foreground: Don't use fork() to detach the GUI from the shell
3651 where it was started. Use this for programs that wait for the
3652 editor to finish (e.g., an e-mail program). Alternatively you
3653 can use "gvim -f" or ":gui -f" to start the GUI in the
3654 foreground. |gui-fork|
3655 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003656 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003657 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3659 corner of the window. It's black&white on non-GTK, because of
3660 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003661 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003663 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003664 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003666 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 file is sourced the system menu has already been loaded; the
3668 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003669 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 'g' Grey menu items: Make menu items that are not active grey. If
3671 'g' is not included inactive menu items are not shown at all.
3672 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003673 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 't' Include tearoff menu items. Currently only works for Win32,
3675 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003676 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003677 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003678 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003679 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003681 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 'R' Right-hand scrollbar is present when there is a vertically
3683 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003684 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003686 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 'L' Left-hand scrollbar is present when there is a vertically
3688 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003689 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3691 the longest visible line, or on the cursor line if the 'h'
3692 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003693 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 'h' Limit horizontal scrollbar size to the length of the cursor
3695 line. Reduces computations. |gui-horiz-scroll|
3696
3697 And yes, you may even have scrollbars on the left AND the right if
3698 you really want to :-). See |gui-scrollbars| for more information.
3699
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003700 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 'v' Use a vertical button layout for dialogs. When not included,
3702 a horizontal layout is preferred, but when it doesn't fit a
3703 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003704 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 'p' Use Pointer callbacks for X11 GUI. This is required for some
3706 window managers. If the cursor is not blinking or hollow at
3707 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003708 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003710 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003711 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712
Bram Moolenaar02467872007-05-06 13:22:01 +00003713
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 *'guipty'* *'noguipty'*
3715'guipty' boolean (default on)
3716 global
3717 {not in Vi}
3718 {only available when compiled with GUI enabled}
3719 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3720 I/O to/from shell commands. See |gui-pty|.
3721
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003722 *'guitablabel'* *'gtl'*
3723'guitablabel' 'gtl' string (default empty)
3724 global
3725 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003726 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003727 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003728 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003729 pages line. When empty and when the result is empty Vim will use a
3730 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003731
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003732 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003733 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003734
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003735 Only used when the GUI tab pages line is displayed. 'e' must be
3736 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3737 used.
3738
Bram Moolenaar57657d82006-04-21 22:12:41 +00003739 *'guitabtooltip'* *'gtt'*
3740'guitabtooltip' 'gtt' string (default empty)
3741 global
3742 {not in Vi}
3743 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003744 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003745 When nonempty describes the text to use in a tooltip for the GUI tab
3746 pages line. When empty Vim will use a default tooltip.
3747 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003748 You can include a line break. Simplest method is to use |:let|: >
3749 :let &guitabtooltip = "line one\nline two"
3750<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003751
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 *'helpfile'* *'hf'*
3753'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3754 (others) "$VIMRUNTIME/doc/help.txt")
3755 global
3756 {not in Vi}
3757 Name of the main help file. All distributed help files should be
3758 placed together in one directory. Additionally, all "doc" directories
3759 in 'runtimepath' will be used.
3760 Environment variables are expanded |:set_env|. For example:
3761 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003762 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 spaces and backslashes.
3764 This option cannot be set from a |modeline| or in the |sandbox|, for
3765 security reasons.
3766
3767 *'helpheight'* *'hh'*
3768'helpheight' 'hh' number (default 20)
3769 global
3770 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003771 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 feature}
3773 Minimal initial height of the help window when it is opened with the
3774 ":help" command. The initial height of the help window is half of the
3775 current window, or (when the 'ea' option is on) the same as other
3776 windows. When the height is less than 'helpheight', the height is
3777 set to 'helpheight'. Set to zero to disable.
3778
3779 *'helplang'* *'hlg'*
3780'helplang' 'hlg' string (default: messages language or empty)
3781 global
3782 {only available when compiled with the |+multi_lang|
3783 feature}
3784 {not in Vi}
3785 Comma separated list of languages. Vim will use the first language
3786 for which the desired help can be found. The English help will always
3787 be used as a last resort. You can add "en" to prefer English over
3788 another language, but that will only find tags that exist in that
3789 language and not in the English help.
3790 Example: >
3791 :set helplang=de,it
3792< This will first search German, then Italian and finally English help
3793 files.
3794 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3795 try to find the tag in the current language before using this option.
3796 See |help-translated|.
3797
3798 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3799'hidden' 'hid' boolean (default off)
3800 global
3801 {not in Vi}
3802 When off a buffer is unloaded when it is |abandon|ed. When on a
3803 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3804 displayed in another window, it does not become hidden, of course.
3805 The commands that move through the buffer list sometimes make a buffer
3806 hidden although the 'hidden' option is off: When the buffer is
3807 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003808 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003809 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 This option is set for one command with ":hide {command}" |:hide|.
3811 WARNING: It's easy to forget that you have changes in hidden buffers.
3812 Think twice when using ":q!" or ":qa!".
3813
3814 *'highlight'* *'hl'*
3815'highlight' 'hl' string (default (as a single string):
3816 "8:SpecialKey,@:NonText,d:Directory,
3817 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003818 M:ModeMsg,n:LineNr,N:CursorLineNr,
3819 r:Question,s:StatusLine,S:StatusLineNC,
3820 c:VertSplit, t:Title,v:Visual,
3821 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 f:Folded,F:FoldColumn,A:DiffAdd,
3823 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003824 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003825 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003826 +:Pmenu,=:PmenuSel,
3827 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 global
3829 {not in Vi}
3830 This option can be used to set highlighting mode for various
3831 occasions. It is a comma separated list of character pairs. The
3832 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3835 |hl-NonText| @ '~' and '@' at the end of the window and
3836 characters from 'showbreak'
3837 |hl-Directory| d directories in CTRL-D listing and other special
3838 things in listings
3839 |hl-ErrorMsg| e error messages
3840 h (obsolete, ignored)
3841 |hl-IncSearch| i 'incsearch' highlighting
3842 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3843 |hl-MoreMsg| m |more-prompt|
3844 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003845 |hl-LineNr| n line number for ":number" and ":#" commands, and
3846 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003847 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3848 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 |hl-Question| r |hit-enter| prompt and yes/no questions
3850 |hl-StatusLine| s status line of current window |status-line|
3851 |hl-StatusLineNC| S status lines of not-current windows
3852 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3853 |hl-VertSplit| c column used to separate vertically split windows
3854 |hl-Visual| v Visual mode
3855 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3856 Selection" Only X11 Gui's |gui-x11| and
3857 |xterm-clipboard|.
3858 |hl-WarningMsg| w warning messages
3859 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3860 |hl-Folded| f line used for closed folds
3861 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003862 |hl-DiffAdd| A added line in diff mode
3863 |hl-DiffChange| C changed line in diff mode
3864 |hl-DiffDelete| D deleted line in diff mode
3865 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003867 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003868 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003869 |hl-SpellRare| R rare word |spell|
3870 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003871 |hl-Conceal| - the placeholders used for concealed characters
3872 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003873 |hl-Pmenu| + popup menu normal line
3874 |hl-PmenuSel| = popup menu normal line
3875 |hl-PmenuSbar| x popup menu scrollbar
3876 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877
3878 The display modes are:
3879 r reverse (termcap entry "mr" and "me")
3880 i italic (termcap entry "ZH" and "ZR")
3881 b bold (termcap entry "md" and "me")
3882 s standout (termcap entry "so" and "se")
3883 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003884 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 n no highlighting
3886 - no highlighting
3887 : use a highlight group
3888 The default is used for occasions that are not included.
3889 If you want to change what the display modes do, see |dos-colors|
3890 for an example.
3891 When using the ':' display mode, this must be followed by the name of
3892 a highlight group. A highlight group can be used to define any type
3893 of highlighting, including using color. See |:highlight| on how to
3894 define one. The default uses a different group for each occasion.
3895 See |highlight-default| for the default highlight groups.
3896
3897 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3898'hlsearch' 'hls' boolean (default off)
3899 global
3900 {not in Vi}
3901 {not available when compiled without the
3902 |+extra_search| feature}
3903 When there is a previous search pattern, highlight all its matches.
3904 The type of highlighting used can be set with the 'l' occasion in the
3905 'highlight' option. This uses the "Search" highlight group by
3906 default. Note that only the matching text is highlighted, any offsets
3907 are not applied.
3908 See also: 'incsearch' and |:match|.
3909 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003910 off with |:nohlsearch|. This does not change the option value, as
3911 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003912 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 When the search pattern can match an end-of-line, Vim will try to
3914 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003917 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003918 You can specify whether the highlight status is restored on startup
3919 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 NOTE: This option is reset when 'compatible' is set.
3921
3922 *'history'* *'hi'*
3923'history' 'hi' number (Vim default: 20, Vi default: 0)
3924 global
3925 {not in Vi}
3926 A history of ":" commands, and a history of previous search patterns
3927 are remembered. This option decides how many entries may be stored in
3928 each of these histories (see |cmdline-editing|).
3929 NOTE: This option is set to the Vi default value when 'compatible' is
3930 set and to the Vim default value when 'compatible' is reset.
3931
3932 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3933'hkmap' 'hk' boolean (default off)
3934 global
3935 {not in Vi}
3936 {only available when compiled with the |+rightleft|
3937 feature}
3938 When on, the keyboard is mapped for the Hebrew character set.
3939 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3940 toggle this option. See |rileft.txt|.
3941 NOTE: This option is reset when 'compatible' is set.
3942
3943 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3944'hkmapp' 'hkp' boolean (default off)
3945 global
3946 {not in Vi}
3947 {only available when compiled with the |+rightleft|
3948 feature}
3949 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3950 This is useful if you have a non-Hebrew keyboard.
3951 See |rileft.txt|.
3952 NOTE: This option is reset when 'compatible' is set.
3953
3954 *'icon'* *'noicon'*
3955'icon' boolean (default off, on when title can be restored)
3956 global
3957 {not in Vi}
3958 {not available when compiled without the |+title|
3959 feature}
3960 When on, the icon text of the window will be set to the value of
3961 'iconstring' (if it is not empty), or to the name of the file
3962 currently being edited. Only the last part of the name is used.
3963 Overridden by the 'iconstring' option.
3964 Only works if the terminal supports setting window icons (currently
3965 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3966 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3967 builtin termcap).
3968 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003969 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 X11.
3971
3972 *'iconstring'*
3973'iconstring' string (default "")
3974 global
3975 {not in Vi}
3976 {not available when compiled without the |+title|
3977 feature}
3978 When this option is not empty, it will be used for the icon text of
3979 the window. This happens only when the 'icon' option is on.
3980 Only works if the terminal supports setting window icon text
3981 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3982 Does not work for MS Windows.
3983 When Vim was compiled with HAVE_X11 defined, the original icon will be
3984 restored if possible |X11|.
3985 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003986 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 'titlestring' for example settings.
3988 {not available when compiled without the |+statusline| feature}
3989
3990 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3991'ignorecase' 'ic' boolean (default off)
3992 global
3993 Ignore case in search patterns. Also used when searching in the tags
3994 file.
3995 Also see 'smartcase'.
3996 Can be overruled by using "\c" or "\C" in the pattern, see
3997 |/ignorecase|.
3998
Bram Moolenaarabab85a2013-06-26 19:18:05 +02003999 *'imactivatefunc'* *'imaf'*
4000'imactivatefunc' 'imaf' string (default "")
4001 global
4002 {not in Vi}
4003 {only available when compiled with |+xim| and
4004 |+GUI_GTK|}
4005 This option specifies a function that will be called to
4006 activate/inactivate Input Method.
4007
4008 Example: >
4009 function ImActivateFunc(active)
4010 if a:active
4011 ... do something
4012 else
4013 ... do something
4014 endif
4015 " return value is not used
4016 endfunction
4017 set imactivatefunc=ImActivateFunc
4018<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 *'imactivatekey'* *'imak'*
4020'imactivatekey' 'imak' string (default "")
4021 global
4022 {not in Vi}
4023 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004024 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 Specifies the key that your Input Method in X-Windows uses for
4026 activation. When this is specified correctly, vim can fully control
4027 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4028 You can't use this option to change the activation key, the option
4029 tells Vim what the key is.
4030 Format:
4031 [MODIFIER_FLAG-]KEY_STRING
4032
4033 These characters can be used for MODIFIER_FLAG (case is ignored):
4034 S Shift key
4035 L Lock key
4036 C Control key
4037 1 Mod1 key
4038 2 Mod2 key
4039 3 Mod3 key
4040 4 Mod4 key
4041 5 Mod5 key
4042 Combinations are allowed, for example "S-C-space" or "SC-space" are
4043 both shift+ctrl+space.
4044 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4045
4046 Example: >
4047 :set imactivatekey=S-space
4048< "S-space" means shift+space. This is the activation key for kinput2 +
4049 canna (Japanese), and ami (Korean).
4050
4051 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4052'imcmdline' 'imc' boolean (default off)
4053 global
4054 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004055 {only available when compiled with the |+xim|,
4056 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 When set the Input Method is always on when starting to edit a command
4058 line, unless entering a search pattern (see 'imsearch' for that).
4059 Setting this option is useful when your input method allows entering
4060 English characters directly, e.g., when it's used to type accented
4061 characters with dead keys.
4062
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004063 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4065 global
4066 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004067 {only available when compiled with the |+xim|,
4068 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 When set the Input Method is never used. This is useful to disable
4070 the IM when it doesn't work properly.
4071 Currently this option is on by default for SGI/IRIX machines. This
4072 may change in later releases.
4073
4074 *'iminsert'* *'imi'*
4075'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4076 local to buffer
4077 {not in Vi}
4078 Specifies whether :lmap or an Input Method (IM) is to be used in
4079 Insert mode. Valid values:
4080 0 :lmap is off and IM is off
4081 1 :lmap is ON and IM is off
4082 2 :lmap is off and IM is ON
4083 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4084 or |global-ime|.
4085 To always reset the option to zero when leaving Insert mode with <Esc>
4086 this can be used: >
4087 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4088< This makes :lmap and IM turn off automatically when leaving Insert
4089 mode.
4090 Note that this option changes when using CTRL-^ in Insert mode
4091 |i_CTRL-^|.
4092 The value is set to 1 when setting 'keymap' to a valid keymap name.
4093 It is also used for the argument of commands like "r" and "f".
4094 The value 0 may not work correctly with Athena and Motif with some XIM
4095 methods. Use 'imdisable' to disable XIM then.
4096
4097 *'imsearch'* *'ims'*
4098'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4099 local to buffer
4100 {not in Vi}
4101 Specifies whether :lmap or an Input Method (IM) is to be used when
4102 entering a search pattern. Valid values:
4103 -1 the value of 'iminsert' is used, makes it look like
4104 'iminsert' is also used when typing a search pattern
4105 0 :lmap is off and IM is off
4106 1 :lmap is ON and IM is off
4107 2 :lmap is off and IM is ON
4108 Note that this option changes when using CTRL-^ in Command-line mode
4109 |c_CTRL-^|.
4110 The value is set to 1 when it is not -1 and setting the 'keymap'
4111 option to a valid keymap name.
4112 The value 0 may not work correctly with Athena and Motif with some XIM
4113 methods. Use 'imdisable' to disable XIM then.
4114
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004115 *'imstatusfunc'* *'imsf'*
4116'imstatusfunc' 'imsf' string (default "")
4117 global
4118 {not in Vi}
4119 {only available when compiled with |+xim| and
4120 |+GUI_GTK|}
4121 This option specifies a function that is called to obtain the status
4122 of Input Method. It must return a positive number when IME is active.
4123
4124 Example: >
4125 function ImStatusFunc()
4126 let is_active = ...do something
4127 return is_active ? 1 : 0
4128 endfunction
4129 set imstatusfunc=ImStatusFunc
4130<
4131 NOTE: This function is invoked very often. Keep it fast.
4132
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 *'include'* *'inc'*
4134'include' 'inc' string (default "^\s*#\s*include")
4135 global or local to buffer |global-local|
4136 {not in Vi}
4137 {not available when compiled without the
4138 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004139 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 pattern, just like for the "/" command (See |pattern|). The default
4141 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004142 "]I", "[d", etc.
4143 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004144 comes after the matched pattern. But if "\zs" appears in the pattern
4145 then the text matched from "\zs" to the end, or until "\ze" if it
4146 appears, is used as the file name. Use this to include characters
4147 that are not in 'isfname', such as a space. You can then use
4148 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004149 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150
4151 *'includeexpr'* *'inex'*
4152'includeexpr' 'inex' string (default "")
4153 local to buffer
4154 {not in Vi}
4155 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004156 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004158 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 :set includeexpr=substitute(v:fname,'\\.','/','g')
4160< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004161
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004163 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 Also used for |<cfile>|.
4165
Bram Moolenaar30b65812012-07-12 22:01:11 +02004166 The expression will be evaluated in the |sandbox| when set from a
4167 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004168
4169 It is not allowed to change text or jump to another window while
4170 evaluating 'includeexpr' |textlock|.
4171
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4173'incsearch' 'is' boolean (default off)
4174 global
4175 {not in Vi}
4176 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004177 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004178 While typing a search command, show where the pattern, as it was typed
4179 so far, matches. The matched string is highlighted. If the pattern
4180 is invalid or not found, nothing is shown. The screen will be updated
4181 often, this is only useful on fast terminals.
4182 Note that the match will be shown, but the cursor will return to its
4183 original position when no match is found and when pressing <Esc>. You
4184 still need to finish the search command with <Enter> to move the
4185 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004186 When compiled with the |+reltime| feature Vim only searches for about
4187 half a second. With a complicated pattern and/or a lot of text the
4188 match may not be found. This is to avoid that Vim hangs while you
4189 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004190 The highlighting can be set with the 'i' flag in 'highlight'.
4191 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004192 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004193 to the command line. If 'ignorecase' and 'smartcase' are set and the
4194 command line has no uppercase characters, the added character is
4195 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004196 CTRL-R CTRL-W can be used to add the word at the end of the current
4197 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 NOTE: This option is reset when 'compatible' is set.
4199
4200 *'indentexpr'* *'inde'*
4201'indentexpr' 'inde' string (default "")
4202 local to buffer
4203 {not in Vi}
4204 {not available when compiled without the |+cindent|
4205 or |+eval| features}
4206 Expression which is evaluated to obtain the proper indent for a line.
4207 It is used when a new line is created, for the |=| operator and
4208 in Insert mode as specified with the 'indentkeys' option.
4209 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004210 'smartindent' indenting. When 'lisp' is set, this option is
4211 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 When 'paste' is set this option is not used for indenting.
4213 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004214 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 when the expression is evaluated (but it may be moved around).
4216 The expression must return the number of spaces worth of indent. It
4217 can return "-1" to keep the current indent (this means 'autoindent' is
4218 used for the indent).
4219 Functions useful for computing the indent are |indent()|, |cindent()|
4220 and |lispindent()|.
4221 The evaluation of the expression must not have side effects! It must
4222 not change the text, jump to another window, etc. Afterwards the
4223 cursor position is always restored, thus the cursor may be moved.
4224 Normally this option would be set to call a function: >
4225 :set indentexpr=GetMyIndent()
4226< Error messages will be suppressed, unless the 'debug' option contains
4227 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004228 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 NOTE: This option is made empty when 'compatible' is set.
4230
Bram Moolenaar30b65812012-07-12 22:01:11 +02004231 The expression will be evaluated in the |sandbox| when set from a
4232 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004233
4234 It is not allowed to change text or jump to another window while
4235 evaluating 'indentexpr' |textlock|.
4236
4237
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 *'indentkeys'* *'indk'*
4239'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4240 local to buffer
4241 {not in Vi}
4242 {not available when compiled without the |+cindent|
4243 feature}
4244 A list of keys that, when typed in Insert mode, cause reindenting of
4245 the current line. Only happens if 'indentexpr' isn't empty.
4246 The format is identical to 'cinkeys', see |indentkeys-format|.
4247 See |C-indenting| and |indent-expression|.
4248
4249 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4250'infercase' 'inf' boolean (default off)
4251 local to buffer
4252 {not in Vi}
4253 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004254 'ignorecase' is also on, the case of the match is adjusted depending
4255 on the typed text. If the typed text contains a lowercase letter
4256 where the match has an upper case letter, the completed part is made
4257 lowercase. If the typed text has no lowercase letters and the match
4258 has a lowercase letter where the typed text has an uppercase letter,
4259 and there is a letter before it, the completed part is made uppercase.
4260 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261
4262 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4263'insertmode' 'im' boolean (default off)
4264 global
4265 {not in Vi}
4266 Makes Vim work in a way that Insert mode is the default mode. Useful
4267 if you want to use Vim as a modeless editor. Used for |evim|.
4268 These Insert mode commands will be useful:
4269 - Use the cursor keys to move around.
4270 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4271 this is a mapping, it is executed as if 'insertmode' was off.
4272 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004274 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4275 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276
4277 These items change when 'insertmode' is set:
4278 - when starting to edit of a file, Vim goes to Insert mode.
4279 - <Esc> in Insert mode is a no-op and beeps.
4280 - <Esc> in Normal mode makes Vim go to Insert mode.
4281 - CTRL-L in Insert mode is a command, it is not inserted.
4282 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4283 However, when <Esc> is used inside a mapping, it behaves like
4284 'insertmode' was not set. This was done to be able to use the same
4285 mappings with 'insertmode' set or not set.
4286 When executing commands with |:normal| 'insertmode' is not used.
4287
4288 NOTE: This option is reset when 'compatible' is set.
4289
4290 *'isfname'* *'isf'*
4291'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4292 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4293 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4294 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4295 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4296 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4297 global
4298 {not in Vi}
4299 The characters specified by this option are included in file names and
4300 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004301 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Multi-byte characters 256 and above are always included, only the
4303 characters up to 255 are specified with this option.
4304 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004305 Think twice before adding white space to this option. Although a
4306 space may appear inside a file name, the effect will be that Vim
4307 doesn't know where a file name starts or ends when doing completion.
4308 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309
4310 Note that on systems using a backslash as path separator, Vim tries to
4311 do its best to make it work as you would expect. That is a bit
4312 tricky, since Vi originally used the backslash to escape special
4313 characters. Vim will not remove a backslash in front of a normal file
4314 name character on these systems, but it will on Unix and alikes. The
4315 '&' and '^' are not included by default, because these are special for
4316 cmd.exe.
4317
4318 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004319 Each part can be a single character number or a range. A range is two
4320 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 decimal number between 0 and 255 or the ASCII character itself (does
4322 not work for digits). Example:
4323 "_,-,128-140,#-43" (include '_' and '-' and the range
4324 128 to 140 and '#' to 43)
4325 If a part starts with '^', the following character number or range
4326 will be excluded from the option. The option is interpreted from left
4327 to right. Put the excluded character after the range where it is
4328 included. To include '^' itself use it as the last character of the
4329 option or the end of a range. Example:
4330 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4331 If the character is '@', all characters where isalpha() returns TRUE
4332 are included. Normally these are the characters a to z and A to Z,
4333 plus accented characters. To include '@' itself use "@-@". Examples:
4334 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004335 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 "a-z,A-Z,@-@" All letters plus the '@' character.
4337 A comma can be included by using it where a character number is
4338 expected. Example:
4339 "48-57,,,_" Digits, comma and underscore.
4340 A comma can be excluded by prepending a '^'. Example:
4341 " -~,^,,9" All characters from space to '~', excluding
4342 comma, plus <Tab>.
4343 See |option-backslash| about including spaces and backslashes.
4344
4345 *'isident'* *'isi'*
4346'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4347 "@,48-57,_,128-167,224-235"
4348 otherwise: "@,48-57,_,192-255")
4349 global
4350 {not in Vi}
4351 The characters given by this option are included in identifiers.
4352 Identifiers are used in recognizing environment variables and after a
4353 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004354 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 option.
4356 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004357 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4359
4360 *'iskeyword'* *'isk'*
4361'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4362 "@,48-57,_,128-167,224-235"
4363 otherwise: "@,48-57,_,192-255"
4364 Vi default: "@,48-57,_")
4365 local to buffer
4366 {not in Vi}
4367 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004368 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 'isfname' for a description of the format of this option. For C
4370 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4371 For a help file it is set to all non-blank printable characters except
4372 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4373 command).
4374 When the 'lisp' option is on the '-' character is always included.
4375 NOTE: This option is set to the Vi default value when 'compatible' is
4376 set and to the Vim default value when 'compatible' is reset.
4377
4378 *'isprint'* *'isp'*
4379'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4380 "@,~-255"; otherwise: "@,161-255")
4381 global
4382 {not in Vi}
4383 The characters given by this option are displayed directly on the
4384 screen. It is also used for "\p" in a |pattern|. The characters from
4385 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4386 even when they are not included in 'isprint' or excluded. See
4387 'isfname' for a description of the format of this option.
4388
4389 Non-printable characters are displayed with two characters:
4390 0 - 31 "^@" - "^_"
4391 32 - 126 always single characters
4392 127 "^?"
4393 128 - 159 "~@" - "~_"
4394 160 - 254 "| " - "|~"
4395 255 "~?"
4396 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4397 displayed as <xx>, with the hexadecimal value of the byte.
4398 When 'display' contains "uhex" all unprintable characters are
4399 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004400 The SpecialKey highlighting will be used for unprintable characters.
4401 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402
4403 Multi-byte characters 256 and above are always included, only the
4404 characters up to 255 are specified with this option. When a character
4405 is printable but it is not available in the current font, a
4406 replacement character will be shown.
4407 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4408 There is no option to specify these characters.
4409
4410 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4411'joinspaces' 'js' boolean (default on)
4412 global
4413 {not in Vi}
4414 Insert two spaces after a '.', '?' and '!' with a join command.
4415 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4416 Otherwise only one space is inserted.
4417 NOTE: This option is set when 'compatible' is set.
4418
4419 *'key'*
4420'key' string (default "")
4421 local to buffer
4422 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004423 {only available when compiled with the |+cryptv|
4424 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004426 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 Careful: Do not set the key value by hand, someone might see the typed
4428 key. Use the |:X| command. But you can make 'key' empty: >
4429 :set key=
4430< It is not possible to get the value of this option with ":set key" or
4431 "echo &key". This is to avoid showing it to someone who shouldn't
4432 know. It also means you cannot see it yourself once you have set it,
4433 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004434 You can use "&key" in an expression to detect whether encryption is
4435 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436
4437 *'keymap'* *'kmp'* *E544*
4438'keymap' 'kmp' string (default "")
4439 local to buffer
4440 {not in Vi}
4441 {only available when compiled with the |+keymap|
4442 feature}
4443 Name of a keyboard mapping. See |mbyte-keymap|.
4444 Setting this option to a valid keymap name has the side effect of
4445 setting 'iminsert' to one, so that the keymap becomes effective.
4446 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004447 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448
4449 *'keymodel'* *'km'*
4450'keymodel' 'km' string (default "")
4451 global
4452 {not in Vi}
4453 List of comma separated words, which enable special things that keys
4454 can do. These values can be used:
4455 startsel Using a shifted special key starts selection (either
4456 Select mode or Visual mode, depending on "key" being
4457 present in 'selectmode').
4458 stopsel Using a not-shifted special key stops selection.
4459 Special keys in this context are the cursor keys, <End>, <Home>,
4460 <PageUp> and <PageDown>.
4461 The 'keymodel' option is set by the |:behave| command.
4462
4463 *'keywordprg'* *'kp'*
4464'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4465 OS/2: "view /", VMS: "help")
4466 global or local to buffer |global-local|
4467 {not in Vi}
4468 Program to use for the |K| command. Environment variables are
4469 expanded |:set_env|. ":help" may be used to access the Vim internal
4470 help. (Note that previously setting the global option to the empty
4471 value did this, which is now deprecated.)
4472 When "man" is used, Vim will automatically translate a count for the
4473 "K" command to a section number. Also for "man -s", in which case the
4474 "-s" is removed when there is no count.
4475 See |option-backslash| about including spaces and backslashes.
4476 Example: >
4477 :set keywordprg=man\ -s
4478< This option cannot be set from a |modeline| or in the |sandbox|, for
4479 security reasons.
4480
4481 *'langmap'* *'lmap'* *E357* *E358*
4482'langmap' 'lmap' string (default "")
4483 global
4484 {not in Vi}
4485 {only available when compiled with the |+langmap|
4486 feature}
4487 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 inserted directly. When in command mode the 'langmap' option takes
4490 care of translating these special characters to the original meaning
4491 of the key. This means you don't have to change the keyboard mode to
4492 be able to execute Normal mode commands.
4493 This is the opposite of the 'keymap' option, where characters are
4494 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004496 Example (for Greek, in UTF-8): *greek* >
4497 :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 +00004498< Example (exchanges meaning of z and y for commands): >
4499 :set langmap=zy,yz,ZY,YZ
4500<
4501 The 'langmap' option is a list of parts, separated with commas. Each
4502 part can be in one of two forms:
4503 1. A list of pairs. Each pair is a "from" character immediately
4504 followed by the "to" character. Examples: "aA", "aAbBcC".
4505 2. A list of "from" characters, a semi-colon and a list of "to"
4506 characters. Example: "abc;ABC"
4507 Example: "aA,fgh;FGH,cCdDeE"
4508 Special characters need to be preceded with a backslash. These are
4509 ";", ',' and backslash itself.
4510
4511 This will allow you to activate vim actions without having to switch
4512 back and forth between the languages. Your language characters will
4513 be understood as normal vim English characters (according to the
4514 langmap mappings) in the following cases:
4515 o Normal/Visual mode (commands, buffer/register names, user mappings)
4516 o Insert/Replace Mode: Register names after CTRL-R
4517 o Insert/Replace Mode: Mappings
4518 Characters entered in Command-line mode will NOT be affected by
4519 this option. Note that this option can be changed at any time
4520 allowing to switch between mappings for different languages/encodings.
4521 Use a mapping to avoid having to type it each time!
4522
4523 *'langmenu'* *'lm'*
4524'langmenu' 'lm' string (default "")
4525 global
4526 {not in Vi}
4527 {only available when compiled with the |+menu| and
4528 |+multi_lang| features}
4529 Language to use for menu translation. Tells which file is loaded
4530 from the "lang" directory in 'runtimepath': >
4531 "lang/menu_" . &langmenu . ".vim"
4532< (without the spaces). For example, to always use the Dutch menus, no
4533 matter what $LANG is set to: >
4534 :set langmenu=nl_NL.ISO_8859-1
4535< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004536 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 If your $LANG is set to a non-English language but you do want to use
4538 the English menus: >
4539 :set langmenu=none
4540< This option must be set before loading menus, switching on filetype
4541 detection or syntax highlighting. Once the menus are defined setting
4542 this option has no effect. But you could do this: >
4543 :source $VIMRUNTIME/delmenu.vim
4544 :set langmenu=de_DE.ISO_8859-1
4545 :source $VIMRUNTIME/menu.vim
4546< Warning: This deletes all menus that you defined yourself!
4547
4548 *'laststatus'* *'ls'*
4549'laststatus' 'ls' number (default 1)
4550 global
4551 {not in Vi}
4552 The value of this option influences when the last window will have a
4553 status line:
4554 0: never
4555 1: only if there are at least two windows
4556 2: always
4557 The screen looks nicer with a status line if you have several
4558 windows, but it takes another screen line. |status-line|
4559
4560 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4561'lazyredraw' 'lz' boolean (default off)
4562 global
4563 {not in Vi}
4564 When this option is set, the screen will not be redrawn while
4565 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004566 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567 update use |:redraw|.
4568
4569 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4570'linebreak' 'lbr' boolean (default off)
4571 local to window
4572 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004573 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 feature}
4575 If on Vim will wrap long lines at a character in 'breakat' rather
4576 than at the last character that fits on the screen. Unlike
4577 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4578 it only affects the way the file is displayed, not its contents. The
4579 value of 'showbreak' is used to put in front of wrapped lines.
4580 This option is not used when the 'wrap' option is off or 'list' is on.
4581 Note that <Tab> characters after an <EOL> are mostly not displayed
4582 with the right amount of white space.
4583
4584 *'lines'* *E593*
4585'lines' number (default 24 or terminal height)
4586 global
4587 Number of lines of the Vim window.
4588 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004589 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 When Vim is running in the GUI or in a resizable window, setting this
4591 option will cause the window size to be changed. When you only want
4592 to use the size for the GUI, put the command in your |gvimrc| file.
4593 Vim limits the number of lines to what fits on the screen. You can
4594 use this command to get the tallest window possible: >
4595 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004596< Minimum value is 2, maximum value is 1000.
4597 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 When you set this option and Vim is unable to change the physical
4599 number of lines of the display, the display may be messed up.
4600
4601 *'linespace'* *'lsp'*
4602'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4603 global
4604 {not in Vi}
4605 {only in the GUI}
4606 Number of pixel lines inserted between characters. Useful if the font
4607 uses the full character cell height, making lines touch each other.
4608 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004609 With some fonts there can be too much room between lines (to have
4610 space for ascents and descents). Then it makes sense to set
4611 'linespace' to a negative value. This may cause display problems
4612 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613
4614 *'lisp'* *'nolisp'*
4615'lisp' boolean (default off)
4616 local to buffer
4617 {not available when compiled without the |+lispindent|
4618 feature}
4619 Lisp mode: When <Enter> is typed in insert mode set the indent for
4620 the next line to Lisp standards (well, sort of). Also happens with
4621 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4622 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4623 better. Also see 'lispwords'.
4624 The '-' character is included in keyword characters. Redefines the
4625 "=" operator to use this same indentation algorithm rather than
4626 calling an external program if 'equalprg' is empty.
4627 This option is not used when 'paste' is set.
4628 {Vi: Does it a little bit differently}
4629
4630 *'lispwords'* *'lw'*
4631'lispwords' 'lw' string (default is very long)
4632 global
4633 {not in Vi}
4634 {not available when compiled without the |+lispindent|
4635 feature}
4636 Comma separated list of words that influence the Lisp indenting.
4637 |'lisp'|
4638
4639 *'list'* *'nolist'*
4640'list' boolean (default off)
4641 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004642 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4643 line. Useful to see the difference between tabs and spaces and for
4644 trailing blanks. Further changed by the 'listchars' option.
4645
4646 The cursor is displayed at the start of the space a Tab character
4647 occupies, not at the end as usual in Normal mode. To get this cursor
4648 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004649 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004650<
4651 Note that list mode will also affect formatting (set with 'textwidth'
4652 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 changing the way tabs are displayed.
4654
4655 *'listchars'* *'lcs'*
4656'listchars' 'lcs' string (default "eol:$")
4657 global
4658 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004659 Strings to use in 'list' mode and for the |:list| command. It is a
4660 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004661 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662 eol:c Character to show at the end of each line. When
4663 omitted, there is no extra character at the end of the
4664 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004665 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004666 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004668 fill the space that the tab normally occupies.
4669 "tab:>-" will show a tab that takes four spaces as
4670 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004671 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004672 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004674 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 extends:c Character to show in the last column, when 'wrap' is
4676 off and the line continues beyond the right of the
4677 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004678 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 precedes:c Character to show in the first column, when 'wrap'
4680 is off and there is text preceding the character
4681 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004682 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004683 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004684 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004685 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004686 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004687 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004689 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004691 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692
4693 Examples: >
4694 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004695 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 :set lcs=extends:>,precedes:<
4697< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004698 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004699 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700
4701 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4702'loadplugins' 'lpl' boolean (default on)
4703 global
4704 {not in Vi}
4705 When on the plugin scripts are loaded when starting up |load-plugins|.
4706 This option can be reset in your |vimrc| file to disable the loading
4707 of plugins.
4708 Note that using the "-u NONE" and "--noplugin" command line arguments
4709 reset this option. |-u| |--noplugin|
4710
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004711 *'macatsui'* *'nomacatsui'*
4712'macatsui' boolean (default on)
4713 global
4714 {only available in Mac GUI version}
4715 This is a workaround for when drawing doesn't work properly. When set
4716 and compiled with multi-byte support ATSUI text drawing is used. When
4717 not set ATSUI text drawing is not used. Switch this option off when
4718 you experience drawing problems. In a future version the problems may
4719 be solved and this option becomes obsolete. Therefore use this method
4720 to unset it: >
4721 if exists('&macatsui')
4722 set nomacatsui
4723 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004724< Another option to check if you have drawing problems is
4725 'termencoding'.
4726
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 *'magic'* *'nomagic'*
4728'magic' boolean (default on)
4729 global
4730 Changes the special characters that can be used in search patterns.
4731 See |pattern|.
4732 NOTE: To avoid portability problems with using patterns, always keep
4733 this option at the default "on". Only switch it off when working with
4734 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004735 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736
4737 *'makeef'* *'mef'*
4738'makeef' 'mef' string (default: "")
4739 global
4740 {not in Vi}
4741 {not available when compiled without the |+quickfix|
4742 feature}
4743 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4744 and the |:grep| command.
4745 When it is empty, an internally generated temp file will be used.
4746 When "##" is included, it is replaced by a number to make the name
4747 unique. This makes sure that the ":make" command doesn't overwrite an
4748 existing file.
4749 NOT used for the ":cf" command. See 'errorfile' for that.
4750 Environment variables are expanded |:set_env|.
4751 See |option-backslash| about including spaces and backslashes.
4752 This option cannot be set from a |modeline| or in the |sandbox|, for
4753 security reasons.
4754
4755 *'makeprg'* *'mp'*
4756'makeprg' 'mp' string (default "make", VMS: "MMS")
4757 global or local to buffer |global-local|
4758 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004759 Program to use for the ":make" command. See |:make_makeprg|.
4760 This option may contain '%' and '#' characters, which are expanded to
4761 the current and alternate file name. |:_%| |:_#|
4762 Environment variables are expanded |:set_env|. See |option-backslash|
4763 about including spaces and backslashes.
4764 Note that a '|' must be escaped twice: once for ":set" and once for
4765 the interpretation of a command. When you use a filter called
4766 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 :set makeprg=gmake\ \\\|\ myfilter
4768< The placeholder "$*" can be given (even multiple times) to specify
4769 where the arguments will be included, for example: >
4770 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4771< This option cannot be set from a |modeline| or in the |sandbox|, for
4772 security reasons.
4773
4774 *'matchpairs'* *'mps'*
4775'matchpairs' 'mps' string (default "(:),{:},[:]")
4776 local to buffer
4777 {not in Vi}
4778 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004779 other.
4780 Only character pairs are allowed that are different, thus you cannot
4781 jump between two double quotes.
4782 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004783 The pairs must be separated by a comma. Example for including '<' and
4784 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 :set mps+=<:>
4786
4787< A more exotic example, to jump between the '=' and ';' in an
4788 assignment, useful for languages like C and Java: >
4789 :au FileType c,cpp,java set mps+==:;
4790
4791< For a more advanced way of using "%", see the matchit.vim plugin in
4792 the $VIMRUNTIME/macros directory. |add-local-help|
4793
4794 *'matchtime'* *'mat'*
4795'matchtime' 'mat' number (default 5)
4796 global
4797 {not in Vi}{in Nvi}
4798 Tenths of a second to show the matching paren, when 'showmatch' is
4799 set. Note that this is not in milliseconds, like other options that
4800 set a time. This is to be compatible with Nvi.
4801
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004802 *'maxcombine'* *'mco'*
4803'maxcombine' 'mco' number (default 2)
4804 global
4805 {not in Vi}
4806 {only available when compiled with the |+multi_byte|
4807 feature}
4808 The maximum number of combining characters supported for displaying.
4809 Only used when 'encoding' is "utf-8".
4810 The default is OK for most languages. Hebrew may require 4.
4811 Maximum value is 6.
4812 Even when this option is set to 2 you can still edit text with more
4813 combining characters, you just can't see them. Use |g8| or |ga|.
4814 See |mbyte-combining|.
4815
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 *'maxfuncdepth'* *'mfd'*
4817'maxfuncdepth' 'mfd' number (default 100)
4818 global
4819 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004820 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004821 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 Maximum depth of function calls for user functions. This normally
4823 catches endless recursion. When using a recursive function with
4824 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4825 more memory, there is the danger of failing when memory is exhausted.
4826 See also |:function|.
4827
4828 *'maxmapdepth'* *'mmd'* *E223*
4829'maxmapdepth' 'mmd' number (default 1000)
4830 global
4831 {not in Vi}
4832 Maximum number of times a mapping is done without resulting in a
4833 character to be used. This normally catches endless mappings, like
4834 ":map x y" with ":map y x". It still does not catch ":map g wg",
4835 because the 'w' is used before the next mapping is done. See also
4836 |key-mapping|.
4837
4838 *'maxmem'* *'mm'*
4839'maxmem' 'mm' number (default between 256 to 5120 (system
4840 dependent) or half the amount of memory
4841 available)
4842 global
4843 {not in Vi}
4844 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4845 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004846 other memory to be freed. The maximum usable value is about 2000000.
4847 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004849 *'maxmempattern'* *'mmp'*
4850'maxmempattern' 'mmp' number (default 1000)
4851 global
4852 {not in Vi}
4853 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004854 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004855 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004856 When Vim runs into the limit it gives an error message and mostly
4857 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004858 Running into the limit often means that the pattern is very
4859 inefficient or too complex. This may already happen with the pattern
4860 "\(.\)*" on a very long line. ".*" works much better.
4861 Vim may run out of memory before hitting the 'maxmempattern' limit.
4862
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 *'maxmemtot'* *'mmt'*
4864'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4865 dependent) or half the amount of memory
4866 available)
4867 global
4868 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004869 Maximum amount of memory in Kbyte to use for all buffers together.
4870 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4871 without a limit. On 64 bit machines higher values might work. But
4872 hey, do you really need more than 2 Gbyte for text editing?
4873 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874
4875 *'menuitems'* *'mis'*
4876'menuitems' 'mis' number (default 25)
4877 global
4878 {not in Vi}
4879 {not available when compiled without the |+menu|
4880 feature}
4881 Maximum number of items to use in a menu. Used for menus that are
4882 generated from a list of items, e.g., the Buffers menu. Changing this
4883 option has no direct effect, the menu must be refreshed first.
4884
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004885 *'mkspellmem'* *'msm'*
4886'mkspellmem' 'msm' string (default "460000,2000,500")
4887 global
4888 {not in Vi}
4889 {not available when compiled without the |+syntax|
4890 feature}
4891 Parameters for |:mkspell|. This tunes when to start compressing the
4892 word tree. Compression can be slow when there are many words, but
4893 it's needed to avoid running out of memory. The amount of memory used
4894 per word depends very much on how similar the words are, that's why
4895 this tuning is complicated.
4896
4897 There are three numbers, separated by commas:
4898 {start},{inc},{added}
4899
4900 For most languages the uncompressed word tree fits in memory. {start}
4901 gives the amount of memory in Kbyte that can be used before any
4902 compression is done. It should be a bit smaller than the amount of
4903 memory that is available to Vim.
4904
4905 When going over the {start} limit the {inc} number specifies the
4906 amount of memory in Kbyte that can be allocated before another
4907 compression is done. A low number means compression is done after
4908 less words are added, which is slow. A high number means more memory
4909 will be allocated.
4910
4911 After doing compression, {added} times 1024 words can be added before
4912 the {inc} limit is ignored and compression is done when any extra
4913 amount of memory is needed. A low number means there is a smaller
4914 chance of hitting the {inc} limit, less memory is used but it's
4915 slower.
4916
4917 The languages for which these numbers are important are Italian and
4918 Hungarian. The default works for when you have about 512 Mbyte. If
4919 you have 1 Gbyte you could use: >
4920 :set mkspellmem=900000,3000,800
4921< If you have less than 512 Mbyte |:mkspell| may fail for some
4922 languages, no matter what you set 'mkspellmem' to.
4923
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004925'modeline' 'ml' boolean (Vim default: on (off for root),
4926 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927 local to buffer
4928 *'modelines'* *'mls'*
4929'modelines' 'mls' number (default 5)
4930 global
4931 {not in Vi}
4932 If 'modeline' is on 'modelines' gives the number of lines that is
4933 checked for set commands. If 'modeline' is off or 'modelines' is zero
4934 no lines are checked. See |modeline|.
4935 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4936 set and to the Vim default value when 'compatible' is reset.
4937
4938 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4939'modifiable' 'ma' boolean (default on)
4940 local to buffer
4941 {not in Vi} *E21*
4942 When off the buffer contents cannot be changed. The 'fileformat' and
4943 'fileencoding' options also can't be changed.
4944 Can be reset with the |-M| command line argument.
4945
4946 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4947'modified' 'mod' boolean (default off)
4948 local to buffer
4949 {not in Vi}
4950 When on, the buffer is considered to be modified. This option is set
4951 when:
4952 1. A change was made to the text since it was last written. Using the
4953 |undo| command to go back to the original text will reset the
4954 option. But undoing changes that were made before writing the
4955 buffer will set the option again, since the text is different from
4956 when it was written.
4957 2. 'fileformat' or 'fileencoding' is different from its original
4958 value. The original value is set when the buffer is read or
4959 written. A ":set nomodified" command also resets the original
4960 values to the current values and the 'modified' option will be
4961 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004962 This option is not set when a change is made to the buffer as the
4963 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4964 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4965 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4967 will be ignored.
4968
4969 *'more'* *'nomore'*
4970'more' boolean (Vim default: on, Vi default: off)
4971 global
4972 {not in Vi}
4973 When on, listings pause when the whole screen is filled. You will get
4974 the |more-prompt|. When this option is off there are no pauses, the
4975 listing continues until finished.
4976 NOTE: This option is set to the Vi default value when 'compatible' is
4977 set and to the Vim default value when 'compatible' is reset.
4978
4979 *'mouse'* *E538*
4980'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4981 global
4982 {not in Vi}
4983 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004984 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4985 sysmouse and Linux console with gpm). For using the mouse in the
4986 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 The mouse can be enabled for different modes:
4988 n Normal mode
4989 v Visual mode
4990 i Insert mode
4991 c Command-line mode
4992 h all previous modes when editing a help file
4993 a all previous modes
4994 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 Normally you would enable the mouse in all four modes with: >
4996 :set mouse=a
4997< When the mouse is not enabled, the GUI will still use the mouse for
4998 modeless selection. This doesn't move the text cursor.
4999
5000 See |mouse-using|. Also see |'clipboard'|.
5001
5002 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005003 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 the mouse buttons can still be used by keeping the shift key pressed.
5005 Also see the 'clipboard' option.
5006
5007 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5008'mousefocus' 'mousef' boolean (default off)
5009 global
5010 {not in Vi}
5011 {only works in the GUI}
5012 The window that the mouse pointer is on is automatically activated.
5013 When changing the window layout or window focus in another way, the
5014 mouse pointer is moved to the window with keyboard focus. Off is the
5015 default because it makes using the pull down menus a little goofy, as
5016 a pointer transit may activate a window unintentionally.
5017
5018 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5019'mousehide' 'mh' boolean (default on)
5020 global
5021 {not in Vi}
5022 {only works in the GUI}
5023 When on, the mouse pointer is hidden when characters are typed.
5024 The mouse pointer is restored when the mouse is moved.
5025
5026 *'mousemodel'* *'mousem'*
5027'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5028 global
5029 {not in Vi}
5030 Sets the model to use for the mouse. The name mostly specifies what
5031 the right mouse button is used for:
5032 extend Right mouse button extends a selection. This works
5033 like in an xterm.
5034 popup Right mouse button pops up a menu. The shifted left
5035 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005036 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 popup_setpos Like "popup", but the cursor will be moved to the
5038 position where the mouse was clicked, and thus the
5039 selected operation will act upon the clicked object.
5040 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005041 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 course, that right clicking outside a selection will
5043 end Visual mode.
5044 Overview of what button does what for each model:
5045 mouse extend popup(_setpos) ~
5046 left click place cursor place cursor
5047 left drag start selection start selection
5048 shift-left search word extend selection
5049 right click extend selection popup menu (place cursor)
5050 right drag extend selection -
5051 middle click paste paste
5052
5053 In the "popup" model the right mouse button produces a pop-up menu.
5054 You need to define this first, see |popup-menu|.
5055
5056 Note that you can further refine the meaning of buttons with mappings.
5057 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5058 selection (because that's handled in the GUI code directly).
5059
5060 The 'mousemodel' option is set by the |:behave| command.
5061
5062 *'mouseshape'* *'mouses'* *E547*
5063'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005064 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 global
5066 {not in Vi}
5067 {only available when compiled with the |+mouseshape|
5068 feature}
5069 This option tells Vim what the mouse pointer should look like in
5070 different modes. The option is a comma separated list of parts, much
5071 like used for 'guicursor'. Each part consist of a mode/location-list
5072 and an argument-list:
5073 mode-list:shape,mode-list:shape,..
5074 The mode-list is a dash separated list of these modes/locations:
5075 In a normal window: ~
5076 n Normal mode
5077 v Visual mode
5078 ve Visual mode with 'selection' "exclusive" (same as 'v',
5079 if not specified)
5080 o Operator-pending mode
5081 i Insert mode
5082 r Replace mode
5083
5084 Others: ~
5085 c appending to the command-line
5086 ci inserting in the command-line
5087 cr replacing in the command-line
5088 m at the 'Hit ENTER' or 'More' prompts
5089 ml idem, but cursor in the last line
5090 e any mode, pointer below last window
5091 s any mode, pointer on a status line
5092 sd any mode, while dragging a status line
5093 vs any mode, pointer on a vertical separator line
5094 vd any mode, while dragging a vertical separator line
5095 a everywhere
5096
5097 The shape is one of the following:
5098 avail name looks like ~
5099 w x arrow Normal mouse pointer
5100 w x blank no pointer at all (use with care!)
5101 w x beam I-beam
5102 w x updown up-down sizing arrows
5103 w x leftright left-right sizing arrows
5104 w x busy The system's usual busy pointer
5105 w x no The system's usual 'no input' pointer
5106 x udsizing indicates up-down resizing
5107 x lrsizing indicates left-right resizing
5108 x crosshair like a big thin +
5109 x hand1 black hand
5110 x hand2 white hand
5111 x pencil what you write with
5112 x question big ?
5113 x rightup-arrow arrow pointing right-up
5114 w x up-arrow arrow pointing up
5115 x <number> any X11 pointer number (see X11/cursorfont.h)
5116
5117 The "avail" column contains a 'w' if the shape is available for Win32,
5118 x for X11.
5119 Any modes not specified or shapes not available use the normal mouse
5120 pointer.
5121
5122 Example: >
5123 :set mouseshape=s:udsizing,m:no
5124< will make the mouse turn to a sizing arrow over the status lines and
5125 indicate no input when the hit-enter prompt is displayed (since
5126 clicking the mouse has no effect in this state.)
5127
5128 *'mousetime'* *'mouset'*
5129'mousetime' 'mouset' number (default 500)
5130 global
5131 {not in Vi}
5132 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5133 time in msec between two mouse clicks for the second click to be
5134 recognized as a multi click.
5135
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005136 *'mzquantum'* *'mzq'*
5137'mzquantum' 'mzq' number (default 100)
5138 global
5139 {not in Vi}
5140 {not available when compiled without the |+mzscheme|
5141 feature}
5142 The number of milliseconds between polls for MzScheme threads.
5143 Negative or zero value means no thread scheduling.
5144
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 *'nrformats'* *'nf'*
5146'nrformats' 'nf' string (default "octal,hex")
5147 local to buffer
5148 {not in Vi}
5149 This defines what bases Vim will consider for numbers when using the
5150 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5151 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005152 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005154 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005155 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005157 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 considered to be hexadecimal. Example: Using CTRL-X on
5159 "0x100" results in "0x0ff".
5160 Numbers which simply begin with a digit in the range 1-9 are always
5161 considered decimal. This also happens for numbers that are not
5162 recognized as octal or hex.
5163
5164 *'number'* *'nu'* *'nonumber'* *'nonu'*
5165'number' 'nu' boolean (default off)
5166 local to window
5167 Print the line number in front of each line. When the 'n' option is
5168 excluded from 'cpoptions' a wrapped line will not use the column of
5169 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005170 The 'numberwidth' option can be used to set the room used for the line
5171 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172 When a long, wrapped line doesn't start with the first character, '-'
5173 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005174 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5175 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005176 *number_relativenumber*
5177 The 'relativenumber' option changes the displayed number to be
5178 relative to the cursor. Together with 'number' there are these
5179 four combinations (cursor in line 3):
5180
5181 'nonu' 'nu' 'nonu' 'nu'
5182 'nornu' 'nornu' 'rnu' 'rnu'
5183
5184 |apple | 1 apple | 2 apple | 2 apple
5185 |pear | 2 pear | 1 pear | 1 pear
5186 |nobody | 3 nobody | 0 nobody |3 nobody
5187 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005189 *'numberwidth'* *'nuw'*
5190'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5191 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005192 {not in Vi}
5193 {only available when compiled with the |+linebreak|
5194 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005195 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005196 when the 'number' or 'relativenumber' option is set or printing lines
5197 with a line number. Since one space is always between the number and
5198 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005199 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005200 fit the highest line number in the buffer respectively the number of
5201 rows in the window, depending on whether 'number' or 'relativenumber'
5202 is set. Thus with the Vim default of 4 there is room for a line number
5203 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005204 The minimum value is 1, the maximum value is 10.
5205 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5206
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005207 *'omnifunc'* *'ofu'*
5208'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005209 local to buffer
5210 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005211 {not available when compiled without the |+eval|
5212 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005213 This option specifies a function to be used for Insert mode omni
5214 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005215 See |complete-functions| for an explanation of how the function is
5216 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005217 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005218 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005219 This option cannot be set from a |modeline| or in the |sandbox|, for
5220 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005221
5222
Bram Moolenaar02467872007-05-06 13:22:01 +00005223 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005224'opendevice' 'odev' boolean (default off)
5225 global
5226 {not in Vi}
5227 {only for MS-DOS, MS-Windows and OS/2}
5228 Enable reading and writing from devices. This may get Vim stuck on a
5229 device that can be opened but doesn't actually do the I/O. Therefore
5230 it is off by default.
5231 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5232 result in editing a device.
5233
5234
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005235 *'operatorfunc'* *'opfunc'*
5236'operatorfunc' 'opfunc' string (default: empty)
5237 global
5238 {not in Vi}
5239 This option specifies a function to be called by the |g@| operator.
5240 See |:map-operator| for more info and an example.
5241
5242 This option cannot be set from a |modeline| or in the |sandbox|, for
5243 security reasons.
5244
5245
Bram Moolenaar251e1912011-06-19 05:09:16 +02005246 *'osfiletype'* *'oft'*
5247'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 local to buffer
5249 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005250 This option was supported on RISC OS, which has been removed.
5251
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252
5253 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005254'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 global
5256 Specifies the nroff macros that separate paragraphs. These are pairs
5257 of two letters (see |object-motions|).
5258
5259 *'paste'* *'nopaste'*
5260'paste' boolean (default off)
5261 global
5262 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005263 Put Vim in Paste mode. This is useful if you want to cut or copy
5264 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 unexpected effects.
5266 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005267 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 knows about pasting and will mostly do the right thing without 'paste'
5269 being set. The same is true for a terminal where Vim handles the
5270 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005271 This option is reset when starting the GUI. Thus if you set it in
5272 your .vimrc it will work in a terminal, but not in the GUI. Setting
5273 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5274 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 When the 'paste' option is switched on (also when it was already on):
5276 - mapping in Insert mode and Command-line mode is disabled
5277 - abbreviations are disabled
5278 - 'textwidth' is set to 0
5279 - 'wrapmargin' is set to 0
5280 - 'autoindent' is reset
5281 - 'smartindent' is reset
5282 - 'softtabstop' is set to 0
5283 - 'revins' is reset
5284 - 'ruler' is reset
5285 - 'showmatch' is reset
5286 - 'formatoptions' is used like it is empty
5287 These options keep their value, but their effect is disabled:
5288 - 'lisp'
5289 - 'indentexpr'
5290 - 'cindent'
5291 NOTE: When you start editing another file while the 'paste' option is
5292 on, settings from the modelines or autocommands may change the
5293 settings again, causing trouble when pasting text. You might want to
5294 set the 'paste' option again.
5295 When the 'paste' option is reset the mentioned options are restored to
5296 the value before the moment 'paste' was switched from off to on.
5297 Resetting 'paste' before ever setting it does not have any effect.
5298 Since mapping doesn't work while 'paste' is active, you need to use
5299 the 'pastetoggle' option to toggle the 'paste' option with some key.
5300
5301 *'pastetoggle'* *'pt'*
5302'pastetoggle' 'pt' string (default "")
5303 global
5304 {not in Vi}
5305 When non-empty, specifies the key sequence that toggles the 'paste'
5306 option. This is like specifying a mapping: >
5307 :map {keys} :set invpaste<CR>
5308< Where {keys} is the value of 'pastetoggle'.
5309 The difference is that it will work even when 'paste' is set.
5310 'pastetoggle' works in Insert mode and Normal mode, but not in
5311 Command-line mode.
5312 Mappings are checked first, thus overrule 'pastetoggle'. However,
5313 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5314 this: >
5315 :map <F10> :set paste<CR>
5316 :map <F11> :set nopaste<CR>
5317 :imap <F10> <C-O>:set paste<CR>
5318 :imap <F11> <nop>
5319 :set pastetoggle=<F11>
5320< This will make <F10> start paste mode and <F11> stop paste mode.
5321 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5322 mode everything is inserted literally, except the 'pastetoggle' key
5323 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005324 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'pex'* *'patchexpr'*
5327'patchexpr' 'pex' string (default "")
5328 global
5329 {not in Vi}
5330 {not available when compiled without the |+diff|
5331 feature}
5332 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005333 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
5335 *'patchmode'* *'pm'* *E206*
5336'patchmode' 'pm' string (default "")
5337 global
5338 {not in Vi}
5339 When non-empty the oldest version of a file is kept. This can be used
5340 to keep the original version of a file if you are changing files in a
5341 source distribution. Only the first time that a file is written a
5342 copy of the original file will be kept. The name of the copy is the
5343 name of the original file with the string in the 'patchmode' option
5344 appended. This option should start with a dot. Use a string like
5345 ".org". 'backupdir' must not be empty for this to work (Detail: The
5346 backup file is renamed to the patchmode file after the new file has
5347 been successfully written, that's why it must be possible to write a
5348 backup file). If there was no file to be backed up, an empty file is
5349 created.
5350 When the 'backupskip' pattern matches, a patchmode file is not made.
5351 Using 'patchmode' for compressed files appends the extension at the
5352 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5353 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005354 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005356 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357'path' 'pa' string (default on Unix: ".,/usr/include,,"
5358 on OS/2: ".,/emx/include,,"
5359 other systems: ".,,")
5360 global or local to buffer |global-local|
5361 {not in Vi}
5362 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005363 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5364 provided that the file being searched for has a relative path (not
5365 starting with "/", "./" or "../"). The directories in the 'path'
5366 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 - Use commas to separate directory names: >
5368 :set path=.,/usr/local/include,/usr/include
5369< - Spaces can also be used to separate directory names (for backwards
5370 compatibility with version 3.0). To have a space in a directory
5371 name, precede it with an extra backslash, and escape the space: >
5372 :set path=.,/dir/with\\\ space
5373< - To include a comma in a directory name precede it with an extra
5374 backslash: >
5375 :set path=.,/dir/with\\,comma
5376< - To search relative to the directory of the current file, use: >
5377 :set path=.
5378< - To search in the current directory use an empty string between two
5379 commas: >
5380 :set path=,,
5381< - A directory name may end in a ':' or '/'.
5382 - Environment variables are expanded |:set_env|.
5383 - When using |netrw.vim| URLs can be used. For example, adding
5384 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005385 - Search upwards and downwards in a directory tree using "*", "**" and
5386 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 {not available when compiled without the |+path_extra| feature}
5388 - Careful with '\' characters, type two to get one in the option: >
5389 :set path=.,c:\\include
5390< Or just use '/' instead: >
5391 :set path=.,c:/include
5392< Don't forget "." or files won't even be found in the same directory as
5393 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005394 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 it is something like 256 or 1024 characters.
5396 You can check if all the include files are found, using the value of
5397 'path', see |:checkpath|.
5398 The use of |:set+=| and |:set-=| is preferred when adding or removing
5399 directories from the list. This avoids problems when a future version
5400 uses another default. To remove the current directory use: >
5401 :set path-=
5402< To add the current directory use: >
5403 :set path+=
5404< To use an environment variable, you probably need to replace the
5405 separator. Here is an example to append $INCL, in which directory
5406 names are separated with a semi-colon: >
5407 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5408< Replace the ';' with a ':' or whatever separator is used. Note that
5409 this doesn't work when $INCL contains a comma or white space.
5410
5411 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5412'preserveindent' 'pi' boolean (default off)
5413 local to buffer
5414 {not in Vi}
5415 When changing the indent of the current line, preserve as much of the
5416 indent structure as possible. Normally the indent is replaced by a
5417 series of tabs followed by spaces as required (unless |'expandtab'| is
5418 enabled, in which case only spaces are used). Enabling this option
5419 means the indent will preserve as many existing characters as possible
5420 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005421 'expandtab' does not apply to the preserved white space, a Tab remains
5422 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 NOTE: When using ">>" multiple times the resulting indent is a mix of
5424 tabs and spaces. You might not like this.
5425 NOTE: 'preserveindent' is reset when 'compatible' is set.
5426 Also see 'copyindent'.
5427 Use |:retab| to clean up white space.
5428
5429 *'previewheight'* *'pvh'*
5430'previewheight' 'pvh' number (default 12)
5431 global
5432 {not in Vi}
5433 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005434 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 Default height for a preview window. Used for |:ptag| and associated
5436 commands. Used for |CTRL-W_}| when no count is given.
5437
5438 *'previewwindow'* *'nopreviewwindow'*
5439 *'pvw'* *'nopvw'* *E590*
5440'previewwindow' 'pvw' boolean (default off)
5441 local to window
5442 {not in Vi}
5443 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005444 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005445 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 set. It's normally not set directly, but by using one of the commands
5447 |:ptag|, |:pedit|, etc.
5448
5449 *'printdevice'* *'pdev'*
5450'printdevice' 'pdev' string (default empty)
5451 global
5452 {not in Vi}
5453 {only available when compiled with the |+printer|
5454 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005455 The name of the printer to be used for |:hardcopy|.
5456 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005457 This option cannot be set from a |modeline| or in the |sandbox|, for
5458 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459
Bram Moolenaar8299df92004-07-10 09:47:34 +00005460 *'printencoding'* *'penc'*
5461'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 global
5463 {not in Vi}
5464 {only available when compiled with the |+printer|
5465 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005466 Sets the character encoding used when printing.
5467 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468
5469 *'printexpr'* *'pexpr'*
5470'printexpr' 'pexpr' String (default: see below)
5471 global
5472 {not in Vi}
5473 {only available when compiled with the |+printer|
5474 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005475 Expression used to print the PostScript produced with |:hardcopy|.
5476 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477
Bram Moolenaar8299df92004-07-10 09:47:34 +00005478 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479'printfont' 'pfn' string (default "courier")
5480 global
5481 {not in Vi}
5482 {only available when compiled with the |+printer|
5483 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005484 The name of the font that will be used for |:hardcopy|.
5485 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486
5487 *'printheader'* *'pheader'*
5488'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5489 global
5490 {not in Vi}
5491 {only available when compiled with the |+printer|
5492 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005493 The format of the header produced in |:hardcopy| output.
5494 See |pheader-option|.
5495
5496 *'printmbcharset'* *'pmbcs'*
5497'printmbcharset' 'pmbcs' string (default "")
5498 global
5499 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005500 {only available when compiled with the |+printer|,
5501 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005502 The CJK character set to be used for CJK output from |:hardcopy|.
5503 See |pmbcs-option|.
5504
5505 *'printmbfont'* *'pmbfn'*
5506'printmbfont' 'pmbfn' string (default "")
5507 global
5508 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005509 {only available when compiled with the |+printer|,
5510 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005511 List of font names to be used for CJK output from |:hardcopy|.
5512 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513
5514 *'printoptions'* *'popt'*
5515'printoptions' 'popt' string (default "")
5516 global
5517 {not in Vi}
5518 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005519 List of items that control the format of the output of |:hardcopy|.
5520 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005522 *'prompt'* *'noprompt'*
5523'prompt' boolean (default on)
5524 global
5525 When on a ":" prompt is used in Ex mode.
5526
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005527 *'pumheight'* *'ph'*
5528'pumheight' 'ph' number (default 0)
5529 global
5530 {not available when compiled without the
5531 |+insert_expand| feature}
5532 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005533 Determines the maximum number of items to show in the popup menu for
5534 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005535 |ins-completion-menu|.
5536
5537
Bram Moolenaar677ee682005-01-27 14:41:15 +00005538 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005539'quoteescape' 'qe' string (default "\")
5540 local to buffer
5541 {not in Vi}
5542 The characters that are used to escape quotes in a string. Used for
5543 objects like a', a" and a` |a'|.
5544 When one of the characters in this option is found inside a string,
5545 the following character will be skipped. The default value makes the
5546 text "foo\"bar\\" considered to be one string.
5547
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5549'readonly' 'ro' boolean (default off)
5550 local to buffer
5551 If on, writes fail unless you use a '!'. Protects you from
5552 accidentally overwriting a file. Default on when Vim is started
5553 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005554 When using ":w!" the 'readonly' option is reset for the current
5555 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005557 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005559 *'redrawtime'* *'rdt'*
5560'redrawtime' 'rdt' number (default 2000)
5561 global
5562 {not in Vi}
5563 {only available when compiled with the |+reltime|
5564 feature}
5565 The time in milliseconds for redrawing the display. This applies to
5566 searching for patterns for 'hlsearch' and |:match| highlighting.
5567 When redrawing takes more than this many milliseconds no further
5568 matches will be highlighted. This is used to avoid that Vim hangs
5569 when using a very complicated pattern.
5570
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005571 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005572'regexpengine' 're' number (default 0)
5573 global
5574 {not in Vi}
5575 This selects the default regexp engine. |two-engines|
5576 The possible values are:
5577 0 automatic selection
5578 1 old engine
5579 2 NFA engine
5580 Note that when using the NFA engine and the pattern contains something
5581 that is not supported the pattern will not match. This is only useful
5582 for debugging the regexp engine.
5583
Bram Moolenaar64486672010-05-16 15:46:46 +02005584 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5585'relativenumber' 'rnu' boolean (default off)
5586 local to window
5587 {not in Vi}
5588 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005589 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005590 precede some vertical motion commands (e.g. j k + -) with, without
5591 having to calculate it yourself. Especially useful in combination with
5592 other commands (e.g. y d c < > gq gw =).
5593 When the 'n' option is excluded from 'cpoptions' a wrapped
5594 line will not use the column of line numbers (this is the default when
5595 'compatible' isn't set).
5596 The 'numberwidth' option can be used to set the room used for the line
5597 number.
5598 When a long, wrapped line doesn't start with the first character, '-'
5599 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005600 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5601 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005602
5603 The number in front of the cursor line also depends on the value of
5604 'number', see |number_relativenumber| for all combinations of the two
5605 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005606
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 *'remap'* *'noremap'*
5608'remap' boolean (default on)
5609 global
5610 Allows for mappings to work recursively. If you do not want this for
5611 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005612 NOTE: To avoid portability problems with Vim scripts, always keep
5613 this option at the default "on". Only switch it off when working with
5614 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615
5616 *'report'*
5617'report' number (default 2)
5618 global
5619 Threshold for reporting number of lines changed. When the number of
5620 changed lines is more than 'report' a message will be given for most
5621 ":" commands. If you want it always, set 'report' to 0.
5622 For the ":substitute" command the number of substitutions is used
5623 instead of the number of lines.
5624
5625 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5626'restorescreen' 'rs' boolean (default on)
5627 global
5628 {not in Vi} {only in Windows 95/NT console version}
5629 When set, the screen contents is restored when exiting Vim. This also
5630 happens when executing external commands.
5631
5632 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5633 options in your .vimrc. To disable restoring:
5634 set t_ti= t_te=
5635 To enable restoring (for an xterm):
5636 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5637 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5638
5639 *'revins'* *'ri'* *'norevins'* *'nori'*
5640'revins' 'ri' boolean (default off)
5641 global
5642 {not in Vi}
5643 {only available when compiled with the |+rightleft|
5644 feature}
5645 Inserting characters in Insert mode will work backwards. See "typing
5646 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5647 command in Insert mode, when 'allowrevins' is set.
5648 NOTE: This option is reset when 'compatible' or 'paste' is set.
5649
5650 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5651'rightleft' 'rl' boolean (default off)
5652 local to window
5653 {not in Vi}
5654 {only available when compiled with the |+rightleft|
5655 feature}
5656 When on, display orientation becomes right-to-left, i.e., characters
5657 that are stored in the file appear from the right to the left.
5658 Using this option, it is possible to edit files for languages that
5659 are written from the right to the left such as Hebrew and Arabic.
5660 This option is per window, so it is possible to edit mixed files
5661 simultaneously, or to view the same file in both ways (this is
5662 useful whenever you have a mixed text file with both right-to-left
5663 and left-to-right strings so that both sets are displayed properly
5664 in different windows). Also see |rileft.txt|.
5665
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005666 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667'rightleftcmd' 'rlc' string (default "search")
5668 local to window
5669 {not in Vi}
5670 {only available when compiled with the |+rightleft|
5671 feature}
5672 Each word in this option enables the command line editing to work in
5673 right-to-left mode for a group of commands:
5674
5675 search "/" and "?" commands
5676
5677 This is useful for languages such as Hebrew, Arabic and Farsi.
5678 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5679
5680 *'ruler'* *'ru'* *'noruler'* *'noru'*
5681'ruler' 'ru' boolean (default off)
5682 global
5683 {not in Vi}
5684 {not available when compiled without the
5685 |+cmdline_info| feature}
5686 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 text in the file is shown on the far right:
5689 Top first line is visible
5690 Bot last line is visible
5691 All first and last line are visible
5692 45% relative position in the file
5693 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005694 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005696 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 this option takes precedence over 'ruler' and 'rulerformat'
5698 If the number of characters displayed is different from the number of
5699 bytes in the text (e.g., for a TAB or a multi-byte character), both
5700 the text column (byte number) and the screen column are shown,
5701 separated with a dash.
5702 For an empty line "0-1" is shown.
5703 For an empty buffer the line number will also be zero: "0,0-1".
5704 This option is reset when the 'paste' option is set.
5705 If you don't want to see the ruler all the time but want to know where
5706 you are, use "g CTRL-G" |g_CTRL-G|.
5707 NOTE: This option is reset when 'compatible' is set.
5708
5709 *'rulerformat'* *'ruf'*
5710'rulerformat' 'ruf' string (default empty)
5711 global
5712 {not in Vi}
5713 {not available when compiled without the |+statusline|
5714 feature}
5715 When this option is not empty, it determines the content of the ruler
5716 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005717 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 The default ruler width is 17 characters. To make the ruler 15
5719 characters wide, put "%15(" at the start and "%)" at the end.
5720 Example: >
5721 :set rulerformat=%15(%c%V\ %p%%%)
5722<
5723 *'runtimepath'* *'rtp'* *vimfiles*
5724'runtimepath' 'rtp' string (default:
5725 Unix: "$HOME/.vim,
5726 $VIM/vimfiles,
5727 $VIMRUNTIME,
5728 $VIM/vimfiles/after,
5729 $HOME/.vim/after"
5730 Amiga: "home:vimfiles,
5731 $VIM/vimfiles,
5732 $VIMRUNTIME,
5733 $VIM/vimfiles/after,
5734 home:vimfiles/after"
5735 PC, OS/2: "$HOME/vimfiles,
5736 $VIM/vimfiles,
5737 $VIMRUNTIME,
5738 $VIM/vimfiles/after,
5739 $HOME/vimfiles/after"
5740 Macintosh: "$VIM:vimfiles,
5741 $VIMRUNTIME,
5742 $VIM:vimfiles:after"
5743 RISC-OS: "Choices:vimfiles,
5744 $VIMRUNTIME,
5745 Choices:vimfiles/after"
5746 VMS: "sys$login:vimfiles,
5747 $VIM/vimfiles,
5748 $VIMRUNTIME,
5749 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005750 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 global
5752 {not in Vi}
5753 This is a list of directories which will be searched for runtime
5754 files:
5755 filetype.vim filetypes by file name |new-filetype|
5756 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005757 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 colors/ color scheme files |:colorscheme|
5759 compiler/ compiler files |:compiler|
5760 doc/ documentation |write-local-help|
5761 ftplugin/ filetype plugins |write-filetype-plugin|
5762 indent/ indent scripts |indent-expression|
5763 keymap/ key mapping files |mbyte-keymap|
5764 lang/ menu translations |:menutrans|
5765 menu.vim GUI menus |menu.vim|
5766 plugin/ plugin scripts |write-plugin|
5767 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005768 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005769 syntax/ syntax files |mysyntaxfile|
5770 tutor/ files for vimtutor |tutor|
5771
5772 And any other file searched for with the |:runtime| command.
5773
5774 The defaults for most systems are setup to search five locations:
5775 1. In your home directory, for your personal preferences.
5776 2. In a system-wide Vim directory, for preferences from the system
5777 administrator.
5778 3. In $VIMRUNTIME, for files distributed with Vim.
5779 *after-directory*
5780 4. In the "after" directory in the system-wide Vim directory. This is
5781 for the system administrator to overrule or add to the distributed
5782 defaults (rarely needed)
5783 5. In the "after" directory in your home directory. This is for
5784 personal preferences to overrule or add to the distributed defaults
5785 or system-wide settings (rarely needed).
5786
5787 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5788 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005789 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 wildcards.
5791 See |:runtime|.
5792 Example: >
5793 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5794< This will use the directory "~/vimruntime" first (containing your
5795 personal Vim runtime files), then "/mygroup/vim" (shared between a
5796 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5797 files).
5798 You probably should always include $VIMRUNTIME somewhere, to use the
5799 distributed runtime files. You can put a directory before $VIMRUNTIME
5800 to find files which replace a distributed runtime files. You can put
5801 a directory after $VIMRUNTIME to find files which add to distributed
5802 runtime files.
5803 This option cannot be set from a |modeline| or in the |sandbox|, for
5804 security reasons.
5805
5806 *'scroll'* *'scr'*
5807'scroll' 'scr' number (default: half the window height)
5808 local to window
5809 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5810 set to half the number of lines in the window when the window size
5811 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005812 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5814 the number of screen lines instead of file lines, makes a difference
5815 when lines wrap}
5816
5817 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5818'scrollbind' 'scb' boolean (default off)
5819 local to window
5820 {not in Vi}
5821 {not available when compiled without the |+scrollbind|
5822 feature}
5823 See also |scroll-binding|. When this option is set, the current
5824 window scrolls as other scrollbind windows (windows that also have
5825 this option set) scroll. This option is useful for viewing the
5826 differences between two versions of a file, see 'diff'.
5827 See |'scrollopt'| for options that determine how this option should be
5828 interpreted.
5829 This option is mostly reset when splitting a window to edit another
5830 file. This means that ":split | edit file" results in two windows
5831 with scroll-binding, but ":split file" does not.
5832
5833 *'scrolljump'* *'sj'*
5834'scrolljump' 'sj' number (default 1)
5835 global
5836 {not in Vi}
5837 Minimal number of lines to scroll when the cursor gets off the
5838 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5839 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005840 When set to a negative number from -1 to -100 this is used as the
5841 percentage of the window height. Thus -50 scrolls half the window
5842 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 NOTE: This option is set to 1 when 'compatible' is set.
5844
5845 *'scrolloff'* *'so'*
5846'scrolloff' 'so' number (default 0)
5847 global
5848 {not in Vi}
5849 Minimal number of screen lines to keep above and below the cursor.
5850 This will make some context visible around where you are working. If
5851 you set it to a very large value (999) the cursor line will always be
5852 in the middle of the window (except at the start or end of the file or
5853 when long lines wrap).
5854 For scrolling horizontally see 'sidescrolloff'.
5855 NOTE: This option is set to 0 when 'compatible' is set.
5856
5857 *'scrollopt'* *'sbo'*
5858'scrollopt' 'sbo' string (default "ver,jump")
5859 global
5860 {not available when compiled without the |+scrollbind|
5861 feature}
5862 {not in Vi}
5863 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005864 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5865 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 The following words are available:
5867 ver Bind vertical scrolling for 'scrollbind' windows
5868 hor Bind horizontal scrolling for 'scrollbind' windows
5869 jump Applies to the offset between two windows for vertical
5870 scrolling. This offset is the difference in the first
5871 displayed line of the bound windows. When moving
5872 around in a window, another 'scrollbind' window may
5873 reach a position before the start or after the end of
5874 the buffer. The offset is not changed though, when
5875 moving back the 'scrollbind' window will try to scroll
5876 to the desired position when possible.
5877 When now making that window the current one, two
5878 things can be done with the relative offset:
5879 1. When "jump" is not included, the relative offset is
5880 adjusted for the scroll position in the new current
5881 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005882 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 2. When "jump" is included, the other windows are
5884 scrolled to keep the same relative offset. When
5885 going back to the other window, it still uses the
5886 same relative offset.
5887 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005888 When 'diff' mode is active there always is vertical scroll binding,
5889 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890
5891 *'sections'* *'sect'*
5892'sections' 'sect' string (default "SHNHH HUnhsh")
5893 global
5894 Specifies the nroff macros that separate sections. These are pairs of
5895 two letters (See |object-motions|). The default makes a section start
5896 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5897
5898 *'secure'* *'nosecure'* *E523*
5899'secure' boolean (default off)
5900 global
5901 {not in Vi}
5902 When on, ":autocmd", shell and write commands are not allowed in
5903 ".vimrc" and ".exrc" in the current directory and map commands are
5904 displayed. Switch it off only if you know that you will not run into
5905 problems, or when the 'exrc' option is off. On Unix this option is
5906 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005907 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 'secure' at the end of your ~/.vimrc then.
5909 This option cannot be set from a |modeline| or in the |sandbox|, for
5910 security reasons.
5911
5912 *'selection'* *'sel'*
5913'selection' 'sel' string (default "inclusive")
5914 global
5915 {not in Vi}
5916 This option defines the behavior of the selection. It is only used
5917 in Visual and Select mode.
5918 Possible values:
5919 value past line inclusive ~
5920 old no yes
5921 inclusive yes yes
5922 exclusive yes no
5923 "past line" means that the cursor is allowed to be positioned one
5924 character past the line.
5925 "inclusive" means that the last character of the selection is included
5926 in an operation. For example, when "x" is used to delete the
5927 selection.
5928 Note that when "exclusive" is used and selecting from the end
5929 backwards, you cannot include the last character of a line, when
5930 starting in Normal mode and 'virtualedit' empty.
5931
5932 The 'selection' option is set by the |:behave| command.
5933
5934 *'selectmode'* *'slm'*
5935'selectmode' 'slm' string (default "")
5936 global
5937 {not in Vi}
5938 This is a comma separated list of words, which specifies when to start
5939 Select mode instead of Visual mode, when a selection is started.
5940 Possible values:
5941 mouse when using the mouse
5942 key when using shifted special keys
5943 cmd when using "v", "V" or CTRL-V
5944 See |Select-mode|.
5945 The 'selectmode' option is set by the |:behave| command.
5946
5947 *'sessionoptions'* *'ssop'*
5948'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005949 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 global
5951 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005952 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 feature}
5954 Changes the effect of the |:mksession| command. It is a comma
5955 separated list of words. Each word enables saving and restoring
5956 something:
5957 word save and restore ~
5958 blank empty windows
5959 buffers hidden and unloaded buffers, not just those in windows
5960 curdir the current directory
5961 folds manually created folds, opened/closed folds and local
5962 fold options
5963 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005964 and contain at least one lowercase letter. Only
5965 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 help the help window
5967 localoptions options and mappings local to a window or buffer (not
5968 global values for local options)
5969 options all options and mappings (also global values for local
5970 options)
5971 resize size of the Vim window: 'lines' and 'columns'
5972 sesdir the directory in which the session file is located
5973 will become the current directory (useful with
5974 projects accessed over a network from different
5975 systems)
5976 slash backslashes in file names replaced with forward
5977 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005978 tabpages all tab pages; without this only the current tab page
5979 is restored, so that you can make a session for each
5980 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 unix with Unix end-of-line format (single <NL>), even when
5982 on Windows or DOS
5983 winpos position of the whole Vim window
5984 winsize window sizes
5985
5986 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005987 When neither "curdir" nor "sesdir" is included, file names are stored
5988 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005989 "slash" and "unix" are useful on Windows when sharing session files
5990 with Unix. The Unix version of Vim cannot source dos format scripts,
5991 but the Windows version of Vim can source unix format scripts.
5992
5993 *'shell'* *'sh'* *E91*
5994'shell' 'sh' string (default $SHELL or "sh",
5995 MS-DOS and Win32: "command.com" or
5996 "cmd.exe", OS/2: "cmd")
5997 global
5998 Name of the shell to use for ! and :! commands. When changing the
5999 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6000 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006001 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 See |option-backslash| about including spaces and backslashes.
6003 Environment variables are expanded |:set_env|.
6004 If the name of the shell contains a space, you might need to enclose
6005 it in quotes. Example: >
6006 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6007< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006008 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 "-f" is not inside the quotes, because it is not part of the command
6010 name. And Vim automagically recognizes the backslashes that are path
6011 separators.
6012 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6013 variable to change the way external commands are executed. See the
6014 libc.inf file of DJGPP.
6015 Under MS-Windows, when the executable ends in ".com" it must be
6016 included. Thus setting the shell to "command.com" or "4dos.com"
6017 works, but "command" and "4dos" do not work for all commands (e.g.,
6018 filtering).
6019 For unknown reasons, when using "4dos.com" the current directory is
6020 changed to "C:\". To avoid this set 'shell' like this: >
6021 :set shell=command.com\ /c\ 4dos
6022< This option cannot be set from a |modeline| or in the |sandbox|, for
6023 security reasons.
6024
6025 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006026'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006027 MS-DOS and Win32, when 'shell' does not
6028 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 global
6030 {not in Vi}
6031 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6032 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6033 systems, the default is set according to the value of 'shell', to
6034 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006035 OS/2 (EMX figures this out itself).
6036 On Unix it can have more than one flag. Each white space separated
6037 part is passed as an argument to the shell command.
6038 See |option-backslash| about including spaces and backslashes.
6039 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 This option cannot be set from a |modeline| or in the |sandbox|, for
6041 security reasons.
6042
6043 *'shellpipe'* *'sp'*
6044'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6045 global
6046 {not in Vi}
6047 {not available when compiled without the |+quickfix|
6048 feature}
6049 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006050 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 including spaces and backslashes.
6052 The name of the temporary file can be represented by "%s" if necessary
6053 (the file name is appended automatically if no %s appears in the value
6054 of this option).
6055 For the Amiga and MS-DOS the default is ">". The output is directly
6056 saved in a file and not echoed to the screen.
6057 For Unix the default it "| tee". The stdout of the compiler is saved
6058 in a file and echoed to the screen. If the 'shell' option is "csh" or
6059 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006060 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6061 default becomes "2>&1| tee". This means that stderr is also included.
6062 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6063 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 The initialization of this option is done after reading the ".vimrc"
6065 and the other initializations, so that when the 'shell' option is set
6066 there, the 'shellpipe' option changes automatically, unless it was
6067 explicitly set before.
6068 When 'shellpipe' is set to an empty string, no redirection of the
6069 ":make" output will be done. This is useful if you use a 'makeprg'
6070 that writes to 'makeef' by itself. If you want no piping, but do
6071 want to include the 'makeef', set 'shellpipe' to a single space.
6072 Don't forget to precede the space with a backslash: ":set sp=\ ".
6073 In the future pipes may be used for filtering and this option will
6074 become obsolete (at least for Unix).
6075 This option cannot be set from a |modeline| or in the |sandbox|, for
6076 security reasons.
6077
6078 *'shellquote'* *'shq'*
6079'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6080 contains "sh" somewhere: "\"")
6081 global
6082 {not in Vi}
6083 Quoting character(s), put around the command passed to the shell, for
6084 the "!" and ":!" commands. The redirection is kept outside of the
6085 quoting. See 'shellxquote' to include the redirection. It's
6086 probably not useful to set both options.
6087 This is an empty string by default. Only known to be useful for
6088 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6089 or bash, where it should be "\"". The default is adjusted according
6090 the value of 'shell', to reduce the need to set this option by the
6091 user. See |dos-shell|.
6092 This option cannot be set from a |modeline| or in the |sandbox|, for
6093 security reasons.
6094
6095 *'shellredir'* *'srr'*
6096'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6097 global
6098 {not in Vi}
6099 String to be used to put the output of a filter command in a temporary
6100 file. See also |:!|. See |option-backslash| about including spaces
6101 and backslashes.
6102 The name of the temporary file can be represented by "%s" if necessary
6103 (the file name is appended automatically if no %s appears in the value
6104 of this option).
6105 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6106 or "zsh" during initializations, the default becomes ">&". If the
6107 'shell' option is "sh", "ksh" or "bash" the default becomes
6108 ">%s 2>&1". This means that stderr is also included.
6109 For Win32, the Unix checks are done and additionally "cmd" is checked
6110 for, which makes the default ">%s 2>&1". Also, the same names with
6111 ".exe" appended are checked for.
6112 The initialization of this option is done after reading the ".vimrc"
6113 and the other initializations, so that when the 'shell' option is set
6114 there, the 'shellredir' option changes automatically unless it was
6115 explicitly set before.
6116 In the future pipes may be used for filtering and this option will
6117 become obsolete (at least for Unix).
6118 This option cannot be set from a |modeline| or in the |sandbox|, for
6119 security reasons.
6120
6121 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6122'shellslash' 'ssl' boolean (default off)
6123 global
6124 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6125 When set, a forward slash is used when expanding file names. This is
6126 useful when a Unix-like shell is used instead of command.com or
6127 cmd.exe. Backward slashes can still be typed, but they are changed to
6128 forward slashes by Vim.
6129 Note that setting or resetting this option has no effect for some
6130 existing file names, thus this option needs to be set before opening
6131 any file for best results. This might change in the future.
6132 'shellslash' only works when a backslash can be used as a path
6133 separator. To test if this is so use: >
6134 if exists('+shellslash')
6135<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006136 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6137'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6138 global
6139 {not in Vi}
6140 When on, use temp files for shell commands. When off use a pipe.
6141 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006142 Currently a pipe is only supported on Unix and MS-Windows 2K and
6143 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006144 :if has("filterpipe")
6145< The advantage of using a pipe is that nobody can read the temp file
6146 and the 'shell' command does not need to support redirection.
6147 The advantage of using a temp file is that the file type and encoding
6148 can be detected.
6149 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6150 |FilterWritePost| autocommands event are not triggered when
6151 'shelltemp' is off.
6152
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 *'shelltype'* *'st'*
6154'shelltype' 'st' number (default 0)
6155 global
6156 {not in Vi} {only for the Amiga}
6157 On the Amiga this option influences the way how the commands work
6158 which use a shell.
6159 0 and 1: always use the shell
6160 2 and 3: use the shell only to filter lines
6161 4 and 5: use shell only for ':sh' command
6162 When not using the shell, the command is executed directly.
6163
6164 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6165 1 and 3: use "shell cmd" to start external commands
6166
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006167 *'shellxescape'* *'sxe'*
6168'shellxescape' 'sxe' string (default: "";
6169 for MS-DOS and MS-Windows: "\"&|<>()@^")
6170 global
6171 {not in Vi}
6172 When 'shellxquote' is set to "(" then the characters listed in this
6173 option will be escaped with a '^' character. This makes it possible
6174 to execute most external commands with cmd.exe.
6175
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 *'shellxquote'* *'sxq'*
6177'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006178 for Win32, when 'shell' is cmd.exe: "("
6179 for Win32, when 'shell' contains "sh"
6180 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 for Unix, when using system(): "\"")
6182 global
6183 {not in Vi}
6184 Quoting character(s), put around the command passed to the shell, for
6185 the "!" and ":!" commands. Includes the redirection. See
6186 'shellquote' to exclude the redirection. It's probably not useful
6187 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006188 When the value is '(' then ')' is appended. When the value is '"('
6189 then ')"' is appended.
6190 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006191 This is an empty string by default on most systems, but is known to be
6192 useful for on Win32 version, either for cmd.exe which automatically
6193 strips off the first and last quote on a command, or 3rd-party shells
6194 such as the MKS Korn Shell or bash, where it should be "\"". The
6195 default is adjusted according the value of 'shell', to reduce the need
6196 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 This option cannot be set from a |modeline| or in the |sandbox|, for
6198 security reasons.
6199
6200 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6201'shiftround' 'sr' boolean (default off)
6202 global
6203 {not in Vi}
6204 Round indent to multiple of 'shiftwidth'. Applies to > and <
6205 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6206 a multiple of 'shiftwidth' (this is Vi compatible).
6207 NOTE: This option is reset when 'compatible' is set.
6208
6209 *'shiftwidth'* *'sw'*
6210'shiftwidth' 'sw' number (default 8)
6211 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006212 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006214 When zero the 'ts' value will be used. Use the |shiftwidth()|
6215 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216
6217 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006218'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6219 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 global
6221 {not in Vi}
6222 This option helps to avoid all the |hit-enter| prompts caused by file
6223 messages, for example with CTRL-G, and to avoid some other messages.
6224 It is a list of flags:
6225 flag meaning when present ~
6226 f use "(3 of 5)" instead of "(file 3 of 5)"
6227 i use "[noeol]" instead of "[Incomplete last line]"
6228 l use "999L, 888C" instead of "999 lines, 888 characters"
6229 m use "[+]" instead of "[Modified]"
6230 n use "[New]" instead of "[New File]"
6231 r use "[RO]" instead of "[readonly]"
6232 w use "[w]" instead of "written" for file write message
6233 and "[a]" instead of "appended" for ':w >> file' command
6234 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6235 "[unix format]" and "[mac]" instead of "[mac format]".
6236 a all of the above abbreviations
6237
6238 o overwrite message for writing a file with subsequent message
6239 for reading a file (useful for ":wn" or when 'autowrite' on)
6240 O message for reading a file overwrites any previous message.
6241 Also for quickfix message (e.g., ":cn").
6242 s don't give "search hit BOTTOM, continuing at TOP" or "search
6243 hit TOP, continuing at BOTTOM" messages
6244 t truncate file message at the start if it is too long to fit
6245 on the command-line, "<" will appear in the left most column.
6246 Ignored in Ex mode.
6247 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006248 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 Ignored in Ex mode.
6250 W don't give "written" or "[w]" when writing a file
6251 A don't give the "ATTENTION" message when an existing swap file
6252 is found.
6253 I don't give the intro message when starting Vim |:intro|.
6254
6255 This gives you the opportunity to avoid that a change between buffers
6256 requires you to hit <Enter>, but still gives as useful a message as
6257 possible for the space available. To get the whole message that you
6258 would have got with 'shm' empty, use ":file!"
6259 Useful values:
6260 shm= No abbreviation of message.
6261 shm=a Abbreviation, but no loss of information.
6262 shm=at Abbreviation, and truncate message when necessary.
6263
6264 NOTE: This option is set to the Vi default value when 'compatible' is
6265 set and to the Vim default value when 'compatible' is reset.
6266
6267 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6268'shortname' 'sn' boolean (default off)
6269 local to buffer
6270 {not in Vi, not in MS-DOS versions}
6271 Filenames are assumed to be 8 characters plus one extension of 3
6272 characters. Multiple dots in file names are not allowed. When this
6273 option is on, dots in file names are replaced with underscores when
6274 adding an extension (".~" or ".swp"). This option is not available
6275 for MS-DOS, because then it would always be on. This option is useful
6276 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6277 or crossdos. When running the Win32 GUI version under Win32s, this
6278 option is always on by default.
6279
6280 *'showbreak'* *'sbr'* *E595*
6281'showbreak' 'sbr' string (default "")
6282 global
6283 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006284 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 feature}
6286 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006287 values are "> " or "+++ ": >
6288 :set showbreak=>\
6289< Note the backslash to escape the trailing space. It's easier like
6290 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006291 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006292< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 comma (in a future version the comma might be used to separate the
6294 part that is shown at the end and at the start of a line).
6295 The characters are highlighted according to the '@' flag in
6296 'highlight'.
6297 Note that tabs after the showbreak will be displayed differently.
6298 If you want the 'showbreak' to appear in between line numbers, add the
6299 "n" flag to 'cpoptions'.
6300
6301 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6302'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6303 off)
6304 global
6305 {not in Vi}
6306 {not available when compiled without the
6307 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006308 Show (partial) command in the last line of the screen. Set this
6309 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 In Visual mode the size of the selected area is shown:
6311 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006312 If the number of bytes is different it is also displayed: "2-6"
6313 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006315 - When selecting a block, the size in screen characters:
6316 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 NOTE: This option is set to the Vi default value when 'compatible' is
6318 set and to the Vim default value when 'compatible' is reset.
6319
6320 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6321'showfulltag' 'sft' boolean (default off)
6322 global
6323 {not in Vi}
6324 When completing a word in insert mode (see |ins-completion|) from the
6325 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006326 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 matched a C function, you can see a template for what arguments are
6328 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006329 Note that this doesn't work well together with having "longest" in
6330 'completeopt', because the completion from the search pattern may not
6331 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332
6333 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6334'showmatch' 'sm' boolean (default off)
6335 global
6336 When a bracket is inserted, briefly jump to the matching one. The
6337 jump is only done if the match can be seen on the screen. The time to
6338 show the match can be set with 'matchtime'.
6339 A Beep is given if there is no match (no matter if the match can be
6340 seen or not). This option is reset when the 'paste' option is set.
6341 When the 'm' flag is not included in 'cpoptions', typing a character
6342 will immediately move the cursor back to where it belongs.
6343 See the "sm" field in 'guicursor' for setting the cursor shape and
6344 blinking when showing the match.
6345 The 'matchpairs' option can be used to specify the characters to show
6346 matches for. 'rightleft' and 'revins' are used to look for opposite
6347 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006348 Also see the matchparen plugin for highlighting the match when moving
6349 around |pi_paren.txt|.
6350 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351
6352 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6353'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6354 global
6355 If in Insert, Replace or Visual mode put a message on the last line.
6356 Use the 'M' flag in 'highlight' to set the type of highlighting for
6357 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006358 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 doesn't mean XIM is really active, especially when 'imactivatekey' is
6360 not set.
6361 NOTE: This option is set to the Vi default value when 'compatible' is
6362 set and to the Vim default value when 'compatible' is reset.
6363
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006364 *'showtabline'* *'stal'*
6365'showtabline' 'stal' number (default 1)
6366 global
6367 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006368 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006369 feature}
6370 The value of this option specifies when the line with tab page labels
6371 will be displayed:
6372 0: never
6373 1: only if there are at least two tab pages
6374 2: always
6375 This is both for the GUI and non-GUI implementation of the tab pages
6376 line.
6377 See |tab-page| for more information about tab pages.
6378
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 *'sidescroll'* *'ss'*
6380'sidescroll' 'ss' number (default 0)
6381 global
6382 {not in Vi}
6383 The minimal number of columns to scroll horizontally. Used only when
6384 the 'wrap' option is off and the cursor is moved off of the screen.
6385 When it is zero the cursor will be put in the middle of the screen.
6386 When using a slow terminal set it to a large number or 0. When using
6387 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6388 commands.
6389
6390 *'sidescrolloff'* *'siso'*
6391'sidescrolloff' 'siso' number (default 0)
6392 global
6393 {not in Vi}
6394 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006395 right of the cursor if 'nowrap' is set. Setting this option to a
6396 value greater than 0 while having |'sidescroll'| also at a non-zero
6397 value makes some context visible in the line you are scrolling in
6398 horizontally (except at beginning of the line). Setting this option
6399 to a large value (like 999) has the effect of keeping the cursor
6400 horizontally centered in the window, as long as one does not come too
6401 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 NOTE: This option is set to 0 when 'compatible' is set.
6403
6404 Example: Try this together with 'sidescroll' and 'listchars' as
6405 in the following example to never allow the cursor to move
6406 onto the "extends" character:
6407
6408 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6409 :set sidescrolloff=1
6410
6411
6412 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6413'smartcase' 'scs' boolean (default off)
6414 global
6415 {not in Vi}
6416 Override the 'ignorecase' option if the search pattern contains upper
6417 case characters. Only used when the search pattern is typed and
6418 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006419 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6421 recalling the search pattern from history and hitting <Enter>.
6422 NOTE: This option is reset when 'compatible' is set.
6423
6424 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6425'smartindent' 'si' boolean (default off)
6426 local to buffer
6427 {not in Vi}
6428 {not available when compiled without the
6429 |+smartindent| feature}
6430 Do smart autoindenting when starting a new line. Works for C-like
6431 programs, but can also be used for other languages. 'cindent' does
6432 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006433 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006434 setting 'si' has no effect. 'indentexpr' is a more advanced
6435 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 Normally 'autoindent' should also be on when using 'smartindent'.
6437 An indent is automatically inserted:
6438 - After a line ending in '{'.
6439 - After a line starting with a keyword from 'cinwords'.
6440 - Before a line starting with '}' (only with the "O" command).
6441 When typing '}' as the first character in a new line, that line is
6442 given the same indent as the matching '{'.
6443 When typing '#' as the first character in a new line, the indent for
6444 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006445 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6447 When using the ">>" command, lines starting with '#' are not shifted
6448 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006449 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 is set smart indenting is disabled.
6451
6452 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6453'smarttab' 'sta' boolean (default off)
6454 global
6455 {not in Vi}
6456 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006457 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6458 <BS> will delete a 'shiftwidth' worth of space at the start of the
6459 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006460 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006461 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6462 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006463 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006465 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 NOTE: This option is reset when 'compatible' is set.
6467
6468 *'softtabstop'* *'sts'*
6469'softtabstop' 'sts' number (default 0)
6470 local to buffer
6471 {not in Vi}
6472 Number of spaces that a <Tab> counts for while performing editing
6473 operations, like inserting a <Tab> or using <BS>. It "feels" like
6474 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6475 used. This is useful to keep the 'ts' setting at its standard value
6476 of 8, while being able to edit like it is set to 'sts'. However,
6477 commands like "x" still work on the actual characters.
6478 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006479 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 'softtabstop' is set to 0 when the 'paste' option is set.
6481 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6482 spaces is minimized by using <Tab>s.
6483 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6484 set.
6485 NOTE: This option is set to 0 when 'compatible' is set.
6486
Bram Moolenaar217ad922005-03-20 22:37:15 +00006487 *'spell'* *'nospell'*
6488'spell' boolean (default off)
6489 local to window
6490 {not in Vi}
6491 {not available when compiled without the |+syntax|
6492 feature}
6493 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006494 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006495
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006496 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006497'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006498 local to buffer
6499 {not in Vi}
6500 {not available when compiled without the |+syntax|
6501 feature}
6502 Pattern to locate the end of a sentence. The following word will be
6503 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006504 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006505 When this check is not wanted make this option empty.
6506 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006507 Be careful with special characters, see |option-backslash| about
6508 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006509 To set this option automatically depending on the language, see
6510 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006511
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006512 *'spellfile'* *'spf'*
6513'spellfile' 'spf' string (default empty)
6514 local to buffer
6515 {not in Vi}
6516 {not available when compiled without the |+syntax|
6517 feature}
6518 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006519 commands. It must end in ".{encoding}.add". You need to include the
6520 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006521 *E765*
6522 It may also be a comma separated list of names. A count before the
6523 |zg| and |zw| commands can be used to access each. This allows using
6524 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006525 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006526 you: Using the first directory in 'runtimepath' that is writable. If
6527 there is no "spell" directory yet it will be created. For the file
6528 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006529 ignoring the region.
6530 The resulting ".spl" file will be used for spell checking, it does not
6531 have to appear in 'spelllang'.
6532 Normally one file is used for all regions, but you can add the region
6533 name if you want to. However, it will then only be used when
6534 'spellfile' is set to it, for entries in 'spelllang' only files
6535 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006536 This option cannot be set from a |modeline| or in the |sandbox|, for
6537 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006538
Bram Moolenaar217ad922005-03-20 22:37:15 +00006539 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006540'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006541 local to buffer
6542 {not in Vi}
6543 {not available when compiled without the |+syntax|
6544 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006545 A comma separated list of word list names. When the 'spell' option is
6546 on spellchecking will be done for these languages. Example: >
6547 set spelllang=en_us,nl,medical
6548< This means US English, Dutch and medical words are recognized. Words
6549 that are not recognized will be highlighted.
6550 The word list name must not include a comma or dot. Using a dash is
6551 recommended to separate the two letter language name from a
6552 specification. Thus "en-rare" is used for rare English words.
6553 A region name must come last and have the form "_xx", where "xx" is
6554 the two-letter, lower case region name. You can use more than one
6555 region by listing them: "en_us,en_ca" supports both US and Canadian
6556 English, but not words specific for Australia, New Zealand or Great
6557 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006558 If the name "cjk" is included East Asian characters are excluded from
6559 spell checking. This is useful when editing text that also has Asian
6560 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006561 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006562 As a special case the name of a .spl file can be given as-is. The
6563 first "_xx" in the name is removed and used as the region name
6564 (_xx is an underscore, two letters and followed by a non-letter).
6565 This is mainly for testing purposes. You must make sure the correct
6566 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006567 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006568 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6569 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006570 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006571
Bram Moolenaar98692072006-02-04 00:57:42 +00006572 If the |spellfile.vim| plugin is active and you use a language name
6573 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6574 will ask you if you want to download the file.
6575
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006576 After this option has been set successfully, Vim will source the files
6577 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006578 up to the first comma, dot or underscore.
6579 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006580
6581
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006582 *'spellsuggest'* *'sps'*
6583'spellsuggest' 'sps' string (default "best")
6584 global
6585 {not in Vi}
6586 {not available when compiled without the |+syntax|
6587 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006588 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006589 the |spellsuggest()| function. This is a comma-separated list of
6590 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006591
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006592 best Internal method that works best for English. Finds
6593 changes like "fast" and uses a bit of sound-a-like
6594 scoring to improve the ordering.
6595
6596 double Internal method that uses two methods and mixes the
6597 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006598 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006599 word. That only works when the language specifies
6600 sound folding. Can be slow and doesn't always give
6601 better results.
6602
6603 fast Internal method that only checks for simple changes:
6604 character inserts/deletes/swaps. Works well for
6605 simple typing mistakes.
6606
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006607 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006608 Not used for |spellsuggest()|. The number of
6609 suggestions is never more than the value of 'lines'
6610 minus two.
6611
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006612 file:{filename} Read file {filename}, which must have two columns,
6613 separated by a slash. The first column contains the
6614 bad word, the second column the suggested good word.
6615 Example:
6616 theribal/terrible ~
6617 Use this for common mistakes that do not appear at the
6618 top of the suggestion list with the internal methods.
6619 Lines without a slash are ignored, use this for
6620 comments.
6621 The file is used for all languages.
6622
6623 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6624 trouble with spaces. |v:val| holds the badly spelled
6625 word. The expression must evaluate to a List of
6626 Lists, each with a suggestion and a score.
6627 Example:
6628 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006629 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006630 internal methods use. A lower score is better.
6631 This may invoke |spellsuggest()| if you temporarily
6632 set 'spellsuggest' to exclude the "expr:" part.
6633 Errors are silently ignored, unless you set the
6634 'verbose' option to a non-zero value.
6635
6636 Only one of "best", "double" or "fast" may be used. The others may
6637 appear several times in any order. Example: >
6638 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6639<
6640 This option cannot be set from a |modeline| or in the |sandbox|, for
6641 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006642
6643
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6645'splitbelow' 'sb' boolean (default off)
6646 global
6647 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006648 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 feature}
6650 When on, splitting a window will put the new window below the current
6651 one. |:split|
6652
6653 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6654'splitright' 'spr' boolean (default off)
6655 global
6656 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006657 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 feature}
6659 When on, splitting a window will put the new window right of the
6660 current one. |:vsplit|
6661
6662 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6663'startofline' 'sol' boolean (default on)
6664 global
6665 {not in Vi}
6666 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006667 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006668 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006669 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 with a linewise operator, with "%" with a count and to buffer changing
6671 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6672 only has a line number, e.g., ":25" or ":+".
6673 In case of buffer changing commands the cursor is placed at the column
6674 where it was the last time the buffer was edited.
6675 NOTE: This option is set when 'compatible' is set.
6676
Bram Moolenaar00654022011-02-25 14:42:19 +01006677 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006679 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 {not in Vi}
6681 {not available when compiled without the |+statusline|
6682 feature}
6683 When nonempty, this option determines the content of the status line.
6684 Also see |status-line|.
6685
6686 The option consists of printf style '%' items interspersed with
6687 normal text. Each status line item is of the form:
6688 %-0{minwid}.{maxwid}{item}
6689 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006690 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691
Bram Moolenaar238a5642006-02-21 22:12:05 +00006692 When the option starts with "%!" then it is used as an expression,
6693 evaluated and the result is used as the option value. Example: >
6694 :set statusline=%!MyStatusLine()
6695< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006696 Note that the "%!" expression is evaluated in the context of the
6697 current window and buffer, while %{} items are evaluated in the
6698 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006699
6700 When there is error while evaluating the option then it will be made
6701 empty to avoid further errors. Otherwise screen updating would loop.
6702
Bram Moolenaar071d4272004-06-13 20:20:40 +00006703 Note that the only effect of 'ruler' when this option is set (and
6704 'laststatus' is 2) is controlling the output of |CTRL-G|.
6705
6706 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006707 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006709 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 minwid Minimum width of the item, padding as set by '-' & '0'.
6711 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006712 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 on the left for text items. Numeric items will be
6714 shifted down to maxwid-2 digits followed by '>'number
6715 where number is the amount of missing digits, much like
6716 an exponential notation.
6717 item A one letter code as described below.
6718
6719 Following is a description of the possible statusline items. The
6720 second character in "item" is the type:
6721 N for number
6722 S for string
6723 F for flags as described below
6724 - not applicable
6725
6726 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006727 f S Path to the file in the buffer, as typed or relative to current
6728 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 F S Full path to the file in the buffer.
6730 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006731 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006733 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006735 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006737 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006739 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006740 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6741 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006742 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6744 being used: "<keymap>"
6745 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006746 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 B N As above, in hexadecimal.
6748 o N Byte number in file of byte under cursor, first byte is 1.
6749 Mnemonic: Offset from start of file (with one added)
6750 {not available when compiled without |+byte_offset| feature}
6751 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006752 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 l N Line number.
6754 L N Number of lines in buffer.
6755 c N Column number.
6756 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006757 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 p N Percentage through file in lines as in |CTRL-G|.
6759 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006760 percentage described for 'ruler'. Always 3 in length, unless
6761 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006762 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006764 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006765 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 ( - Start of item group. Can be used for setting the width and
6767 alignment of a section. Must be followed by %) somewhere.
6768 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006769 T N For 'tabline': start of tab page N label. Use %T after the last
6770 label. This information is used for mouse clicks.
6771 X N For 'tabline': start of close tab N label. Use %X after the
6772 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6773 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 < - Where to truncate line if too long. Default is at the start.
6775 No width fields allowed.
6776 = - Separation point between left and right aligned items.
6777 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006778 # - Set highlight group. The name must follow and then a # again.
6779 Thus use %#HLname# for highlight group HLname. The same
6780 highlighting is used, also for the statusline of non-current
6781 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006783 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 The difference between User{N} and StatusLine will be applied
6785 to StatusLineNC for the statusline of non-current windows.
6786 The number N must be between 1 and 9. See |hl-User1..9|
6787
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006788 When displaying a flag, Vim removes the leading comma, if any, when
6789 that flag comes right after plaintext. This will make a nice display
6790 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791
Bram Moolenaar582fd852005-03-28 20:58:01 +00006792 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 not set) and a minwid is not set for the group, the whole group will
6794 become empty. This will make a group like the following disappear
6795 completely from the statusline when none of the flags are set. >
6796 :set statusline=...%(\ [%M%R%H]%)...
6797<
6798 Beware that an expression is evaluated each and every time the status
6799 line is displayed. The current buffer and current window will be set
6800 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006801 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006803 real current buffer.
6804
Bram Moolenaar30b65812012-07-12 22:01:11 +02006805 The 'statusline' option will be evaluated in the |sandbox| if set from
6806 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006807
6808 It is not allowed to change text or jump to another window while
6809 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
6811 If the statusline is not updated when you want it (e.g., after setting
6812 a variable that's used in an expression), you can force an update by
6813 setting an option without changing its value. Example: >
6814 :let &ro = &ro
6815
6816< A result of all digits is regarded a number for display purposes.
6817 Otherwise the result is taken as flag text and applied to the rules
6818 described above.
6819
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006820 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6822 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6823
6824 Examples:
6825 Emulate standard status line with 'ruler' set >
6826 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6827< Similar, but add ASCII value of char under the cursor (like "ga") >
6828 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6829< Display byte count and byte value, modified flag in red. >
6830 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6831 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6832< Display a ,GZ flag if a compressed file is loaded >
6833 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6834< In the |:autocmd|'s: >
6835 :let b:gzflag = 1
6836< And: >
6837 :unlet b:gzflag
6838< And define this function: >
6839 :function VarExists(var, val)
6840 : if exists(a:var) | return a:val | else | return '' | endif
6841 :endfunction
6842<
6843 *'suffixes'* *'su'*
6844'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6845 global
6846 {not in Vi}
6847 Files with these suffixes get a lower priority when multiple files
6848 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006849 suffixes. Spaces after the comma are ignored. A dot is also seen as
6850 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 separator, precede it with a backslash (see |option-backslash| about
6852 including spaces and backslashes).
6853 See 'wildignore' for completely ignoring files.
6854 The use of |:set+=| and |:set-=| is preferred when adding or removing
6855 suffixes from the list. This avoids problems when a future version
6856 uses another default.
6857
6858 *'suffixesadd'* *'sua'*
6859'suffixesadd' 'sua' string (default "")
6860 local to buffer
6861 {not in Vi}
6862 {not available when compiled without the
6863 |+file_in_path| feature}
6864 Comma separated list of suffixes, which are used when searching for a
6865 file for the "gf", "[I", etc. commands. Example: >
6866 :set suffixesadd=.java
6867<
6868 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6869'swapfile' 'swf' boolean (default on)
6870 local to buffer
6871 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006872 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 swapfile is not wanted for a specific buffer. For example, with
6874 confidential information that even root must not be able to access.
6875 Careful: All text will be in memory:
6876 - Don't use this for big files.
6877 - Recovery will be impossible!
6878 A swapfile will only be present when |'updatecount'| is non-zero and
6879 'swapfile' is set.
6880 When 'swapfile' is reset, the swap file for the current buffer is
6881 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6882 non-zero, a swap file is immediately created.
6883 Also see |swap-file| and |'swapsync'|.
6884
6885 This option is used together with 'bufhidden' and 'buftype' to
6886 specify special kinds of buffers. See |special-buffers|.
6887
6888 *'swapsync'* *'sws'*
6889'swapsync' 'sws' string (default "fsync")
6890 global
6891 {not in Vi}
6892 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006893 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 When this option is empty parts of the swap file may be in memory and
6895 not written to disk. When the system crashes you may lose more work.
6896 On Unix the system does a sync now and then without Vim asking for it,
6897 so the disadvantage of setting this option off is small. On some
6898 systems the swap file will not be written at all. For a unix system
6899 setting it to "sync" will use the sync() call instead of the default
6900 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006901 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902
6903 *'switchbuf'* *'swb'*
6904'switchbuf' 'swb' string (default "")
6905 global
6906 {not in Vi}
6907 This option controls the behavior when switching between buffers.
6908 Possible values (comma separated list):
6909 useopen If included, jump to the first open window that
6910 contains the specified buffer (if there is one).
6911 Otherwise: Do not examine other windows.
6912 This setting is checked with |quickfix| commands, when
6913 jumping to errors (":cc", ":cn", "cp", etc.). It is
6914 also used in all buffer related split commands, for
6915 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006916 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006917 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006919 a buffer for a |quickfix| command that display errors.
6920 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006921 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006922 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006924 *'synmaxcol'* *'smc'*
6925'synmaxcol' 'smc' number (default 3000)
6926 local to buffer
6927 {not in Vi}
6928 {not available when compiled without the |+syntax|
6929 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006930 Maximum column in which to search for syntax items. In long lines the
6931 text after this column is not highlighted and following lines may not
6932 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006933 This helps to avoid very slow redrawing for an XML file that is one
6934 long line.
6935 Set to zero to remove the limit.
6936
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 *'syntax'* *'syn'*
6938'syntax' 'syn' string (default empty)
6939 local to buffer
6940 {not in Vi}
6941 {not available when compiled without the |+syntax|
6942 feature}
6943 When this option is set, the syntax with this name is loaded, unless
6944 syntax highlighting has been switched off with ":syntax off".
6945 Otherwise this option does not always reflect the current syntax (the
6946 b:current_syntax variable does).
6947 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006948 not automatically recognized. Example, in an IDL file:
6949 /* vim: set syntax=idl : */ ~
6950 When a dot appears in the value then this separates two filetype
6951 names. Example:
6952 /* vim: set syntax=c.doxygen : */ ~
6953 This will use the "c" syntax first, then the "doxygen" syntax.
6954 Note that the second one must be prepared to be loaded as an addition,
6955 otherwise it will be skipped. More than one dot may appear.
6956 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 :set syntax=OFF
6958< To switch syntax highlighting on according to the current value of the
6959 'filetype' option: >
6960 :set syntax=ON
6961< What actually happens when setting the 'syntax' option is that the
6962 Syntax autocommand event is triggered with the value as argument.
6963 This option is not copied to another buffer, independent of the 's' or
6964 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006965 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006967 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006968'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006969 global
6970 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006971 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006972 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006973 When nonempty, this option determines the content of the tab pages
6974 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006975 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006976
6977 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006978 option and only when there is no GUI tab line. When 'e' is in
6979 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006980 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006981
6982 The value is evaluated like with 'statusline'. You can use
6983 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006984 the text to be displayed. Use "%1T" for the first label, "%2T" for
6985 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006986
6987 Keep in mind that only one of the tab pages is the current one, others
6988 are invisible and you can't jump to their windows.
6989
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006990
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006991 *'tabpagemax'* *'tpm'*
6992'tabpagemax' 'tpm' number (default 10)
6993 global
6994 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006995 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006996 feature}
6997 Maximum number of tab pages to be opened by the |-p| command line
6998 argument or the ":tab all" command. |tabpage|
6999
7000
7001 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002'tabstop' 'ts' number (default 8)
7003 local to buffer
7004 Number of spaces that a <Tab> in the file counts for. Also see
7005 |:retab| command, and 'softtabstop' option.
7006
7007 Note: Setting 'tabstop' to any other value than 8 can make your file
7008 appear wrong in many places (e.g., when printing it).
7009
7010 There are four main ways to use tabs in Vim:
7011 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7012 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007013 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 behave like a tab appears every 4 (or 3) characters.
7015 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7016 'expandtab'. This way you will always insert spaces. The
7017 formatting will never be messed up when 'tabstop' is changed.
7018 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007019 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 works when using Vim to edit the file.
7021 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7022 'noexpandtab'. This should then work (for initial indents only)
7023 for any tabstop setting that people use. It might be nice to have
7024 tabs after the first non-blank inserted as spaces if you do this
7025 though. Otherwise aligned comments will be wrong when 'tabstop' is
7026 changed.
7027
7028 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7029'tagbsearch' 'tbs' boolean (default on)
7030 global
7031 {not in Vi}
7032 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 searching makes searching for a tag a LOT faster, but a linear search
7035 will find more tags if the tags file wasn't properly sorted.
7036 Vim normally assumes that your tags files are sorted, or indicate that
7037 they are not sorted. Only when this is not the case does the
7038 'tagbsearch' option need to be switched off.
7039
7040 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007041 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 certain files, or retry all files with a linear search. When
7043 'tagbsearch' is off, only a linear search is done.
7044
7045 Linear searching is done anyway, for one file, when Vim finds a line
7046 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007047 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048< [The whitespace before and after the '0' must be a single <Tab>]
7049
7050 When a binary search was done and no match was found in any of the
7051 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7052 instead of a normal tag name, a retry is done with a linear search.
7053 Tags in unsorted tags files, and matches with different case will only
7054 be found in the retry.
7055
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007056 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007057 linear search can be avoided for the 'ignorecase' case. Use a value
7058 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7059 case-fold sorted with the -f switch to "sort" in most unices, as in
7060 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007061 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7062 for this as well. Note that case must be folded to uppercase for this
7063 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064
7065 When 'tagbsearch' is off, tags searching is slower when a full match
7066 exists, but faster when no full match exists. Tags in unsorted tags
7067 files may only be found with 'tagbsearch' off.
7068 When the tags file is not sorted, or sorted in a wrong way (not on
7069 ASCII byte value), 'tagbsearch' should be off, or the line given above
7070 must be included in the tags file.
7071 This option doesn't affect commands that find all matching tags (e.g.,
7072 command-line completion and ":help").
7073 {Vi: always uses binary search in some versions}
7074
7075 *'taglength'* *'tl'*
7076'taglength' 'tl' number (default 0)
7077 global
7078 If non-zero, tags are significant up to this number of characters.
7079
7080 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7081'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7082 global
7083 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007084 If on and using a tags file in another directory, file names in that
7085 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 NOTE: This option is set to the Vi default value when 'compatible' is
7087 set and to the Vim default value when 'compatible' is reset.
7088
7089 *'tags'* *'tag'* *E433*
7090'tags' 'tag' string (default "./tags,tags", when compiled with
7091 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7092 global or local to buffer |global-local|
7093 Filenames for the tag command, separated by spaces or commas. To
7094 include a space or comma in a file name, precede it with a backslash
7095 (see |option-backslash| about including spaces and backslashes).
7096 When a file name starts with "./", the '.' is replaced with the path
7097 of the current file. But only when the 'd' flag is not included in
7098 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7099 |tags-option|.
7100 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007101 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7102 find all files named "tags" below "/lib". The filename itself cannot
7103 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7104 files called "tags?". {not available when compiled without the
7105 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007106 The |tagfiles()| function can be used to get a list of the file names
7107 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007108 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7109 files are also supported. They are automatically recognized. The
7110 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7111 differences are ignored (MS-Windows). |emacs-tags|
7112 The use of |:set+=| and |:set-=| is preferred when adding or removing
7113 file names from the list. This avoids problems when a future version
7114 uses another default.
7115 {Vi: default is "tags /usr/lib/tags"}
7116
7117 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7118'tagstack' 'tgst' boolean (default on)
7119 global
7120 {not in all versions of Vi}
7121 When on, the |tagstack| is used normally. When off, a ":tag" or
7122 ":tselect" command with an argument will not push the tag onto the
7123 tagstack. A following ":tag" without an argument, a ":pop" command or
7124 any other command that uses the tagstack will use the unmodified
7125 tagstack, but does change the pointer to the active entry.
7126 Resetting this option is useful when using a ":tag" command in a
7127 mapping which should not change the tagstack.
7128
7129 *'term'* *E529* *E530* *E531*
7130'term' string (default is $TERM, if that fails:
7131 in the GUI: "builtin_gui"
7132 on Amiga: "amiga"
7133 on BeOS: "beos-ansi"
7134 on Mac: "mac-ansi"
7135 on MiNT: "vt52"
7136 on MS-DOS: "pcterm"
7137 on OS/2: "os2ansi"
7138 on Unix: "ansi"
7139 on VMS: "ansi"
7140 on Win 32: "win32")
7141 global
7142 Name of the terminal. Used for choosing the terminal control
7143 characters. Environment variables are expanded |:set_env|.
7144 For example: >
7145 :set term=$TERM
7146< See |termcap|.
7147
7148 *'termbidi'* *'tbidi'*
7149 *'notermbidi'* *'notbidi'*
7150'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7151 global
7152 {not in Vi}
7153 {only available when compiled with the |+arabic|
7154 feature}
7155 The terminal is in charge of Bi-directionality of text (as specified
7156 by Unicode). The terminal is also expected to do the required shaping
7157 that some languages (such as Arabic) require.
7158 Setting this option implies that 'rightleft' will not be set when
7159 'arabic' is set and the value of 'arabicshape' will be ignored.
7160 Note that setting 'termbidi' has the immediate effect that
7161 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7162 This option is reset when the GUI is started.
7163 For further details see |arabic.txt|.
7164
7165 *'termencoding'* *'tenc'*
7166'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7167 Macintosh GUI: "macroman")
7168 global
7169 {only available when compiled with the |+multi_byte|
7170 feature}
7171 {not in Vi}
7172 Encoding used for the terminal. This specifies what character
7173 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007174 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007175 display). Except for the Mac when 'macatsui' is off, then
7176 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 In the Win32 console version the default value is the console codepage
7178 when it differs from the ANSI codepage.
7179 *E617*
7180 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7181 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7182 Any attempts to set a different value will be rejected, and an error
7183 message is shown.
7184 For the Win32 GUI 'termencoding' is not used for typed characters,
7185 because the Win32 system always passes Unicode characters.
7186 When empty, the same encoding is used as for the 'encoding' option.
7187 This is the normal value.
7188 Not all combinations for 'termencoding' and 'encoding' are valid. See
7189 |encoding-table|.
7190 The value for this option must be supported by internal conversions or
7191 iconv(). When this is not possible no conversion will be done and you
7192 will probably experience problems with non-ASCII characters.
7193 Example: You are working with the locale set to euc-jp (Japanese) and
7194 want to edit a UTF-8 file: >
7195 :let &termencoding = &encoding
7196 :set encoding=utf-8
7197< You need to do this when your system has no locale support for UTF-8.
7198
7199 *'terse'* *'noterse'*
7200'terse' boolean (default off)
7201 global
7202 When set: Add 's' flag to 'shortmess' option (this makes the message
7203 for a search that hits the start or end of the file not being
7204 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7205 shortens a lot of messages}
7206
7207 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7208'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7209 global
7210 {not in Vi}
7211 This option is obsolete. Use 'fileformats'.
7212 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7213 set to the default value for the current system. When 'textauto' is
7214 reset, 'fileformats' is made empty.
7215 NOTE: This option is set to the Vi default value when 'compatible' is
7216 set and to the Vim default value when 'compatible' is reset.
7217
7218 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7219'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7220 others: default off)
7221 local to buffer
7222 {not in Vi}
7223 This option is obsolete. Use 'fileformat'.
7224 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7225 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7226 "unix".
7227
7228 *'textwidth'* *'tw'*
7229'textwidth' 'tw' number (default 0)
7230 local to buffer
7231 {not in Vi}
7232 Maximum width of text that is being inserted. A longer line will be
7233 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007234 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7235 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007237 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 NOTE: This option is set to 0 when 'compatible' is set.
7239
7240 *'thesaurus'* *'tsr'*
7241'thesaurus' 'tsr' string (default "")
7242 global or local to buffer |global-local|
7243 {not in Vi}
7244 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007245 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 the file should contain words with similar meaning, separated by
7247 non-keyword characters (white space is preferred). Maximum line
7248 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007249 To obtain a file to be used here, check out this ftp site:
7250 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007251 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 after a comma are ignored, otherwise spaces are included in the file
7253 name. See |option-backslash| about using backslashes.
7254 The use of |:set+=| and |:set-=| is preferred when adding or removing
7255 directories from the list. This avoids problems when a future version
7256 uses another default.
7257 Backticks cannot be used in this option for security reasons.
7258
7259 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7260'tildeop' 'top' boolean (default off)
7261 global
7262 {not in Vi}
7263 When on: The tilde command "~" behaves like an operator.
7264 NOTE: This option is reset when 'compatible' is set.
7265
7266 *'timeout'* *'to'* *'notimeout'* *'noto'*
7267'timeout' 'to' boolean (default on)
7268 global
7269 *'ttimeout'* *'nottimeout'*
7270'ttimeout' boolean (default off)
7271 global
7272 {not in Vi}
7273 These two options together determine the behavior when part of a
7274 mapped key sequence or keyboard code has been received:
7275
7276 'timeout' 'ttimeout' action ~
7277 off off do not time out
7278 on on or off time out on :mappings and key codes
7279 off on time out on key codes
7280
7281 If both options are off, Vim will wait until either the complete
7282 mapping or key sequence has been received, or it is clear that there
7283 is no mapping or key sequence for the received characters. For
7284 example: if you have mapped "vl" and Vim has received 'v', the next
7285 character is needed to see if the 'v' is followed by an 'l'.
7286 When one of the options is on, Vim will wait for about 1 second for
7287 the next character to arrive. After that the already received
7288 characters are interpreted as single characters. The waiting time can
7289 be changed with the 'timeoutlen' option.
7290 On slow terminals or very busy systems timing out may cause
7291 malfunctioning cursor keys. If both options are off, Vim waits
7292 forever after an entered <Esc> if there are key codes that start
7293 with <Esc>. You will have to type <Esc> twice. If you do not have
7294 problems with key codes, but would like to have :mapped key
7295 sequences not timing out in 1 second, set the 'ttimeout' option and
7296 reset the 'timeout' option.
7297
7298 NOTE: 'ttimeout' is reset when 'compatible' is set.
7299
7300 *'timeoutlen'* *'tm'*
7301'timeoutlen' 'tm' number (default 1000)
7302 global
7303 {not in all versions of Vi}
7304 *'ttimeoutlen'* *'ttm'*
7305'ttimeoutlen' 'ttm' number (default -1)
7306 global
7307 {not in Vi}
7308 The time in milliseconds that is waited for a key code or mapped key
7309 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7310 when part of a command has been typed.
7311 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7312 different timeout value for key codes is desired set 'ttimeoutlen' to
7313 a non-negative number.
7314
7315 ttimeoutlen mapping delay key code delay ~
7316 < 0 'timeoutlen' 'timeoutlen'
7317 >= 0 'timeoutlen' 'ttimeoutlen'
7318
7319 The timeout only happens when the 'timeout' and 'ttimeout' options
7320 tell so. A useful setting would be >
7321 :set timeout timeoutlen=3000 ttimeoutlen=100
7322< (time out on mapping after three seconds, time out on key codes after
7323 a tenth of a second).
7324
7325 *'title'* *'notitle'*
7326'title' boolean (default off, on when title can be restored)
7327 global
7328 {not in Vi}
7329 {not available when compiled without the |+title|
7330 feature}
7331 When on, the title of the window will be set to the value of
7332 'titlestring' (if it is not empty), or to:
7333 filename [+=-] (path) - VIM
7334 Where:
7335 filename the name of the file being edited
7336 - indicates the file cannot be modified, 'ma' off
7337 + indicates the file was modified
7338 = indicates the file is read-only
7339 =+ indicates the file is read-only and modified
7340 (path) is the path of the file being edited
7341 - VIM the server name |v:servername| or "VIM"
7342 Only works if the terminal supports setting window titles
7343 (currently Amiga console, Win32 console, all GUI versions and
7344 terminals with a non- empty 't_ts' option - these are Unix xterm and
7345 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7346 *X11*
7347 When Vim was compiled with HAVE_X11 defined, the original title will
7348 be restored if possible. The output of ":version" will include "+X11"
7349 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7350 works for the icon name |'icon'|.
7351 But: When Vim was started with the |-X| argument, restoring the title
7352 will not work (except in the GUI).
7353 If the title cannot be restored, it is set to the value of 'titleold'.
7354 You might want to restore the title outside of Vim then.
7355 When using an xterm from a remote machine you can use this command:
7356 rsh machine_name xterm -display $DISPLAY &
7357 then the WINDOWID environment variable should be inherited and the
7358 title of the window should change back to what it should be after
7359 exiting Vim.
7360
7361 *'titlelen'*
7362'titlelen' number (default 85)
7363 global
7364 {not in Vi}
7365 {not available when compiled without the |+title|
7366 feature}
7367 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007368 title. When the title is longer, only the end of the path name is
7369 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 Using a percentage makes this adapt to the width of the window. But
7371 it won't work perfectly, because the actual number of characters
7372 available also depends on the font used and other things in the title
7373 bar. When 'titlelen' is zero the full path is used. Otherwise,
7374 values from 1 to 30000 percent can be used.
7375 'titlelen' is also used for the 'titlestring' option.
7376
7377 *'titleold'*
7378'titleold' string (default "Thanks for flying Vim")
7379 global
7380 {not in Vi}
7381 {only available when compiled with the |+title|
7382 feature}
7383 This option will be used for the window title when exiting Vim if the
7384 original title cannot be restored. Only happens if 'title' is on or
7385 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007386 This option cannot be set from a |modeline| or in the |sandbox|, for
7387 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 *'titlestring'*
7389'titlestring' string (default "")
7390 global
7391 {not in Vi}
7392 {not available when compiled without the |+title|
7393 feature}
7394 When this option is not empty, it will be used for the title of the
7395 window. This happens only when the 'title' option is on.
7396 Only works if the terminal supports setting window titles (currently
7397 Amiga console, Win32 console, all GUI versions and terminals with a
7398 non-empty 't_ts' option).
7399 When Vim was compiled with HAVE_X11 defined, the original title will
7400 be restored if possible |X11|.
7401 When this option contains printf-style '%' items, they will be
7402 expanded according to the rules used for 'statusline'.
7403 Example: >
7404 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7405 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7406< The value of 'titlelen' is used to align items in the middle or right
7407 of the available space.
7408 Some people prefer to have the file name first: >
7409 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7410< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007411 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 separating space only when needed.
7413 NOTE: Use of special characters in 'titlestring' may cause the display
7414 to be garbled (e.g., when it contains a CR or NL character).
7415 {not available when compiled without the |+statusline| feature}
7416
7417 *'toolbar'* *'tb'*
7418'toolbar' 'tb' string (default "icons,tooltips")
7419 global
7420 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7421 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007422 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007423 possible values are:
7424 icons Toolbar buttons are shown with icons.
7425 text Toolbar buttons shown with text.
7426 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007427 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 tooltips Tooltips are active for toolbar buttons.
7429 Tooltips refer to the popup help text which appears after the mouse
7430 cursor is placed over a toolbar button for a brief moment.
7431
7432 If you want the toolbar to be shown with icons as well as text, do the
7433 following: >
7434 :set tb=icons,text
7435< Motif and Athena cannot display icons and text at the same time. They
7436 will show icons if both are requested.
7437
7438 If none of the strings specified in 'toolbar' are valid or if
7439 'toolbar' is empty, this option is ignored. If you want to disable
7440 the toolbar, you need to set the 'guioptions' option. For example: >
7441 :set guioptions-=T
7442< Also see |gui-toolbar|.
7443
7444 *'toolbariconsize'* *'tbis'*
7445'toolbariconsize' 'tbis' string (default "small")
7446 global
7447 {not in Vi}
7448 {only in the GTK+ 2 GUI}
7449 Controls the size of toolbar icons. The possible values are:
7450 tiny Use tiny toolbar icons.
7451 small Use small toolbar icons (default).
7452 medium Use medium-sized toolbar icons.
7453 large Use large toolbar icons.
7454 The exact dimensions in pixels of the various icon sizes depend on
7455 the current theme. Common dimensions are large=32x32, medium=24x24,
7456 small=20x20 and tiny=16x16.
7457
7458 If 'toolbariconsize' is empty, the global default size as determined
7459 by user preferences or the current theme is used.
7460
7461 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7462'ttybuiltin' 'tbi' boolean (default on)
7463 global
7464 {not in Vi}
7465 When on, the builtin termcaps are searched before the external ones.
7466 When off the builtin termcaps are searched after the external ones.
7467 When this option is changed, you should set the 'term' option next for
7468 the change to take effect, for example: >
7469 :set notbi term=$TERM
7470< See also |termcap|.
7471 Rationale: The default for this option is "on", because the builtin
7472 termcap entries are generally better (many systems contain faulty
7473 xterm entries...).
7474
7475 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7476'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7477 sun-cmd, screen, rxvt, dtterm or
7478 iris-ansi; also on when running Vim in
7479 a DOS console)
7480 global
7481 {not in Vi}
7482 Indicates a fast terminal connection. More characters will be sent to
7483 the screen for redrawing, instead of using insert/delete line
7484 commands. Improves smoothness of redrawing when there are multiple
7485 windows and the terminal does not support a scrolling region.
7486 Also enables the extra writing of characters at the end of each screen
7487 line for lines that wrap. This helps when using copy/paste with the
7488 mouse in an xterm and other terminals.
7489
7490 *'ttymouse'* *'ttym'*
7491'ttymouse' 'ttym' string (default depends on 'term')
7492 global
7493 {not in Vi}
7494 {only in Unix and VMS, doesn't work in the GUI; not
7495 available when compiled without |+mouse|}
7496 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007497 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 *xterm-mouse*
7499 xterm xterm-like mouse handling. The mouse generates
7500 "<Esc>[Mscr", where "scr" is three bytes:
7501 "s" = button state
7502 "c" = column plus 33
7503 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007504 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007505 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 xterm2 Works like "xterm", but with the xterm reporting the
7507 mouse position while the mouse is dragged. This works
7508 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007509 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 work. See below for how Vim detects this
7511 automatically.
7512 *netterm-mouse*
7513 netterm NetTerm mouse handling. The mouse generates
7514 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7515 for the row and column.
7516 *dec-mouse*
7517 dec DEC terminal mouse handling. The mouse generates a
7518 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007519 This is also available for an Xterm, if it was
7520 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007521 *jsbterm-mouse*
7522 jsbterm JSB term mouse handling.
7523 *pterm-mouse*
7524 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007525 *urxvt-mouse*
7526 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar9b451252012-08-15 17:43:31 +02007527 *sgr-mouse*
7528 sgr Mouse handling for the terminal that emits SGR-styled
7529 mouse reporting. Works with xterm version 277 or
7530 later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531
7532 The mouse handling must be enabled at compile time |+mouse_xterm|
7533 |+mouse_dec| |+mouse_netterm|.
7534 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7535 recognized, if enabled at compile time. DEC terminal mouse codes
7536 are recognized if enabled at compile time, and 'ttymouse' is not
7537 "xterm" (because the xterm and dec mouse codes conflict).
7538 This option is automatically set to "xterm", when the 'term' option is
7539 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7540 or "xterm2" already. The main use of this option is to set it to
7541 "xterm", when the terminal name doesn't start with "xterm", but it can
7542 handle xterm mouse codes.
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02007543 The "sgr" value will be set if the xterm version is 277 or later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007545 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 feature and if |t_RV| is set to the escape sequence to request the
7547 xterm version number. Otherwise "xterm2" must be set explicitly.
7548 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7549 t_RV to an empty string: >
7550 :set t_RV=
7551<
7552 *'ttyscroll'* *'tsl'*
7553'ttyscroll' 'tsl' number (default 999)
7554 global
7555 Maximum number of lines to scroll the screen. If there are more lines
7556 to scroll the window is redrawn. For terminals where scrolling is
7557 very slow and redrawing is not slow this can be set to a small number,
7558 e.g., 3, to speed up displaying.
7559
7560 *'ttytype'* *'tty'*
7561'ttytype' 'tty' string (default from $TERM)
7562 global
7563 Alias for 'term', see above.
7564
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007565 *'undodir'* *'udir'*
7566'undodir' 'udir' string (default ".")
7567 global
7568 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007569 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007570 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007571 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007572 "." means using the directory of the file. The undo file name for
7573 "file.txt" is ".file.txt.un~".
7574 For other directories the file name is the full path of the edited
7575 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007576 When writing: The first directory that exists is used. "." always
7577 works, no directories after "." will be used for writing.
7578 When reading all entries are tried to find an undo file. The first
7579 undo file that exists is used. When it cannot be read an error is
7580 given, no further entry is used.
7581 See |undo-persistence|.
7582
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007583 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007584'undofile' 'udf' boolean (default off)
7585 local to buffer
7586 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007587 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007588 When on, Vim automatically saves undo history to an undo file when
7589 writing a buffer to a file, and restores undo history from the same
7590 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007591 The directory where the undo file is stored is specified by 'undodir'.
7592 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007593 The undo file is not read when 'undoreload' causes the buffer from
7594 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007595 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007596
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 *'undolevels'* *'ul'*
7598'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7599 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007600 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 {not in Vi}
7602 Maximum number of changes that can be undone. Since undo information
7603 is kept in memory, higher numbers will cause more memory to be used
7604 (nevertheless, a single change can use an unlimited amount of memory).
7605 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7606 itself: >
7607 set ul=0
7608< But you can also get Vi compatibility by including the 'u' flag in
7609 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007610 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007611 Set to -1 for no undo at all. You might want to do this only for the
7612 current buffer: >
7613 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007615 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007617 *'undoreload'* *'ur'*
7618'undoreload' 'ur' number (default 10000)
7619 global
7620 {not in Vi}
7621 Save the whole buffer for undo when reloading it. This applies to the
7622 ":e!" command and reloading for when the buffer changed outside of
7623 Vim. |FileChangedShell|
7624 The save only happens when this options is negative or when the number
7625 of lines is smaller than the value of this option.
7626 Set this option to zero to disable undo for a reload.
7627
7628 When saving undo for a reload, any undo file is not read.
7629
7630 Note that this causes the whole buffer to be stored in memory. Set
7631 this option to a lower value if you run out of memory.
7632
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 *'updatecount'* *'uc'*
7634'updatecount' 'uc' number (default: 200)
7635 global
7636 {not in Vi}
7637 After typing this many characters the swap file will be written to
7638 disk. When zero, no swap file will be created at all (see chapter on
7639 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7640 Vim with the "-n" option, see |startup|. When editing in readonly
7641 mode this option will be initialized to 10000.
7642 The swapfile can be disabled per buffer with |'swapfile'|.
7643 When 'updatecount' is set from zero to non-zero, swap files are
7644 created for all buffers that have 'swapfile' set. When 'updatecount'
7645 is set to zero, existing swap files are not deleted.
7646 Also see |'swapsync'|.
7647 This option has no meaning in buffers where |'buftype'| is "nofile"
7648 or "nowrite".
7649
7650 *'updatetime'* *'ut'*
7651'updatetime' 'ut' number (default 4000)
7652 global
7653 {not in Vi}
7654 If this many milliseconds nothing is typed the swap file will be
7655 written to disk (see |crash-recovery|). Also used for the
7656 |CursorHold| autocommand event.
7657
7658 *'verbose'* *'vbs'*
7659'verbose' 'vbs' number (default 0)
7660 global
7661 {not in Vi, although some versions have a boolean
7662 verbose option}
7663 When bigger than zero, Vim will give messages about what it is doing.
7664 Currently, these messages are given:
7665 >= 1 When the viminfo file is read or written.
7666 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007667 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 >= 8 Files for which a group of autocommands is executed.
7669 >= 9 Every executed autocommand.
7670 >= 12 Every executed function.
7671 >= 13 When an exception is thrown, caught, finished, or discarded.
7672 >= 14 Anything pending in a ":finally" clause.
7673 >= 15 Every executed Ex command (truncated at 200 characters).
7674
7675 This option can also be set with the "-V" argument. See |-V|.
7676 This option is also set by the |:verbose| command.
7677
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007678 When the 'verbosefile' option is set then the verbose messages are not
7679 displayed.
7680
7681 *'verbosefile'* *'vfile'*
7682'verbosefile' 'vfile' string (default empty)
7683 global
7684 {not in Vi}
7685 When not empty all messages are written in a file with this name.
7686 When the file exists messages are appended.
7687 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007688 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007689 Setting 'verbosefile' to a new value is like making it empty first.
7690 The difference with |:redir| is that verbose messages are not
7691 displayed when 'verbosefile' is set.
7692
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 *'viewdir'* *'vdir'*
7694'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7695 "$VIM/vimfiles/view",
7696 for Unix: "~/.vim/view",
7697 for Macintosh: "$VIM:vimfiles:view"
7698 for VMS: "sys$login:vimfiles/view"
7699 for RiscOS: "Choices:vimfiles/view")
7700 global
7701 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007702 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 feature}
7704 Name of the directory where to store files for |:mkview|.
7705 This option cannot be set from a |modeline| or in the |sandbox|, for
7706 security reasons.
7707
7708 *'viewoptions'* *'vop'*
7709'viewoptions' 'vop' string (default: "folds,options,cursor")
7710 global
7711 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007712 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 feature}
7714 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007715 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 word save and restore ~
7717 cursor cursor position in file and in window
7718 folds manually created folds, opened/closed folds and local
7719 fold options
7720 options options and mappings local to a window or buffer (not
7721 global values for local options)
7722 slash backslashes in file names replaced with forward
7723 slashes
7724 unix with Unix end-of-line format (single <NL>), even when
7725 on Windows or DOS
7726
7727 "slash" and "unix" are useful on Windows when sharing view files
7728 with Unix. The Unix version of Vim cannot source dos format scripts,
7729 but the Windows version of Vim can source unix format scripts.
7730
7731 *'viminfo'* *'vi'* *E526* *E527* *E528*
7732'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007733 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7734 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7735 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007736 global
7737 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007738 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 feature}
7740 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007741 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 separated list of parameters, each consisting of a single character
7743 identifying the particular parameter, followed by a number or string
7744 which specifies the value of that parameter. If a particular
7745 character is left out, then the default value is used for that
7746 parameter. The following is a list of the identifying characters and
7747 the effect of their value.
7748 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007749 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 ! When included, save and restore global variables that start
7751 with an uppercase letter, and don't contain a lowercase
7752 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007753 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007754 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007755 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007756 " Maximum number of lines saved for each register. Old name of
7757 the '<' item, with the disadvantage that you need to put a
7758 backslash before the ", otherwise it will be recognized as the
7759 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007760 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 % When included, save and restore the buffer list. If Vim is
7762 started with a file name argument, the buffer list is not
7763 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007764 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 without a file name and buffers for help files are not written
7766 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007767 When followed by a number, the number specifies the maximum
7768 number of buffers that are stored. Without a number all
7769 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007770 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 ' Maximum number of previously edited files for which the marks
7772 are remembered. This parameter must always be included when
7773 'viminfo' is non-empty.
7774 Including this item also means that the |jumplist| and the
7775 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007776 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007778 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 patterns are also saved. When not included, the value of
7780 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007781 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007783 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007784 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 < Maximum number of lines saved for each register. If zero then
7786 registers are not saved. When not included, all lines are
7787 saved. '"' is the old name for this item.
7788 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007789 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007790 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007791 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007792 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 c When included, convert the text in the viminfo file from the
7794 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007795 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007796 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007797 f Whether file marks need to be stored. If zero, file marks ('0
7798 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007799 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007801 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 h Disable the effect of 'hlsearch' when loading the viminfo
7803 file. When not included, it depends on whether ":nohlsearch"
7804 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007805 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007806 n Name of the viminfo file. The name must immediately follow
7807 the 'n'. Must be the last one! If the "-i" argument was
7808 given when starting Vim, that file name overrides the one
7809 given here with 'viminfo'. Environment variables are expanded
7810 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007811 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 r Removable media. The argument is a string (up to the next
7813 ','). This parameter can be given several times. Each
7814 specifies the start of a path for which no marks will be
7815 stored. This is to avoid removable media. For MS-DOS you
7816 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7817 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7818 ignored. Maximum length of each 'r' argument is 50
7819 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007820 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 s Maximum size of an item in Kbyte. If zero then registers are
7822 not saved. Currently only applies to registers. The default
7823 "s10" will exclude registers with more than 10 Kbyte of text.
7824 Also see the '<' item above: line count limit.
7825
7826 Example: >
7827 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7828<
7829 '50 Marks will be remembered for the last 50 files you
7830 edited.
7831 <1000 Contents of registers (up to 1000 lines each) will be
7832 remembered.
7833 s100 Registers with more than 100 Kbyte text are skipped.
7834 :0 Command-line history will not be saved.
7835 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7836 no / Since '/' is not specified, the default will be used,
7837 that is, save all of the search history, and also the
7838 previous search and substitute patterns.
7839 no % The buffer list will not be saved nor read back.
7840 no h 'hlsearch' highlighting will be restored.
7841
7842 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7843 load the contents of the file, this is not done automatically.
7844
7845 This option cannot be set from a |modeline| or in the |sandbox|, for
7846 security reasons.
7847
7848 *'virtualedit'* *'ve'*
7849'virtualedit' 've' string (default "")
7850 global
7851 {not in Vi}
7852 {not available when compiled without the
7853 |+virtualedit| feature}
7854 A comma separated list of these words:
7855 block Allow virtual editing in Visual block mode.
7856 insert Allow virtual editing in Insert mode.
7857 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007858 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007859
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007861 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 of the line. Useful for selecting a rectangle in Visual mode and
7863 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007864 "onemore" is not the same, it will only allow moving the cursor just
7865 after the last character of the line. This makes some commands more
7866 consistent. Previously the cursor was always past the end of the line
7867 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007868 break some plugins or Vim scripts. For example because |l| can move
7869 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02007870 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007871 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02007872 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007873 It doesn't make sense to combine "all" with "onemore", but you will
7874 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875
7876 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7877'visualbell' 'vb' boolean (default off)
7878 global
7879 {not in Vi}
7880 Use visual bell instead of beeping. The terminal code to display the
7881 visual bell is given with 't_vb'. When no beep or flash is wanted,
7882 use ":set vb t_vb=".
7883 Note: When the GUI starts, 't_vb' is reset to its default value. You
7884 might want to set it again in your |gvimrc|.
7885 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7886 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7887 where 40 is the time in msec.
7888 Does not work on the Amiga, you always get a screen flash.
7889 Also see 'errorbells'.
7890
7891 *'warn'* *'nowarn'*
7892'warn' boolean (default on)
7893 global
7894 Give a warning message when a shell command is used while the buffer
7895 has been changed.
7896
7897 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7898'weirdinvert' 'wiv' boolean (default off)
7899 global
7900 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007901 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007902 It is provided for backwards compatibility with version 4.x.
7903 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7904 vice versa. Has no effect when the GUI is running.
7905
7906 *'whichwrap'* *'ww'*
7907'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7908 global
7909 {not in Vi}
7910 Allow specified keys that move the cursor left/right to move to the
7911 previous/next line when the cursor is on the first/last character in
7912 the line. Concatenate characters to allow this for these keys:
7913 char key mode ~
7914 b <BS> Normal and Visual
7915 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007916 h "h" Normal and Visual (not recommended)
7917 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 < <Left> Normal and Visual
7919 > <Right> Normal and Visual
7920 ~ "~" Normal
7921 [ <Left> Insert and Replace
7922 ] <Right> Insert and Replace
7923 For example: >
7924 :set ww=<,>,[,]
7925< allows wrap only when cursor keys are used.
7926 When the movement keys are used in combination with a delete or change
7927 operator, the <EOL> also counts for a character. This makes "3h"
7928 different from "3dh" when the cursor crosses the end of a line. This
7929 is also true for "x" and "X", because they do the same as "dl" and
7930 "dh". If you use this, you may also want to use the mapping
7931 ":map <BS> X" to make backspace delete the character in front of the
7932 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007933 When 'l' is included and it is used after an operator at the end of a
7934 line then it will not move to the next line. This makes "dl", "cl",
7935 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 NOTE: This option is set to the Vi default value when 'compatible' is
7937 set and to the Vim default value when 'compatible' is reset.
7938
7939 *'wildchar'* *'wc'*
7940'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7941 global
7942 {not in Vi}
7943 Character you have to type to start wildcard expansion in the
7944 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007945 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 The character is not recognized when used inside a macro. See
7947 'wildcharm' for that.
7948 Although 'wc' is a number option, you can set it to a special key: >
7949 :set wc=<Esc>
7950< NOTE: This option is set to the Vi default value when 'compatible' is
7951 set and to the Vim default value when 'compatible' is reset.
7952
7953 *'wildcharm'* *'wcm'*
7954'wildcharm' 'wcm' number (default: none (0))
7955 global
7956 {not in Vi}
7957 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007958 recognized when used inside a macro. You can find "spare" command-line
7959 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 you'll never actually type 'wildcharm', just use it in mappings that
7961 automatically invoke completion mode, e.g.: >
7962 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007963 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964< Then after typing :ss you can use CTRL-P & CTRL-N.
7965
7966 *'wildignore'* *'wig'*
7967'wildignore' 'wig' string (default "")
7968 global
7969 {not in Vi}
7970 {not available when compiled without the |+wildignore|
7971 feature}
7972 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02007973 patterns is ignored when expanding |wildcards|, completing file or
7974 directory names, and influences the result of |expand()|, |glob()| and
7975 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7977 Also see 'suffixes'.
7978 Example: >
7979 :set wildignore=*.o,*.obj
7980< The use of |:set+=| and |:set-=| is preferred when adding or removing
7981 a pattern from the list. This avoids problems when a future version
7982 uses another default.
7983
Bram Moolenaar94950a92010-12-02 16:01:29 +01007984
Bram Moolenaar81af9252010-12-10 20:35:50 +01007985 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007986'wildignorecase' 'wic' boolean (default off)
7987 global
7988 {not in Vi}
7989 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01007990 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01007991 Does not apply when the shell is used to expand wildcards, which
7992 happens when there are special characters.
7993
7994
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7996'wildmenu' 'wmnu' boolean (default off)
7997 global
7998 {not in Vi}
7999 {not available if compiled without the |+wildmenu|
8000 feature}
8001 When 'wildmenu' is on, command-line completion operates in an enhanced
8002 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8003 the possible matches are shown just above the command line, with the
8004 first match highlighted (overwriting the status line, if there is
8005 one). Keys that show the previous/next match, such as <Tab> or
8006 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8007 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8008 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008009 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 If there are more matches than can fit in the line, a ">" is shown on
8011 the right and/or a "<" is shown on the left. The status line scrolls
8012 as needed.
8013 The "wildmenu" mode is abandoned when a key is hit that is not used
8014 for selecting a completion.
8015 While the "wildmenu" is active the following keys have special
8016 meanings:
8017
8018 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8019 <Down> - in filename/menu name completion: move into a
8020 subdirectory or submenu.
8021 <CR> - in menu completion, when the cursor is just after a
8022 dot: move into a submenu.
8023 <Up> - in filename/menu name completion: move up into
8024 parent directory or parent menu.
8025
8026 This makes the menus accessible from the console |console-menus|.
8027
8028 If you prefer the <Left> and <Right> keys to move the cursor instead
8029 of selecting a different match, use this: >
8030 :cnoremap <Left> <Space><BS><Left>
8031 :cnoremap <Right> <Space><BS><Right>
8032<
8033 The "WildMenu" highlighting is used for displaying the current match
8034 |hl-WildMenu|.
8035
8036 *'wildmode'* *'wim'*
8037'wildmode' 'wim' string (Vim default: "full")
8038 global
8039 {not in Vi}
8040 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008041 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008042 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 first part specifies the behavior for the first use of 'wildchar',
8044 The second part for the second use, etc.
8045 These are the possible values for each part:
8046 "" Complete only the first match.
8047 "full" Complete the next full match. After the last match,
8048 the original string is used and then the first match
8049 again.
8050 "longest" Complete till longest common string. If this doesn't
8051 result in a longer string, use the next part.
8052 "longest:full" Like "longest", but also start 'wildmenu' if it is
8053 enabled.
8054 "list" When more than one match, list all matches.
8055 "list:full" When more than one match, list all matches and
8056 complete first match.
8057 "list:longest" When more than one match, list all matches and
8058 complete till longest common string.
8059 When there is only a single match, it is fully completed in all cases.
8060
8061 Examples: >
8062 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008063< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 :set wildmode=longest,full
8065< Complete longest common string, then each full match >
8066 :set wildmode=list:full
8067< List all matches and complete each full match >
8068 :set wildmode=list,full
8069< List all matches without completing, then each full match >
8070 :set wildmode=longest,list
8071< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008072 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008074 *'wildoptions'* *'wop'*
8075'wildoptions' 'wop' string (default "")
8076 global
8077 {not in Vi}
8078 {not available when compiled without the |+wildignore|
8079 feature}
8080 A list of words that change how command line completion is done.
8081 Currently only one word is allowed:
8082 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008083 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008084 is displayed per line. Often used tag kinds are:
8085 d #define
8086 f function
8087 Also see |cmdline-completion|.
8088
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 *'winaltkeys'* *'wak'*
8090'winaltkeys' 'wak' string (default "menu")
8091 global
8092 {not in Vi}
8093 {only used in Win32, Motif, GTK and Photon GUI}
8094 Some GUI versions allow the access to menu entries by using the ALT
8095 key in combination with a character that appears underlined in the
8096 menu. This conflicts with the use of the ALT key for mappings and
8097 entering special characters. This option tells what to do:
8098 no Don't use ALT keys for menus. ALT key combinations can be
8099 mapped, but there is no automatic handling. This can then be
8100 done with the |:simalt| command.
8101 yes ALT key handling is done by the windowing system. ALT key
8102 combinations cannot be mapped.
8103 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008104 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105 keys can be mapped.
8106 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8107 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008108 This option is not used for <F10>; on Win32 and with GTK <F10> will
8109 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008111 *'window'* *'wi'*
8112'window' 'wi' number (default screen height - 1)
8113 global
8114 Window height. Do not confuse this with the height of the Vim window,
8115 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008116 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8117 value is smaller than 'lines' minus one. The screen will scroll
8118 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008119 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8120 in a much smarter way, taking care of wrapping lines.
8121 When resizing the Vim window, the value is smaller than 1 or more than
8122 or equal to 'lines' it will be set to 'lines' minus 1.
8123 {Vi also uses the option to specify the number of displayed lines}
8124
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 *'winheight'* *'wh'* *E591*
8126'winheight' 'wh' number (default 1)
8127 global
8128 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008129 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008130 feature}
8131 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008132 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008133 focus goes to a window that is smaller, its size is increased, at the
8134 cost of the height of other windows.
8135 Set 'winheight' to a small number for normal editing.
8136 Set it to 999 to make the current window fill most of the screen.
8137 Other windows will be only 'winminheight' high. This has the drawback
8138 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8139 to create only two windows, set the option after startup is done,
8140 using the |VimEnter| event: >
8141 au VimEnter * set winheight=999
8142< Minimum value is 1.
8143 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 height of the current window.
8145 'winheight' applies to the current window. Use 'winminheight' to set
8146 the minimal height for other windows.
8147
8148 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8149'winfixheight' 'wfh' boolean (default off)
8150 local to window
8151 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008152 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008153 feature}
8154 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008155 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8156 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008157 The height may be changed anyway when running out of room.
8158
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008159 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8160'winfixwidth' 'wfw' boolean (default off)
8161 local to window
8162 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008163 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008164 feature}
8165 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008166 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008167 The width may be changed anyway when running out of room.
8168
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 *'winminheight'* *'wmh'*
8170'winminheight' 'wmh' number (default 1)
8171 global
8172 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008173 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 feature}
8175 The minimal height of a window, when it's not the current window.
8176 This is a hard minimum, windows will never become smaller.
8177 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8178 status bar) if necessary. They will return to at least one line when
8179 they become active (since the cursor has to have somewhere to go.)
8180 Use 'winheight' to set the minimal height of the current window.
8181 This option is only checked when making a window smaller. Don't use a
8182 large number, it will cause errors when opening more than a few
8183 windows. A value of 0 to 3 is reasonable.
8184
8185 *'winminwidth'* *'wmw'*
8186'winminwidth' 'wmw' number (default 1)
8187 global
8188 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008189 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008190 feature}
8191 The minimal width of a window, when it's not the current window.
8192 This is a hard minimum, windows will never become smaller.
8193 When set to zero, windows may be "squashed" to zero columns (i.e. just
8194 a vertical separator) if necessary. They will return to at least one
8195 line when they become active (since the cursor has to have somewhere
8196 to go.)
8197 Use 'winwidth' to set the minimal width of the current window.
8198 This option is only checked when making a window smaller. Don't use a
8199 large number, it will cause errors when opening more than a few
8200 windows. A value of 0 to 12 is reasonable.
8201
8202 *'winwidth'* *'wiw'* *E592*
8203'winwidth' 'wiw' number (default 20)
8204 global
8205 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008206 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008207 feature}
8208 Minimal number of columns for the current window. This is not a hard
8209 minimum, Vim will use fewer columns if there is not enough room. If
8210 the current window is smaller, its size is increased, at the cost of
8211 the width of other windows. Set it to 999 to make the current window
8212 always fill the screen. Set it to a small number for normal editing.
8213 The width is not adjusted after one of the commands to change the
8214 width of the current window.
8215 'winwidth' applies to the current window. Use 'winminwidth' to set
8216 the minimal width for other windows.
8217
8218 *'wrap'* *'nowrap'*
8219'wrap' boolean (default on)
8220 local to window
8221 {not in Vi}
8222 This option changes how text is displayed. It doesn't change the text
8223 in the buffer, see 'textwidth' for that.
8224 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008225 displaying continues on the next line. When off lines will not wrap
8226 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 moved to a part that is not shown, the screen will scroll
8228 horizontally.
8229 The line will be broken in the middle of a word if necessary. See
8230 'linebreak' to get the break at a word boundary.
8231 To make scrolling horizontally a bit more useful, try this: >
8232 :set sidescroll=5
8233 :set listchars+=precedes:<,extends:>
8234< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008235 This option can't be set from a |modeline| when the 'diff' option is
8236 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008237
8238 *'wrapmargin'* *'wm'*
8239'wrapmargin' 'wm' number (default 0)
8240 local to buffer
8241 Number of characters from the right window border where wrapping
8242 starts. When typing text beyond this limit, an <EOL> will be inserted
8243 and inserting continues on the next line.
8244 Options that add a margin, such as 'number' and 'foldcolumn', cause
8245 the text width to be further reduced. This is Vi compatible.
8246 When 'textwidth' is non-zero, this option is not used.
8247 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8248 and less usefully}
8249
8250 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8251'wrapscan' 'ws' boolean (default on) *E384* *E385*
8252 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008253 Searches wrap around the end of the file. Also applies to |]s| and
8254 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255
8256 *'write'* *'nowrite'*
8257'write' boolean (default on)
8258 global
8259 {not in Vi}
8260 Allows writing files. When not set, writing a file is not allowed.
8261 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008262 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 argument. Filtering text is still possible, even though this requires
8264 writing a temporary file.
8265
8266 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8267'writeany' 'wa' boolean (default off)
8268 global
8269 Allows writing to any file with no need for "!" override.
8270
8271 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8272'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8273 otherwise)
8274 global
8275 {not in Vi}
8276 Make a backup before overwriting a file. The backup is removed after
8277 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008278 also on.
8279 WARNING: Switching this option off means that when Vim fails to write
8280 your buffer correctly and then, for whatever reason, Vim exits, you
8281 lose both the original file and what you were writing. Only reset
8282 this option if your file system is almost full and it makes the write
8283 fail (and make sure not to exit Vim until the write was successful).
8284 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008285 When the 'backupskip' pattern matches, a backup is not made anyway.
8286 NOTE: This option is set to the default value when 'compatible' is
8287 set.
8288
8289 *'writedelay'* *'wd'*
8290'writedelay' 'wd' number (default 0)
8291 global
8292 {not in Vi}
8293 The number of microseconds to wait for each character sent to the
8294 screen. When non-zero, characters are sent to the terminal one by
8295 one. For MS-DOS pcterm this does not work. For debugging purposes.
8296
8297 vim:tw=78:ts=8:ft=help:norl: