blob: 98f22ddb8ae71bc537b3190f05a0753fdd024dbd [file] [log] [blame]
Bram Moolenaare6ae6222013-05-21 21:01:10 +02001*options.txt* For Vim version 7.3. Last change: 2013 May 17
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:
483 [text]{white}{vi:|vim:|ex:}[white]{options}
484
485[text] any text or empty
486{white} at least one blank character (<Space> or <Tab>)
487{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
488[white] optional white space
489{options} a list of option settings, separated with white space or ':',
490 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000491 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The second form (this is compatible with some versions of Vi):
497
498 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
499
500[text] any text or empty
501{white} at least one blank character (<Space> or <Tab>)
502{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
503[white] optional white space
504se[t] the string "set " or "se " (note the space)
505{options} a list of options, separated with white space, which is the
506 argument for a ":set" command
507: a colon
508[text] any text or empty
509
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510Example:
511 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The white space before {vi:|vim:|ex:} is required. This minimizes the chance
514that a normal word like "lex:" is caught. There is one exception: "vi:" and
515"vim:" can also be at the start of the line (for compatibility with version
5163.0). Using "ex:" at the start of the line will be ignored (this could be
517short for "example:").
518
519 *modeline-local*
520The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000521buffer and window that contain the file. Although it's possible to set global
522options from a modeline, this is unusual. If you have two windows open and
523the files in it set the same global option to a different value, the result
524depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000525
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000526When editing a file that was already loaded, only the window-local options
527from the modeline are used. Thus if you manually changed a buffer-local
528option after opening the file, it won't be changed if you edit the same buffer
529in another window. But window-local options will be set.
530
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531 *modeline-version*
532If the modeline is only to be used for some versions of Vim, the version
533number can be specified where "vim:" is used:
534 vim{vers}: version {vers} or later
535 vim<{vers}: version before {vers}
536 vim={vers}: version {vers}
537 vim>{vers}: version after {vers}
538{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000539For example, to use a modeline only for Vim 6.0 and later:
540 /* vim600: set foldmethod=marker: */ ~
541To use a modeline for Vim before version 5.7:
542 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543There can be no blanks between "vim" and the ":".
544
545
546The number of lines that are checked can be set with the 'modelines' option.
547If 'modeline' is off or 'modelines' is 0 no lines are checked.
548
549Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000550like:
551 /* vi:ts=4: */ ~
552will give an error message for the trailing "*/". This line is OK:
553 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
555If an error is detected the rest of the line is skipped.
556
557If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000558backslash in front of the ':' will be removed. Example:
559 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560This sets the 'dir' option to "c:\tmp". Only a single backslash before the
561':' is removed. Thus to include "\:" you have to specify "\\:".
562
563No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000564might create a Trojan horse text file with modelines). And not all options
565can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000566|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000567causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
568are wrapped unexpectedly. So disable modelines before editing untrusted text.
569The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570
571Hint: If you would like to do something else than setting an option, you could
572define an autocommand that checks the file for a specific string. For
573example: >
574 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
575And define a function SetVar() that does something with the line containing
576"VAR".
577
578==============================================================================
5793. Options summary *option-summary*
580
581In the list below all the options are mentioned with their full name and with
582an abbreviation if there is one. Both forms may be used.
583
584In this document when a boolean option is "set" that means that ":set option"
585is entered. When an option is "reset", ":set nooption" is used.
586
587For some options there are two default values: The "Vim default", which is
588used when 'compatible' is not set, and the "Vi default", which is used when
589'compatible' is set.
590
591Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593different value in each window. For example the 'list' option can be set in
594one window and reset in another for the same text, giving both types of view
595at the same time. There are a few options that are specific to a certain
596file. These can have a different value for each file or buffer. For example
597the 'textwidth' option can be 78 for a normal text file and 0 for a C
598program.
599
600 global one option for all buffers and windows
601 local to window each window has its own copy of this option
602 local to buffer each buffer has its own copy of this option
603
604When creating a new window the option values from the currently active window
605are used as a default value for the window-specific options. For the
606buffer-specific options this depends on the 's' and 'S' flags in the
607'cpoptions' option. If 's' is included (which is the default) the values for
608buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000609first entered. If 'S' is present the options are copied each time the buffer
610is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611present, the options are copied from the currently active buffer when the
612buffer is created.
613
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000614Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000616Not all options are supported in all versions. This depends on the supported
617features and sometimes on the system. A remark about this is in curly braces
618below. When an option is not supported it may still be set without getting an
619error, this is called a hidden option. You can't get the value of a hidden
620option though, it is not stored.
621
622To test if option "foo" can be used with ":set" use something like this: >
623 if exists('&foo')
624This also returns true for a hidden option. To test if option "foo" is really
625supported use something like this: >
626 if exists('+foo')
627<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000628 *E355*
629A jump table for the options with a short description can be found at |Q_op|.
630
631 *'aleph'* *'al'* *aleph* *Aleph*
632'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
633 global
634 {not in Vi}
635 {only available when compiled with the |+rightleft|
636 feature}
637 The ASCII code for the first letter of the Hebrew alphabet. The
638 routine that maps the keyboard in Hebrew mode, both in Insert mode
639 (when hkmap is set) and on the command-line (when hitting CTRL-_)
640 outputs the Hebrew characters in the range [aleph..aleph+26].
641 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
642 See |rileft.txt|.
643
644 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
645'allowrevins' 'ari' boolean (default off)
646 global
647 {not in Vi}
648 {only available when compiled with the |+rightleft|
649 feature}
650 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
651 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
652 into reverse Insert mode, and don't know how to get out. See
653 'revins'.
654 NOTE: This option is reset when 'compatible' is set.
655
656 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
657'altkeymap' 'akm' boolean (default off)
658 global
659 {not in Vi}
660 {only available when compiled with the |+farsi|
661 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000662 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000663 the keyboard map between Farsi and English, when 'allowrevins' set.
664
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 is useful to start the Vim in native mode i.e. English (left-to-right
667 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000668 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669
670 *'ambiwidth'* *'ambw'*
671'ambiwidth' 'ambw' string (default: "single")
672 global
673 {not in Vi}
674 {only available when compiled with the |+multi_byte|
675 feature}
676 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
677 Tells Vim what to do with characters with East Asian Width Class
678 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
679 letters, Cyrillic letters).
680
681 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000682 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683 expected by most users.
684 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200685 *E834* *E835*
686 The value "double" cannot be used if 'listchars' or 'fillchars'
687 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688
689 There are a number of CJK fonts for which the width of glyphs for
690 those characters are solely based on how many octets they take in
691 legacy/traditional CJK encodings. In those encodings, Euro,
692 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000695 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696 Vim is running inside a terminal (emulators) that uses a CJK font
697 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
698 this option should be set to "double" to match the width perceived
699 by Vim with the width of glyphs in the font. Perhaps it also has
700 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
701 when the system locale is set to one of CJK locales. See Unicode
702 Standard Annex #11 (http://www.unicode.org/reports/tr11).
703
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100704 Vim may set this option automatically at startup time when Vim is
705 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200706 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100707
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
709'antialias' 'anti' boolean (default: off)
710 global
711 {not in Vi}
712 {only available when compiled with GUI enabled
713 on Mac OS X}
714 This option only has an effect in the GUI version of Vim on Mac OS X
715 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
716 which can be easier to read at certain sizes on certain displays.
717 Setting this option can sometimes cause problems if 'guifont' is set
718 to its default (empty string).
719
720 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
721'autochdir' 'acd' boolean (default off)
722 global
723 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200724 {only available when compiled with it, use
725 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000726 When on, Vim will change the current working directory whenever you
727 open a file, switch buffers, delete a buffer or open/close a window.
728 It will change to the directory containing the file which was opened
729 or selected.
730 This option is provided for backward compatibility with the Vim
731 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000732 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733
734 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
735'arabic' 'arab' boolean (default off)
736 local to window
737 {not in Vi}
738 {only available when compiled with the |+arabic|
739 feature}
740 This option can be set to start editing Arabic text.
741 Setting this option will:
742 - Set the 'rightleft' option, unless 'termbidi' is set.
743 - Set the 'arabicshape' option, unless 'termbidi' is set.
744 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
745 between typing English and Arabic key mapping.
746 - Set the 'delcombine' option
747 Note that 'encoding' must be "utf-8" for working with Arabic text.
748
749 Resetting this option will:
750 - Reset the 'rightleft' option.
751 - Disable the use of 'keymap' (without changing its value).
752 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200753 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000754 Also see |arabic.txt|.
755
756 *'arabicshape'* *'arshape'*
757 *'noarabicshape'* *'noarshape'*
758'arabicshape' 'arshape' boolean (default on)
759 global
760 {not in Vi}
761 {only available when compiled with the |+arabic|
762 feature}
763 When on and 'termbidi' is off, the required visual character
764 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200765 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 one which encompasses:
767 a) the changing/morphing of characters based on their location
768 within a word (initial, medial, final and stand-alone).
769 b) the enabling of the ability to compose characters
770 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100771 When disabled the display shows each character's true stand-alone
772 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 Arabic is a complex language which requires other settings, for
774 further details see |arabic.txt|.
775
776 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
777'autoindent' 'ai' boolean (default off)
778 local to buffer
779 Copy indent from current line when starting a new line (typing <CR>
780 in Insert mode or when using the "o" or "O" command). If you do not
781 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000782 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
783 to another line has the same effect, unless the 'I' flag is included
784 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000785 When autoindent is on, formatting (with the "gq" command or when you
786 reach 'textwidth' in Insert mode) uses the indentation of the first
787 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 When 'smartindent' or 'cindent' is on the indent is changed in
789 a different way.
790 The 'autoindent' option is reset when the 'paste' option is set.
791 {small difference from Vi: After the indent is deleted when typing
792 <Esc> or <CR>, the cursor position when moving up or down is after the
793 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
794
795 *'autoread'* *'ar'* *'noautoread'* *'noar'*
796'autoread' 'ar' boolean (default off)
797 global or local to buffer |global-local|
798 {not in Vi}
799 When a file has been detected to have been changed outside of Vim and
800 it has not been changed inside of Vim, automatically read it again.
801 When the file has been deleted this is not done. |timestamp|
802 If this option has a local value, use this command to switch back to
803 using the global value: >
804 :set autoread<
805<
806 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
807'autowrite' 'aw' boolean (default off)
808 global
809 Write the contents of the file, if it has been modified, on each
810 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000811 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000812 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
813 Note that for some commands the 'autowrite' option is not used, see
814 'autowriteall' for that.
815
816 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
817'autowriteall' 'awa' boolean (default off)
818 global
819 {not in Vi}
820 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
821 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
822 Setting this option also implies that Vim behaves like 'autowrite' has
823 been set.
824
825 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200826'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 global
828 {not in Vi}
829 When set to "dark", Vim will try to use colors that look good on a
830 dark background. When set to "light", Vim will try to use colors that
831 look good on a light background. Any other value is illegal.
832 Vim tries to set the default value according to the terminal used.
833 This will not always be correct.
834 Setting this option does not change the background color, it tells Vim
835 what the background color looks like. For changing the background
836 color, see |:hi-normal|.
837
838 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000839 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000840 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100841 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 setting 'background' will cause the color scheme to be reloaded. If
843 the color scheme adjusts to the value of 'background' this will work.
844 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100845 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000846
847 When setting 'background' to the default value with: >
848 :set background&
849< Vim will guess the value. In the GUI this should work correctly,
850 in other cases Vim might not be able to guess the right value.
851
852 When starting the GUI, the default value for 'background' will be
853 "light". When the value is not set in the .gvimrc, and Vim detects
854 that the background is actually quite dark, 'background' is set to
855 "dark". But this happens only AFTER the .gvimrc file has been read
856 (because the window needs to be opened to find the actual background
857 color). To get around this, force the GUI window to be opened by
858 putting a ":gui" command in the .gvimrc file, before where the value
859 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200860
861 For MS-DOS, Windows and OS/2 the default is "dark".
862 For other systems "dark" is used when 'term' is "linux",
863 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
864 background. Otherwise the default is "light".
865
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 Normally this option would be set in the .vimrc file. Possibly
867 depending on the terminal name. Example: >
868 :if &term == "pcterm"
869 : set background=dark
870 :endif
871< When this option is set, the default settings for the highlight groups
872 will change. To use other settings, place ":highlight" commands AFTER
873 the setting of the 'background' option.
874 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
875 to select the colors for syntax highlighting. After changing this
876 option, you must load syntax.vim again to see the result. This can be
877 done with ":syntax on".
878
879 *'backspace'* *'bs'*
880'backspace' 'bs' string (default "")
881 global
882 {not in Vi}
883 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
884 mode. This is a list of items, separated by commas. Each item allows
885 a way to backspace over something:
886 value effect ~
887 indent allow backspacing over autoindent
888 eol allow backspacing over line breaks (join lines)
889 start allow backspacing over the start of insert; CTRL-W and CTRL-U
890 stop once at the start of insert.
891
892 When the value is empty, Vi compatible backspacing is used.
893
894 For backwards compatibility with version 5.4 and earlier:
895 value effect ~
896 0 same as ":set backspace=" (Vi compatible)
897 1 same as ":set backspace=indent,eol"
898 2 same as ":set backspace=indent,eol,start"
899
900 See |:fixdel| if your <BS> or <Del> key does not do what you want.
901 NOTE: This option is set to "" when 'compatible' is set.
902
903 *'backup'* *'bk'* *'nobackup'* *'nobk'*
904'backup' 'bk' boolean (default off)
905 global
906 {not in Vi}
907 Make a backup before overwriting a file. Leave it around after the
908 file has been successfully written. If you do not want to keep the
909 backup file, but you do want a backup while the file is being
910 written, reset this option and set the 'writebackup' option (this is
911 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000912 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000913 |backup-table| for more explanations.
914 When the 'backupskip' pattern matches, a backup is not made anyway.
915 When 'patchmode' is set, the backup may be renamed to become the
916 oldest version of a file.
917 NOTE: This option is reset when 'compatible' is set.
918
919 *'backupcopy'* *'bkc'*
920'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
921 global
922 {not in Vi}
923 When writing a file and a backup is made, this option tells how it's
924 done. This is a comma separated list of words.
925
926 The main values are:
927 "yes" make a copy of the file and overwrite the original one
928 "no" rename the file and write a new one
929 "auto" one of the previous, what works best
930
931 Extra values that can be combined with the ones above are:
932 "breaksymlink" always break symlinks when writing
933 "breakhardlink" always break hardlinks when writing
934
935 Making a copy and overwriting the original file:
936 - Takes extra time to copy the file.
937 + When the file has special attributes, is a (hard/symbolic) link or
938 has a resource fork, all this is preserved.
939 - When the file is a link the backup will have the name of the link,
940 not of the real file.
941
942 Renaming the file and writing a new one:
943 + It's fast.
944 - Sometimes not all attributes of the file can be copied to the new
945 file.
946 - When the file is a link the new file will not be a link.
947
948 The "auto" value is the middle way: When Vim sees that renaming file
949 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000950 the file is not a link) that is used. When problems are expected, a
951 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000952
953 The "breaksymlink" and "breakhardlink" values can be used in
954 combination with any of "yes", "no" and "auto". When included, they
955 force Vim to always break either symbolic or hard links by doing
956 exactly what the "no" option does, renaming the original file to
957 become the backup and writing a new file in its place. This can be
958 useful for example in source trees where all the files are symbolic or
959 hard links and any changes should stay in the local source tree, not
960 be propagated back to the original source.
961 *crontab*
962 One situation where "no" and "auto" will cause problems: A program
963 that opens a file, invokes Vim to edit that file, and then tests if
964 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000965 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 example.
967
968 When a copy is made, the original file is truncated and then filled
969 with the new text. This means that protection bits, owner and
970 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000971 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972 group of the backup is set to the group of the original file. If this
973 fails, the protection bits for the group are made the same as for
974 others.
975
976 When the file is renamed this is the other way around: The backup has
977 the same attributes of the original file, and the newly written file
978 is owned by the current user. When the file was a (hard/symbolic)
979 link, the new file will not! That's why the "auto" value doesn't
980 rename when the file is a link. The owner and group of the newly
981 written file will be set to the same ones as the original file, but
982 the system may refuse to do this. In that case the "auto" value will
983 again not rename the file.
984
985 *'backupdir'* *'bdir'*
986'backupdir' 'bdir' string (default for Amiga: ".,t:",
987 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
988 for Unix: ".,~/tmp,~/")
989 global
990 {not in Vi}
991 List of directories for the backup file, separated with commas.
992 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100993 where this is possible. The directory must exist, Vim will not
994 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100995 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 impossible!). Writing may fail because of this.
997 - A directory "." means to put the backup file in the same directory
998 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000999 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001000 put the backup file relative to where the edited file is. The
1001 leading "." is replaced with the path name of the edited file.
1002 ("." inside a directory name has no special meaning).
1003 - Spaces after the comma are ignored, other spaces are considered part
1004 of the directory name. To have a space at the start of a directory
1005 name, precede it with a backslash.
1006 - To include a comma in a directory name precede it with a backslash.
1007 - A directory name may end in an '/'.
1008 - Environment variables are expanded |:set_env|.
1009 - Careful with '\' characters, type one before a space, type two to
1010 get one in the option (see |option-backslash|), for example: >
1011 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1012< - For backwards compatibility with Vim version 3.0 a '>' at the start
1013 of the option is removed.
1014 See also 'backup' and 'writebackup' options.
1015 If you want to hide your backup files on Unix, consider this value: >
1016 :set backupdir=./.backup,~/.backup,.,/tmp
1017< You must create a ".backup" directory in each directory and in your
1018 home directory for this to work properly.
1019 The use of |:set+=| and |:set-=| is preferred when adding or removing
1020 directories from the list. This avoids problems when a future version
1021 uses another default.
1022 This option cannot be set from a |modeline| or in the |sandbox|, for
1023 security reasons.
1024
1025 *'backupext'* *'bex'* *E589*
1026'backupext' 'bex' string (default "~", for VMS: "_")
1027 global
1028 {not in Vi}
1029 String which is appended to a file name to make the name of the
1030 backup file. The default is quite unusual, because this avoids
1031 accidentally overwriting existing files with a backup file. You might
1032 prefer using ".bak", but make sure that you don't have files with
1033 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001034 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001036 If you like to keep a lot of backups, you could use a BufWritePre
1037 autocommand to change 'backupext' just before writing the file to
1038 include a timestamp. >
1039 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1040< Use 'backupdir' to put the backup in a different directory.
1041
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 *'backupskip'* *'bsk'*
1043'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1044 global
1045 {not in Vi}
1046 {not available when compiled without the |+wildignore|
1047 feature}
1048 A list of file patterns. When one of the patterns matches with the
1049 name of the file which is written, no backup file is created. Both
1050 the specified file name and the full path name of the file are used.
1051 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1052 Watch out for special characters, see |option-backslash|.
1053 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001054 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001055
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001056 WARNING: Not having a backup file means that when Vim fails to write
1057 your buffer correctly and then, for whatever reason, Vim exits, you
1058 lose both the original file and what you were writing. Only disable
1059 backups if you don't care about losing the file.
1060
Bram Moolenaar02467872007-05-06 13:22:01 +00001061 Note that environment variables are not expanded. If you want to use
1062 $HOME you must expand it explicitly, e.g.: >
1063 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1064
1065< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001066 backup would be made by renaming the original file crontab won't see
1067 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068
1069 *'balloondelay'* *'bdlay'*
1070'balloondelay' 'bdlay' number (default: 600)
1071 global
1072 {not in Vi}
1073 {only available when compiled with the |+balloon_eval|
1074 feature}
1075 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1076
1077 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1078'ballooneval' 'beval' boolean (default off)
1079 global
1080 {not in Vi}
1081 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001082 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 Switch on the |balloon-eval| functionality.
1084
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001085 *'balloonexpr'* *'bexpr'*
1086'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001087 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001088 {not in Vi}
1089 {only available when compiled with the |+balloon_eval|
1090 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001091 Expression for text to show in evaluation balloon. It is only used
1092 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001093
1094 v:beval_bufnr number of the buffer in which balloon is going to show
1095 v:beval_winnr number of the window
1096 v:beval_lnum line number
1097 v:beval_col column number (byte index)
1098 v:beval_text word under or after the mouse pointer
1099
1100 The evaluation of the expression must not have side effects!
1101 Example: >
1102 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001103 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001104 \', column ' . v:beval_col .
1105 \ ' of file ' . bufname(v:beval_bufnr) .
1106 \ ' on word "' . v:beval_text . '"'
1107 endfunction
1108 set bexpr=MyBalloonExpr()
1109 set ballooneval
1110<
1111 NOTE: The balloon is displayed only if the cursor is on a text
1112 character. If the result of evaluating 'balloonexpr' is not empty,
1113 Vim does not try to send a message to an external debugger (Netbeans
1114 or Sun Workshop).
1115
Bram Moolenaar30b65812012-07-12 22:01:11 +02001116 The expression will be evaluated in the |sandbox| when set from a
1117 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001118
1119 It is not allowed to change text or jump to another window while
1120 evaluating 'balloonexpr' |textlock|.
1121
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001122 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001123 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001124< When they are supported "\n" characters will start a new line. If the
1125 expression evaluates to a |List| this is equal to using each List item
1126 as a string and putting "\n" in between them.
1127
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1129'binary' 'bin' boolean (default off)
1130 local to buffer
1131 {not in Vi}
1132 This option should be set before editing a binary file. You can also
1133 use the |-b| Vim argument. When this option is switched on a few
1134 options will be changed (also when it already was on):
1135 'textwidth' will be set to 0
1136 'wrapmargin' will be set to 0
1137 'modeline' will be off
1138 'expandtab' will be off
1139 Also, 'fileformat' and 'fileformats' options will not be used, the
1140 file is read and written like 'fileformat' was "unix" (a single <NL>
1141 separates lines).
1142 The 'fileencoding' and 'fileencodings' options will not be used, the
1143 file is read without conversion.
1144 NOTE: When you start editing a(nother) file while the 'bin' option is
1145 on, settings from autocommands may change the settings again (e.g.,
1146 'textwidth'), causing trouble when editing. You might want to set
1147 'bin' again when the file has been loaded.
1148 The previous values of these options are remembered and restored when
1149 'bin' is switched from on to off. Each buffer has its own set of
1150 saved option values.
1151 To edit a file with 'binary' set you can use the |++bin| argument.
1152 This avoids you have to do ":set bin", which would have effect for all
1153 files you edit.
1154 When writing a file the <EOL> for the last line is only written if
1155 there was one in the original file (normally Vim appends an <EOL> to
1156 the last line if there is none; this would make the file longer). See
1157 the 'endofline' option.
1158
1159 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1160'bioskey' 'biosk' boolean (default on)
1161 global
1162 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001163 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 better to detect CTRL-C, but only works for the console. When using a
1165 terminal over a serial port reset this option.
1166 Also see |'conskey'|.
1167
1168 *'bomb'* *'nobomb'*
1169'bomb' boolean (default off)
1170 local to buffer
1171 {not in Vi}
1172 {only available when compiled with the |+multi_byte|
1173 feature}
1174 When writing a file and the following conditions are met, a BOM (Byte
1175 Order Mark) is prepended to the file:
1176 - this option is on
1177 - the 'binary' option is off
1178 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1179 endian variants.
1180 Some applications use the BOM to recognize the encoding of the file.
1181 Often used for UCS-2 files on MS-Windows. For other applications it
1182 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001183 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1185 check for the presence of the BOM is done and 'bomb' set accordingly.
1186 Unless 'binary' is set, it is removed from the first line, so that you
1187 don't see it when editing. When you don't change the options, the BOM
1188 will be restored when writing the file.
1189
1190 *'breakat'* *'brk'*
1191'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1192 global
1193 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001194 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 feature}
1196 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001197 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1198 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199
1200 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001201'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001203 {not in Vi} {only for Motif, Athena, GTK, Mac and
1204 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001205 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001206 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001207 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 buffer Use the directory of the related buffer.
1209 current Use the current directory.
1210 {path} Use the specified directory
1211
1212 *'bufhidden'* *'bh'*
1213'bufhidden' 'bh' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 This option specifies what happens when a buffer is no longer
1219 displayed in a window:
1220 <empty> follow the global 'hidden' option
1221 hide hide the buffer (don't unload it), also when 'hidden'
1222 is not set
1223 unload unload the buffer, also when 'hidden' is set or using
1224 |:hide|
1225 delete delete the buffer from the buffer list, also when
1226 'hidden' is set or using |:hide|, like using
1227 |:bdelete|
1228 wipe wipe out the buffer from the buffer list, also when
1229 'hidden' is set or using |:hide|, like using
1230 |:bwipeout|
1231
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001232 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001233 are lost without a warning. Also, these values may break autocommands
1234 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 This option is used together with 'buftype' and 'swapfile' to specify
1236 special kinds of buffers. See |special-buffers|.
1237
1238 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1239'buflisted' 'bl' boolean (default: on)
1240 local to buffer
1241 {not in Vi}
1242 When this option is set, the buffer shows up in the buffer list. If
1243 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1244 This option is reset by Vim for buffers that are only used to remember
1245 a file name or marks. Vim sets it when starting to edit a buffer.
1246 But not when moving to a buffer with ":buffer".
1247
1248 *'buftype'* *'bt'* *E382*
1249'buftype' 'bt' string (default: "")
1250 local to buffer
1251 {not in Vi}
1252 {not available when compiled without the |+quickfix|
1253 feature}
1254 The value of this option specifies the type of a buffer:
1255 <empty> normal buffer
1256 nofile buffer which is not related to a file and will not be
1257 written
1258 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001259 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001260 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001261 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001263 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 help help buffer (you are not supposed to set this
1265 manually)
1266
1267 This option is used together with 'bufhidden' and 'swapfile' to
1268 specify special kinds of buffers. See |special-buffers|.
1269
1270 Be careful with changing this option, it can have many side effects!
1271
Bram Moolenaar280f1262006-01-30 00:14:18 +00001272 A "quickfix" buffer is only used for the error list and the location
1273 list. This value is set by the |:cwindow| and |:lwindow| commands and
1274 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275
1276 "nofile" and "nowrite" buffers are similar:
1277 both: The buffer is not to be written to disk, ":w" doesn't
1278 work (":w filename" does work though).
1279 both: The buffer is never considered to be |'modified'|.
1280 There is no warning when the changes will be lost, for
1281 example when you quit Vim.
1282 both: A swap file is only created when using too much memory
1283 (when 'swapfile' has been reset there is never a swap
1284 file).
1285 nofile only: The buffer name is fixed, it is not handled like a
1286 file name. It is not modified in response to a |:cd|
1287 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001288 *E676*
1289 "acwrite" implies that the buffer name is not related to a file, like
1290 "nofile", but it will be written. Thus, in contrast to "nofile" and
1291 "nowrite", ":w" does work and a modified buffer can't be abandoned
1292 without saving. For writing there must be matching |BufWriteCmd|,
1293 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001294
1295 *'casemap'* *'cmp'*
1296'casemap' 'cmp' string (default: "internal,keepascii")
1297 global
1298 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001299 {only available when compiled with the |+multi_byte|
1300 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 Specifies details about changing the case of letters. It may contain
1302 these words, separated by a comma:
1303 internal Use internal case mapping functions, the current
1304 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001305 matters when 'encoding' is a Unicode encoding,
1306 "latin1" or "iso-8859-15". When "internal" is
1307 omitted, the towupper() and towlower() system library
1308 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1310 case mapping, the current locale is not effective.
1311 This probably only matters for Turkish.
1312
1313 *'cdpath'* *'cd'* *E344* *E346*
1314'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1315 global
1316 {not in Vi}
1317 {not available when compiled without the
1318 |+file_in_path| feature}
1319 This is a list of directories which will be searched when using the
1320 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001321 for has a relative path, not an absolute part starting with "/", "./"
1322 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 The 'cdpath' option's value has the same form and semantics as
1324 |'path'|. Also see |file-searching|.
1325 The default value is taken from $CDPATH, with a "," prepended to look
1326 in the current directory first.
1327 If the default value taken from $CDPATH is not what you want, include
1328 a modified version of the following command in your vimrc file to
1329 override it: >
1330 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1331< This option cannot be set from a |modeline| or in the |sandbox|, for
1332 security reasons.
1333 (parts of 'cdpath' can be passed to the shell to expand file names).
1334
1335 *'cedit'*
1336'cedit' string (Vi default: "", Vim default: CTRL-F)
1337 global
1338 {not in Vi}
1339 {not available when compiled without the |+vertsplit|
1340 feature}
1341 The key used in Command-line Mode to open the command-line window.
1342 The default is CTRL-F when 'compatible' is off.
1343 Only non-printable keys are allowed.
1344 The key can be specified as a single character, but it is difficult to
1345 type. The preferred way is to use the <> notation. Examples: >
1346 :set cedit=<C-Y>
1347 :set cedit=<Esc>
1348< |Nvi| also has this option, but it only uses the first character.
1349 See |cmdwin|.
1350
1351 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1352'charconvert' 'ccv' string (default "")
1353 global
1354 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001355 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 {not in Vi}
1357 An expression that is used for character encoding conversion. It is
1358 evaluated when a file that is to be read or has been written has a
1359 different encoding from what is desired.
1360 'charconvert' is not used when the internal iconv() function is
1361 supported and is able to do the conversion. Using iconv() is
1362 preferred, because it is much faster.
1363 'charconvert' is not used when reading stdin |--|, because there is no
1364 file to convert from. You will have to save the text in a file first.
1365 The expression must return zero or an empty string for success,
1366 non-zero for failure.
1367 The possible encoding names encountered are in 'encoding'.
1368 Additionally, names given in 'fileencodings' and 'fileencoding' are
1369 used.
1370 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1371 is done internally by Vim, 'charconvert' is not used for this.
1372 'charconvert' is also used to convert the viminfo file, if the 'c'
1373 flag is present in 'viminfo'. Also used for Unicode conversion.
1374 Example: >
1375 set charconvert=CharConvert()
1376 fun CharConvert()
1377 system("recode "
1378 \ . v:charconvert_from . ".." . v:charconvert_to
1379 \ . " <" . v:fname_in . " >" v:fname_out)
1380 return v:shell_error
1381 endfun
1382< The related Vim variables are:
1383 v:charconvert_from name of the current encoding
1384 v:charconvert_to name of the desired encoding
1385 v:fname_in name of the input file
1386 v:fname_out name of the output file
1387 Note that v:fname_in and v:fname_out will never be the same.
1388 Note that v:charconvert_from and v:charconvert_to may be different
1389 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1390 Encryption is not done by Vim when using 'charconvert'. If you want
1391 to encrypt the file after conversion, 'charconvert' should take care
1392 of this.
1393 This option cannot be set from a |modeline| or in the |sandbox|, for
1394 security reasons.
1395
1396 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1397'cindent' 'cin' boolean (default off)
1398 local to buffer
1399 {not in Vi}
1400 {not available when compiled without the |+cindent|
1401 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001402 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403 that trigger reindenting in insert mode and 'cinoptions' to set your
1404 preferred indent style.
1405 If 'indentexpr' is not empty, it overrules 'cindent'.
1406 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1407 the "=" operator indents using this algorithm rather than calling an
1408 external program.
1409 See |C-indenting|.
1410 When you don't like the way 'cindent' works, try the 'smartindent'
1411 option or 'indentexpr'.
1412 This option is not used when 'paste' is set.
1413 NOTE: This option is reset when 'compatible' is set.
1414
1415 *'cinkeys'* *'cink'*
1416'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1417 local to buffer
1418 {not in Vi}
1419 {not available when compiled without the |+cindent|
1420 feature}
1421 A list of keys that, when typed in Insert mode, cause reindenting of
1422 the current line. Only used if 'cindent' is on and 'indentexpr' is
1423 empty.
1424 For the format of this option see |cinkeys-format|.
1425 See |C-indenting|.
1426
1427 *'cinoptions'* *'cino'*
1428'cinoptions' 'cino' string (default "")
1429 local to buffer
1430 {not in Vi}
1431 {not available when compiled without the |+cindent|
1432 feature}
1433 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1434 program. See |cinoptions-values| for the values of this option, and
1435 |C-indenting| for info on C indenting in general.
1436
1437
1438 *'cinwords'* *'cinw'*
1439'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1440 local to buffer
1441 {not in Vi}
1442 {not available when compiled without both the
1443 |+cindent| and the |+smartindent| features}
1444 These keywords start an extra indent in the next line when
1445 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1446 an appropriate place (inside {}).
1447 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1448 matter, include the keyword both the uppercase and lowercase:
1449 "if,If,IF".
1450
1451 *'clipboard'* *'cb'*
1452'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1453 for X-windows, "" otherwise)
1454 global
1455 {not in Vi}
1456 {only in GUI versions or when the |+xterm_clipboard|
1457 feature is included}
1458 This option is a list of comma separated names.
1459 These names are recognized:
1460
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001461 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 unnamed When included, Vim will use the clipboard register '*'
1463 for all yank, delete, change and put operations which
1464 would normally go to the unnamed register. When a
1465 register is explicitly specified, it will always be
1466 used regardless of whether "unnamed" is in 'clipboard'
1467 or not. The clipboard register can always be
1468 explicitly accessed using the "* notation. Also see
1469 |gui-clipboard|.
1470
Bram Moolenaar30b65812012-07-12 22:01:11 +02001471 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001472 unnamedplus A variant of the "unnamed" flag which uses the
1473 clipboard register '+' (|quoteplus|) instead of
1474 register '*' for all yank, delete, change and put
1475 operations which would normally go to the unnamed
1476 register. When "unnamed" is also included to the
1477 option, yank operations (but not delete, change or
1478 put) will additionally copy the text into register
1479 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001480 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001481 Availability can be checked with: >
1482 if has('unnamedplus')
1483<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001484 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485 autoselect Works like the 'a' flag in 'guioptions': If present,
1486 then whenever Visual mode is started, or the Visual
1487 area extended, Vim tries to become the owner of the
1488 windowing system's global selection or put the
1489 selected text on the clipboard used by the selection
1490 register "*. See |guioptions_a| and |quotestar| for
1491 details. When the GUI is active, the 'a' flag in
1492 'guioptions' is used, when the GUI is not active, this
1493 "autoselect" flag is used.
1494 Also applies to the modeless selection.
1495
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001496 *clipboard-autoselectplus*
1497 autoselectplus Like "autoselect" but using the + register instead of
1498 the * register. Compare to the 'P' flag in
1499 'guioptions'.
1500
1501 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 autoselectml Like "autoselect", but for the modeless selection
1503 only. Compare to the 'A' flag in 'guioptions'.
1504
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001505 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001506 html When the clipboard contains HTML, use this when
1507 pasting. When putting text on the clipboard, mark it
1508 as HTML. This works to copy rendered HTML from
1509 Firefox, paste it as raw HTML in Vim, select the HTML
1510 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001511 You probably want to add this only temporarily,
1512 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001513 Only supported for GTK version 2 and later.
1514 Only available with the |+multi_byte| feature.
1515
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001516 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 exclude:{pattern}
1518 Defines a pattern that is matched against the name of
1519 the terminal 'term'. If there is a match, no
1520 connection will be made to the X server. This is
1521 useful in this situation:
1522 - Running Vim in a console.
1523 - $DISPLAY is set to start applications on another
1524 display.
1525 - You do not want to connect to the X server in the
1526 console, but do want this in a terminal emulator.
1527 To never connect to the X server use: >
1528 exclude:.*
1529< This has the same effect as using the |-X| argument.
1530 Note that when there is no connection to the X server
1531 the window title won't be restored and the clipboard
1532 cannot be accessed.
1533 The value of 'magic' is ignored, {pattern} is
1534 interpreted as if 'magic' was on.
1535 The rest of the option value will be used for
1536 {pattern}, this must be the last entry.
1537
1538 *'cmdheight'* *'ch'*
1539'cmdheight' 'ch' number (default 1)
1540 global
1541 {not in Vi}
1542 Number of screen lines to use for the command-line. Helps avoiding
1543 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001544 The value of this option is stored with the tab page, so that each tab
1545 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546
1547 *'cmdwinheight'* *'cwh'*
1548'cmdwinheight' 'cwh' number (default 7)
1549 global
1550 {not in Vi}
1551 {not available when compiled without the |+vertsplit|
1552 feature}
1553 Number of screen lines to use for the command-line window. |cmdwin|
1554
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001555 *'colorcolumn'* *'cc'*
1556'colorcolumn' 'cc' string (default "")
1557 local to window
1558 {not in Vi}
1559 {not available when compiled without the |+syntax|
1560 feature}
1561 'colorcolumn' is a comma separated list of screen columns that are
1562 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1563 text. Will make screen redrawing slower.
1564 The screen column can be an absolute number, or a number preceded with
1565 '+' or '-', which is added to or subtracted from 'textwidth'. >
1566
1567 :set cc=+1 " highlight column after 'textwidth'
1568 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1569 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1570<
1571 When 'textwidth' is zero then the items with '-' and '+' are not used.
1572 A maximum of 256 columns are highlighted.
1573
Bram Moolenaar071d4272004-06-13 20:20:40 +00001574 *'columns'* *'co'* *E594*
1575'columns' 'co' number (default 80 or terminal width)
1576 global
1577 {not in Vi}
1578 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001579 initialization and does not have to be set by hand. Also see
1580 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 When Vim is running in the GUI or in a resizable window, setting this
1582 option will cause the window size to be changed. When you only want
1583 to use the size for the GUI, put the command in your |gvimrc| file.
1584 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001585 number of columns of the display, the display may be messed up. For
1586 the GUI it is always possible and Vim limits the number of columns to
1587 what fits on the screen. You can use this command to get the widest
1588 window possible: >
1589 :set columns=9999
1590< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591
1592 *'comments'* *'com'* *E524* *E525*
1593'comments' 'com' string (default
1594 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1595 local to buffer
1596 {not in Vi}
1597 {not available when compiled without the |+comments|
1598 feature}
1599 A comma separated list of strings that can start a comment line. See
1600 |format-comments|. See |option-backslash| about using backslashes to
1601 insert a space.
1602
1603 *'commentstring'* *'cms'* *E537*
1604'commentstring' 'cms' string (default "/*%s*/")
1605 local to buffer
1606 {not in Vi}
1607 {not available when compiled without the |+folding|
1608 feature}
1609 A template for a comment. The "%s" in the value is replaced with the
1610 comment text. Currently only used to add markers for folding, see
1611 |fold-marker|.
1612
1613 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001614'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1615 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 global
1617 {not in Vi}
1618 This option has the effect of making Vim either more Vi-compatible, or
1619 make Vim behave in a more useful way.
1620 This is a special kind of option, because when it's set or reset,
1621 other options are also changed as a side effect. CAREFUL: Setting or
1622 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001623 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 set this option in your vimrc file, you should probably put it at the
1625 very start.
1626 By default this option is on and the Vi defaults are used for the
1627 options. This default was chosen for those people who want to use Vim
1628 just like Vi, and don't even (want to) know about the 'compatible'
1629 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001630 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001631 this option is switched off, and all options that have not been
1632 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001633 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001634 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001635 happen for the system-wide vimrc or gvimrc file, nor for a file given
1636 with the |-u| argument). Also see |compatible-default| and
1637 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001638 You can also set this option with the "-C" argument, and reset it with
1639 "-N". See |-C| and |-N|.
1640 Switching this option off makes the Vim defaults be used for options
1641 that have a different Vi and Vim default value. See the options
1642 marked with a '+' below. Other options are not modified.
1643 At the moment this option is set, several other options will be set
1644 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001645 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001646 editing.
1647 See also 'cpoptions'.
1648
1649 option + set value effect ~
1650
1651 'allowrevins' off no CTRL-_ command
1652 'backupcopy' Unix: "yes" backup file is a copy
1653 others: "auto" copy or rename backup file
1654 'backspace' "" normal backspace
1655 'backup' off no backup file
1656 'cindent' off no C code indentation
1657 'cedit' + "" no key to open the |cmdwin|
1658 'cpoptions' + (all flags) Vi-compatible flags
1659 'cscopetag' off don't use cscope for ":tag"
1660 'cscopetagorder' 0 see |cscopetagorder|
1661 'cscopeverbose' off see |cscopeverbose|
1662 'digraph' off no digraphs
1663 'esckeys' + off no <Esc>-keys in Insert mode
1664 'expandtab' off tabs not expanded to spaces
1665 'fileformats' + "" no automatic file format detection,
1666 "dos,unix" except for DOS, Windows and OS/2
1667 'formatoptions' + "vt" Vi compatible formatting
1668 'gdefault' off no default 'g' flag for ":s"
1669 'history' + 0 no commandline history
1670 'hkmap' off no Hebrew keyboard mapping
1671 'hkmapp' off no phonetic Hebrew keyboard mapping
1672 'hlsearch' off no highlighting of search matches
1673 'incsearch' off no incremental searching
1674 'indentexpr' "" no indenting by expression
1675 'insertmode' off do not start in Insert mode
1676 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1677 characters and '_'
1678 'joinspaces' on insert 2 spaces after period
1679 'modeline' + off no modelines
1680 'more' + off no pauses in listings
1681 'revins' off no reverse insert
1682 'ruler' off no ruler
1683 'scrolljump' 1 no jump scroll
1684 'scrolloff' 0 no scroll offset
1685 'shiftround' off indent not rounded to shiftwidth
1686 'shortmess' + "" no shortening of messages
1687 'showcmd' + off command characters not shown
1688 'showmode' + off current mode not shown
1689 'smartcase' off no automatic ignore case switch
1690 'smartindent' off no smart indentation
1691 'smarttab' off no smart tab size
1692 'softtabstop' 0 tabs are always 'tabstop' positions
1693 'startofline' on goto startofline with some commands
1694 'tagrelative' + off tag file names are not relative
1695 'textauto' + off no automatic textmode detection
1696 'textwidth' 0 no automatic line wrap
1697 'tildeop' off tilde is not an operator
1698 'ttimeout' off no terminal timeout
1699 'whichwrap' + "" left-right movements don't wrap
1700 'wildchar' + CTRL-E only when the current value is <Tab>
1701 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001702 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001703
1704 *'complete'* *'cpt'* *E535*
1705'complete' 'cpt' string (default: ".,w,b,u,t,i")
1706 local to buffer
1707 {not in Vi}
1708 This option specifies how keyword completion |ins-completion| works
1709 when CTRL-P or CTRL-N are used. It is also used for whole-line
1710 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1711 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001712 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 w scan buffers from other windows
1714 b scan other loaded buffers that are in the buffer list
1715 u scan the unloaded buffers that are in the buffer list
1716 U scan the buffers that are not in the buffer list
1717 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001718 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 k{dict} scan the file {dict}. Several "k" flags can be given,
1720 patterns are valid too. For example: >
1721 :set cpt=k/usr/dict/*,k~/spanish
1722< s scan the files given with the 'thesaurus' option
1723 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1724 are valid too.
1725 i scan current and included files
1726 d scan current and included files for defined name or macro
1727 |i_CTRL-X_CTRL-D|
1728 ] tag completion
1729 t same as "]"
1730
1731 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1732 not executed, this may lead to unexpected completions from some files
1733 (gzipped files for example). Unloaded buffers are not scanned for
1734 whole-line completion.
1735
1736 The default is ".,w,b,u,t,i", which means to scan:
1737 1. the current buffer
1738 2. buffers in other windows
1739 3. other loaded buffers
1740 4. unloaded buffers
1741 5. tags
1742 6. included files
1743
1744 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001745 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1746 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001748 *'completefunc'* *'cfu'*
1749'completefunc' 'cfu' string (default: empty)
1750 local to buffer
1751 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001752 {not available when compiled without the |+eval|
1753 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001754 This option specifies a function to be used for Insert mode completion
1755 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001756 See |complete-functions| for an explanation of how the function is
1757 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001758 This option cannot be set from a |modeline| or in the |sandbox|, for
1759 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001760
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001761 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001762'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001763 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001764 {not available when compiled without the
1765 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001766 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001767 A comma separated list of options for Insert mode completion
1768 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001769
1770 menu Use a popup menu to show the possible completions. The
1771 menu is only shown when there is more than one match and
1772 sufficient colors are available. |ins-completion-menu|
1773
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001774 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001775 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001776 match, e.g., what file it comes from.
1777
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001778 longest Only insert the longest common text of the matches. If
1779 the menu is displayed you can use CTRL-L to add more
1780 characters. Whether case is ignored depends on the kind
1781 of completion. For buffer text the 'ignorecase' option is
1782 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001783
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001784 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001785 completion in the preview window. Only works in
1786 combination with "menu" or "menuone".
1787
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001788
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001789 *'concealcursor'* *'cocu'*
1790'concealcursor' 'cocu' string (default: "")
1791 local to window
1792 {not in Vi}
1793 {not available when compiled without the |+conceal|
1794 feature}
1795 Sets the modes in which text in the cursor line can also be concealed.
1796 When the current mode is listed then concealing happens just like in
1797 other lines.
1798 n Normal mode
1799 v Visual mode
1800 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001801 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001802
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001803 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001804 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001805 are moving around text is concealed, but when starting to insert text
1806 or selecting a Visual area the concealed text is displayed, so that
1807 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001808 Keep in mind that the cursor position is not always where it's
1809 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001810
1811
1812'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001813 number (default 0)
1814 local to window
1815 {not in Vi}
1816 {not available when compiled without the |+conceal|
1817 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001818 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1819 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001820
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001821 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001822 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001823 1 Each block of concealed text is replaced with one
1824 character. If the syntax item does not have a custom
1825 replacement character defined (see |:syn-cchar|) the
1826 character defined in 'listchars' is used (default is a
1827 space).
1828 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001829 2 Concealed text is completely hidden unless it has a
1830 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001831 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001832 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001833
Bram Moolenaara7781e02010-07-19 20:13:22 +02001834 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001835 edit and copy the text. This can be changed with the 'concealcursor'
1836 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001837
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1839'confirm' 'cf' boolean (default off)
1840 global
1841 {not in Vi}
1842 When 'confirm' is on, certain operations that would normally
1843 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1844 instead raise a |dialog| asking if you wish to save the current
1845 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1846 If 'confirm' is off you can still activate confirmation for one
1847 command only (this is most useful in mappings) with the |:confirm|
1848 command.
1849 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1850
1851 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1852'conskey' 'consk' boolean (default off)
1853 global
1854 {not in Vi} {only for MS-DOS}
1855 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001856 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 three methods of console input are available:
1858 'conskey' 'bioskey' action ~
1859 on on or off direct console input
1860 off on BIOS
1861 off off STDIN
1862
1863 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1864'copyindent' 'ci' boolean (default off)
1865 local to buffer
1866 {not in Vi}
1867 Copy the structure of the existing lines indent when autoindenting a
1868 new line. Normally the new indent is reconstructed by a series of
1869 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1870 in which case only spaces are used). Enabling this option makes the
1871 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001872 existing line. 'expandtab' has no effect on these characters, a Tab
1873 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 line, the remaining space is filled in the normal manner.
1875 NOTE: 'copyindent' is reset when 'compatible' is set.
1876 Also see 'preserveindent'.
1877
1878 *'cpoptions'* *'cpo'*
1879'cpoptions' 'cpo' string (Vim default: "aABceFs",
1880 Vi default: all flags)
1881 global
1882 {not in Vi}
1883 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001884 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 not being vi-compatible is mostly or sometimes preferred.
1886 'cpoptions' stands for "compatible-options".
1887 Commas can be added for readability.
1888 To avoid problems with flags that are added in the future, use the
1889 "+=" and "-=" feature of ":set" |add-option-flags|.
1890 NOTE: This option is set to the Vi default value when 'compatible' is
1891 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001892 NOTE: This option is set to the POSIX default value at startup when
1893 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001894 variable exists |posix|. This means Vim tries to behave like the
1895 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896
1897 contains behavior ~
1898 *cpo-a*
1899 a When included, a ":read" command with a file name
1900 argument will set the alternate file name for the
1901 current window.
1902 *cpo-A*
1903 A When included, a ":write" command with a file name
1904 argument will set the alternate file name for the
1905 current window.
1906 *cpo-b*
1907 b "\|" in a ":map" command is recognized as the end of
1908 the map command. The '\' is included in the mapping,
1909 the text after the '|' is interpreted as the next
1910 command. Use a CTRL-V instead of a backslash to
1911 include the '|' in the mapping. Applies to all
1912 mapping, abbreviation, menu and autocmd commands.
1913 See also |map_bar|.
1914 *cpo-B*
1915 B A backslash has no special meaning in mappings,
1916 abbreviations and the "to" part of the menu commands.
1917 Remove this flag to be able to use a backslash like a
1918 CTRL-V. For example, the command ":map X \<Esc>"
1919 results in X being mapped to:
1920 'B' included: "\^[" (^[ is a real <Esc>)
1921 'B' excluded: "<Esc>" (5 characters)
1922 ('<' excluded in both cases)
1923 *cpo-c*
1924 c Searching continues at the end of any match at the
1925 cursor position, but not further than the start of the
1926 next line. When not present searching continues
1927 one character from the cursor position. With 'c'
1928 "abababababab" only gets three matches when repeating
1929 "/abab", without 'c' there are five matches.
1930 *cpo-C*
1931 C Do not concatenate sourced lines that start with a
1932 backslash. See |line-continuation|.
1933 *cpo-d*
1934 d Using "./" in the 'tags' option doesn't mean to use
1935 the tags file relative to the current file, but the
1936 tags file in the current directory.
1937 *cpo-D*
1938 D Can't use CTRL-K to enter a digraph after Normal mode
1939 commands with a character argument, like |r|, |f| and
1940 |t|.
1941 *cpo-e*
1942 e When executing a register with ":@r", always add a
1943 <CR> to the last line, also when the register is not
1944 linewise. If this flag is not present, the register
1945 is not linewise and the last line does not end in a
1946 <CR>, then the last line is put on the command-line
1947 and can be edited before hitting <CR>.
1948 *cpo-E*
1949 E It is an error when using "y", "d", "c", "g~", "gu" or
1950 "gU" on an Empty region. The operators only work when
1951 at least one character is to be operate on. Example:
1952 This makes "y0" fail in the first column.
1953 *cpo-f*
1954 f When included, a ":read" command with a file name
1955 argument will set the file name for the current buffer,
1956 if the current buffer doesn't have a file name yet.
1957 *cpo-F*
1958 F When included, a ":write" command with a file name
1959 argument will set the file name for the current
1960 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001961 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 *cpo-g*
1963 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001964 *cpo-H*
1965 H When using "I" on a line with only blanks, insert
1966 before the last blank. Without this flag insert after
1967 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 *cpo-i*
1969 i When included, interrupting the reading of a file will
1970 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001971 *cpo-I*
1972 I When moving the cursor up or down just after inserting
1973 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 *cpo-j*
1975 j When joining lines, only add two spaces after a '.',
1976 not after '!' or '?'. Also see 'joinspaces'.
1977 *cpo-J*
1978 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001979 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 white space.
1981 *cpo-k*
1982 k Disable the recognition of raw key codes in
1983 mappings, abbreviations, and the "to" part of menu
1984 commands. For example, if <Key> sends ^[OA (where ^[
1985 is <Esc>), the command ":map X ^[OA" results in X
1986 being mapped to:
1987 'k' included: "^[OA" (3 characters)
1988 'k' excluded: "<Key>" (one key code)
1989 Also see the '<' flag below.
1990 *cpo-K*
1991 K Don't wait for a key code to complete when it is
1992 halfway a mapping. This breaks mapping <F1><F1> when
1993 only part of the second <F1> has been read. It
1994 enables cancelling the mapping by typing <F1><Esc>.
1995 *cpo-l*
1996 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001997 literally, only "\]", "\^", "\-" and "\\" are special.
1998 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2000 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002001 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 *cpo-L*
2003 L When the 'list' option is set, 'wrapmargin',
2004 'textwidth', 'softtabstop' and Virtual Replace mode
2005 (see |gR|) count a <Tab> as two characters, instead of
2006 the normal behavior of a <Tab>.
2007 *cpo-m*
2008 m When included, a showmatch will always wait half a
2009 second. When not included, a showmatch will wait half
2010 a second or until a character is typed. |'showmatch'|
2011 *cpo-M*
2012 M When excluded, "%" matching will take backslashes into
2013 account. Thus in "( \( )" and "\( ( \)" the outer
2014 parenthesis match. When included "%" ignores
2015 backslashes, which is Vi compatible.
2016 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002017 n When included, the column used for 'number' and
2018 'relativenumber' will also be used for text of wrapped
2019 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 *cpo-o*
2021 o Line offset to search command is not remembered for
2022 next search.
2023 *cpo-O*
2024 O Don't complain if a file is being overwritten, even
2025 when it didn't exist when editing it. This is a
2026 protection against a file unexpectedly created by
2027 someone else. Vi didn't complain about this.
2028 *cpo-p*
2029 p Vi compatible Lisp indenting. When not present, a
2030 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002031 *cpo-P*
2032 P When included, a ":write" command that appends to a
2033 file will set the file name for the current buffer, if
2034 the current buffer doesn't have a file name yet and
2035 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002036 *cpo-q*
2037 q When joining multiple lines leave the cursor at the
2038 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 *cpo-r*
2040 r Redo ("." command) uses "/" to repeat a search
2041 command, instead of the actually used search string.
2042 *cpo-R*
2043 R Remove marks from filtered lines. Without this flag
2044 marks are kept like |:keepmarks| was used.
2045 *cpo-s*
2046 s Set buffer options when entering the buffer for the
2047 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002048 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 set when the buffer is created.
2050 *cpo-S*
2051 S Set buffer options always when entering a buffer
2052 (except 'readonly', 'fileformat', 'filetype' and
2053 'syntax'). This is the (most) Vi compatible setting.
2054 The options are set to the values in the current
2055 buffer. When you change an option and go to another
2056 buffer, the value is copied. Effectively makes the
2057 buffer options global to all buffers.
2058
2059 's' 'S' copy buffer options
2060 no no when buffer created
2061 yes no when buffer first entered (default)
2062 X yes each time when buffer entered (vi comp.)
2063 *cpo-t*
2064 t Search pattern for the tag command is remembered for
2065 "n" command. Otherwise Vim only puts the pattern in
2066 the history for search pattern, but doesn't change the
2067 last used search pattern.
2068 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002069 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 *cpo-v*
2071 v Backspaced characters remain visible on the screen in
2072 Insert mode. Without this flag the characters are
2073 erased from the screen right away. With this flag the
2074 screen newly typed text overwrites backspaced
2075 characters.
2076 *cpo-w*
2077 w When using "cw" on a blank character, only change one
2078 character and not all blanks until the start of the
2079 next word.
2080 *cpo-W*
2081 W Don't overwrite a readonly file. When omitted, ":w!"
2082 overwrites a readonly file, if possible.
2083 *cpo-x*
2084 x <Esc> on the command-line executes the command-line.
2085 The default in Vim is to abandon the command-line,
2086 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002087 *cpo-X*
2088 X When using a count with "R" the replaced text is
2089 deleted only once. Also when repeating "R" with "."
2090 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 *cpo-y*
2092 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002093 *cpo-Z*
2094 Z When using "w!" while the 'readonly' option is set,
2095 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 *cpo-!*
2097 ! When redoing a filter command, use the last used
2098 external command, whatever it was. Otherwise the last
2099 used -filter- command is used.
2100 *cpo-$*
2101 $ When making a change to one line, don't redisplay the
2102 line, but put a '$' at the end of the changed text.
2103 The changed text will be overwritten when you type the
2104 new text. The line is redisplayed if you type any
2105 command that moves the cursor from the insertion
2106 point.
2107 *cpo-%*
2108 % Vi-compatible matching is done for the "%" command.
2109 Does not recognize "#if", "#endif", etc.
2110 Does not recognize "/*" and "*/".
2111 Parens inside single and double quotes are also
2112 counted, causing a string that contains a paren to
2113 disturb the matching. For example, in a line like
2114 "if (strcmp("foo(", s))" the first paren does not
2115 match the last one. When this flag is not included,
2116 parens inside single and double quotes are treated
2117 specially. When matching a paren outside of quotes,
2118 everything inside quotes is ignored. When matching a
2119 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002120 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002121 This flag is also used for other features, such as
2122 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002123 *cpo--*
2124 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002125 it would go above the first line or below the last
2126 line. Without it the cursor moves to the first or
2127 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002128 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002129 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002130 *cpo-+*
2131 + When included, a ":write file" command will reset the
2132 'modified' flag of the buffer, even though the buffer
2133 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002134 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 * Use ":*" in the same way as ":@". When not included,
2136 ":*" is an alias for ":'<,'>", select the Visual area.
2137 *cpo-<*
2138 < Disable the recognition of special key codes in |<>|
2139 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002140 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002141 ":map X <Tab>" results in X being mapped to:
2142 '<' included: "<Tab>" (5 characters)
2143 '<' excluded: "^I" (^I is a real <Tab>)
2144 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002145 *cpo->*
2146 > When appending to a register, put a line break before
2147 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002148 *cpo-;*
2149 ; When using |,| or |;| to repeat the last |t| search
2150 and the cursor is right in front of the searched
2151 character, the cursor won't move. When not included,
2152 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002153 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002154
2155 POSIX flags. These are not included in the Vi default value, except
2156 when $VIM_POSIX was set on startup. |posix|
2157
2158 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002159 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002160 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002161 *cpo-&*
2162 & When ":preserve" was used keep the swap file when
2163 exiting normally while this buffer is still loaded.
2164 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002165 *cpo-\*
2166 \ Backslash in a [] range in a search pattern is taken
2167 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002168 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2169 '\' excluded: "/[ \-]" finds <Space> and '-'
2170 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002171 *cpo-/*
2172 / When "%" is used as the replacement string in a |:s|
2173 command, use the previous replacement string. |:s%|
2174 *cpo-{*
2175 { The |{| and |}| commands also stop at a "{" character
2176 at the start of a line.
2177 *cpo-.*
2178 . The ":chdir" and ":cd" commands fail if the current
2179 buffer is modified, unless ! is used. Vim doesn't
2180 need this, since it remembers the full path of an
2181 opened file.
2182 *cpo-bar*
2183 | The value of the $LINES and $COLUMNS environment
2184 variables overrule the terminal size values obtained
2185 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002186
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002188 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002189'cryptmethod' string (default "zip")
2190 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002191 {not in Vi}
2192 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002193 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002194 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002195 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002196 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002197 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002198 or later, files can NOT be read by Vim 7.2 and older.
2199 This adds a "seed" to the file, every time you write
2200 the file the encrypted bytes will be different.
2201
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002202 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002203 to the detected method of the file being read. Thus if you write it
2204 without changing 'cryptmethod' the same method will be used.
2205 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002206 explicitly write it, you don't get a warning unless there are other
2207 modifications. Also see |:X|.
2208
2209 When setting the global value to an empty string, it will end up with
2210 the value "zip". When setting the local value to an empty string the
2211 buffer will use the global value.
2212
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002213 When a new encryption method is added in a later version of Vim, and
2214 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002215 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002216
2217
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *'cscopepathcomp'* *'cspc'*
2219'cscopepathcomp' 'cspc' number (default 0)
2220 global
2221 {not available when compiled without the |+cscope|
2222 feature}
2223 {not in Vi}
2224 Determines how many components of the path to show in a list of tags.
2225 See |cscopepathcomp|.
2226
2227 *'cscopeprg'* *'csprg'*
2228'cscopeprg' 'csprg' string (default "cscope")
2229 global
2230 {not available when compiled without the |+cscope|
2231 feature}
2232 {not in Vi}
2233 Specifies the command to execute cscope. See |cscopeprg|.
2234 This option cannot be set from a |modeline| or in the |sandbox|, for
2235 security reasons.
2236
2237 *'cscopequickfix'* *'csqf'*
2238'cscopequickfix' 'csqf' string (default "")
2239 global
2240 {not available when compiled without the |+cscope|
2241 or |+quickfix| features}
2242 {not in Vi}
2243 Specifies whether to use quickfix window to show cscope results.
2244 See |cscopequickfix|.
2245
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002246 *'cscoperelative'* *'csre'*
2247'cscoperelative' 'csre' boolean (default off)
2248 global
2249 {not available when compiled without the |+cscope|
2250 feature}
2251 {not in Vi}
2252 In the absence of a prefix (-P) for cscope. setting this option enables
2253 to use the basename of cscope.out path as the prefix.
2254 See |cscoperelative|.
2255
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2257'cscopetag' 'cst' boolean (default off)
2258 global
2259 {not available when compiled without the |+cscope|
2260 feature}
2261 {not in Vi}
2262 Use cscope for tag commands. See |cscope-options|.
2263 NOTE: This option is reset when 'compatible' is set.
2264
2265 *'cscopetagorder'* *'csto'*
2266'cscopetagorder' 'csto' number (default 0)
2267 global
2268 {not available when compiled without the |+cscope|
2269 feature}
2270 {not in Vi}
2271 Determines the order in which ":cstag" performs a search. See
2272 |cscopetagorder|.
2273 NOTE: This option is set to 0 when 'compatible' is set.
2274
2275 *'cscopeverbose'* *'csverb'*
2276 *'nocscopeverbose'* *'nocsverb'*
2277'cscopeverbose' 'csverb' boolean (default off)
2278 global
2279 {not available when compiled without the |+cscope|
2280 feature}
2281 {not in Vi}
2282 Give messages when adding a cscope database. See |cscopeverbose|.
2283 NOTE: This option is reset when 'compatible' is set.
2284
Bram Moolenaar860cae12010-06-05 23:22:07 +02002285 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2286'cursorbind' 'crb' boolean (default off)
2287 local to window
2288 {not in Vi}
2289 {not available when compiled without the |+cursorbind|
2290 feature}
2291 When this option is set, as the cursor in the current
2292 window moves other cursorbound windows (windows that also have
2293 this option set) move their cursors to the corresponding line and
2294 column. This option is useful for viewing the
2295 differences between two versions of a file (see 'diff'); in diff mode,
2296 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002297 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002298
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002299
2300 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2301'cursorcolumn' 'cuc' boolean (default off)
2302 local to window
2303 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002304 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002305 feature}
2306 Highlight the screen column of the cursor with CursorColumn
2307 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2308 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002309 If you only want the highlighting in the current window you can use
2310 these autocommands: >
2311 au WinLeave * set nocursorline nocursorcolumn
2312 au WinEnter * set cursorline cursorcolumn
2313<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002314
2315 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2316'cursorline' 'cul' boolean (default off)
2317 local to window
2318 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002319 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002320 feature}
2321 Highlight the screen line of the cursor with CursorLine
2322 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2323 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002324 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002325 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002326
2327
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 *'debug'*
2329'debug' string (default "")
2330 global
2331 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002332 These values can be used:
2333 msg Error messages that would otherwise be omitted will be given
2334 anyway.
2335 throw Error messages that would otherwise be omitted will be given
2336 anyway and also throw an exception and set |v:errmsg|.
2337 beep A message will be given when otherwise only a beep would be
2338 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002339 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002340 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2341 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342
2343 *'define'* *'def'*
2344'define' 'def' string (default "^\s*#\s*define")
2345 global or local to buffer |global-local|
2346 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002347 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002348 pattern, just like for the "/" command. This option is used for the
2349 commands like "[i" and "[d" |include-search|. The 'isident' option is
2350 used to recognize the defined name after the match:
2351 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2352 See |option-backslash| about inserting backslashes to include a space
2353 or backslash.
2354 The default value is for C programs. For C++ this value would be
2355 useful, to include const type declarations: >
2356 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2357< When using the ":set" command, you need to double the backslashes!
2358
2359 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2360'delcombine' 'deco' boolean (default off)
2361 global
2362 {not in Vi}
2363 {only available when compiled with the |+multi_byte|
2364 feature}
2365 If editing Unicode and this option is set, backspace and Normal mode
2366 "x" delete each combining character on its own. When it is off (the
2367 default) the character along with its combining characters are
2368 deleted.
2369 Note: When 'delcombine' is set "xx" may work different from "2x"!
2370
2371 This is useful for Arabic, Hebrew and many other languages where one
2372 may have combining characters overtop of base characters, and want
2373 to remove only the combining ones.
2374
2375 *'dictionary'* *'dict'*
2376'dictionary' 'dict' string (default "")
2377 global or local to buffer |global-local|
2378 {not in Vi}
2379 List of file names, separated by commas, that are used to lookup words
2380 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2381 contain a list of words. This can be one word per line, or several
2382 words per line, separated by non-keyword characters (white space is
2383 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002384 When this option is empty, or an entry "spell" is present, spell
2385 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002386 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 after a comma are ignored, otherwise spaces are included in the file
2388 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002389 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 Where to find a list of words?
2391 - On FreeBSD, there is the file "/usr/share/dict/words".
2392 - In the Simtel archive, look in the "msdos/linguist" directory.
2393 - In "miscfiles" of the GNU collection.
2394 The use of |:set+=| and |:set-=| is preferred when adding or removing
2395 directories from the list. This avoids problems when a future version
2396 uses another default.
2397 Backticks cannot be used in this option for security reasons.
2398
2399 *'diff'* *'nodiff'*
2400'diff' boolean (default off)
2401 local to window
2402 {not in Vi}
2403 {not available when compiled without the |+diff|
2404 feature}
2405 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002406 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407
2408 *'dex'* *'diffexpr'*
2409'diffexpr' 'dex' string (default "")
2410 global
2411 {not in Vi}
2412 {not available when compiled without the |+diff|
2413 feature}
2414 Expression which is evaluated to obtain an ed-style diff file from two
2415 versions of a file. See |diff-diffexpr|.
2416 This option cannot be set from a |modeline| or in the |sandbox|, for
2417 security reasons.
2418
2419 *'dip'* *'diffopt'*
2420'diffopt' 'dip' string (default "filler")
2421 global
2422 {not in Vi}
2423 {not available when compiled without the |+diff|
2424 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002425 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 All are optional. Items must be separated by a comma.
2427
2428 filler Show filler lines, to keep the text
2429 synchronized with a window that has inserted
2430 lines at the same position. Mostly useful
2431 when windows are side-by-side and 'scrollbind'
2432 is set.
2433
2434 context:{n} Use a context of {n} lines between a change
2435 and a fold that contains unchanged lines.
2436 When omitted a context of six lines is used.
2437 See |fold-diff|.
2438
2439 icase Ignore changes in case of text. "a" and "A"
2440 are considered the same. Adds the "-i" flag
2441 to the "diff" command if 'diffexpr' is empty.
2442
2443 iwhite Ignore changes in amount of white space. Adds
2444 the "-b" flag to the "diff" command if
2445 'diffexpr' is empty. Check the documentation
2446 of the "diff" command for what this does
2447 exactly. It should ignore adding trailing
2448 white space, but not leading white space.
2449
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002450 horizontal Start diff mode with horizontal splits (unless
2451 explicitly specified otherwise).
2452
2453 vertical Start diff mode with vertical splits (unless
2454 explicitly specified otherwise).
2455
2456 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2457 starting diff mode. Without this 2 is used.
2458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 Examples: >
2460
2461 :set diffopt=filler,context:4
2462 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002463 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464<
2465 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2466'digraph' 'dg' boolean (default off)
2467 global
2468 {not in Vi}
2469 {not available when compiled without the |+digraphs|
2470 feature}
2471 Enable the entering of digraphs in Insert mode with {char1} <BS>
2472 {char2}. See |digraphs|.
2473 NOTE: This option is reset when 'compatible' is set.
2474
2475 *'directory'* *'dir'*
2476'directory' 'dir' string (default for Amiga: ".,t:",
2477 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2478 for Unix: ".,~/tmp,/var/tmp,/tmp")
2479 global
2480 List of directory names for the swap file, separated with commas.
2481 - The swap file will be created in the first directory where this is
2482 possible.
2483 - Empty means that no swap file will be used (recovery is
2484 impossible!).
2485 - A directory "." means to put the swap file in the same directory as
2486 the edited file. On Unix, a dot is prepended to the file name, so
2487 it doesn't show in a directory listing. On MS-Windows the "hidden"
2488 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002489 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490 put the swap file relative to where the edited file is. The leading
2491 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002492 - For Unix and Win32, if a directory ends in two path separators "//"
2493 or "\\", the swap file name will be built from the complete path to
2494 the file with all path separators substituted to percent '%' signs.
2495 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002496 On Win32, when a separating comma is following, you must use "//",
2497 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 - Spaces after the comma are ignored, other spaces are considered part
2499 of the directory name. To have a space at the start of a directory
2500 name, precede it with a backslash.
2501 - To include a comma in a directory name precede it with a backslash.
2502 - A directory name may end in an ':' or '/'.
2503 - Environment variables are expanded |:set_env|.
2504 - Careful with '\' characters, type one before a space, type two to
2505 get one in the option (see |option-backslash|), for example: >
2506 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2507< - For backwards compatibility with Vim version 3.0 a '>' at the start
2508 of the option is removed.
2509 Using "." first in the list is recommended. This means that editing
2510 the same file twice will result in a warning. Using "/tmp" on Unix is
2511 discouraged: When the system crashes you lose the swap file.
2512 "/var/tmp" is often not cleared when rebooting, thus is a better
2513 choice than "/tmp". But it can contain a lot of files, your swap
2514 files get lost in the crowd. That is why a "tmp" directory in your
2515 home directory is tried first.
2516 The use of |:set+=| and |:set-=| is preferred when adding or removing
2517 directories from the list. This avoids problems when a future version
2518 uses another default.
2519 This option cannot be set from a |modeline| or in the |sandbox|, for
2520 security reasons.
2521 {Vi: directory to put temp file in, defaults to "/tmp"}
2522
2523 *'display'* *'dy'*
2524'display' 'dy' string (default "")
2525 global
2526 {not in Vi}
2527 Change the way text is displayed. This is comma separated list of
2528 flags:
2529 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002530 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 last line that doesn't fit is replaced with "@" lines.
2532 uhex Show unprintable characters hexadecimal as <xx>
2533 instead of using ^C and ~C.
2534
2535 *'eadirection'* *'ead'*
2536'eadirection' 'ead' string (default "both")
2537 global
2538 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002539 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 feature}
2541 Tells when the 'equalalways' option applies:
2542 ver vertically, width of windows is not affected
2543 hor horizontally, height of windows is not affected
2544 both width and height of windows is affected
2545
2546 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2547'edcompatible' 'ed' boolean (default off)
2548 global
2549 Makes the 'g' and 'c' flags of the ":substitute" command to be
2550 toggled each time the flag is given. See |complex-change|. See
2551 also 'gdefault' option.
2552 Switching this option on is discouraged!
2553
2554 *'encoding'* *'enc'* *E543*
2555'encoding' 'enc' string (default: "latin1" or value from $LANG)
2556 global
2557 {only available when compiled with the |+multi_byte|
2558 feature}
2559 {not in Vi}
2560 Sets the character encoding used inside Vim. It applies to text in
2561 the buffers, registers, Strings in expressions, text stored in the
2562 viminfo file, etc. It sets the kind of characters which Vim can work
2563 with. See |encoding-names| for the possible values.
2564
2565 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002566 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002568 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
Bram Moolenaar865242e2010-07-14 21:12:05 +02002570 This option cannot be set from a |modeline|. It would most likely
2571 corrupt the text.
2572
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2574 "utf-8". Although care has been taken to allow different values of
2575 'encoding', "utf-8" is the natural choice for the environment and
2576 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002577 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 versions, and to avoid changing the encoding of newly created files
2579 without your knowledge (in case 'fileencodings' is empty).
2580
2581 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002582 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 iconv() or as specified with 'charconvert'.
2584
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002585 If you need to know whether 'encoding' is a multi-byte encoding, you
2586 can use: >
2587 if has("multi_byte_encoding")
2588<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 Normally 'encoding' will be equal to your current locale. This will
2590 be the default if Vim recognizes your environment settings. If
2591 'encoding' is not set to the current locale, 'termencoding' must be
2592 set to convert typed and displayed text. See |encoding-table|.
2593
2594 When you set this option, it fires the |EncodingChanged| autocommand
2595 event so that you can set up fonts if necessary.
2596
2597 When the option is set, the value is converted to lowercase. Thus
2598 you can set it with uppercase values too. Underscores are translated
2599 to '-' signs.
2600 When the encoding is recognized, it is changed to the standard name.
2601 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2602 "iso-8859-2" and "utf8" becomes "utf-8".
2603
2604 Note: "latin1" is also used when the encoding could not be detected.
2605 This only works when editing files in the same encoding! When the
2606 actual character set is not latin1, make sure 'fileencoding' and
2607 'fileencodings' are empty. When conversion is needed, switch to using
2608 utf-8.
2609
2610 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2611 You don't notice this while editing, but it does matter for the
2612 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2613 setting 'encoding' to one of these values instead of utf-8 only has
2614 effect for encoding used for files when 'fileencoding' is empty.
2615
Bram Moolenaar661b1822005-07-28 22:36:45 +00002616 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2617 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618
2619 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2620'endofline' 'eol' boolean (default on)
2621 local to buffer
2622 {not in Vi}
2623 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 option is automatically set when starting to edit a new file, unless
2626 the file does not have an <EOL> for the last line in the file, in
2627 which case it is reset. Normally you don't have to set or reset this
2628 option. When 'binary' is off the value is not used when writing the
2629 file. When 'binary' is on it is used to remember the presence of a
2630 <EOL> for the last line in the file, so that when you write the file
2631 the situation from the original file can be kept. But you can change
2632 it if you want to.
2633
2634 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2635'equalalways' 'ea' boolean (default on)
2636 global
2637 {not in Vi}
2638 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002639 splitting or closing a window. This also happens the moment the
2640 option is switched on. When off, splitting a window will reduce the
2641 size of the current window and leave the other windows the same. When
2642 closing a window the extra lines are given to the window next to it
2643 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 When mixing vertically and horizontally split windows, a minimal size
2645 is computed and some windows may be larger if there is room. The
2646 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002647 Changing the height and width of a window can be avoided by setting
2648 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002649 If a window size is specified when creating a new window sizes are
2650 currently not equalized (it's complicated, but may be implemented in
2651 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652
2653 *'equalprg'* *'ep'*
2654'equalprg' 'ep' string (default "")
2655 global or local to buffer |global-local|
2656 {not in Vi}
2657 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002658 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002659 or 'indentexpr'. When Vim was compiled without internal formatting,
2660 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002661 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 about including spaces and backslashes.
2663 This option cannot be set from a |modeline| or in the |sandbox|, for
2664 security reasons.
2665
2666 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2667'errorbells' 'eb' boolean (default off)
2668 global
2669 Ring the bell (beep or screen flash) for error messages. This only
2670 makes a difference for error messages, the bell will be used always
2671 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002672 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 screen flash or do nothing.
2674
2675 *'errorfile'* *'ef'*
2676'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2677 others: "errors.err")
2678 global
2679 {not in Vi}
2680 {not available when compiled without the |+quickfix|
2681 feature}
2682 Name of the errorfile for the QuickFix mode (see |:cf|).
2683 When the "-q" command-line argument is used, 'errorfile' is set to the
2684 following argument. See |-q|.
2685 NOT used for the ":make" command. See 'makeef' for that.
2686 Environment variables are expanded |:set_env|.
2687 See |option-backslash| about including spaces and backslashes.
2688 This option cannot be set from a |modeline| or in the |sandbox|, for
2689 security reasons.
2690
2691 *'errorformat'* *'efm'*
2692'errorformat' 'efm' string (default is very long)
2693 global or local to buffer |global-local|
2694 {not in Vi}
2695 {not available when compiled without the |+quickfix|
2696 feature}
2697 Scanf-like description of the format for the lines in the error file
2698 (see |errorformat|).
2699
2700 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2701'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2702 global
2703 {not in Vi}
2704 Function keys that start with an <Esc> are recognized in Insert
2705 mode. When this option is off, the cursor and function keys cannot be
2706 used in Insert mode if they start with an <Esc>. The advantage of
2707 this is that the single <Esc> is recognized immediately, instead of
2708 after one second. Instead of resetting this option, you might want to
2709 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2710 when 'esckeys' is off, you can still map anything, but the cursor keys
2711 won't work by default.
2712 NOTE: This option is set to the Vi default value when 'compatible' is
2713 set and to the Vim default value when 'compatible' is reset.
2714
2715 *'eventignore'* *'ei'*
2716'eventignore' 'ei' string (default "")
2717 global
2718 {not in Vi}
2719 {not available when compiled without the |+autocmd|
2720 feature}
2721 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002722 When set to "all" or when "all" is one of the items, all autocommand
2723 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 Otherwise this is a comma separated list of event names. Example: >
2725 :set ei=WinEnter,WinLeave
2726<
2727 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2728'expandtab' 'et' boolean (default off)
2729 local to buffer
2730 {not in Vi}
2731 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002732 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2734 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2735 NOTE: This option is reset when 'compatible' is set.
2736
2737 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2738'exrc' 'ex' boolean (default off)
2739 global
2740 {not in Vi}
2741 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2742 directory. If you switch this option on you should also consider
2743 setting the 'secure' option (see |initialization|). Using a local
2744 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2745 also see |.vimrc| and |gui-init|.
2746 This option cannot be set from a |modeline| or in the |sandbox|, for
2747 security reasons.
2748
2749 *'fileencoding'* *'fenc'* *E213*
2750'fileencoding' 'fenc' string (default: "")
2751 local to buffer
2752 {only available when compiled with the |+multi_byte|
2753 feature}
2754 {not in Vi}
2755 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002756
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002758 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 When 'fileencoding' is empty, the same value as 'encoding' will be
2760 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002761 Conversion will also be done when 'encoding' and 'fileencoding' are
2762 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2763 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002765 'encoding' is "utf-8" or another Unicode encoding, conversion
2766 is most likely done in a way that the reverse conversion
2767 results in the same text. When 'encoding' is not "utf-8" some
2768 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002769
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 See 'encoding' for the possible values. Additionally, values may be
2771 specified that can be handled by the converter, see
2772 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002773
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 When reading a file 'fileencoding' will be set from 'fileencodings'.
2775 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002776 'fileencoding', use the |++enc| argument. One exception: when
2777 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002778 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002779
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2781 When the option is set, the value is converted to lowercase. Thus
2782 you can set it with uppercase values too. '_' characters are
2783 replaced with '-'. If a name is recognized from the list for
2784 'encoding', it is replaced by the standard name. For example
2785 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002786
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 When this option is set, after starting to edit a file, the 'modified'
2788 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002789
2790 Keep in mind that changing 'fenc' from a modeline happens
2791 AFTER the text has been read, thus it applies to when the file will be
2792 written. If you do set 'fenc' in a modeline, you might want to set
2793 'nomodified' to avoid not being able to ":q".
2794
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 This option can not be changed when 'modifiable' is off.
2796
2797 *'fe'*
2798 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 old short name was 'fe', which is no longer used.
2801
2802 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002803'fileencodings' 'fencs' string (default: "ucs-bom",
2804 "ucs-bom,utf-8,default,latin1" when
2805 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 global
2807 {only available when compiled with the |+multi_byte|
2808 feature}
2809 {not in Vi}
2810 This is a list of character encodings considered when starting to edit
2811 an existing file. When a file is read, Vim tries to use the first
2812 mentioned character encoding. If an error is detected, the next one
2813 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002814 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 an empty string, which means the value of 'encoding' is used.
2816 WARNING: Conversion can cause loss of information! When
2817 'encoding' is "utf-8" (or one of the other Unicode variants)
2818 conversion is most likely done in a way that the reverse
2819 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002820 "utf-8" some non-ASCII characters may be lost! You can use
2821 the |++bad| argument to specify what is done with characters
2822 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 For an empty file or a file with only ASCII characters most encodings
2824 will work and the first entry of 'fileencodings' will be used (except
2825 "ucs-bom", which requires the BOM to be present). If you prefer
2826 another encoding use an BufReadPost autocommand event to test if your
2827 preferred encoding is to be used. Example: >
2828 au BufReadPost * if search('\S', 'w') == 0 |
2829 \ set fenc=iso-2022-jp | endif
2830< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2831 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002832 When the |++enc| argument is used then the value of 'fileencodings' is
2833 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002834 Note that 'fileencodings' is not used for a new file, the global value
2835 of 'fileencoding' is used instead. You can set it with: >
2836 :setglobal fenc=iso-8859-2
2837< This means that a non-existing file may get a different encoding than
2838 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 The special value "ucs-bom" can be used to check for a Unicode BOM
2840 (Byte Order Mark) at the start of the file. It must not be preceded
2841 by "utf-8" or another Unicode encoding for this to work properly.
2842 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2843 because Vim cannot detect an error, thus the encoding is always
2844 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002845 The special value "default" can be used for the encoding from the
2846 environment. This is the default value for 'encoding'. It is useful
2847 when 'encoding' is set to "utf-8" and your environment uses a
2848 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002849 When 'encoding' is "utf-8" and a file contains an illegal byte
2850 sequence it won't be recognized as UTF-8. You can use the |8g8|
2851 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 WRONG VALUES: WHAT'S WRONG:
2853 latin1,utf-8 "latin1" will always be used
2854 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2855 file
2856 cp1250,latin1 "cp1250" will always be used
2857 If 'fileencodings' is empty, 'fileencoding' is not modified.
2858 See 'fileencoding' for the possible values.
2859 Setting this option does not have an effect until the next time a file
2860 is read.
2861
2862 *'fileformat'* *'ff'*
2863'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2864 Unix default: "unix",
2865 Macintosh default: "mac")
2866 local to buffer
2867 {not in Vi}
2868 This gives the <EOL> of the current buffer, which is used for
2869 reading/writing the buffer from/to a file:
2870 dos <CR> <NL>
2871 unix <NL>
2872 mac <CR>
2873 When "dos" is used, CTRL-Z at the end of a file is ignored.
2874 See |file-formats| and |file-read|.
2875 For the character encoding of the file see 'fileencoding'.
2876 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002877 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 This option is set automatically when starting to edit a file and
2879 'fileformats' is not empty and 'binary' is off.
2880 When this option is set, after starting to edit a file, the 'modified'
2881 option is set, because the file would be different when written.
2882 This option can not be changed when 'modifiable' is off.
2883 For backwards compatibility: When this option is set to "dos",
2884 'textmode' is set, otherwise 'textmode' is reset.
2885
2886 *'fileformats'* *'ffs'*
2887'fileformats' 'ffs' string (default:
2888 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2889 Vim Unix: "unix,dos",
2890 Vim Mac: "mac,unix,dos",
2891 Vi Cygwin: "unix,dos",
2892 Vi others: "")
2893 global
2894 {not in Vi}
2895 This gives the end-of-line (<EOL>) formats that will be tried when
2896 starting to edit a new buffer and when reading a file into an existing
2897 buffer:
2898 - When empty, the format defined with 'fileformat' will be used
2899 always. It is not set automatically.
2900 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 'fileformats' name will be used when a file is read into an existing
2903 buffer, no matter what 'fileformat' for that buffer is set to.
2904 - When more than one name is present, separated by commas, automatic
2905 <EOL> detection will be done when reading a file. When starting to
2906 edit a file, a check is done for the <EOL>:
2907 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2908 'fileformat' is set to "dos".
2909 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002910 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002912 3. If 'fileformat' has not yet been set, and if 'fileformats'
2913 includes "mac", 'fileformat' is set to "mac".
2914 This means that "mac" is only chosen when:
2915 "unix" is not present or no <NL> is found in the file, and
2916 "dos" is not present or no <CR><NL> is found in the file.
2917 Except: if "unix" was chosen, but there is a <CR> before
2918 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002919 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 4. If 'fileformat' is still not set, the first name from
2921 'fileformats' is used.
2922 When reading a file into an existing buffer, the same is done, but
2923 this happens like 'fileformat' has been set appropriately for that
2924 file only, the option is not changed.
2925 When 'binary' is set, the value of 'fileformats' is not used.
2926
Bram Moolenaar81af9252010-12-10 20:35:50 +01002927 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002928 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2931 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2932 done:
2933 - When 'fileformats' is empty, there is no automatic detection. Dos
2934 format will be used.
2935 - When 'fileformats' is set to one or more names, automatic detection
2936 is done. This is based on the first <NL> in the file: If there is a
2937 <CR> in front of it, Dos format is used, otherwise Unix format is
2938 used.
2939 Also see |file-formats|.
2940 For backwards compatibility: When this option is set to an empty
2941 string or one format (no comma is included), 'textauto' is reset,
2942 otherwise 'textauto' is set.
2943 NOTE: This option is set to the Vi default value when 'compatible' is
2944 set and to the Vim default value when 'compatible' is reset.
2945
Bram Moolenaarbf884932013-04-05 22:26:15 +02002946 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2947'fileignorecase' 'fic' boolean (default on for systems where case in file
2948 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002949 global
2950 {not in Vi}
2951 When set case is ignored when using file names and directories.
2952 See 'wildignorecase' for only ignoring case when doing completion.
2953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 *'filetype'* *'ft'*
2955'filetype' 'ft' string (default: "")
2956 local to buffer
2957 {not in Vi}
2958 {not available when compiled without the |+autocmd|
2959 feature}
2960 When this option is set, the FileType autocommand event is triggered.
2961 All autocommands that match with the value of this option will be
2962 executed. Thus the value of 'filetype' is used in place of the file
2963 name.
2964 Otherwise this option does not always reflect the current file type.
2965 This option is normally set when the file type is detected. To enable
2966 this use the ":filetype on" command. |:filetype|
2967 Setting this option to a different value is most useful in a modeline,
2968 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002969 Example, for in an IDL file:
2970 /* vim: set filetype=idl : */ ~
2971 |FileType| |filetypes|
2972 When a dot appears in the value then this separates two filetype
2973 names. Example:
2974 /* vim: set filetype=c.doxygen : */ ~
2975 This will use the "c" filetype first, then the "doxygen" filetype.
2976 This works both for filetype plugins and for syntax files. More than
2977 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 This option is not copied to another buffer, independent of the 's' or
2979 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002980 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981
2982 *'fillchars'* *'fcs'*
2983'fillchars' 'fcs' string (default "vert:|,fold:-")
2984 global
2985 {not in Vi}
2986 {not available when compiled without the |+windows|
2987 and |+folding| features}
2988 Characters to fill the statuslines and vertical separators.
2989 It is a comma separated list of items:
2990
2991 item default Used for ~
2992 stl:c ' ' or '^' statusline of the current window
2993 stlnc:c ' ' or '-' statusline of the non-current windows
2994 vert:c '|' vertical separators |:vsplit|
2995 fold:c '-' filling 'foldtext'
2996 diff:c '-' deleted lines of the 'diff' option
2997
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002998 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 "stlnc" the space will be used when there is highlighting, '^' or '-'
3000 otherwise.
3001
3002 Example: >
3003 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3004< This is similar to the default, except that these characters will also
3005 be used when there is highlighting.
3006
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003007 for "stl" and "stlnc" only single-byte values are supported.
3008
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 The highlighting used for these items:
3010 item highlight group ~
3011 stl:c StatusLine |hl-StatusLine|
3012 stlnc:c StatusLineNC |hl-StatusLineNC|
3013 vert:c VertSplit |hl-VertSplit|
3014 fold:c Folded |hl-Folded|
3015 diff:c DiffDelete |hl-DiffDelete|
3016
3017 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3018'fkmap' 'fk' boolean (default off) *E198*
3019 global
3020 {not in Vi}
3021 {only available when compiled with the |+rightleft|
3022 feature}
3023 When on, the keyboard is mapped for the Farsi character set.
3024 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003025 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026
3027 *'foldclose'* *'fcl'*
3028'foldclose' 'fcl' string (default "")
3029 global
3030 {not in Vi}
3031 {not available when compiled without the |+folding|
3032 feature}
3033 When set to "all", a fold is closed when the cursor isn't in it and
3034 its level is higher than 'foldlevel'. Useful if you want folds to
3035 automatically close when moving out of them.
3036
3037 *'foldcolumn'* *'fdc'*
3038'foldcolumn' 'fdc' number (default 0)
3039 local to window
3040 {not in Vi}
3041 {not available when compiled without the |+folding|
3042 feature}
3043 When non-zero, a column with the specified width is shown at the side
3044 of the window which indicates open and closed folds. The maximum
3045 value is 12.
3046 See |folding|.
3047
3048 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3049'foldenable' 'fen' boolean (default on)
3050 local to window
3051 {not in Vi}
3052 {not available when compiled without the |+folding|
3053 feature}
3054 When off, all folds are open. This option can be used to quickly
3055 switch between showing all text unfolded and viewing the text with
3056 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003057 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 'foldenable' is off.
3059 This option is set by commands that create a new fold or close a fold.
3060 See |folding|.
3061
3062 *'foldexpr'* *'fde'*
3063'foldexpr' 'fde' string (default: "0")
3064 local to window
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003067 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003069 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003070
Bram Moolenaar30b65812012-07-12 22:01:11 +02003071 The expression will be evaluated in the |sandbox| if set from a
3072 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003073 This option can't be set from a |modeline| when the 'diff' option is
3074 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003075
3076 It is not allowed to change text or jump to another window while
3077 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078
3079 *'foldignore'* *'fdi'*
3080'foldignore' 'fdi' string (default: "#")
3081 local to window
3082 {not in Vi}
3083 {not available when compiled without the |+folding|
3084 feature}
3085 Used only when 'foldmethod' is "indent". Lines starting with
3086 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003087 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 The default "#" works well for C programs. See |fold-indent|.
3089
3090 *'foldlevel'* *'fdl'*
3091'foldlevel' 'fdl' number (default: 0)
3092 local to window
3093 {not in Vi}
3094 {not available when compiled without the |+folding|
3095 feature}
3096 Sets the fold level: Folds with a higher level will be closed.
3097 Setting this option to zero will close all folds. Higher numbers will
3098 close fewer folds.
3099 This option is set by commands like |zm|, |zM| and |zR|.
3100 See |fold-foldlevel|.
3101
3102 *'foldlevelstart'* *'fdls'*
3103'foldlevelstart' 'fdls' number (default: -1)
3104 global
3105 {not in Vi}
3106 {not available when compiled without the |+folding|
3107 feature}
3108 Sets 'foldlevel' when starting to edit another buffer in a window.
3109 Useful to always start editing with all folds closed (value zero),
3110 some folds closed (one) or no folds closed (99).
3111 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003112 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 ignores this option and closes all folds.
3114 It is also done before BufReadPre autocommands, to allow an autocmd to
3115 overrule the 'foldlevel' value for specific files.
3116 When the value is negative, it is not used.
3117
3118 *'foldmarker'* *'fmr'* *E536*
3119'foldmarker' 'fmr' string (default: "{{{,}}}")
3120 local to window
3121 {not in Vi}
3122 {not available when compiled without the |+folding|
3123 feature}
3124 The start and end marker used when 'foldmethod' is "marker". There
3125 must be one comma, which separates the start and end marker. The
3126 marker is a literal string (a regular expression would be too slow).
3127 See |fold-marker|.
3128
3129 *'foldmethod'* *'fdm'*
3130'foldmethod' 'fdm' string (default: "manual")
3131 local to window
3132 {not in Vi}
3133 {not available when compiled without the |+folding|
3134 feature}
3135 The kind of folding used for the current window. Possible values:
3136 |fold-manual| manual Folds are created manually.
3137 |fold-indent| indent Lines with equal indent form a fold.
3138 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3139 |fold-marker| marker Markers are used to specify folds.
3140 |fold-syntax| syntax Syntax highlighting items specify folds.
3141 |fold-diff| diff Fold text that is not changed.
3142
3143 *'foldminlines'* *'fml'*
3144'foldminlines' 'fml' number (default: 1)
3145 local to window
3146 {not in Vi}
3147 {not available when compiled without the |+folding|
3148 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003149 Sets the number of screen lines above which a fold can be displayed
3150 closed. Also for manually closed folds. With the default value of
3151 one a fold can only be closed if it takes up two or more screen lines.
3152 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003153 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 "zc" to close a fold, which is displayed open because it's smaller
3155 than 'foldminlines', a following "zc" may close a containing fold.
3156
3157 *'foldnestmax'* *'fdn'*
3158'foldnestmax' 'fdn' number (default: 20)
3159 local to window
3160 {not in Vi}
3161 {not available when compiled without the |+folding|
3162 feature}
3163 Sets the maximum nesting of folds for the "indent" and "syntax"
3164 methods. This avoids that too many folds will be created. Using more
3165 than 20 doesn't work, because the internal limit is 20.
3166
3167 *'foldopen'* *'fdo'*
3168'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3169 search,tag,undo")
3170 global
3171 {not in Vi}
3172 {not available when compiled without the |+folding|
3173 feature}
3174 Specifies for which type of commands folds will be opened, if the
3175 command moves the cursor into a closed fold. It is a comma separated
3176 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003177 NOTE: When the command is part of a mapping this option is not used.
3178 Add the |zv| command to the mapping to get the same effect.
3179 (rationale: the mapping may want to control opening folds itself)
3180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 item commands ~
3182 all any
3183 block "(", "{", "[[", "[{", etc.
3184 hor horizontal movements: "l", "w", "fx", etc.
3185 insert any command in Insert mode
3186 jump far jumps: "G", "gg", etc.
3187 mark jumping to a mark: "'m", CTRL-O, etc.
3188 percent "%"
3189 quickfix ":cn", ":crew", ":make", etc.
3190 search search for a pattern: "/", "n", "*", "gd", etc.
3191 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003192 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 tag jumping to a tag: ":ta", CTRL-T, etc.
3194 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 When a movement command is used for an operator (e.g., "dl" or "y%")
3196 this option is not used. This means the operator will include the
3197 whole closed fold.
3198 Note that vertical movements are not here, because it would make it
3199 very difficult to move onto a closed fold.
3200 In insert mode the folds containing the cursor will always be open
3201 when text is inserted.
3202 To close folds you can re-apply 'foldlevel' with the |zx| command or
3203 set the 'foldclose' option to "all".
3204
3205 *'foldtext'* *'fdt'*
3206'foldtext' 'fdt' string (default: "foldtext()")
3207 local to window
3208 {not in Vi}
3209 {not available when compiled without the |+folding|
3210 feature}
3211 An expression which is used to specify the text displayed for a closed
3212 fold. See |fold-foldtext|.
3213
Bram Moolenaar30b65812012-07-12 22:01:11 +02003214 The expression will be evaluated in the |sandbox| if set from a
3215 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003216
3217 It is not allowed to change text or jump to another window while
3218 evaluating 'foldtext' |textlock|.
3219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 *'formatoptions'* *'fo'*
3221'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3222 local to buffer
3223 {not in Vi}
3224 This is a sequence of letters which describes how automatic
3225 formatting is to be done. See |fo-table|. When the 'paste' option is
3226 on, no formatting is done (like 'formatoptions' is empty). Commas can
3227 be inserted for readability.
3228 To avoid problems with flags that are added in the future, use the
3229 "+=" and "-=" feature of ":set" |add-option-flags|.
3230 NOTE: This option is set to the Vi default value when 'compatible' is
3231 set and to the Vim default value when 'compatible' is reset.
3232
Bram Moolenaar86b68352004-12-27 21:59:20 +00003233 *'formatlistpat'* *'flp'*
3234'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3235 local to buffer
3236 {not in Vi}
3237 A pattern that is used to recognize a list header. This is used for
3238 the "n" flag in 'formatoptions'.
3239 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003240 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003241 while still checking more characters. There must be a character
3242 following the pattern, when it matches the whole line it is handled
3243 like there is no match.
3244 The default recognizes a number, followed by an optional punctuation
3245 character and white space.
3246
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 *'formatprg'* *'fp'*
3248'formatprg' 'fp' string (default "")
3249 global
3250 {not in Vi}
3251 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003252 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003254 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003255 If the 'formatexpr' option is not empty it will be used instead.
3256 Otherwise, if 'formatprg' option is an empty string, the internal
3257 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003258 Environment variables are expanded |:set_env|. See |option-backslash|
3259 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003260 This option cannot be set from a |modeline| or in the |sandbox|, for
3261 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003263 *'formatexpr'* *'fex'*
3264'formatexpr' 'fex' string (default "")
3265 local to buffer
3266 {not in Vi}
3267 {not available when compiled without the |+eval|
3268 feature}
3269 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003270 operator or automatic formatting (see 'formatoptions'). When this
3271 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003272
3273 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003274 The |v:count| variable holds the number of lines to be formatted.
3275 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003276 inserted if the expression is being evaluated due to
3277 automatic formatting. This can be empty. Don't insert
3278 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003279
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003280 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003281 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003282< This will invoke the mylang#Format() function in the
3283 autoload/mylang.vim file in 'runtimepath'. |autoload|
3284
3285 The expression is also evaluated when 'textwidth' is set and adding
3286 text beyond that limit. This happens under the same conditions as
3287 when internal formatting is used. Make sure the cursor is kept in the
3288 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003289 return "i" or "R" in this situation.
3290
3291 When the expression evaluates to non-zero Vim will fall back to using
3292 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003293
Bram Moolenaar30b65812012-07-12 22:01:11 +02003294 The expression will be evaluated in the |sandbox| when set from a
3295 modeline, see |sandbox-option|. That stops the option from working,
3296 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003297
3298 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003299'fsync' 'fs' boolean (default on)
3300 global
3301 {not in Vi}
3302 When on, the library function fsync() will be called after writing a
3303 file. This will flush a file to disk, ensuring that it is safely
3304 written even on filesystems which do metadata-only journaling. This
3305 will force the harddrive to spin up on Linux systems running in laptop
3306 mode, so it may be undesirable in some situations. Be warned that
3307 turning this off increases the chances of data loss after a crash. On
3308 systems without an fsync() implementation, this variable is always
3309 off.
3310 Also see 'swapsync' for controlling fsync() on swap files.
3311
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3313'gdefault' 'gd' boolean (default off)
3314 global
3315 {not in Vi}
3316 When on, the ":substitute" flag 'g' is default on. This means that
3317 all matches in a line are substituted instead of one. When a 'g' flag
3318 is given to a ":substitute" command, this will toggle the substitution
3319 of all or one match. See |complex-change|.
3320
3321 command 'gdefault' on 'gdefault' off ~
3322 :s/// subst. all subst. one
3323 :s///g subst. one subst. all
3324 :s///gg subst. all subst. one
3325
3326 NOTE: This option is reset when 'compatible' is set.
3327
3328 *'grepformat'* *'gfm'*
3329'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3330 global
3331 {not in Vi}
3332 Format to recognize for the ":grep" command output.
3333 This is a scanf-like string that uses the same format as the
3334 'errorformat' option: see |errorformat|.
3335
3336 *'grepprg'* *'gp'*
3337'grepprg' 'gp' string (default "grep -n ",
3338 Unix: "grep -n $* /dev/null",
3339 Win32: "findstr /n" or "grep -n",
3340 VMS: "SEARCH/NUMBERS ")
3341 global or local to buffer |global-local|
3342 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003343 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 and '#' characters, which are expanded like when used in a command-
3345 line. The placeholder "$*" is allowed to specify where the arguments
3346 will be included. Environment variables are expanded |:set_env|. See
3347 |option-backslash| about including spaces and backslashes.
3348 When your "grep" accepts the "-H" argument, use this to make ":grep"
3349 also work well with a single file: >
3350 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003351< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003352 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3353 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003354 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 apply equally to 'grepprg'.
3356 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3357 otherwise it's "grep -n".
3358 This option cannot be set from a |modeline| or in the |sandbox|, for
3359 security reasons.
3360
3361 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3362'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3363 ve:ver35-Cursor,
3364 o:hor50-Cursor,
3365 i-ci:ver25-Cursor/lCursor,
3366 r-cr:hor20-Cursor/lCursor,
3367 sm:block-Cursor
3368 -blinkwait175-blinkoff150-blinkon175",
3369 for MS-DOS and Win32 console:
3370 "n-v-c:block,o:hor50,i-ci:hor15,
3371 r-cr:hor30,sm:block")
3372 global
3373 {not in Vi}
3374 {only available when compiled with GUI enabled, and
3375 for MS-DOS and Win32 console}
3376 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003377 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 the height of the cursor can be changed. This can be done by
3379 specifying a block cursor, or a percentage for a vertical or
3380 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003381 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003383 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 mode-list and an argument-list:
3385 mode-list:argument-list,mode-list:argument-list,..
3386 The mode-list is a dash separated list of these modes:
3387 n Normal mode
3388 v Visual mode
3389 ve Visual mode with 'selection' "exclusive" (same as 'v',
3390 if not specified)
3391 o Operator-pending mode
3392 i Insert mode
3393 r Replace mode
3394 c Command-line Normal (append) mode
3395 ci Command-line Insert mode
3396 cr Command-line Replace mode
3397 sm showmatch in Insert mode
3398 a all modes
3399 The argument-list is a dash separated list of these arguments:
3400 hor{N} horizontal bar, {N} percent of the character height
3401 ver{N} vertical bar, {N} percent of the character width
3402 block block cursor, fills the whole character
3403 [only one of the above three should be present]
3404 blinkwait{N} *cursor-blinking*
3405 blinkon{N}
3406 blinkoff{N}
3407 blink times for cursor: blinkwait is the delay before
3408 the cursor starts blinking, blinkon is the time that
3409 the cursor is shown and blinkoff is the time that the
3410 cursor is not shown. The times are in msec. When one
3411 of the numbers is zero, there is no blinking. The
3412 default is: "blinkwait700-blinkon400-blinkoff250".
3413 These numbers are used for a missing entry. This
3414 means that blinking is enabled by default. To switch
3415 blinking off you can use "blinkon0". The cursor only
3416 blinks when Vim is waiting for input, not while
3417 executing a command.
3418 To make the cursor blink in an xterm, see
3419 |xterm-blink|.
3420 {group-name}
3421 a highlight group name, that sets the color and font
3422 for the cursor
3423 {group-name}/{group-name}
3424 Two highlight group names, the first is used when
3425 no language mappings are used, the other when they
3426 are. |language-mapping|
3427
3428 Examples of parts:
3429 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3430 block cursor with colors from the "nCursor"
3431 highlight group
3432 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3433 In Insert and Command-line Insert mode, use a
3434 30% vertical bar cursor with colors from the
3435 "iCursor" highlight group. Blink a bit
3436 faster.
3437
3438 The 'a' mode is different. It will set the given argument-list for
3439 all modes. It does not reset anything to defaults. This can be used
3440 to do a common setting for all modes. For example, to switch off
3441 blinking: "a:blinkon0"
3442
3443 Examples of cursor highlighting: >
3444 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3445 :highlight Cursor gui=NONE guifg=bg guibg=fg
3446<
3447 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003448 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449'guifont' 'gfn' string (default "")
3450 global
3451 {not in Vi}
3452 {only available when compiled with GUI enabled}
3453 This is a list of fonts which will be used for the GUI version of Vim.
3454 In its simplest form the value is just one font name. When
3455 the font cannot be found you will get an error message. To try other
3456 font names a list can be specified, font names separated with commas.
3457 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003458
Bram Moolenaar05159a02005-02-26 23:04:13 +00003459 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3460 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003461
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 Spaces after a comma are ignored. To include a comma in a font name
3463 precede it with a backslash. Setting an option requires an extra
3464 backslash before a space and a backslash. See also
3465 |option-backslash|. For example: >
3466 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003467< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003469
3470 If none of the fonts can be loaded, Vim will keep the current setting.
3471 If an empty font list is given, Vim will try using other resource
3472 settings (for X, it will use the Vim.font resource), and finally it
3473 will try some builtin default which should always be there ("7x13" in
3474 the case of X). The font names given should be "normal" fonts. Vim
3475 will try to find the related bold and italic fonts.
3476
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003477 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003478 :set guifont=*
3479< will bring up a font requester, where you can pick the font you want.
3480
3481 The font name depends on the GUI used. See |setting-guifont| for a
3482 way to set 'guifont' for various systems.
3483
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 For the GTK+ 2 GUI the font name looks like this: >
3485 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003486< That's all. XLFDs are not used. For Chinese this is reported to work
3487 well: >
3488 if has("gui_gtk2")
3489 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3490 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3491 endif
3492<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003493 For Mac OSX you can use something like this: >
3494 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003495< Also see 'macatsui', it can help fix display problems.
3496 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003498 width). An exception is GTK 2: all fonts are accepted, but
3499 mono-spaced fonts look best.
3500
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 To preview a font on X11, you might be able to use the "xfontsel"
3502 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003503
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 For the Win32 GUI *E244* *E245*
3505 - takes these options in the font name:
3506 hXX - height is XX (points, can be floating-point)
3507 wXX - width is XX (points, can be floating-point)
3508 b - bold
3509 i - italic
3510 u - underline
3511 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003512 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3514 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3515 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003516 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517
3518 Use a ':' to separate the options.
3519 - A '_' can be used in the place of a space, so you don't need to use
3520 backslashes to escape the spaces.
3521 - Examples: >
3522 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3523 :set guifont=Andale_Mono:h7.5:w4.5
3524< See also |font-sizes|.
3525
3526 *'guifontset'* *'gfs'*
3527 *E250* *E252* *E234* *E597* *E598*
3528'guifontset' 'gfs' string (default "")
3529 global
3530 {not in Vi}
3531 {only available when compiled with GUI enabled and
3532 with the |+xfontset| feature}
3533 {not available in the GTK+ 2 GUI}
3534 When not empty, specifies two (or more) fonts to be used. The first
3535 one for normal English, the second one for your special language. See
3536 |xfontset|.
3537 Setting this option also means that all font names will be handled as
3538 a fontset name. Also the ones used for the "font" argument of the
3539 |:highlight| command.
3540 The fonts must match with the current locale. If fonts for the
3541 character sets that the current locale uses are not included, setting
3542 'guifontset' will fail.
3543 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3544 the comma-separated names are alternative names, one of which will be
3545 used. In 'guifontset' the whole string is one fontset name,
3546 including the commas. It is not possible to specify alternative
3547 fontset names.
3548 This example works on many X11 systems: >
3549 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3550<
3551 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3552'guifontwide' 'gfw' string (default "")
3553 global
3554 {not in Vi}
3555 {only available when compiled with GUI enabled}
3556 When not empty, specifies a comma-separated list of fonts to be used
3557 for double-width characters. The first font that can be loaded is
3558 used.
3559 Note: The size of these fonts must be exactly twice as wide as the one
3560 specified with 'guifont' and the same height.
3561
3562 All GUI versions but GTK+ 2:
3563
3564 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3565 'guifontset' is empty or invalid.
3566 When 'guifont' is set and a valid font is found in it and
3567 'guifontwide' is empty Vim will attempt to find a matching
3568 double-width font and set 'guifontwide' to it.
3569
3570 GTK+ 2 GUI only: *guifontwide_gtk2*
3571
3572 If set and valid, 'guifontwide' is always used for double width
3573 characters, even if 'encoding' is not set to "utf-8".
3574 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003575 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 font for characters not available in 'guifont'. Thus you do not need
3577 to set 'guifontwide' at all unless you want to override the choice
3578 made by Pango/Xft.
3579
Bram Moolenaar0f272122013-01-23 18:37:40 +01003580 Windows +multibyte only: *guifontwide_win_mbyte*
3581
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003582 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003583
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 *'guiheadroom'* *'ghr'*
3585'guiheadroom' 'ghr' number (default 50)
3586 global
3587 {not in Vi} {only for GTK and X11 GUI}
3588 The number of pixels subtracted from the screen height when fitting
3589 the GUI window on the screen. Set this before the GUI is started,
3590 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003591 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 lines will be left for window decorations and other items on the
3593 screen. Set it to a negative value to allow windows taller than the
3594 screen.
3595
3596 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003597'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3598 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 global
3600 {not in Vi}
3601 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003602 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 sequence of letters which describes what components and options of the
3604 GUI should be used.
3605 To avoid problems with flags that are added in the future, use the
3606 "+=" and "-=" feature of ":set" |add-option-flags|.
3607
3608 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003609 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 'a' Autoselect: If present, then whenever VISUAL mode is started,
3611 or the Visual area extended, Vim tries to become the owner of
3612 the windowing system's global selection. This means that the
3613 Visually highlighted text is available for pasting into other
3614 applications as well as into Vim itself. When the Visual mode
3615 ends, possibly due to an operation on the text, or when an
3616 application wants to paste the selection, the highlighted text
3617 is automatically yanked into the "* selection register.
3618 Thus the selection is still available for pasting into other
3619 applications after the VISUAL mode has ended.
3620 If not present, then Vim won't become the owner of the
3621 windowing system's global selection unless explicitly told to
3622 by a yank or delete operation for the "* register.
3623 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003624 *'go-P'*
3625 'P' Like autoselect but using the "+ register instead of the "*
3626 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003627 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003628 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 applies to the modeless selection.
3630
3631 'guioptions' autoselect Visual autoselect modeless ~
3632 "" - -
3633 "a" yes yes
3634 "A" - yes
3635 "aA" yes yes
3636
Bram Moolenaar02467872007-05-06 13:22:01 +00003637 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 'c' Use console dialogs instead of popup dialogs for simple
3639 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003640 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003641 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003642 'guitablabel' can be used to change the text in the labels.
3643 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003644 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003645 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003646 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 'f' Foreground: Don't use fork() to detach the GUI from the shell
3648 where it was started. Use this for programs that wait for the
3649 editor to finish (e.g., an e-mail program). Alternatively you
3650 can use "gvim -f" or ":gui -f" to start the GUI in the
3651 foreground. |gui-fork|
3652 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003653 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003654 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3656 corner of the window. It's black&white on non-GTK, because of
3657 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003658 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003660 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003661 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003663 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 file is sourced the system menu has already been loaded; the
3665 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003666 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 'g' Grey menu items: Make menu items that are not active grey. If
3668 'g' is not included inactive menu items are not shown at all.
3669 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003670 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 't' Include tearoff menu items. Currently only works for Win32,
3672 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003673 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003674 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003675 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003676 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003678 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 'R' Right-hand scrollbar is present when there is a vertically
3680 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003681 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003683 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 'L' Left-hand scrollbar is present when there is a vertically
3685 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003686 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3688 the longest visible line, or on the cursor line if the 'h'
3689 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003690 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 'h' Limit horizontal scrollbar size to the length of the cursor
3692 line. Reduces computations. |gui-horiz-scroll|
3693
3694 And yes, you may even have scrollbars on the left AND the right if
3695 you really want to :-). See |gui-scrollbars| for more information.
3696
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003697 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'v' Use a vertical button layout for dialogs. When not included,
3699 a horizontal layout is preferred, but when it doesn't fit a
3700 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003701 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 'p' Use Pointer callbacks for X11 GUI. This is required for some
3703 window managers. If the cursor is not blinking or hollow at
3704 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003705 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003707 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003708 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709
Bram Moolenaar02467872007-05-06 13:22:01 +00003710
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 *'guipty'* *'noguipty'*
3712'guipty' boolean (default on)
3713 global
3714 {not in Vi}
3715 {only available when compiled with GUI enabled}
3716 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3717 I/O to/from shell commands. See |gui-pty|.
3718
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003719 *'guitablabel'* *'gtl'*
3720'guitablabel' 'gtl' string (default empty)
3721 global
3722 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003723 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003724 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003725 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003726 pages line. When empty and when the result is empty Vim will use a
3727 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003728
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003729 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003730 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003731
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003732 Only used when the GUI tab pages line is displayed. 'e' must be
3733 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3734 used.
3735
Bram Moolenaar57657d82006-04-21 22:12:41 +00003736 *'guitabtooltip'* *'gtt'*
3737'guitabtooltip' 'gtt' string (default empty)
3738 global
3739 {not in Vi}
3740 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003741 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003742 When nonempty describes the text to use in a tooltip for the GUI tab
3743 pages line. When empty Vim will use a default tooltip.
3744 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003745 You can include a line break. Simplest method is to use |:let|: >
3746 :let &guitabtooltip = "line one\nline two"
3747<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003748
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 *'helpfile'* *'hf'*
3750'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3751 (others) "$VIMRUNTIME/doc/help.txt")
3752 global
3753 {not in Vi}
3754 Name of the main help file. All distributed help files should be
3755 placed together in one directory. Additionally, all "doc" directories
3756 in 'runtimepath' will be used.
3757 Environment variables are expanded |:set_env|. For example:
3758 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003759 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 spaces and backslashes.
3761 This option cannot be set from a |modeline| or in the |sandbox|, for
3762 security reasons.
3763
3764 *'helpheight'* *'hh'*
3765'helpheight' 'hh' number (default 20)
3766 global
3767 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003768 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 feature}
3770 Minimal initial height of the help window when it is opened with the
3771 ":help" command. The initial height of the help window is half of the
3772 current window, or (when the 'ea' option is on) the same as other
3773 windows. When the height is less than 'helpheight', the height is
3774 set to 'helpheight'. Set to zero to disable.
3775
3776 *'helplang'* *'hlg'*
3777'helplang' 'hlg' string (default: messages language or empty)
3778 global
3779 {only available when compiled with the |+multi_lang|
3780 feature}
3781 {not in Vi}
3782 Comma separated list of languages. Vim will use the first language
3783 for which the desired help can be found. The English help will always
3784 be used as a last resort. You can add "en" to prefer English over
3785 another language, but that will only find tags that exist in that
3786 language and not in the English help.
3787 Example: >
3788 :set helplang=de,it
3789< This will first search German, then Italian and finally English help
3790 files.
3791 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3792 try to find the tag in the current language before using this option.
3793 See |help-translated|.
3794
3795 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3796'hidden' 'hid' boolean (default off)
3797 global
3798 {not in Vi}
3799 When off a buffer is unloaded when it is |abandon|ed. When on a
3800 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3801 displayed in another window, it does not become hidden, of course.
3802 The commands that move through the buffer list sometimes make a buffer
3803 hidden although the 'hidden' option is off: When the buffer is
3804 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003805 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003806 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 This option is set for one command with ":hide {command}" |:hide|.
3808 WARNING: It's easy to forget that you have changes in hidden buffers.
3809 Think twice when using ":q!" or ":qa!".
3810
3811 *'highlight'* *'hl'*
3812'highlight' 'hl' string (default (as a single string):
3813 "8:SpecialKey,@:NonText,d:Directory,
3814 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003815 M:ModeMsg,n:LineNr,N:CursorLineNr,
3816 r:Question,s:StatusLine,S:StatusLineNC,
3817 c:VertSplit, t:Title,v:Visual,
3818 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 f:Folded,F:FoldColumn,A:DiffAdd,
3820 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003821 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003822 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003823 +:Pmenu,=:PmenuSel,
3824 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 global
3826 {not in Vi}
3827 This option can be used to set highlighting mode for various
3828 occasions. It is a comma separated list of character pairs. The
3829 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003830 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3832 |hl-NonText| @ '~' and '@' at the end of the window and
3833 characters from 'showbreak'
3834 |hl-Directory| d directories in CTRL-D listing and other special
3835 things in listings
3836 |hl-ErrorMsg| e error messages
3837 h (obsolete, ignored)
3838 |hl-IncSearch| i 'incsearch' highlighting
3839 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3840 |hl-MoreMsg| m |more-prompt|
3841 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003842 |hl-LineNr| n line number for ":number" and ":#" commands, and
3843 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003844 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3845 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 |hl-Question| r |hit-enter| prompt and yes/no questions
3847 |hl-StatusLine| s status line of current window |status-line|
3848 |hl-StatusLineNC| S status lines of not-current windows
3849 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3850 |hl-VertSplit| c column used to separate vertically split windows
3851 |hl-Visual| v Visual mode
3852 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3853 Selection" Only X11 Gui's |gui-x11| and
3854 |xterm-clipboard|.
3855 |hl-WarningMsg| w warning messages
3856 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3857 |hl-Folded| f line used for closed folds
3858 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003859 |hl-DiffAdd| A added line in diff mode
3860 |hl-DiffChange| C changed line in diff mode
3861 |hl-DiffDelete| D deleted line in diff mode
3862 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003864 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003865 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003866 |hl-SpellRare| R rare word |spell|
3867 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003868 |hl-Conceal| - the placeholders used for concealed characters
3869 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003870 |hl-Pmenu| + popup menu normal line
3871 |hl-PmenuSel| = popup menu normal line
3872 |hl-PmenuSbar| x popup menu scrollbar
3873 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874
3875 The display modes are:
3876 r reverse (termcap entry "mr" and "me")
3877 i italic (termcap entry "ZH" and "ZR")
3878 b bold (termcap entry "md" and "me")
3879 s standout (termcap entry "so" and "se")
3880 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003881 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 n no highlighting
3883 - no highlighting
3884 : use a highlight group
3885 The default is used for occasions that are not included.
3886 If you want to change what the display modes do, see |dos-colors|
3887 for an example.
3888 When using the ':' display mode, this must be followed by the name of
3889 a highlight group. A highlight group can be used to define any type
3890 of highlighting, including using color. See |:highlight| on how to
3891 define one. The default uses a different group for each occasion.
3892 See |highlight-default| for the default highlight groups.
3893
3894 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3895'hlsearch' 'hls' boolean (default off)
3896 global
3897 {not in Vi}
3898 {not available when compiled without the
3899 |+extra_search| feature}
3900 When there is a previous search pattern, highlight all its matches.
3901 The type of highlighting used can be set with the 'l' occasion in the
3902 'highlight' option. This uses the "Search" highlight group by
3903 default. Note that only the matching text is highlighted, any offsets
3904 are not applied.
3905 See also: 'incsearch' and |:match|.
3906 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003907 off with |:nohlsearch|. This does not change the option value, as
3908 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003909 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910 When the search pattern can match an end-of-line, Vim will try to
3911 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003912 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003914 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003915 You can specify whether the highlight status is restored on startup
3916 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 NOTE: This option is reset when 'compatible' is set.
3918
3919 *'history'* *'hi'*
3920'history' 'hi' number (Vim default: 20, Vi default: 0)
3921 global
3922 {not in Vi}
3923 A history of ":" commands, and a history of previous search patterns
3924 are remembered. This option decides how many entries may be stored in
3925 each of these histories (see |cmdline-editing|).
3926 NOTE: This option is set to the Vi default value when 'compatible' is
3927 set and to the Vim default value when 'compatible' is reset.
3928
3929 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3930'hkmap' 'hk' boolean (default off)
3931 global
3932 {not in Vi}
3933 {only available when compiled with the |+rightleft|
3934 feature}
3935 When on, the keyboard is mapped for the Hebrew character set.
3936 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3937 toggle this option. See |rileft.txt|.
3938 NOTE: This option is reset when 'compatible' is set.
3939
3940 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3941'hkmapp' 'hkp' boolean (default off)
3942 global
3943 {not in Vi}
3944 {only available when compiled with the |+rightleft|
3945 feature}
3946 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3947 This is useful if you have a non-Hebrew keyboard.
3948 See |rileft.txt|.
3949 NOTE: This option is reset when 'compatible' is set.
3950
3951 *'icon'* *'noicon'*
3952'icon' boolean (default off, on when title can be restored)
3953 global
3954 {not in Vi}
3955 {not available when compiled without the |+title|
3956 feature}
3957 When on, the icon text of the window will be set to the value of
3958 'iconstring' (if it is not empty), or to the name of the file
3959 currently being edited. Only the last part of the name is used.
3960 Overridden by the 'iconstring' option.
3961 Only works if the terminal supports setting window icons (currently
3962 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3963 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3964 builtin termcap).
3965 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003966 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 X11.
3968
3969 *'iconstring'*
3970'iconstring' string (default "")
3971 global
3972 {not in Vi}
3973 {not available when compiled without the |+title|
3974 feature}
3975 When this option is not empty, it will be used for the icon text of
3976 the window. This happens only when the 'icon' option is on.
3977 Only works if the terminal supports setting window icon text
3978 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3979 Does not work for MS Windows.
3980 When Vim was compiled with HAVE_X11 defined, the original icon will be
3981 restored if possible |X11|.
3982 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003983 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 'titlestring' for example settings.
3985 {not available when compiled without the |+statusline| feature}
3986
3987 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3988'ignorecase' 'ic' boolean (default off)
3989 global
3990 Ignore case in search patterns. Also used when searching in the tags
3991 file.
3992 Also see 'smartcase'.
3993 Can be overruled by using "\c" or "\C" in the pattern, see
3994 |/ignorecase|.
3995
3996 *'imactivatekey'* *'imak'*
3997'imactivatekey' 'imak' string (default "")
3998 global
3999 {not in Vi}
4000 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004001 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 Specifies the key that your Input Method in X-Windows uses for
4003 activation. When this is specified correctly, vim can fully control
4004 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4005 You can't use this option to change the activation key, the option
4006 tells Vim what the key is.
4007 Format:
4008 [MODIFIER_FLAG-]KEY_STRING
4009
4010 These characters can be used for MODIFIER_FLAG (case is ignored):
4011 S Shift key
4012 L Lock key
4013 C Control key
4014 1 Mod1 key
4015 2 Mod2 key
4016 3 Mod3 key
4017 4 Mod4 key
4018 5 Mod5 key
4019 Combinations are allowed, for example "S-C-space" or "SC-space" are
4020 both shift+ctrl+space.
4021 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4022
4023 Example: >
4024 :set imactivatekey=S-space
4025< "S-space" means shift+space. This is the activation key for kinput2 +
4026 canna (Japanese), and ami (Korean).
4027
4028 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4029'imcmdline' 'imc' boolean (default off)
4030 global
4031 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004032 {only available when compiled with the |+xim|,
4033 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 When set the Input Method is always on when starting to edit a command
4035 line, unless entering a search pattern (see 'imsearch' for that).
4036 Setting this option is useful when your input method allows entering
4037 English characters directly, e.g., when it's used to type accented
4038 characters with dead keys.
4039
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004040 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4042 global
4043 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004044 {only available when compiled with the |+xim|,
4045 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 When set the Input Method is never used. This is useful to disable
4047 the IM when it doesn't work properly.
4048 Currently this option is on by default for SGI/IRIX machines. This
4049 may change in later releases.
4050
4051 *'iminsert'* *'imi'*
4052'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4053 local to buffer
4054 {not in Vi}
4055 Specifies whether :lmap or an Input Method (IM) is to be used in
4056 Insert mode. Valid values:
4057 0 :lmap is off and IM is off
4058 1 :lmap is ON and IM is off
4059 2 :lmap is off and IM is ON
4060 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4061 or |global-ime|.
4062 To always reset the option to zero when leaving Insert mode with <Esc>
4063 this can be used: >
4064 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4065< This makes :lmap and IM turn off automatically when leaving Insert
4066 mode.
4067 Note that this option changes when using CTRL-^ in Insert mode
4068 |i_CTRL-^|.
4069 The value is set to 1 when setting 'keymap' to a valid keymap name.
4070 It is also used for the argument of commands like "r" and "f".
4071 The value 0 may not work correctly with Athena and Motif with some XIM
4072 methods. Use 'imdisable' to disable XIM then.
4073
4074 *'imsearch'* *'ims'*
4075'imsearch' 'ims' 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 when
4079 entering a search pattern. Valid values:
4080 -1 the value of 'iminsert' is used, makes it look like
4081 'iminsert' is also used when typing a search pattern
4082 0 :lmap is off and IM is off
4083 1 :lmap is ON and IM is off
4084 2 :lmap is off and IM is ON
4085 Note that this option changes when using CTRL-^ in Command-line mode
4086 |c_CTRL-^|.
4087 The value is set to 1 when it is not -1 and setting the 'keymap'
4088 option to a valid keymap name.
4089 The value 0 may not work correctly with Athena and Motif with some XIM
4090 methods. Use 'imdisable' to disable XIM then.
4091
4092 *'include'* *'inc'*
4093'include' 'inc' string (default "^\s*#\s*include")
4094 global or local to buffer |global-local|
4095 {not in Vi}
4096 {not available when compiled without the
4097 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004098 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 pattern, just like for the "/" command (See |pattern|). The default
4100 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004101 "]I", "[d", etc.
4102 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004103 comes after the matched pattern. But if "\zs" appears in the pattern
4104 then the text matched from "\zs" to the end, or until "\ze" if it
4105 appears, is used as the file name. Use this to include characters
4106 that are not in 'isfname', such as a space. You can then use
4107 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004108 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109
4110 *'includeexpr'* *'inex'*
4111'includeexpr' 'inex' string (default "")
4112 local to buffer
4113 {not in Vi}
4114 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004115 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004117 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004118 :set includeexpr=substitute(v:fname,'\\.','/','g')
4119< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004122 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 Also used for |<cfile>|.
4124
Bram Moolenaar30b65812012-07-12 22:01:11 +02004125 The expression will be evaluated in the |sandbox| when set from a
4126 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004127
4128 It is not allowed to change text or jump to another window while
4129 evaluating 'includeexpr' |textlock|.
4130
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4132'incsearch' 'is' boolean (default off)
4133 global
4134 {not in Vi}
4135 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004136 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004137 While typing a search command, show where the pattern, as it was typed
4138 so far, matches. The matched string is highlighted. If the pattern
4139 is invalid or not found, nothing is shown. The screen will be updated
4140 often, this is only useful on fast terminals.
4141 Note that the match will be shown, but the cursor will return to its
4142 original position when no match is found and when pressing <Esc>. You
4143 still need to finish the search command with <Enter> to move the
4144 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004145 When compiled with the |+reltime| feature Vim only searches for about
4146 half a second. With a complicated pattern and/or a lot of text the
4147 match may not be found. This is to avoid that Vim hangs while you
4148 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004149 The highlighting can be set with the 'i' flag in 'highlight'.
4150 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004151 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004152 to the command line. If 'ignorecase' and 'smartcase' are set and the
4153 command line has no uppercase characters, the added character is
4154 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004155 CTRL-R CTRL-W can be used to add the word at the end of the current
4156 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 NOTE: This option is reset when 'compatible' is set.
4158
4159 *'indentexpr'* *'inde'*
4160'indentexpr' 'inde' string (default "")
4161 local to buffer
4162 {not in Vi}
4163 {not available when compiled without the |+cindent|
4164 or |+eval| features}
4165 Expression which is evaluated to obtain the proper indent for a line.
4166 It is used when a new line is created, for the |=| operator and
4167 in Insert mode as specified with the 'indentkeys' option.
4168 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004169 'smartindent' indenting. When 'lisp' is set, this option is
4170 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 When 'paste' is set this option is not used for indenting.
4172 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004173 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 when the expression is evaluated (but it may be moved around).
4175 The expression must return the number of spaces worth of indent. It
4176 can return "-1" to keep the current indent (this means 'autoindent' is
4177 used for the indent).
4178 Functions useful for computing the indent are |indent()|, |cindent()|
4179 and |lispindent()|.
4180 The evaluation of the expression must not have side effects! It must
4181 not change the text, jump to another window, etc. Afterwards the
4182 cursor position is always restored, thus the cursor may be moved.
4183 Normally this option would be set to call a function: >
4184 :set indentexpr=GetMyIndent()
4185< Error messages will be suppressed, unless the 'debug' option contains
4186 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004187 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 NOTE: This option is made empty when 'compatible' is set.
4189
Bram Moolenaar30b65812012-07-12 22:01:11 +02004190 The expression will be evaluated in the |sandbox| when set from a
4191 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004192
4193 It is not allowed to change text or jump to another window while
4194 evaluating 'indentexpr' |textlock|.
4195
4196
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 *'indentkeys'* *'indk'*
4198'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4199 local to buffer
4200 {not in Vi}
4201 {not available when compiled without the |+cindent|
4202 feature}
4203 A list of keys that, when typed in Insert mode, cause reindenting of
4204 the current line. Only happens if 'indentexpr' isn't empty.
4205 The format is identical to 'cinkeys', see |indentkeys-format|.
4206 See |C-indenting| and |indent-expression|.
4207
4208 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4209'infercase' 'inf' boolean (default off)
4210 local to buffer
4211 {not in Vi}
4212 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004213 'ignorecase' is also on, the case of the match is adjusted depending
4214 on the typed text. If the typed text contains a lowercase letter
4215 where the match has an upper case letter, the completed part is made
4216 lowercase. If the typed text has no lowercase letters and the match
4217 has a lowercase letter where the typed text has an uppercase letter,
4218 and there is a letter before it, the completed part is made uppercase.
4219 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220
4221 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4222'insertmode' 'im' boolean (default off)
4223 global
4224 {not in Vi}
4225 Makes Vim work in a way that Insert mode is the default mode. Useful
4226 if you want to use Vim as a modeless editor. Used for |evim|.
4227 These Insert mode commands will be useful:
4228 - Use the cursor keys to move around.
4229 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4230 this is a mapping, it is executed as if 'insertmode' was off.
4231 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004233 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4234 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
4236 These items change when 'insertmode' is set:
4237 - when starting to edit of a file, Vim goes to Insert mode.
4238 - <Esc> in Insert mode is a no-op and beeps.
4239 - <Esc> in Normal mode makes Vim go to Insert mode.
4240 - CTRL-L in Insert mode is a command, it is not inserted.
4241 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4242 However, when <Esc> is used inside a mapping, it behaves like
4243 'insertmode' was not set. This was done to be able to use the same
4244 mappings with 'insertmode' set or not set.
4245 When executing commands with |:normal| 'insertmode' is not used.
4246
4247 NOTE: This option is reset when 'compatible' is set.
4248
4249 *'isfname'* *'isf'*
4250'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4251 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4252 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4253 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4254 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4255 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4256 global
4257 {not in Vi}
4258 The characters specified by this option are included in file names and
4259 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004260 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 Multi-byte characters 256 and above are always included, only the
4262 characters up to 255 are specified with this option.
4263 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004264 Think twice before adding white space to this option. Although a
4265 space may appear inside a file name, the effect will be that Vim
4266 doesn't know where a file name starts or ends when doing completion.
4267 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268
4269 Note that on systems using a backslash as path separator, Vim tries to
4270 do its best to make it work as you would expect. That is a bit
4271 tricky, since Vi originally used the backslash to escape special
4272 characters. Vim will not remove a backslash in front of a normal file
4273 name character on these systems, but it will on Unix and alikes. The
4274 '&' and '^' are not included by default, because these are special for
4275 cmd.exe.
4276
4277 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004278 Each part can be a single character number or a range. A range is two
4279 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 decimal number between 0 and 255 or the ASCII character itself (does
4281 not work for digits). Example:
4282 "_,-,128-140,#-43" (include '_' and '-' and the range
4283 128 to 140 and '#' to 43)
4284 If a part starts with '^', the following character number or range
4285 will be excluded from the option. The option is interpreted from left
4286 to right. Put the excluded character after the range where it is
4287 included. To include '^' itself use it as the last character of the
4288 option or the end of a range. Example:
4289 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4290 If the character is '@', all characters where isalpha() returns TRUE
4291 are included. Normally these are the characters a to z and A to Z,
4292 plus accented characters. To include '@' itself use "@-@". Examples:
4293 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004294 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 "a-z,A-Z,@-@" All letters plus the '@' character.
4296 A comma can be included by using it where a character number is
4297 expected. Example:
4298 "48-57,,,_" Digits, comma and underscore.
4299 A comma can be excluded by prepending a '^'. Example:
4300 " -~,^,,9" All characters from space to '~', excluding
4301 comma, plus <Tab>.
4302 See |option-backslash| about including spaces and backslashes.
4303
4304 *'isident'* *'isi'*
4305'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4306 "@,48-57,_,128-167,224-235"
4307 otherwise: "@,48-57,_,192-255")
4308 global
4309 {not in Vi}
4310 The characters given by this option are included in identifiers.
4311 Identifiers are used in recognizing environment variables and after a
4312 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004313 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 option.
4315 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004316 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4318
4319 *'iskeyword'* *'isk'*
4320'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4321 "@,48-57,_,128-167,224-235"
4322 otherwise: "@,48-57,_,192-255"
4323 Vi default: "@,48-57,_")
4324 local to buffer
4325 {not in Vi}
4326 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004327 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 'isfname' for a description of the format of this option. For C
4329 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4330 For a help file it is set to all non-blank printable characters except
4331 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4332 command).
4333 When the 'lisp' option is on the '-' character is always included.
4334 NOTE: This option is set to the Vi default value when 'compatible' is
4335 set and to the Vim default value when 'compatible' is reset.
4336
4337 *'isprint'* *'isp'*
4338'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4339 "@,~-255"; otherwise: "@,161-255")
4340 global
4341 {not in Vi}
4342 The characters given by this option are displayed directly on the
4343 screen. It is also used for "\p" in a |pattern|. The characters from
4344 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4345 even when they are not included in 'isprint' or excluded. See
4346 'isfname' for a description of the format of this option.
4347
4348 Non-printable characters are displayed with two characters:
4349 0 - 31 "^@" - "^_"
4350 32 - 126 always single characters
4351 127 "^?"
4352 128 - 159 "~@" - "~_"
4353 160 - 254 "| " - "|~"
4354 255 "~?"
4355 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4356 displayed as <xx>, with the hexadecimal value of the byte.
4357 When 'display' contains "uhex" all unprintable characters are
4358 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004359 The SpecialKey highlighting will be used for unprintable characters.
4360 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361
4362 Multi-byte characters 256 and above are always included, only the
4363 characters up to 255 are specified with this option. When a character
4364 is printable but it is not available in the current font, a
4365 replacement character will be shown.
4366 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4367 There is no option to specify these characters.
4368
4369 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4370'joinspaces' 'js' boolean (default on)
4371 global
4372 {not in Vi}
4373 Insert two spaces after a '.', '?' and '!' with a join command.
4374 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4375 Otherwise only one space is inserted.
4376 NOTE: This option is set when 'compatible' is set.
4377
4378 *'key'*
4379'key' string (default "")
4380 local to buffer
4381 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004382 {only available when compiled with the |+cryptv|
4383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004385 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 Careful: Do not set the key value by hand, someone might see the typed
4387 key. Use the |:X| command. But you can make 'key' empty: >
4388 :set key=
4389< It is not possible to get the value of this option with ":set key" or
4390 "echo &key". This is to avoid showing it to someone who shouldn't
4391 know. It also means you cannot see it yourself once you have set it,
4392 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004393 You can use "&key" in an expression to detect whether encryption is
4394 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395
4396 *'keymap'* *'kmp'* *E544*
4397'keymap' 'kmp' string (default "")
4398 local to buffer
4399 {not in Vi}
4400 {only available when compiled with the |+keymap|
4401 feature}
4402 Name of a keyboard mapping. See |mbyte-keymap|.
4403 Setting this option to a valid keymap name has the side effect of
4404 setting 'iminsert' to one, so that the keymap becomes effective.
4405 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004406 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407
4408 *'keymodel'* *'km'*
4409'keymodel' 'km' string (default "")
4410 global
4411 {not in Vi}
4412 List of comma separated words, which enable special things that keys
4413 can do. These values can be used:
4414 startsel Using a shifted special key starts selection (either
4415 Select mode or Visual mode, depending on "key" being
4416 present in 'selectmode').
4417 stopsel Using a not-shifted special key stops selection.
4418 Special keys in this context are the cursor keys, <End>, <Home>,
4419 <PageUp> and <PageDown>.
4420 The 'keymodel' option is set by the |:behave| command.
4421
4422 *'keywordprg'* *'kp'*
4423'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4424 OS/2: "view /", VMS: "help")
4425 global or local to buffer |global-local|
4426 {not in Vi}
4427 Program to use for the |K| command. Environment variables are
4428 expanded |:set_env|. ":help" may be used to access the Vim internal
4429 help. (Note that previously setting the global option to the empty
4430 value did this, which is now deprecated.)
4431 When "man" is used, Vim will automatically translate a count for the
4432 "K" command to a section number. Also for "man -s", in which case the
4433 "-s" is removed when there is no count.
4434 See |option-backslash| about including spaces and backslashes.
4435 Example: >
4436 :set keywordprg=man\ -s
4437< This option cannot be set from a |modeline| or in the |sandbox|, for
4438 security reasons.
4439
4440 *'langmap'* *'lmap'* *E357* *E358*
4441'langmap' 'lmap' string (default "")
4442 global
4443 {not in Vi}
4444 {only available when compiled with the |+langmap|
4445 feature}
4446 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004447 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 inserted directly. When in command mode the 'langmap' option takes
4449 care of translating these special characters to the original meaning
4450 of the key. This means you don't have to change the keyboard mode to
4451 be able to execute Normal mode commands.
4452 This is the opposite of the 'keymap' option, where characters are
4453 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004455 Example (for Greek, in UTF-8): *greek* >
4456 :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 +00004457< Example (exchanges meaning of z and y for commands): >
4458 :set langmap=zy,yz,ZY,YZ
4459<
4460 The 'langmap' option is a list of parts, separated with commas. Each
4461 part can be in one of two forms:
4462 1. A list of pairs. Each pair is a "from" character immediately
4463 followed by the "to" character. Examples: "aA", "aAbBcC".
4464 2. A list of "from" characters, a semi-colon and a list of "to"
4465 characters. Example: "abc;ABC"
4466 Example: "aA,fgh;FGH,cCdDeE"
4467 Special characters need to be preceded with a backslash. These are
4468 ";", ',' and backslash itself.
4469
4470 This will allow you to activate vim actions without having to switch
4471 back and forth between the languages. Your language characters will
4472 be understood as normal vim English characters (according to the
4473 langmap mappings) in the following cases:
4474 o Normal/Visual mode (commands, buffer/register names, user mappings)
4475 o Insert/Replace Mode: Register names after CTRL-R
4476 o Insert/Replace Mode: Mappings
4477 Characters entered in Command-line mode will NOT be affected by
4478 this option. Note that this option can be changed at any time
4479 allowing to switch between mappings for different languages/encodings.
4480 Use a mapping to avoid having to type it each time!
4481
4482 *'langmenu'* *'lm'*
4483'langmenu' 'lm' string (default "")
4484 global
4485 {not in Vi}
4486 {only available when compiled with the |+menu| and
4487 |+multi_lang| features}
4488 Language to use for menu translation. Tells which file is loaded
4489 from the "lang" directory in 'runtimepath': >
4490 "lang/menu_" . &langmenu . ".vim"
4491< (without the spaces). For example, to always use the Dutch menus, no
4492 matter what $LANG is set to: >
4493 :set langmenu=nl_NL.ISO_8859-1
4494< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004495 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 If your $LANG is set to a non-English language but you do want to use
4497 the English menus: >
4498 :set langmenu=none
4499< This option must be set before loading menus, switching on filetype
4500 detection or syntax highlighting. Once the menus are defined setting
4501 this option has no effect. But you could do this: >
4502 :source $VIMRUNTIME/delmenu.vim
4503 :set langmenu=de_DE.ISO_8859-1
4504 :source $VIMRUNTIME/menu.vim
4505< Warning: This deletes all menus that you defined yourself!
4506
4507 *'laststatus'* *'ls'*
4508'laststatus' 'ls' number (default 1)
4509 global
4510 {not in Vi}
4511 The value of this option influences when the last window will have a
4512 status line:
4513 0: never
4514 1: only if there are at least two windows
4515 2: always
4516 The screen looks nicer with a status line if you have several
4517 windows, but it takes another screen line. |status-line|
4518
4519 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4520'lazyredraw' 'lz' boolean (default off)
4521 global
4522 {not in Vi}
4523 When this option is set, the screen will not be redrawn while
4524 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004525 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 update use |:redraw|.
4527
4528 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4529'linebreak' 'lbr' boolean (default off)
4530 local to window
4531 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004532 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 feature}
4534 If on Vim will wrap long lines at a character in 'breakat' rather
4535 than at the last character that fits on the screen. Unlike
4536 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4537 it only affects the way the file is displayed, not its contents. The
4538 value of 'showbreak' is used to put in front of wrapped lines.
4539 This option is not used when the 'wrap' option is off or 'list' is on.
4540 Note that <Tab> characters after an <EOL> are mostly not displayed
4541 with the right amount of white space.
4542
4543 *'lines'* *E593*
4544'lines' number (default 24 or terminal height)
4545 global
4546 Number of lines of the Vim window.
4547 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004548 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 When Vim is running in the GUI or in a resizable window, setting this
4550 option will cause the window size to be changed. When you only want
4551 to use the size for the GUI, put the command in your |gvimrc| file.
4552 Vim limits the number of lines to what fits on the screen. You can
4553 use this command to get the tallest window possible: >
4554 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004555< Minimum value is 2, maximum value is 1000.
4556 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 When you set this option and Vim is unable to change the physical
4558 number of lines of the display, the display may be messed up.
4559
4560 *'linespace'* *'lsp'*
4561'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4562 global
4563 {not in Vi}
4564 {only in the GUI}
4565 Number of pixel lines inserted between characters. Useful if the font
4566 uses the full character cell height, making lines touch each other.
4567 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004568 With some fonts there can be too much room between lines (to have
4569 space for ascents and descents). Then it makes sense to set
4570 'linespace' to a negative value. This may cause display problems
4571 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572
4573 *'lisp'* *'nolisp'*
4574'lisp' boolean (default off)
4575 local to buffer
4576 {not available when compiled without the |+lispindent|
4577 feature}
4578 Lisp mode: When <Enter> is typed in insert mode set the indent for
4579 the next line to Lisp standards (well, sort of). Also happens with
4580 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4581 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4582 better. Also see 'lispwords'.
4583 The '-' character is included in keyword characters. Redefines the
4584 "=" operator to use this same indentation algorithm rather than
4585 calling an external program if 'equalprg' is empty.
4586 This option is not used when 'paste' is set.
4587 {Vi: Does it a little bit differently}
4588
4589 *'lispwords'* *'lw'*
4590'lispwords' 'lw' string (default is very long)
4591 global
4592 {not in Vi}
4593 {not available when compiled without the |+lispindent|
4594 feature}
4595 Comma separated list of words that influence the Lisp indenting.
4596 |'lisp'|
4597
4598 *'list'* *'nolist'*
4599'list' boolean (default off)
4600 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004601 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4602 line. Useful to see the difference between tabs and spaces and for
4603 trailing blanks. Further changed by the 'listchars' option.
4604
4605 The cursor is displayed at the start of the space a Tab character
4606 occupies, not at the end as usual in Normal mode. To get this cursor
4607 position while displaying Tabs with spaces, use: >
4608 :set list lcs=tab\ \
4609<
4610 Note that list mode will also affect formatting (set with 'textwidth'
4611 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 changing the way tabs are displayed.
4613
4614 *'listchars'* *'lcs'*
4615'listchars' 'lcs' string (default "eol:$")
4616 global
4617 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004618 Strings to use in 'list' mode and for the |:list| command. It is a
4619 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004620 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 eol:c Character to show at the end of each line. When
4622 omitted, there is no extra character at the end of the
4623 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004624 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004625 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004627 fill the space that the tab normally occupies.
4628 "tab:>-" will show a tab that takes four spaces as
4629 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004630 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004631 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004633 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 extends:c Character to show in the last column, when 'wrap' is
4635 off and the line continues beyond the right of the
4636 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004637 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 precedes:c Character to show in the first column, when 'wrap'
4639 is off and there is text preceding the character
4640 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004641 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004642 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004643 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004644 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004645 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004646 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004648 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004650 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651
4652 Examples: >
4653 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004654 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 :set lcs=extends:>,precedes:<
4656< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004657 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004658 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659
4660 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4661'loadplugins' 'lpl' boolean (default on)
4662 global
4663 {not in Vi}
4664 When on the plugin scripts are loaded when starting up |load-plugins|.
4665 This option can be reset in your |vimrc| file to disable the loading
4666 of plugins.
4667 Note that using the "-u NONE" and "--noplugin" command line arguments
4668 reset this option. |-u| |--noplugin|
4669
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004670 *'macatsui'* *'nomacatsui'*
4671'macatsui' boolean (default on)
4672 global
4673 {only available in Mac GUI version}
4674 This is a workaround for when drawing doesn't work properly. When set
4675 and compiled with multi-byte support ATSUI text drawing is used. When
4676 not set ATSUI text drawing is not used. Switch this option off when
4677 you experience drawing problems. In a future version the problems may
4678 be solved and this option becomes obsolete. Therefore use this method
4679 to unset it: >
4680 if exists('&macatsui')
4681 set nomacatsui
4682 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004683< Another option to check if you have drawing problems is
4684 'termencoding'.
4685
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 *'magic'* *'nomagic'*
4687'magic' boolean (default on)
4688 global
4689 Changes the special characters that can be used in search patterns.
4690 See |pattern|.
4691 NOTE: To avoid portability problems with using patterns, always keep
4692 this option at the default "on". Only switch it off when working with
4693 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004694 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695
4696 *'makeef'* *'mef'*
4697'makeef' 'mef' string (default: "")
4698 global
4699 {not in Vi}
4700 {not available when compiled without the |+quickfix|
4701 feature}
4702 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4703 and the |:grep| command.
4704 When it is empty, an internally generated temp file will be used.
4705 When "##" is included, it is replaced by a number to make the name
4706 unique. This makes sure that the ":make" command doesn't overwrite an
4707 existing file.
4708 NOT used for the ":cf" command. See 'errorfile' for that.
4709 Environment variables are expanded |:set_env|.
4710 See |option-backslash| about including spaces and backslashes.
4711 This option cannot be set from a |modeline| or in the |sandbox|, for
4712 security reasons.
4713
4714 *'makeprg'* *'mp'*
4715'makeprg' 'mp' string (default "make", VMS: "MMS")
4716 global or local to buffer |global-local|
4717 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004718 Program to use for the ":make" command. See |:make_makeprg|.
4719 This option may contain '%' and '#' characters, which are expanded to
4720 the current and alternate file name. |:_%| |:_#|
4721 Environment variables are expanded |:set_env|. See |option-backslash|
4722 about including spaces and backslashes.
4723 Note that a '|' must be escaped twice: once for ":set" and once for
4724 the interpretation of a command. When you use a filter called
4725 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 :set makeprg=gmake\ \\\|\ myfilter
4727< The placeholder "$*" can be given (even multiple times) to specify
4728 where the arguments will be included, for example: >
4729 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4730< This option cannot be set from a |modeline| or in the |sandbox|, for
4731 security reasons.
4732
4733 *'matchpairs'* *'mps'*
4734'matchpairs' 'mps' string (default "(:),{:},[:]")
4735 local to buffer
4736 {not in Vi}
4737 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004738 other.
4739 Only character pairs are allowed that are different, thus you cannot
4740 jump between two double quotes.
4741 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004742 The pairs must be separated by a comma. Example for including '<' and
4743 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 :set mps+=<:>
4745
4746< A more exotic example, to jump between the '=' and ';' in an
4747 assignment, useful for languages like C and Java: >
4748 :au FileType c,cpp,java set mps+==:;
4749
4750< For a more advanced way of using "%", see the matchit.vim plugin in
4751 the $VIMRUNTIME/macros directory. |add-local-help|
4752
4753 *'matchtime'* *'mat'*
4754'matchtime' 'mat' number (default 5)
4755 global
4756 {not in Vi}{in Nvi}
4757 Tenths of a second to show the matching paren, when 'showmatch' is
4758 set. Note that this is not in milliseconds, like other options that
4759 set a time. This is to be compatible with Nvi.
4760
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004761 *'maxcombine'* *'mco'*
4762'maxcombine' 'mco' number (default 2)
4763 global
4764 {not in Vi}
4765 {only available when compiled with the |+multi_byte|
4766 feature}
4767 The maximum number of combining characters supported for displaying.
4768 Only used when 'encoding' is "utf-8".
4769 The default is OK for most languages. Hebrew may require 4.
4770 Maximum value is 6.
4771 Even when this option is set to 2 you can still edit text with more
4772 combining characters, you just can't see them. Use |g8| or |ga|.
4773 See |mbyte-combining|.
4774
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 *'maxfuncdepth'* *'mfd'*
4776'maxfuncdepth' 'mfd' number (default 100)
4777 global
4778 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004779 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004780 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 Maximum depth of function calls for user functions. This normally
4782 catches endless recursion. When using a recursive function with
4783 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4784 more memory, there is the danger of failing when memory is exhausted.
4785 See also |:function|.
4786
4787 *'maxmapdepth'* *'mmd'* *E223*
4788'maxmapdepth' 'mmd' number (default 1000)
4789 global
4790 {not in Vi}
4791 Maximum number of times a mapping is done without resulting in a
4792 character to be used. This normally catches endless mappings, like
4793 ":map x y" with ":map y x". It still does not catch ":map g wg",
4794 because the 'w' is used before the next mapping is done. See also
4795 |key-mapping|.
4796
4797 *'maxmem'* *'mm'*
4798'maxmem' 'mm' number (default between 256 to 5120 (system
4799 dependent) or half the amount of memory
4800 available)
4801 global
4802 {not in Vi}
4803 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4804 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004805 other memory to be freed. The maximum usable value is about 2000000.
4806 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004807
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004808 *'maxmempattern'* *'mmp'*
4809'maxmempattern' 'mmp' number (default 1000)
4810 global
4811 {not in Vi}
4812 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004813 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004814 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004815 When Vim runs into the limit it gives an error message and mostly
4816 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004817 Running into the limit often means that the pattern is very
4818 inefficient or too complex. This may already happen with the pattern
4819 "\(.\)*" on a very long line. ".*" works much better.
4820 Vim may run out of memory before hitting the 'maxmempattern' limit.
4821
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 *'maxmemtot'* *'mmt'*
4823'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4824 dependent) or half the amount of memory
4825 available)
4826 global
4827 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004828 Maximum amount of memory in Kbyte to use for all buffers together.
4829 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4830 without a limit. On 64 bit machines higher values might work. But
4831 hey, do you really need more than 2 Gbyte for text editing?
4832 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833
4834 *'menuitems'* *'mis'*
4835'menuitems' 'mis' number (default 25)
4836 global
4837 {not in Vi}
4838 {not available when compiled without the |+menu|
4839 feature}
4840 Maximum number of items to use in a menu. Used for menus that are
4841 generated from a list of items, e.g., the Buffers menu. Changing this
4842 option has no direct effect, the menu must be refreshed first.
4843
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004844 *'mkspellmem'* *'msm'*
4845'mkspellmem' 'msm' string (default "460000,2000,500")
4846 global
4847 {not in Vi}
4848 {not available when compiled without the |+syntax|
4849 feature}
4850 Parameters for |:mkspell|. This tunes when to start compressing the
4851 word tree. Compression can be slow when there are many words, but
4852 it's needed to avoid running out of memory. The amount of memory used
4853 per word depends very much on how similar the words are, that's why
4854 this tuning is complicated.
4855
4856 There are three numbers, separated by commas:
4857 {start},{inc},{added}
4858
4859 For most languages the uncompressed word tree fits in memory. {start}
4860 gives the amount of memory in Kbyte that can be used before any
4861 compression is done. It should be a bit smaller than the amount of
4862 memory that is available to Vim.
4863
4864 When going over the {start} limit the {inc} number specifies the
4865 amount of memory in Kbyte that can be allocated before another
4866 compression is done. A low number means compression is done after
4867 less words are added, which is slow. A high number means more memory
4868 will be allocated.
4869
4870 After doing compression, {added} times 1024 words can be added before
4871 the {inc} limit is ignored and compression is done when any extra
4872 amount of memory is needed. A low number means there is a smaller
4873 chance of hitting the {inc} limit, less memory is used but it's
4874 slower.
4875
4876 The languages for which these numbers are important are Italian and
4877 Hungarian. The default works for when you have about 512 Mbyte. If
4878 you have 1 Gbyte you could use: >
4879 :set mkspellmem=900000,3000,800
4880< If you have less than 512 Mbyte |:mkspell| may fail for some
4881 languages, no matter what you set 'mkspellmem' to.
4882
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004884'modeline' 'ml' boolean (Vim default: on (off for root),
4885 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886 local to buffer
4887 *'modelines'* *'mls'*
4888'modelines' 'mls' number (default 5)
4889 global
4890 {not in Vi}
4891 If 'modeline' is on 'modelines' gives the number of lines that is
4892 checked for set commands. If 'modeline' is off or 'modelines' is zero
4893 no lines are checked. See |modeline|.
4894 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4895 set and to the Vim default value when 'compatible' is reset.
4896
4897 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4898'modifiable' 'ma' boolean (default on)
4899 local to buffer
4900 {not in Vi} *E21*
4901 When off the buffer contents cannot be changed. The 'fileformat' and
4902 'fileencoding' options also can't be changed.
4903 Can be reset with the |-M| command line argument.
4904
4905 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4906'modified' 'mod' boolean (default off)
4907 local to buffer
4908 {not in Vi}
4909 When on, the buffer is considered to be modified. This option is set
4910 when:
4911 1. A change was made to the text since it was last written. Using the
4912 |undo| command to go back to the original text will reset the
4913 option. But undoing changes that were made before writing the
4914 buffer will set the option again, since the text is different from
4915 when it was written.
4916 2. 'fileformat' or 'fileencoding' is different from its original
4917 value. The original value is set when the buffer is read or
4918 written. A ":set nomodified" command also resets the original
4919 values to the current values and the 'modified' option will be
4920 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004921 This option is not set when a change is made to the buffer as the
4922 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4923 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4924 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4926 will be ignored.
4927
4928 *'more'* *'nomore'*
4929'more' boolean (Vim default: on, Vi default: off)
4930 global
4931 {not in Vi}
4932 When on, listings pause when the whole screen is filled. You will get
4933 the |more-prompt|. When this option is off there are no pauses, the
4934 listing continues until finished.
4935 NOTE: This option is set to the Vi default value when 'compatible' is
4936 set and to the Vim default value when 'compatible' is reset.
4937
4938 *'mouse'* *E538*
4939'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4940 global
4941 {not in Vi}
4942 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004943 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4944 sysmouse and Linux console with gpm). For using the mouse in the
4945 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 The mouse can be enabled for different modes:
4947 n Normal mode
4948 v Visual mode
4949 i Insert mode
4950 c Command-line mode
4951 h all previous modes when editing a help file
4952 a all previous modes
4953 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 Normally you would enable the mouse in all four modes with: >
4955 :set mouse=a
4956< When the mouse is not enabled, the GUI will still use the mouse for
4957 modeless selection. This doesn't move the text cursor.
4958
4959 See |mouse-using|. Also see |'clipboard'|.
4960
4961 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004962 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 the mouse buttons can still be used by keeping the shift key pressed.
4964 Also see the 'clipboard' option.
4965
4966 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4967'mousefocus' 'mousef' boolean (default off)
4968 global
4969 {not in Vi}
4970 {only works in the GUI}
4971 The window that the mouse pointer is on is automatically activated.
4972 When changing the window layout or window focus in another way, the
4973 mouse pointer is moved to the window with keyboard focus. Off is the
4974 default because it makes using the pull down menus a little goofy, as
4975 a pointer transit may activate a window unintentionally.
4976
4977 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4978'mousehide' 'mh' boolean (default on)
4979 global
4980 {not in Vi}
4981 {only works in the GUI}
4982 When on, the mouse pointer is hidden when characters are typed.
4983 The mouse pointer is restored when the mouse is moved.
4984
4985 *'mousemodel'* *'mousem'*
4986'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4987 global
4988 {not in Vi}
4989 Sets the model to use for the mouse. The name mostly specifies what
4990 the right mouse button is used for:
4991 extend Right mouse button extends a selection. This works
4992 like in an xterm.
4993 popup Right mouse button pops up a menu. The shifted left
4994 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004995 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 popup_setpos Like "popup", but the cursor will be moved to the
4997 position where the mouse was clicked, and thus the
4998 selected operation will act upon the clicked object.
4999 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005000 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 course, that right clicking outside a selection will
5002 end Visual mode.
5003 Overview of what button does what for each model:
5004 mouse extend popup(_setpos) ~
5005 left click place cursor place cursor
5006 left drag start selection start selection
5007 shift-left search word extend selection
5008 right click extend selection popup menu (place cursor)
5009 right drag extend selection -
5010 middle click paste paste
5011
5012 In the "popup" model the right mouse button produces a pop-up menu.
5013 You need to define this first, see |popup-menu|.
5014
5015 Note that you can further refine the meaning of buttons with mappings.
5016 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5017 selection (because that's handled in the GUI code directly).
5018
5019 The 'mousemodel' option is set by the |:behave| command.
5020
5021 *'mouseshape'* *'mouses'* *E547*
5022'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005023 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 global
5025 {not in Vi}
5026 {only available when compiled with the |+mouseshape|
5027 feature}
5028 This option tells Vim what the mouse pointer should look like in
5029 different modes. The option is a comma separated list of parts, much
5030 like used for 'guicursor'. Each part consist of a mode/location-list
5031 and an argument-list:
5032 mode-list:shape,mode-list:shape,..
5033 The mode-list is a dash separated list of these modes/locations:
5034 In a normal window: ~
5035 n Normal mode
5036 v Visual mode
5037 ve Visual mode with 'selection' "exclusive" (same as 'v',
5038 if not specified)
5039 o Operator-pending mode
5040 i Insert mode
5041 r Replace mode
5042
5043 Others: ~
5044 c appending to the command-line
5045 ci inserting in the command-line
5046 cr replacing in the command-line
5047 m at the 'Hit ENTER' or 'More' prompts
5048 ml idem, but cursor in the last line
5049 e any mode, pointer below last window
5050 s any mode, pointer on a status line
5051 sd any mode, while dragging a status line
5052 vs any mode, pointer on a vertical separator line
5053 vd any mode, while dragging a vertical separator line
5054 a everywhere
5055
5056 The shape is one of the following:
5057 avail name looks like ~
5058 w x arrow Normal mouse pointer
5059 w x blank no pointer at all (use with care!)
5060 w x beam I-beam
5061 w x updown up-down sizing arrows
5062 w x leftright left-right sizing arrows
5063 w x busy The system's usual busy pointer
5064 w x no The system's usual 'no input' pointer
5065 x udsizing indicates up-down resizing
5066 x lrsizing indicates left-right resizing
5067 x crosshair like a big thin +
5068 x hand1 black hand
5069 x hand2 white hand
5070 x pencil what you write with
5071 x question big ?
5072 x rightup-arrow arrow pointing right-up
5073 w x up-arrow arrow pointing up
5074 x <number> any X11 pointer number (see X11/cursorfont.h)
5075
5076 The "avail" column contains a 'w' if the shape is available for Win32,
5077 x for X11.
5078 Any modes not specified or shapes not available use the normal mouse
5079 pointer.
5080
5081 Example: >
5082 :set mouseshape=s:udsizing,m:no
5083< will make the mouse turn to a sizing arrow over the status lines and
5084 indicate no input when the hit-enter prompt is displayed (since
5085 clicking the mouse has no effect in this state.)
5086
5087 *'mousetime'* *'mouset'*
5088'mousetime' 'mouset' number (default 500)
5089 global
5090 {not in Vi}
5091 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5092 time in msec between two mouse clicks for the second click to be
5093 recognized as a multi click.
5094
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005095 *'mzquantum'* *'mzq'*
5096'mzquantum' 'mzq' number (default 100)
5097 global
5098 {not in Vi}
5099 {not available when compiled without the |+mzscheme|
5100 feature}
5101 The number of milliseconds between polls for MzScheme threads.
5102 Negative or zero value means no thread scheduling.
5103
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 *'nrformats'* *'nf'*
5105'nrformats' 'nf' string (default "octal,hex")
5106 local to buffer
5107 {not in Vi}
5108 This defines what bases Vim will consider for numbers when using the
5109 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5110 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005111 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005113 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005114 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005116 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 considered to be hexadecimal. Example: Using CTRL-X on
5118 "0x100" results in "0x0ff".
5119 Numbers which simply begin with a digit in the range 1-9 are always
5120 considered decimal. This also happens for numbers that are not
5121 recognized as octal or hex.
5122
5123 *'number'* *'nu'* *'nonumber'* *'nonu'*
5124'number' 'nu' boolean (default off)
5125 local to window
5126 Print the line number in front of each line. When the 'n' option is
5127 excluded from 'cpoptions' a wrapped line will not use the column of
5128 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005129 The 'numberwidth' option can be used to set the room used for the line
5130 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 When a long, wrapped line doesn't start with the first character, '-'
5132 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005133 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5134 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005135 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005137 *'numberwidth'* *'nuw'*
5138'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5139 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005140 {not in Vi}
5141 {only available when compiled with the |+linebreak|
5142 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005143 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005144 when the 'number' or 'relativenumber' option is set or printing lines
5145 with a line number. Since one space is always between the number and
5146 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005147 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005148 fit the highest line number in the buffer respectively the number of
5149 rows in the window, depending on whether 'number' or 'relativenumber'
5150 is set. Thus with the Vim default of 4 there is room for a line number
5151 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005152 The minimum value is 1, the maximum value is 10.
5153 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5154
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005155 *'omnifunc'* *'ofu'*
5156'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005157 local to buffer
5158 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005159 {not available when compiled without the |+eval|
5160 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005161 This option specifies a function to be used for Insert mode omni
5162 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005163 See |complete-functions| for an explanation of how the function is
5164 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005165 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005166 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005167 This option cannot be set from a |modeline| or in the |sandbox|, for
5168 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005169
5170
Bram Moolenaar02467872007-05-06 13:22:01 +00005171 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005172'opendevice' 'odev' boolean (default off)
5173 global
5174 {not in Vi}
5175 {only for MS-DOS, MS-Windows and OS/2}
5176 Enable reading and writing from devices. This may get Vim stuck on a
5177 device that can be opened but doesn't actually do the I/O. Therefore
5178 it is off by default.
5179 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5180 result in editing a device.
5181
5182
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005183 *'operatorfunc'* *'opfunc'*
5184'operatorfunc' 'opfunc' string (default: empty)
5185 global
5186 {not in Vi}
5187 This option specifies a function to be called by the |g@| operator.
5188 See |:map-operator| for more info and an example.
5189
5190 This option cannot be set from a |modeline| or in the |sandbox|, for
5191 security reasons.
5192
5193
Bram Moolenaar251e1912011-06-19 05:09:16 +02005194 *'osfiletype'* *'oft'*
5195'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 local to buffer
5197 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005198 This option was supported on RISC OS, which has been removed.
5199
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200
5201 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005202'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005203 global
5204 Specifies the nroff macros that separate paragraphs. These are pairs
5205 of two letters (see |object-motions|).
5206
5207 *'paste'* *'nopaste'*
5208'paste' boolean (default off)
5209 global
5210 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005211 Put Vim in Paste mode. This is useful if you want to cut or copy
5212 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 unexpected effects.
5214 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005215 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 knows about pasting and will mostly do the right thing without 'paste'
5217 being set. The same is true for a terminal where Vim handles the
5218 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005219 This option is reset when starting the GUI. Thus if you set it in
5220 your .vimrc it will work in a terminal, but not in the GUI. Setting
5221 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5222 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 When the 'paste' option is switched on (also when it was already on):
5224 - mapping in Insert mode and Command-line mode is disabled
5225 - abbreviations are disabled
5226 - 'textwidth' is set to 0
5227 - 'wrapmargin' is set to 0
5228 - 'autoindent' is reset
5229 - 'smartindent' is reset
5230 - 'softtabstop' is set to 0
5231 - 'revins' is reset
5232 - 'ruler' is reset
5233 - 'showmatch' is reset
5234 - 'formatoptions' is used like it is empty
5235 These options keep their value, but their effect is disabled:
5236 - 'lisp'
5237 - 'indentexpr'
5238 - 'cindent'
5239 NOTE: When you start editing another file while the 'paste' option is
5240 on, settings from the modelines or autocommands may change the
5241 settings again, causing trouble when pasting text. You might want to
5242 set the 'paste' option again.
5243 When the 'paste' option is reset the mentioned options are restored to
5244 the value before the moment 'paste' was switched from off to on.
5245 Resetting 'paste' before ever setting it does not have any effect.
5246 Since mapping doesn't work while 'paste' is active, you need to use
5247 the 'pastetoggle' option to toggle the 'paste' option with some key.
5248
5249 *'pastetoggle'* *'pt'*
5250'pastetoggle' 'pt' string (default "")
5251 global
5252 {not in Vi}
5253 When non-empty, specifies the key sequence that toggles the 'paste'
5254 option. This is like specifying a mapping: >
5255 :map {keys} :set invpaste<CR>
5256< Where {keys} is the value of 'pastetoggle'.
5257 The difference is that it will work even when 'paste' is set.
5258 'pastetoggle' works in Insert mode and Normal mode, but not in
5259 Command-line mode.
5260 Mappings are checked first, thus overrule 'pastetoggle'. However,
5261 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5262 this: >
5263 :map <F10> :set paste<CR>
5264 :map <F11> :set nopaste<CR>
5265 :imap <F10> <C-O>:set paste<CR>
5266 :imap <F11> <nop>
5267 :set pastetoggle=<F11>
5268< This will make <F10> start paste mode and <F11> stop paste mode.
5269 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5270 mode everything is inserted literally, except the 'pastetoggle' key
5271 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005272 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273
5274 *'pex'* *'patchexpr'*
5275'patchexpr' 'pex' string (default "")
5276 global
5277 {not in Vi}
5278 {not available when compiled without the |+diff|
5279 feature}
5280 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005281 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282
5283 *'patchmode'* *'pm'* *E206*
5284'patchmode' 'pm' string (default "")
5285 global
5286 {not in Vi}
5287 When non-empty the oldest version of a file is kept. This can be used
5288 to keep the original version of a file if you are changing files in a
5289 source distribution. Only the first time that a file is written a
5290 copy of the original file will be kept. The name of the copy is the
5291 name of the original file with the string in the 'patchmode' option
5292 appended. This option should start with a dot. Use a string like
5293 ".org". 'backupdir' must not be empty for this to work (Detail: The
5294 backup file is renamed to the patchmode file after the new file has
5295 been successfully written, that's why it must be possible to write a
5296 backup file). If there was no file to be backed up, an empty file is
5297 created.
5298 When the 'backupskip' pattern matches, a patchmode file is not made.
5299 Using 'patchmode' for compressed files appends the extension at the
5300 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5301 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005302 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005304 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305'path' 'pa' string (default on Unix: ".,/usr/include,,"
5306 on OS/2: ".,/emx/include,,"
5307 other systems: ".,,")
5308 global or local to buffer |global-local|
5309 {not in Vi}
5310 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005311 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5312 provided that the file being searched for has a relative path (not
5313 starting with "/", "./" or "../"). The directories in the 'path'
5314 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315 - Use commas to separate directory names: >
5316 :set path=.,/usr/local/include,/usr/include
5317< - Spaces can also be used to separate directory names (for backwards
5318 compatibility with version 3.0). To have a space in a directory
5319 name, precede it with an extra backslash, and escape the space: >
5320 :set path=.,/dir/with\\\ space
5321< - To include a comma in a directory name precede it with an extra
5322 backslash: >
5323 :set path=.,/dir/with\\,comma
5324< - To search relative to the directory of the current file, use: >
5325 :set path=.
5326< - To search in the current directory use an empty string between two
5327 commas: >
5328 :set path=,,
5329< - A directory name may end in a ':' or '/'.
5330 - Environment variables are expanded |:set_env|.
5331 - When using |netrw.vim| URLs can be used. For example, adding
5332 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005333 - Search upwards and downwards in a directory tree using "*", "**" and
5334 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 {not available when compiled without the |+path_extra| feature}
5336 - Careful with '\' characters, type two to get one in the option: >
5337 :set path=.,c:\\include
5338< Or just use '/' instead: >
5339 :set path=.,c:/include
5340< Don't forget "." or files won't even be found in the same directory as
5341 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005342 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 it is something like 256 or 1024 characters.
5344 You can check if all the include files are found, using the value of
5345 'path', see |:checkpath|.
5346 The use of |:set+=| and |:set-=| is preferred when adding or removing
5347 directories from the list. This avoids problems when a future version
5348 uses another default. To remove the current directory use: >
5349 :set path-=
5350< To add the current directory use: >
5351 :set path+=
5352< To use an environment variable, you probably need to replace the
5353 separator. Here is an example to append $INCL, in which directory
5354 names are separated with a semi-colon: >
5355 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5356< Replace the ';' with a ':' or whatever separator is used. Note that
5357 this doesn't work when $INCL contains a comma or white space.
5358
5359 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5360'preserveindent' 'pi' boolean (default off)
5361 local to buffer
5362 {not in Vi}
5363 When changing the indent of the current line, preserve as much of the
5364 indent structure as possible. Normally the indent is replaced by a
5365 series of tabs followed by spaces as required (unless |'expandtab'| is
5366 enabled, in which case only spaces are used). Enabling this option
5367 means the indent will preserve as many existing characters as possible
5368 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005369 'expandtab' does not apply to the preserved white space, a Tab remains
5370 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 NOTE: When using ">>" multiple times the resulting indent is a mix of
5372 tabs and spaces. You might not like this.
5373 NOTE: 'preserveindent' is reset when 'compatible' is set.
5374 Also see 'copyindent'.
5375 Use |:retab| to clean up white space.
5376
5377 *'previewheight'* *'pvh'*
5378'previewheight' 'pvh' number (default 12)
5379 global
5380 {not in Vi}
5381 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005382 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 Default height for a preview window. Used for |:ptag| and associated
5384 commands. Used for |CTRL-W_}| when no count is given.
5385
5386 *'previewwindow'* *'nopreviewwindow'*
5387 *'pvw'* *'nopvw'* *E590*
5388'previewwindow' 'pvw' boolean (default off)
5389 local to window
5390 {not in Vi}
5391 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005392 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005393 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 set. It's normally not set directly, but by using one of the commands
5395 |:ptag|, |:pedit|, etc.
5396
5397 *'printdevice'* *'pdev'*
5398'printdevice' 'pdev' string (default empty)
5399 global
5400 {not in Vi}
5401 {only available when compiled with the |+printer|
5402 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005403 The name of the printer to be used for |:hardcopy|.
5404 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005405 This option cannot be set from a |modeline| or in the |sandbox|, for
5406 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407
Bram Moolenaar8299df92004-07-10 09:47:34 +00005408 *'printencoding'* *'penc'*
5409'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 global
5411 {not in Vi}
5412 {only available when compiled with the |+printer|
5413 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005414 Sets the character encoding used when printing.
5415 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416
5417 *'printexpr'* *'pexpr'*
5418'printexpr' 'pexpr' String (default: see below)
5419 global
5420 {not in Vi}
5421 {only available when compiled with the |+printer|
5422 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005423 Expression used to print the PostScript produced with |:hardcopy|.
5424 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425
Bram Moolenaar8299df92004-07-10 09:47:34 +00005426 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427'printfont' 'pfn' string (default "courier")
5428 global
5429 {not in Vi}
5430 {only available when compiled with the |+printer|
5431 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005432 The name of the font that will be used for |:hardcopy|.
5433 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434
5435 *'printheader'* *'pheader'*
5436'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5437 global
5438 {not in Vi}
5439 {only available when compiled with the |+printer|
5440 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005441 The format of the header produced in |:hardcopy| output.
5442 See |pheader-option|.
5443
5444 *'printmbcharset'* *'pmbcs'*
5445'printmbcharset' 'pmbcs' string (default "")
5446 global
5447 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005448 {only available when compiled with the |+printer|,
5449 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005450 The CJK character set to be used for CJK output from |:hardcopy|.
5451 See |pmbcs-option|.
5452
5453 *'printmbfont'* *'pmbfn'*
5454'printmbfont' 'pmbfn' string (default "")
5455 global
5456 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005457 {only available when compiled with the |+printer|,
5458 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005459 List of font names to be used for CJK output from |:hardcopy|.
5460 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
5462 *'printoptions'* *'popt'*
5463'printoptions' 'popt' string (default "")
5464 global
5465 {not in Vi}
5466 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005467 List of items that control the format of the output of |:hardcopy|.
5468 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005470 *'prompt'* *'noprompt'*
5471'prompt' boolean (default on)
5472 global
5473 When on a ":" prompt is used in Ex mode.
5474
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005475 *'pumheight'* *'ph'*
5476'pumheight' 'ph' number (default 0)
5477 global
5478 {not available when compiled without the
5479 |+insert_expand| feature}
5480 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005481 Determines the maximum number of items to show in the popup menu for
5482 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005483 |ins-completion-menu|.
5484
5485
Bram Moolenaar677ee682005-01-27 14:41:15 +00005486 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005487'quoteescape' 'qe' string (default "\")
5488 local to buffer
5489 {not in Vi}
5490 The characters that are used to escape quotes in a string. Used for
5491 objects like a', a" and a` |a'|.
5492 When one of the characters in this option is found inside a string,
5493 the following character will be skipped. The default value makes the
5494 text "foo\"bar\\" considered to be one string.
5495
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5497'readonly' 'ro' boolean (default off)
5498 local to buffer
5499 If on, writes fail unless you use a '!'. Protects you from
5500 accidentally overwriting a file. Default on when Vim is started
5501 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005502 When using ":w!" the 'readonly' option is reset for the current
5503 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005505 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005507 *'redrawtime'* *'rdt'*
5508'redrawtime' 'rdt' number (default 2000)
5509 global
5510 {not in Vi}
5511 {only available when compiled with the |+reltime|
5512 feature}
5513 The time in milliseconds for redrawing the display. This applies to
5514 searching for patterns for 'hlsearch' and |:match| highlighting.
5515 When redrawing takes more than this many milliseconds no further
5516 matches will be highlighted. This is used to avoid that Vim hangs
5517 when using a very complicated pattern.
5518
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005519 *'regexpengine''* *'re'*
5520'regexpengine' 're' number (default 0)
5521 global
5522 {not in Vi}
5523 This selects the default regexp engine. |two-engines|
5524 The possible values are:
5525 0 automatic selection
5526 1 old engine
5527 2 NFA engine
5528 Note that when using the NFA engine and the pattern contains something
5529 that is not supported the pattern will not match. This is only useful
5530 for debugging the regexp engine.
5531
Bram Moolenaar64486672010-05-16 15:46:46 +02005532 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5533'relativenumber' 'rnu' boolean (default off)
5534 local to window
5535 {not in Vi}
5536 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005537 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005538 precede some vertical motion commands (e.g. j k + -) with, without
5539 having to calculate it yourself. Especially useful in combination with
5540 other commands (e.g. y d c < > gq gw =).
5541 When the 'n' option is excluded from 'cpoptions' a wrapped
5542 line will not use the column of line numbers (this is the default when
5543 'compatible' isn't set).
5544 The 'numberwidth' option can be used to set the room used for the line
5545 number.
5546 When a long, wrapped line doesn't start with the first character, '-'
5547 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005548 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5549 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005550 When setting this option, 'number' is reset.
5551
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 *'remap'* *'noremap'*
5553'remap' boolean (default on)
5554 global
5555 Allows for mappings to work recursively. If you do not want this for
5556 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005557 NOTE: To avoid portability problems with Vim scripts, always keep
5558 this option at the default "on". Only switch it off when working with
5559 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560
5561 *'report'*
5562'report' number (default 2)
5563 global
5564 Threshold for reporting number of lines changed. When the number of
5565 changed lines is more than 'report' a message will be given for most
5566 ":" commands. If you want it always, set 'report' to 0.
5567 For the ":substitute" command the number of substitutions is used
5568 instead of the number of lines.
5569
5570 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5571'restorescreen' 'rs' boolean (default on)
5572 global
5573 {not in Vi} {only in Windows 95/NT console version}
5574 When set, the screen contents is restored when exiting Vim. This also
5575 happens when executing external commands.
5576
5577 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5578 options in your .vimrc. To disable restoring:
5579 set t_ti= t_te=
5580 To enable restoring (for an xterm):
5581 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5582 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5583
5584 *'revins'* *'ri'* *'norevins'* *'nori'*
5585'revins' 'ri' boolean (default off)
5586 global
5587 {not in Vi}
5588 {only available when compiled with the |+rightleft|
5589 feature}
5590 Inserting characters in Insert mode will work backwards. See "typing
5591 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5592 command in Insert mode, when 'allowrevins' is set.
5593 NOTE: This option is reset when 'compatible' or 'paste' is set.
5594
5595 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5596'rightleft' 'rl' boolean (default off)
5597 local to window
5598 {not in Vi}
5599 {only available when compiled with the |+rightleft|
5600 feature}
5601 When on, display orientation becomes right-to-left, i.e., characters
5602 that are stored in the file appear from the right to the left.
5603 Using this option, it is possible to edit files for languages that
5604 are written from the right to the left such as Hebrew and Arabic.
5605 This option is per window, so it is possible to edit mixed files
5606 simultaneously, or to view the same file in both ways (this is
5607 useful whenever you have a mixed text file with both right-to-left
5608 and left-to-right strings so that both sets are displayed properly
5609 in different windows). Also see |rileft.txt|.
5610
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005611 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612'rightleftcmd' 'rlc' string (default "search")
5613 local to window
5614 {not in Vi}
5615 {only available when compiled with the |+rightleft|
5616 feature}
5617 Each word in this option enables the command line editing to work in
5618 right-to-left mode for a group of commands:
5619
5620 search "/" and "?" commands
5621
5622 This is useful for languages such as Hebrew, Arabic and Farsi.
5623 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5624
5625 *'ruler'* *'ru'* *'noruler'* *'noru'*
5626'ruler' 'ru' boolean (default off)
5627 global
5628 {not in Vi}
5629 {not available when compiled without the
5630 |+cmdline_info| feature}
5631 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005632 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 text in the file is shown on the far right:
5634 Top first line is visible
5635 Bot last line is visible
5636 All first and last line are visible
5637 45% relative position in the file
5638 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005639 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005641 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 this option takes precedence over 'ruler' and 'rulerformat'
5643 If the number of characters displayed is different from the number of
5644 bytes in the text (e.g., for a TAB or a multi-byte character), both
5645 the text column (byte number) and the screen column are shown,
5646 separated with a dash.
5647 For an empty line "0-1" is shown.
5648 For an empty buffer the line number will also be zero: "0,0-1".
5649 This option is reset when the 'paste' option is set.
5650 If you don't want to see the ruler all the time but want to know where
5651 you are, use "g CTRL-G" |g_CTRL-G|.
5652 NOTE: This option is reset when 'compatible' is set.
5653
5654 *'rulerformat'* *'ruf'*
5655'rulerformat' 'ruf' string (default empty)
5656 global
5657 {not in Vi}
5658 {not available when compiled without the |+statusline|
5659 feature}
5660 When this option is not empty, it determines the content of the ruler
5661 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005662 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005663 The default ruler width is 17 characters. To make the ruler 15
5664 characters wide, put "%15(" at the start and "%)" at the end.
5665 Example: >
5666 :set rulerformat=%15(%c%V\ %p%%%)
5667<
5668 *'runtimepath'* *'rtp'* *vimfiles*
5669'runtimepath' 'rtp' string (default:
5670 Unix: "$HOME/.vim,
5671 $VIM/vimfiles,
5672 $VIMRUNTIME,
5673 $VIM/vimfiles/after,
5674 $HOME/.vim/after"
5675 Amiga: "home:vimfiles,
5676 $VIM/vimfiles,
5677 $VIMRUNTIME,
5678 $VIM/vimfiles/after,
5679 home:vimfiles/after"
5680 PC, OS/2: "$HOME/vimfiles,
5681 $VIM/vimfiles,
5682 $VIMRUNTIME,
5683 $VIM/vimfiles/after,
5684 $HOME/vimfiles/after"
5685 Macintosh: "$VIM:vimfiles,
5686 $VIMRUNTIME,
5687 $VIM:vimfiles:after"
5688 RISC-OS: "Choices:vimfiles,
5689 $VIMRUNTIME,
5690 Choices:vimfiles/after"
5691 VMS: "sys$login:vimfiles,
5692 $VIM/vimfiles,
5693 $VIMRUNTIME,
5694 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005695 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 global
5697 {not in Vi}
5698 This is a list of directories which will be searched for runtime
5699 files:
5700 filetype.vim filetypes by file name |new-filetype|
5701 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005702 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 colors/ color scheme files |:colorscheme|
5704 compiler/ compiler files |:compiler|
5705 doc/ documentation |write-local-help|
5706 ftplugin/ filetype plugins |write-filetype-plugin|
5707 indent/ indent scripts |indent-expression|
5708 keymap/ key mapping files |mbyte-keymap|
5709 lang/ menu translations |:menutrans|
5710 menu.vim GUI menus |menu.vim|
5711 plugin/ plugin scripts |write-plugin|
5712 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005713 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 syntax/ syntax files |mysyntaxfile|
5715 tutor/ files for vimtutor |tutor|
5716
5717 And any other file searched for with the |:runtime| command.
5718
5719 The defaults for most systems are setup to search five locations:
5720 1. In your home directory, for your personal preferences.
5721 2. In a system-wide Vim directory, for preferences from the system
5722 administrator.
5723 3. In $VIMRUNTIME, for files distributed with Vim.
5724 *after-directory*
5725 4. In the "after" directory in the system-wide Vim directory. This is
5726 for the system administrator to overrule or add to the distributed
5727 defaults (rarely needed)
5728 5. In the "after" directory in your home directory. This is for
5729 personal preferences to overrule or add to the distributed defaults
5730 or system-wide settings (rarely needed).
5731
5732 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5733 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005734 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 wildcards.
5736 See |:runtime|.
5737 Example: >
5738 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5739< This will use the directory "~/vimruntime" first (containing your
5740 personal Vim runtime files), then "/mygroup/vim" (shared between a
5741 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5742 files).
5743 You probably should always include $VIMRUNTIME somewhere, to use the
5744 distributed runtime files. You can put a directory before $VIMRUNTIME
5745 to find files which replace a distributed runtime files. You can put
5746 a directory after $VIMRUNTIME to find files which add to distributed
5747 runtime files.
5748 This option cannot be set from a |modeline| or in the |sandbox|, for
5749 security reasons.
5750
5751 *'scroll'* *'scr'*
5752'scroll' 'scr' number (default: half the window height)
5753 local to window
5754 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5755 set to half the number of lines in the window when the window size
5756 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005757 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5759 the number of screen lines instead of file lines, makes a difference
5760 when lines wrap}
5761
5762 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5763'scrollbind' 'scb' boolean (default off)
5764 local to window
5765 {not in Vi}
5766 {not available when compiled without the |+scrollbind|
5767 feature}
5768 See also |scroll-binding|. When this option is set, the current
5769 window scrolls as other scrollbind windows (windows that also have
5770 this option set) scroll. This option is useful for viewing the
5771 differences between two versions of a file, see 'diff'.
5772 See |'scrollopt'| for options that determine how this option should be
5773 interpreted.
5774 This option is mostly reset when splitting a window to edit another
5775 file. This means that ":split | edit file" results in two windows
5776 with scroll-binding, but ":split file" does not.
5777
5778 *'scrolljump'* *'sj'*
5779'scrolljump' 'sj' number (default 1)
5780 global
5781 {not in Vi}
5782 Minimal number of lines to scroll when the cursor gets off the
5783 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5784 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005785 When set to a negative number from -1 to -100 this is used as the
5786 percentage of the window height. Thus -50 scrolls half the window
5787 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 NOTE: This option is set to 1 when 'compatible' is set.
5789
5790 *'scrolloff'* *'so'*
5791'scrolloff' 'so' number (default 0)
5792 global
5793 {not in Vi}
5794 Minimal number of screen lines to keep above and below the cursor.
5795 This will make some context visible around where you are working. If
5796 you set it to a very large value (999) the cursor line will always be
5797 in the middle of the window (except at the start or end of the file or
5798 when long lines wrap).
5799 For scrolling horizontally see 'sidescrolloff'.
5800 NOTE: This option is set to 0 when 'compatible' is set.
5801
5802 *'scrollopt'* *'sbo'*
5803'scrollopt' 'sbo' string (default "ver,jump")
5804 global
5805 {not available when compiled without the |+scrollbind|
5806 feature}
5807 {not in Vi}
5808 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005809 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5810 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 The following words are available:
5812 ver Bind vertical scrolling for 'scrollbind' windows
5813 hor Bind horizontal scrolling for 'scrollbind' windows
5814 jump Applies to the offset between two windows for vertical
5815 scrolling. This offset is the difference in the first
5816 displayed line of the bound windows. When moving
5817 around in a window, another 'scrollbind' window may
5818 reach a position before the start or after the end of
5819 the buffer. The offset is not changed though, when
5820 moving back the 'scrollbind' window will try to scroll
5821 to the desired position when possible.
5822 When now making that window the current one, two
5823 things can be done with the relative offset:
5824 1. When "jump" is not included, the relative offset is
5825 adjusted for the scroll position in the new current
5826 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005827 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 2. When "jump" is included, the other windows are
5829 scrolled to keep the same relative offset. When
5830 going back to the other window, it still uses the
5831 same relative offset.
5832 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005833 When 'diff' mode is active there always is vertical scroll binding,
5834 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835
5836 *'sections'* *'sect'*
5837'sections' 'sect' string (default "SHNHH HUnhsh")
5838 global
5839 Specifies the nroff macros that separate sections. These are pairs of
5840 two letters (See |object-motions|). The default makes a section start
5841 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5842
5843 *'secure'* *'nosecure'* *E523*
5844'secure' boolean (default off)
5845 global
5846 {not in Vi}
5847 When on, ":autocmd", shell and write commands are not allowed in
5848 ".vimrc" and ".exrc" in the current directory and map commands are
5849 displayed. Switch it off only if you know that you will not run into
5850 problems, or when the 'exrc' option is off. On Unix this option is
5851 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005852 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 'secure' at the end of your ~/.vimrc then.
5854 This option cannot be set from a |modeline| or in the |sandbox|, for
5855 security reasons.
5856
5857 *'selection'* *'sel'*
5858'selection' 'sel' string (default "inclusive")
5859 global
5860 {not in Vi}
5861 This option defines the behavior of the selection. It is only used
5862 in Visual and Select mode.
5863 Possible values:
5864 value past line inclusive ~
5865 old no yes
5866 inclusive yes yes
5867 exclusive yes no
5868 "past line" means that the cursor is allowed to be positioned one
5869 character past the line.
5870 "inclusive" means that the last character of the selection is included
5871 in an operation. For example, when "x" is used to delete the
5872 selection.
5873 Note that when "exclusive" is used and selecting from the end
5874 backwards, you cannot include the last character of a line, when
5875 starting in Normal mode and 'virtualedit' empty.
5876
5877 The 'selection' option is set by the |:behave| command.
5878
5879 *'selectmode'* *'slm'*
5880'selectmode' 'slm' string (default "")
5881 global
5882 {not in Vi}
5883 This is a comma separated list of words, which specifies when to start
5884 Select mode instead of Visual mode, when a selection is started.
5885 Possible values:
5886 mouse when using the mouse
5887 key when using shifted special keys
5888 cmd when using "v", "V" or CTRL-V
5889 See |Select-mode|.
5890 The 'selectmode' option is set by the |:behave| command.
5891
5892 *'sessionoptions'* *'ssop'*
5893'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005894 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 global
5896 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005897 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005898 feature}
5899 Changes the effect of the |:mksession| command. It is a comma
5900 separated list of words. Each word enables saving and restoring
5901 something:
5902 word save and restore ~
5903 blank empty windows
5904 buffers hidden and unloaded buffers, not just those in windows
5905 curdir the current directory
5906 folds manually created folds, opened/closed folds and local
5907 fold options
5908 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005909 and contain at least one lowercase letter. Only
5910 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 help the help window
5912 localoptions options and mappings local to a window or buffer (not
5913 global values for local options)
5914 options all options and mappings (also global values for local
5915 options)
5916 resize size of the Vim window: 'lines' and 'columns'
5917 sesdir the directory in which the session file is located
5918 will become the current directory (useful with
5919 projects accessed over a network from different
5920 systems)
5921 slash backslashes in file names replaced with forward
5922 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005923 tabpages all tab pages; without this only the current tab page
5924 is restored, so that you can make a session for each
5925 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 unix with Unix end-of-line format (single <NL>), even when
5927 on Windows or DOS
5928 winpos position of the whole Vim window
5929 winsize window sizes
5930
5931 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005932 When neither "curdir" nor "sesdir" is included, file names are stored
5933 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 "slash" and "unix" are useful on Windows when sharing session files
5935 with Unix. The Unix version of Vim cannot source dos format scripts,
5936 but the Windows version of Vim can source unix format scripts.
5937
5938 *'shell'* *'sh'* *E91*
5939'shell' 'sh' string (default $SHELL or "sh",
5940 MS-DOS and Win32: "command.com" or
5941 "cmd.exe", OS/2: "cmd")
5942 global
5943 Name of the shell to use for ! and :! commands. When changing the
5944 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5945 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005946 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 See |option-backslash| about including spaces and backslashes.
5948 Environment variables are expanded |:set_env|.
5949 If the name of the shell contains a space, you might need to enclose
5950 it in quotes. Example: >
5951 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5952< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005953 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 "-f" is not inside the quotes, because it is not part of the command
5955 name. And Vim automagically recognizes the backslashes that are path
5956 separators.
5957 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5958 variable to change the way external commands are executed. See the
5959 libc.inf file of DJGPP.
5960 Under MS-Windows, when the executable ends in ".com" it must be
5961 included. Thus setting the shell to "command.com" or "4dos.com"
5962 works, but "command" and "4dos" do not work for all commands (e.g.,
5963 filtering).
5964 For unknown reasons, when using "4dos.com" the current directory is
5965 changed to "C:\". To avoid this set 'shell' like this: >
5966 :set shell=command.com\ /c\ 4dos
5967< This option cannot be set from a |modeline| or in the |sandbox|, for
5968 security reasons.
5969
5970 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005971'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005972 MS-DOS and Win32, when 'shell' does not
5973 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 global
5975 {not in Vi}
5976 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5977 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5978 systems, the default is set according to the value of 'shell', to
5979 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005980 OS/2 (EMX figures this out itself).
5981 On Unix it can have more than one flag. Each white space separated
5982 part is passed as an argument to the shell command.
5983 See |option-backslash| about including spaces and backslashes.
5984 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 This option cannot be set from a |modeline| or in the |sandbox|, for
5986 security reasons.
5987
5988 *'shellpipe'* *'sp'*
5989'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5990 global
5991 {not in Vi}
5992 {not available when compiled without the |+quickfix|
5993 feature}
5994 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005995 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005996 including spaces and backslashes.
5997 The name of the temporary file can be represented by "%s" if necessary
5998 (the file name is appended automatically if no %s appears in the value
5999 of this option).
6000 For the Amiga and MS-DOS the default is ">". The output is directly
6001 saved in a file and not echoed to the screen.
6002 For Unix the default it "| tee". The stdout of the compiler is saved
6003 in a file and echoed to the screen. If the 'shell' option is "csh" or
6004 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006005 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6006 default becomes "2>&1| tee". This means that stderr is also included.
6007 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6008 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006009 The initialization of this option is done after reading the ".vimrc"
6010 and the other initializations, so that when the 'shell' option is set
6011 there, the 'shellpipe' option changes automatically, unless it was
6012 explicitly set before.
6013 When 'shellpipe' is set to an empty string, no redirection of the
6014 ":make" output will be done. This is useful if you use a 'makeprg'
6015 that writes to 'makeef' by itself. If you want no piping, but do
6016 want to include the 'makeef', set 'shellpipe' to a single space.
6017 Don't forget to precede the space with a backslash: ":set sp=\ ".
6018 In the future pipes may be used for filtering and this option will
6019 become obsolete (at least for Unix).
6020 This option cannot be set from a |modeline| or in the |sandbox|, for
6021 security reasons.
6022
6023 *'shellquote'* *'shq'*
6024'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6025 contains "sh" somewhere: "\"")
6026 global
6027 {not in Vi}
6028 Quoting character(s), put around the command passed to the shell, for
6029 the "!" and ":!" commands. The redirection is kept outside of the
6030 quoting. See 'shellxquote' to include the redirection. It's
6031 probably not useful to set both options.
6032 This is an empty string by default. Only known to be useful for
6033 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6034 or bash, where it should be "\"". The default is adjusted according
6035 the value of 'shell', to reduce the need to set this option by the
6036 user. See |dos-shell|.
6037 This option cannot be set from a |modeline| or in the |sandbox|, for
6038 security reasons.
6039
6040 *'shellredir'* *'srr'*
6041'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6042 global
6043 {not in Vi}
6044 String to be used to put the output of a filter command in a temporary
6045 file. See also |:!|. See |option-backslash| about including spaces
6046 and backslashes.
6047 The name of the temporary file can be represented by "%s" if necessary
6048 (the file name is appended automatically if no %s appears in the value
6049 of this option).
6050 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6051 or "zsh" during initializations, the default becomes ">&". If the
6052 'shell' option is "sh", "ksh" or "bash" the default becomes
6053 ">%s 2>&1". This means that stderr is also included.
6054 For Win32, the Unix checks are done and additionally "cmd" is checked
6055 for, which makes the default ">%s 2>&1". Also, the same names with
6056 ".exe" appended are checked for.
6057 The initialization of this option is done after reading the ".vimrc"
6058 and the other initializations, so that when the 'shell' option is set
6059 there, the 'shellredir' option changes automatically unless it was
6060 explicitly set before.
6061 In the future pipes may be used for filtering and this option will
6062 become obsolete (at least for Unix).
6063 This option cannot be set from a |modeline| or in the |sandbox|, for
6064 security reasons.
6065
6066 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6067'shellslash' 'ssl' boolean (default off)
6068 global
6069 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6070 When set, a forward slash is used when expanding file names. This is
6071 useful when a Unix-like shell is used instead of command.com or
6072 cmd.exe. Backward slashes can still be typed, but they are changed to
6073 forward slashes by Vim.
6074 Note that setting or resetting this option has no effect for some
6075 existing file names, thus this option needs to be set before opening
6076 any file for best results. This might change in the future.
6077 'shellslash' only works when a backslash can be used as a path
6078 separator. To test if this is so use: >
6079 if exists('+shellslash')
6080<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006081 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6082'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6083 global
6084 {not in Vi}
6085 When on, use temp files for shell commands. When off use a pipe.
6086 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006087 Currently a pipe is only supported on Unix and MS-Windows 2K and
6088 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006089 :if has("filterpipe")
6090< The advantage of using a pipe is that nobody can read the temp file
6091 and the 'shell' command does not need to support redirection.
6092 The advantage of using a temp file is that the file type and encoding
6093 can be detected.
6094 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6095 |FilterWritePost| autocommands event are not triggered when
6096 'shelltemp' is off.
6097
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 *'shelltype'* *'st'*
6099'shelltype' 'st' number (default 0)
6100 global
6101 {not in Vi} {only for the Amiga}
6102 On the Amiga this option influences the way how the commands work
6103 which use a shell.
6104 0 and 1: always use the shell
6105 2 and 3: use the shell only to filter lines
6106 4 and 5: use shell only for ':sh' command
6107 When not using the shell, the command is executed directly.
6108
6109 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6110 1 and 3: use "shell cmd" to start external commands
6111
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006112 *'shellxescape'* *'sxe'*
6113'shellxescape' 'sxe' string (default: "";
6114 for MS-DOS and MS-Windows: "\"&|<>()@^")
6115 global
6116 {not in Vi}
6117 When 'shellxquote' is set to "(" then the characters listed in this
6118 option will be escaped with a '^' character. This makes it possible
6119 to execute most external commands with cmd.exe.
6120
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 *'shellxquote'* *'sxq'*
6122'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006123 for Win32, when 'shell' is cmd.exe: "("
6124 for Win32, when 'shell' contains "sh"
6125 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 for Unix, when using system(): "\"")
6127 global
6128 {not in Vi}
6129 Quoting character(s), put around the command passed to the shell, for
6130 the "!" and ":!" commands. Includes the redirection. See
6131 'shellquote' to exclude the redirection. It's probably not useful
6132 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006133 When the value is '(' then ')' is appended. When the value is '"('
6134 then ')"' is appended.
6135 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006136 This is an empty string by default on most systems, but is known to be
6137 useful for on Win32 version, either for cmd.exe which automatically
6138 strips off the first and last quote on a command, or 3rd-party shells
6139 such as the MKS Korn Shell or bash, where it should be "\"". The
6140 default is adjusted according the value of 'shell', to reduce the need
6141 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 This option cannot be set from a |modeline| or in the |sandbox|, for
6143 security reasons.
6144
6145 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6146'shiftround' 'sr' boolean (default off)
6147 global
6148 {not in Vi}
6149 Round indent to multiple of 'shiftwidth'. Applies to > and <
6150 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6151 a multiple of 'shiftwidth' (this is Vi compatible).
6152 NOTE: This option is reset when 'compatible' is set.
6153
6154 *'shiftwidth'* *'sw'*
6155'shiftwidth' 'sw' number (default 8)
6156 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006157 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006159 When zero the 'ts' value will be used. Use the |shiftwidth()|
6160 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161
6162 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006163'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6164 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 global
6166 {not in Vi}
6167 This option helps to avoid all the |hit-enter| prompts caused by file
6168 messages, for example with CTRL-G, and to avoid some other messages.
6169 It is a list of flags:
6170 flag meaning when present ~
6171 f use "(3 of 5)" instead of "(file 3 of 5)"
6172 i use "[noeol]" instead of "[Incomplete last line]"
6173 l use "999L, 888C" instead of "999 lines, 888 characters"
6174 m use "[+]" instead of "[Modified]"
6175 n use "[New]" instead of "[New File]"
6176 r use "[RO]" instead of "[readonly]"
6177 w use "[w]" instead of "written" for file write message
6178 and "[a]" instead of "appended" for ':w >> file' command
6179 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6180 "[unix format]" and "[mac]" instead of "[mac format]".
6181 a all of the above abbreviations
6182
6183 o overwrite message for writing a file with subsequent message
6184 for reading a file (useful for ":wn" or when 'autowrite' on)
6185 O message for reading a file overwrites any previous message.
6186 Also for quickfix message (e.g., ":cn").
6187 s don't give "search hit BOTTOM, continuing at TOP" or "search
6188 hit TOP, continuing at BOTTOM" messages
6189 t truncate file message at the start if it is too long to fit
6190 on the command-line, "<" will appear in the left most column.
6191 Ignored in Ex mode.
6192 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006193 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 Ignored in Ex mode.
6195 W don't give "written" or "[w]" when writing a file
6196 A don't give the "ATTENTION" message when an existing swap file
6197 is found.
6198 I don't give the intro message when starting Vim |:intro|.
6199
6200 This gives you the opportunity to avoid that a change between buffers
6201 requires you to hit <Enter>, but still gives as useful a message as
6202 possible for the space available. To get the whole message that you
6203 would have got with 'shm' empty, use ":file!"
6204 Useful values:
6205 shm= No abbreviation of message.
6206 shm=a Abbreviation, but no loss of information.
6207 shm=at Abbreviation, and truncate message when necessary.
6208
6209 NOTE: This option is set to the Vi default value when 'compatible' is
6210 set and to the Vim default value when 'compatible' is reset.
6211
6212 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6213'shortname' 'sn' boolean (default off)
6214 local to buffer
6215 {not in Vi, not in MS-DOS versions}
6216 Filenames are assumed to be 8 characters plus one extension of 3
6217 characters. Multiple dots in file names are not allowed. When this
6218 option is on, dots in file names are replaced with underscores when
6219 adding an extension (".~" or ".swp"). This option is not available
6220 for MS-DOS, because then it would always be on. This option is useful
6221 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6222 or crossdos. When running the Win32 GUI version under Win32s, this
6223 option is always on by default.
6224
6225 *'showbreak'* *'sbr'* *E595*
6226'showbreak' 'sbr' string (default "")
6227 global
6228 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006229 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 feature}
6231 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006232 values are "> " or "+++ ": >
6233 :set showbreak=>\
6234< Note the backslash to escape the trailing space. It's easier like
6235 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006236 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006237< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 comma (in a future version the comma might be used to separate the
6239 part that is shown at the end and at the start of a line).
6240 The characters are highlighted according to the '@' flag in
6241 'highlight'.
6242 Note that tabs after the showbreak will be displayed differently.
6243 If you want the 'showbreak' to appear in between line numbers, add the
6244 "n" flag to 'cpoptions'.
6245
6246 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6247'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6248 off)
6249 global
6250 {not in Vi}
6251 {not available when compiled without the
6252 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006253 Show (partial) command in the last line of the screen. Set this
6254 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255 In Visual mode the size of the selected area is shown:
6256 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006257 If the number of bytes is different it is also displayed: "2-6"
6258 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006260 - When selecting a block, the size in screen characters:
6261 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 NOTE: This option is set to the Vi default value when 'compatible' is
6263 set and to the Vim default value when 'compatible' is reset.
6264
6265 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6266'showfulltag' 'sft' boolean (default off)
6267 global
6268 {not in Vi}
6269 When completing a word in insert mode (see |ins-completion|) from the
6270 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006271 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 matched a C function, you can see a template for what arguments are
6273 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006274 Note that this doesn't work well together with having "longest" in
6275 'completeopt', because the completion from the search pattern may not
6276 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277
6278 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6279'showmatch' 'sm' boolean (default off)
6280 global
6281 When a bracket is inserted, briefly jump to the matching one. The
6282 jump is only done if the match can be seen on the screen. The time to
6283 show the match can be set with 'matchtime'.
6284 A Beep is given if there is no match (no matter if the match can be
6285 seen or not). This option is reset when the 'paste' option is set.
6286 When the 'm' flag is not included in 'cpoptions', typing a character
6287 will immediately move the cursor back to where it belongs.
6288 See the "sm" field in 'guicursor' for setting the cursor shape and
6289 blinking when showing the match.
6290 The 'matchpairs' option can be used to specify the characters to show
6291 matches for. 'rightleft' and 'revins' are used to look for opposite
6292 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006293 Also see the matchparen plugin for highlighting the match when moving
6294 around |pi_paren.txt|.
6295 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006296
6297 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6298'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6299 global
6300 If in Insert, Replace or Visual mode put a message on the last line.
6301 Use the 'M' flag in 'highlight' to set the type of highlighting for
6302 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 doesn't mean XIM is really active, especially when 'imactivatekey' is
6305 not set.
6306 NOTE: This option is set to the Vi default value when 'compatible' is
6307 set and to the Vim default value when 'compatible' is reset.
6308
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006309 *'showtabline'* *'stal'*
6310'showtabline' 'stal' number (default 1)
6311 global
6312 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006313 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006314 feature}
6315 The value of this option specifies when the line with tab page labels
6316 will be displayed:
6317 0: never
6318 1: only if there are at least two tab pages
6319 2: always
6320 This is both for the GUI and non-GUI implementation of the tab pages
6321 line.
6322 See |tab-page| for more information about tab pages.
6323
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 *'sidescroll'* *'ss'*
6325'sidescroll' 'ss' number (default 0)
6326 global
6327 {not in Vi}
6328 The minimal number of columns to scroll horizontally. Used only when
6329 the 'wrap' option is off and the cursor is moved off of the screen.
6330 When it is zero the cursor will be put in the middle of the screen.
6331 When using a slow terminal set it to a large number or 0. When using
6332 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6333 commands.
6334
6335 *'sidescrolloff'* *'siso'*
6336'sidescrolloff' 'siso' number (default 0)
6337 global
6338 {not in Vi}
6339 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006340 right of the cursor if 'nowrap' is set. Setting this option to a
6341 value greater than 0 while having |'sidescroll'| also at a non-zero
6342 value makes some context visible in the line you are scrolling in
6343 horizontally (except at beginning of the line). Setting this option
6344 to a large value (like 999) has the effect of keeping the cursor
6345 horizontally centered in the window, as long as one does not come too
6346 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 NOTE: This option is set to 0 when 'compatible' is set.
6348
6349 Example: Try this together with 'sidescroll' and 'listchars' as
6350 in the following example to never allow the cursor to move
6351 onto the "extends" character:
6352
6353 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6354 :set sidescrolloff=1
6355
6356
6357 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6358'smartcase' 'scs' boolean (default off)
6359 global
6360 {not in Vi}
6361 Override the 'ignorecase' option if the search pattern contains upper
6362 case characters. Only used when the search pattern is typed and
6363 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006364 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6366 recalling the search pattern from history and hitting <Enter>.
6367 NOTE: This option is reset when 'compatible' is set.
6368
6369 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6370'smartindent' 'si' boolean (default off)
6371 local to buffer
6372 {not in Vi}
6373 {not available when compiled without the
6374 |+smartindent| feature}
6375 Do smart autoindenting when starting a new line. Works for C-like
6376 programs, but can also be used for other languages. 'cindent' does
6377 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006378 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006379 setting 'si' has no effect. 'indentexpr' is a more advanced
6380 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 Normally 'autoindent' should also be on when using 'smartindent'.
6382 An indent is automatically inserted:
6383 - After a line ending in '{'.
6384 - After a line starting with a keyword from 'cinwords'.
6385 - Before a line starting with '}' (only with the "O" command).
6386 When typing '}' as the first character in a new line, that line is
6387 given the same indent as the matching '{'.
6388 When typing '#' as the first character in a new line, the indent for
6389 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006390 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6392 When using the ">>" command, lines starting with '#' are not shifted
6393 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006394 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 is set smart indenting is disabled.
6396
6397 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6398'smarttab' 'sta' boolean (default off)
6399 global
6400 {not in Vi}
6401 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006402 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6403 <BS> will delete a 'shiftwidth' worth of space at the start of the
6404 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006405 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006406 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6407 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006408 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006410 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 NOTE: This option is reset when 'compatible' is set.
6412
6413 *'softtabstop'* *'sts'*
6414'softtabstop' 'sts' number (default 0)
6415 local to buffer
6416 {not in Vi}
6417 Number of spaces that a <Tab> counts for while performing editing
6418 operations, like inserting a <Tab> or using <BS>. It "feels" like
6419 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6420 used. This is useful to keep the 'ts' setting at its standard value
6421 of 8, while being able to edit like it is set to 'sts'. However,
6422 commands like "x" still work on the actual characters.
6423 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006424 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 'softtabstop' is set to 0 when the 'paste' option is set.
6426 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6427 spaces is minimized by using <Tab>s.
6428 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6429 set.
6430 NOTE: This option is set to 0 when 'compatible' is set.
6431
Bram Moolenaar217ad922005-03-20 22:37:15 +00006432 *'spell'* *'nospell'*
6433'spell' boolean (default off)
6434 local to window
6435 {not in Vi}
6436 {not available when compiled without the |+syntax|
6437 feature}
6438 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006439 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006440
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006441 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006442'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006443 local to buffer
6444 {not in Vi}
6445 {not available when compiled without the |+syntax|
6446 feature}
6447 Pattern to locate the end of a sentence. The following word will be
6448 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006449 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006450 When this check is not wanted make this option empty.
6451 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006452 Be careful with special characters, see |option-backslash| about
6453 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006454 To set this option automatically depending on the language, see
6455 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006456
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006457 *'spellfile'* *'spf'*
6458'spellfile' 'spf' string (default empty)
6459 local to buffer
6460 {not in Vi}
6461 {not available when compiled without the |+syntax|
6462 feature}
6463 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006464 commands. It must end in ".{encoding}.add". You need to include the
6465 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006466 *E765*
6467 It may also be a comma separated list of names. A count before the
6468 |zg| and |zw| commands can be used to access each. This allows using
6469 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006470 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006471 you: Using the first directory in 'runtimepath' that is writable. If
6472 there is no "spell" directory yet it will be created. For the file
6473 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006474 ignoring the region.
6475 The resulting ".spl" file will be used for spell checking, it does not
6476 have to appear in 'spelllang'.
6477 Normally one file is used for all regions, but you can add the region
6478 name if you want to. However, it will then only be used when
6479 'spellfile' is set to it, for entries in 'spelllang' only files
6480 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006481 This option cannot be set from a |modeline| or in the |sandbox|, for
6482 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006483
Bram Moolenaar217ad922005-03-20 22:37:15 +00006484 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006485'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006486 local to buffer
6487 {not in Vi}
6488 {not available when compiled without the |+syntax|
6489 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006490 A comma separated list of word list names. When the 'spell' option is
6491 on spellchecking will be done for these languages. Example: >
6492 set spelllang=en_us,nl,medical
6493< This means US English, Dutch and medical words are recognized. Words
6494 that are not recognized will be highlighted.
6495 The word list name must not include a comma or dot. Using a dash is
6496 recommended to separate the two letter language name from a
6497 specification. Thus "en-rare" is used for rare English words.
6498 A region name must come last and have the form "_xx", where "xx" is
6499 the two-letter, lower case region name. You can use more than one
6500 region by listing them: "en_us,en_ca" supports both US and Canadian
6501 English, but not words specific for Australia, New Zealand or Great
6502 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006503 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006504 As a special case the name of a .spl file can be given as-is. The
6505 first "_xx" in the name is removed and used as the region name
6506 (_xx is an underscore, two letters and followed by a non-letter).
6507 This is mainly for testing purposes. You must make sure the correct
6508 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006509 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006510 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6511 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006512 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006513
Bram Moolenaar98692072006-02-04 00:57:42 +00006514 If the |spellfile.vim| plugin is active and you use a language name
6515 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6516 will ask you if you want to download the file.
6517
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006518 After this option has been set successfully, Vim will source the files
6519 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006520 up to the first comma, dot or underscore.
6521 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006522
6523
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006524 *'spellsuggest'* *'sps'*
6525'spellsuggest' 'sps' string (default "best")
6526 global
6527 {not in Vi}
6528 {not available when compiled without the |+syntax|
6529 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006530 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006531 the |spellsuggest()| function. This is a comma-separated list of
6532 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006533
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006534 best Internal method that works best for English. Finds
6535 changes like "fast" and uses a bit of sound-a-like
6536 scoring to improve the ordering.
6537
6538 double Internal method that uses two methods and mixes the
6539 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006540 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006541 word. That only works when the language specifies
6542 sound folding. Can be slow and doesn't always give
6543 better results.
6544
6545 fast Internal method that only checks for simple changes:
6546 character inserts/deletes/swaps. Works well for
6547 simple typing mistakes.
6548
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006549 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006550 Not used for |spellsuggest()|. The number of
6551 suggestions is never more than the value of 'lines'
6552 minus two.
6553
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006554 file:{filename} Read file {filename}, which must have two columns,
6555 separated by a slash. The first column contains the
6556 bad word, the second column the suggested good word.
6557 Example:
6558 theribal/terrible ~
6559 Use this for common mistakes that do not appear at the
6560 top of the suggestion list with the internal methods.
6561 Lines without a slash are ignored, use this for
6562 comments.
6563 The file is used for all languages.
6564
6565 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6566 trouble with spaces. |v:val| holds the badly spelled
6567 word. The expression must evaluate to a List of
6568 Lists, each with a suggestion and a score.
6569 Example:
6570 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006571 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006572 internal methods use. A lower score is better.
6573 This may invoke |spellsuggest()| if you temporarily
6574 set 'spellsuggest' to exclude the "expr:" part.
6575 Errors are silently ignored, unless you set the
6576 'verbose' option to a non-zero value.
6577
6578 Only one of "best", "double" or "fast" may be used. The others may
6579 appear several times in any order. Example: >
6580 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6581<
6582 This option cannot be set from a |modeline| or in the |sandbox|, for
6583 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006584
6585
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6587'splitbelow' 'sb' boolean (default off)
6588 global
6589 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006590 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 feature}
6592 When on, splitting a window will put the new window below the current
6593 one. |:split|
6594
6595 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6596'splitright' 'spr' boolean (default off)
6597 global
6598 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006599 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 feature}
6601 When on, splitting a window will put the new window right of the
6602 current one. |:vsplit|
6603
6604 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6605'startofline' 'sol' boolean (default on)
6606 global
6607 {not in Vi}
6608 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006609 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006610 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006611 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 with a linewise operator, with "%" with a count and to buffer changing
6613 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6614 only has a line number, e.g., ":25" or ":+".
6615 In case of buffer changing commands the cursor is placed at the column
6616 where it was the last time the buffer was edited.
6617 NOTE: This option is set when 'compatible' is set.
6618
Bram Moolenaar00654022011-02-25 14:42:19 +01006619 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006621 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 {not in Vi}
6623 {not available when compiled without the |+statusline|
6624 feature}
6625 When nonempty, this option determines the content of the status line.
6626 Also see |status-line|.
6627
6628 The option consists of printf style '%' items interspersed with
6629 normal text. Each status line item is of the form:
6630 %-0{minwid}.{maxwid}{item}
6631 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006632 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633
Bram Moolenaar238a5642006-02-21 22:12:05 +00006634 When the option starts with "%!" then it is used as an expression,
6635 evaluated and the result is used as the option value. Example: >
6636 :set statusline=%!MyStatusLine()
6637< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006638 Note that the "%!" expression is evaluated in the context of the
6639 current window and buffer, while %{} items are evaluated in the
6640 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006641
6642 When there is error while evaluating the option then it will be made
6643 empty to avoid further errors. Otherwise screen updating would loop.
6644
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 Note that the only effect of 'ruler' when this option is set (and
6646 'laststatus' is 2) is controlling the output of |CTRL-G|.
6647
6648 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006649 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006651 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 minwid Minimum width of the item, padding as set by '-' & '0'.
6653 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006654 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 on the left for text items. Numeric items will be
6656 shifted down to maxwid-2 digits followed by '>'number
6657 where number is the amount of missing digits, much like
6658 an exponential notation.
6659 item A one letter code as described below.
6660
6661 Following is a description of the possible statusline items. The
6662 second character in "item" is the type:
6663 N for number
6664 S for string
6665 F for flags as described below
6666 - not applicable
6667
6668 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006669 f S Path to the file in the buffer, as typed or relative to current
6670 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 F S Full path to the file in the buffer.
6672 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006673 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006675 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006677 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006679 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006681 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6683 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006684 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6686 being used: "<keymap>"
6687 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006688 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 B N As above, in hexadecimal.
6690 o N Byte number in file of byte under cursor, first byte is 1.
6691 Mnemonic: Offset from start of file (with one added)
6692 {not available when compiled without |+byte_offset| feature}
6693 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006694 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 l N Line number.
6696 L N Number of lines in buffer.
6697 c N Column number.
6698 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006699 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 p N Percentage through file in lines as in |CTRL-G|.
6701 P S Percentage through file of displayed window. This is like the
6702 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006703 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006705 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006706 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 ( - Start of item group. Can be used for setting the width and
6708 alignment of a section. Must be followed by %) somewhere.
6709 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006710 T N For 'tabline': start of tab page N label. Use %T after the last
6711 label. This information is used for mouse clicks.
6712 X N For 'tabline': start of close tab N label. Use %X after the
6713 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6714 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 < - Where to truncate line if too long. Default is at the start.
6716 No width fields allowed.
6717 = - Separation point between left and right aligned items.
6718 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006719 # - Set highlight group. The name must follow and then a # again.
6720 Thus use %#HLname# for highlight group HLname. The same
6721 highlighting is used, also for the statusline of non-current
6722 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006724 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 The difference between User{N} and StatusLine will be applied
6726 to StatusLineNC for the statusline of non-current windows.
6727 The number N must be between 1 and 9. See |hl-User1..9|
6728
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006729 When displaying a flag, Vim removes the leading comma, if any, when
6730 that flag comes right after plaintext. This will make a nice display
6731 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732
Bram Moolenaar582fd852005-03-28 20:58:01 +00006733 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 not set) and a minwid is not set for the group, the whole group will
6735 become empty. This will make a group like the following disappear
6736 completely from the statusline when none of the flags are set. >
6737 :set statusline=...%(\ [%M%R%H]%)...
6738<
6739 Beware that an expression is evaluated each and every time the status
6740 line is displayed. The current buffer and current window will be set
6741 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006742 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006744 real current buffer.
6745
Bram Moolenaar30b65812012-07-12 22:01:11 +02006746 The 'statusline' option will be evaluated in the |sandbox| if set from
6747 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006748
6749 It is not allowed to change text or jump to another window while
6750 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751
6752 If the statusline is not updated when you want it (e.g., after setting
6753 a variable that's used in an expression), you can force an update by
6754 setting an option without changing its value. Example: >
6755 :let &ro = &ro
6756
6757< A result of all digits is regarded a number for display purposes.
6758 Otherwise the result is taken as flag text and applied to the rules
6759 described above.
6760
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006761 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6763 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6764
6765 Examples:
6766 Emulate standard status line with 'ruler' set >
6767 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6768< Similar, but add ASCII value of char under the cursor (like "ga") >
6769 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6770< Display byte count and byte value, modified flag in red. >
6771 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6772 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6773< Display a ,GZ flag if a compressed file is loaded >
6774 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6775< In the |:autocmd|'s: >
6776 :let b:gzflag = 1
6777< And: >
6778 :unlet b:gzflag
6779< And define this function: >
6780 :function VarExists(var, val)
6781 : if exists(a:var) | return a:val | else | return '' | endif
6782 :endfunction
6783<
6784 *'suffixes'* *'su'*
6785'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6786 global
6787 {not in Vi}
6788 Files with these suffixes get a lower priority when multiple files
6789 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006790 suffixes. Spaces after the comma are ignored. A dot is also seen as
6791 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 separator, precede it with a backslash (see |option-backslash| about
6793 including spaces and backslashes).
6794 See 'wildignore' for completely ignoring files.
6795 The use of |:set+=| and |:set-=| is preferred when adding or removing
6796 suffixes from the list. This avoids problems when a future version
6797 uses another default.
6798
6799 *'suffixesadd'* *'sua'*
6800'suffixesadd' 'sua' string (default "")
6801 local to buffer
6802 {not in Vi}
6803 {not available when compiled without the
6804 |+file_in_path| feature}
6805 Comma separated list of suffixes, which are used when searching for a
6806 file for the "gf", "[I", etc. commands. Example: >
6807 :set suffixesadd=.java
6808<
6809 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6810'swapfile' 'swf' boolean (default on)
6811 local to buffer
6812 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006813 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 swapfile is not wanted for a specific buffer. For example, with
6815 confidential information that even root must not be able to access.
6816 Careful: All text will be in memory:
6817 - Don't use this for big files.
6818 - Recovery will be impossible!
6819 A swapfile will only be present when |'updatecount'| is non-zero and
6820 'swapfile' is set.
6821 When 'swapfile' is reset, the swap file for the current buffer is
6822 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6823 non-zero, a swap file is immediately created.
6824 Also see |swap-file| and |'swapsync'|.
6825
6826 This option is used together with 'bufhidden' and 'buftype' to
6827 specify special kinds of buffers. See |special-buffers|.
6828
6829 *'swapsync'* *'sws'*
6830'swapsync' 'sws' string (default "fsync")
6831 global
6832 {not in Vi}
6833 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006834 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 When this option is empty parts of the swap file may be in memory and
6836 not written to disk. When the system crashes you may lose more work.
6837 On Unix the system does a sync now and then without Vim asking for it,
6838 so the disadvantage of setting this option off is small. On some
6839 systems the swap file will not be written at all. For a unix system
6840 setting it to "sync" will use the sync() call instead of the default
6841 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006842 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006843
6844 *'switchbuf'* *'swb'*
6845'switchbuf' 'swb' string (default "")
6846 global
6847 {not in Vi}
6848 This option controls the behavior when switching between buffers.
6849 Possible values (comma separated list):
6850 useopen If included, jump to the first open window that
6851 contains the specified buffer (if there is one).
6852 Otherwise: Do not examine other windows.
6853 This setting is checked with |quickfix| commands, when
6854 jumping to errors (":cc", ":cn", "cp", etc.). It is
6855 also used in all buffer related split commands, for
6856 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006857 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006858 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006860 a buffer for a |quickfix| command that display errors.
6861 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006862 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006863 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006865 *'synmaxcol'* *'smc'*
6866'synmaxcol' 'smc' number (default 3000)
6867 local to buffer
6868 {not in Vi}
6869 {not available when compiled without the |+syntax|
6870 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006871 Maximum column in which to search for syntax items. In long lines the
6872 text after this column is not highlighted and following lines may not
6873 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006874 This helps to avoid very slow redrawing for an XML file that is one
6875 long line.
6876 Set to zero to remove the limit.
6877
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 *'syntax'* *'syn'*
6879'syntax' 'syn' string (default empty)
6880 local to buffer
6881 {not in Vi}
6882 {not available when compiled without the |+syntax|
6883 feature}
6884 When this option is set, the syntax with this name is loaded, unless
6885 syntax highlighting has been switched off with ":syntax off".
6886 Otherwise this option does not always reflect the current syntax (the
6887 b:current_syntax variable does).
6888 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006889 not automatically recognized. Example, in an IDL file:
6890 /* vim: set syntax=idl : */ ~
6891 When a dot appears in the value then this separates two filetype
6892 names. Example:
6893 /* vim: set syntax=c.doxygen : */ ~
6894 This will use the "c" syntax first, then the "doxygen" syntax.
6895 Note that the second one must be prepared to be loaded as an addition,
6896 otherwise it will be skipped. More than one dot may appear.
6897 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 :set syntax=OFF
6899< To switch syntax highlighting on according to the current value of the
6900 'filetype' option: >
6901 :set syntax=ON
6902< What actually happens when setting the 'syntax' option is that the
6903 Syntax autocommand event is triggered with the value as argument.
6904 This option is not copied to another buffer, independent of the 's' or
6905 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006906 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006908 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006909'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006910 global
6911 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006912 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006913 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006914 When nonempty, this option determines the content of the tab pages
6915 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006916 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006917
6918 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006919 option and only when there is no GUI tab line. When 'e' is in
6920 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006921 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006922
6923 The value is evaluated like with 'statusline'. You can use
6924 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006925 the text to be displayed. Use "%1T" for the first label, "%2T" for
6926 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006927
6928 Keep in mind that only one of the tab pages is the current one, others
6929 are invisible and you can't jump to their windows.
6930
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006931
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006932 *'tabpagemax'* *'tpm'*
6933'tabpagemax' 'tpm' number (default 10)
6934 global
6935 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006936 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006937 feature}
6938 Maximum number of tab pages to be opened by the |-p| command line
6939 argument or the ":tab all" command. |tabpage|
6940
6941
6942 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943'tabstop' 'ts' number (default 8)
6944 local to buffer
6945 Number of spaces that a <Tab> in the file counts for. Also see
6946 |:retab| command, and 'softtabstop' option.
6947
6948 Note: Setting 'tabstop' to any other value than 8 can make your file
6949 appear wrong in many places (e.g., when printing it).
6950
6951 There are four main ways to use tabs in Vim:
6952 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6953 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006954 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 behave like a tab appears every 4 (or 3) characters.
6956 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6957 'expandtab'. This way you will always insert spaces. The
6958 formatting will never be messed up when 'tabstop' is changed.
6959 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006960 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 works when using Vim to edit the file.
6962 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6963 'noexpandtab'. This should then work (for initial indents only)
6964 for any tabstop setting that people use. It might be nice to have
6965 tabs after the first non-blank inserted as spaces if you do this
6966 though. Otherwise aligned comments will be wrong when 'tabstop' is
6967 changed.
6968
6969 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6970'tagbsearch' 'tbs' boolean (default on)
6971 global
6972 {not in Vi}
6973 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006974 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 searching makes searching for a tag a LOT faster, but a linear search
6976 will find more tags if the tags file wasn't properly sorted.
6977 Vim normally assumes that your tags files are sorted, or indicate that
6978 they are not sorted. Only when this is not the case does the
6979 'tagbsearch' option need to be switched off.
6980
6981 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006982 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 certain files, or retry all files with a linear search. When
6984 'tagbsearch' is off, only a linear search is done.
6985
6986 Linear searching is done anyway, for one file, when Vim finds a line
6987 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006988 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989< [The whitespace before and after the '0' must be a single <Tab>]
6990
6991 When a binary search was done and no match was found in any of the
6992 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6993 instead of a normal tag name, a retry is done with a linear search.
6994 Tags in unsorted tags files, and matches with different case will only
6995 be found in the retry.
6996
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006997 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 linear search can be avoided for the 'ignorecase' case. Use a value
6999 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7000 case-fold sorted with the -f switch to "sort" in most unices, as in
7001 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007002 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7003 for this as well. Note that case must be folded to uppercase for this
7004 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007005
7006 When 'tagbsearch' is off, tags searching is slower when a full match
7007 exists, but faster when no full match exists. Tags in unsorted tags
7008 files may only be found with 'tagbsearch' off.
7009 When the tags file is not sorted, or sorted in a wrong way (not on
7010 ASCII byte value), 'tagbsearch' should be off, or the line given above
7011 must be included in the tags file.
7012 This option doesn't affect commands that find all matching tags (e.g.,
7013 command-line completion and ":help").
7014 {Vi: always uses binary search in some versions}
7015
7016 *'taglength'* *'tl'*
7017'taglength' 'tl' number (default 0)
7018 global
7019 If non-zero, tags are significant up to this number of characters.
7020
7021 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7022'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7023 global
7024 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007025 If on and using a tags file in another directory, file names in that
7026 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 NOTE: This option is set to the Vi default value when 'compatible' is
7028 set and to the Vim default value when 'compatible' is reset.
7029
7030 *'tags'* *'tag'* *E433*
7031'tags' 'tag' string (default "./tags,tags", when compiled with
7032 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7033 global or local to buffer |global-local|
7034 Filenames for the tag command, separated by spaces or commas. To
7035 include a space or comma in a file name, precede it with a backslash
7036 (see |option-backslash| about including spaces and backslashes).
7037 When a file name starts with "./", the '.' is replaced with the path
7038 of the current file. But only when the 'd' flag is not included in
7039 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7040 |tags-option|.
7041 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007042 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7043 find all files named "tags" below "/lib". The filename itself cannot
7044 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7045 files called "tags?". {not available when compiled without the
7046 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007047 The |tagfiles()| function can be used to get a list of the file names
7048 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7050 files are also supported. They are automatically recognized. The
7051 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7052 differences are ignored (MS-Windows). |emacs-tags|
7053 The use of |:set+=| and |:set-=| is preferred when adding or removing
7054 file names from the list. This avoids problems when a future version
7055 uses another default.
7056 {Vi: default is "tags /usr/lib/tags"}
7057
7058 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7059'tagstack' 'tgst' boolean (default on)
7060 global
7061 {not in all versions of Vi}
7062 When on, the |tagstack| is used normally. When off, a ":tag" or
7063 ":tselect" command with an argument will not push the tag onto the
7064 tagstack. A following ":tag" without an argument, a ":pop" command or
7065 any other command that uses the tagstack will use the unmodified
7066 tagstack, but does change the pointer to the active entry.
7067 Resetting this option is useful when using a ":tag" command in a
7068 mapping which should not change the tagstack.
7069
7070 *'term'* *E529* *E530* *E531*
7071'term' string (default is $TERM, if that fails:
7072 in the GUI: "builtin_gui"
7073 on Amiga: "amiga"
7074 on BeOS: "beos-ansi"
7075 on Mac: "mac-ansi"
7076 on MiNT: "vt52"
7077 on MS-DOS: "pcterm"
7078 on OS/2: "os2ansi"
7079 on Unix: "ansi"
7080 on VMS: "ansi"
7081 on Win 32: "win32")
7082 global
7083 Name of the terminal. Used for choosing the terminal control
7084 characters. Environment variables are expanded |:set_env|.
7085 For example: >
7086 :set term=$TERM
7087< See |termcap|.
7088
7089 *'termbidi'* *'tbidi'*
7090 *'notermbidi'* *'notbidi'*
7091'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7092 global
7093 {not in Vi}
7094 {only available when compiled with the |+arabic|
7095 feature}
7096 The terminal is in charge of Bi-directionality of text (as specified
7097 by Unicode). The terminal is also expected to do the required shaping
7098 that some languages (such as Arabic) require.
7099 Setting this option implies that 'rightleft' will not be set when
7100 'arabic' is set and the value of 'arabicshape' will be ignored.
7101 Note that setting 'termbidi' has the immediate effect that
7102 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7103 This option is reset when the GUI is started.
7104 For further details see |arabic.txt|.
7105
7106 *'termencoding'* *'tenc'*
7107'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7108 Macintosh GUI: "macroman")
7109 global
7110 {only available when compiled with the |+multi_byte|
7111 feature}
7112 {not in Vi}
7113 Encoding used for the terminal. This specifies what character
7114 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007115 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007116 display). Except for the Mac when 'macatsui' is off, then
7117 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 In the Win32 console version the default value is the console codepage
7119 when it differs from the ANSI codepage.
7120 *E617*
7121 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7122 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7123 Any attempts to set a different value will be rejected, and an error
7124 message is shown.
7125 For the Win32 GUI 'termencoding' is not used for typed characters,
7126 because the Win32 system always passes Unicode characters.
7127 When empty, the same encoding is used as for the 'encoding' option.
7128 This is the normal value.
7129 Not all combinations for 'termencoding' and 'encoding' are valid. See
7130 |encoding-table|.
7131 The value for this option must be supported by internal conversions or
7132 iconv(). When this is not possible no conversion will be done and you
7133 will probably experience problems with non-ASCII characters.
7134 Example: You are working with the locale set to euc-jp (Japanese) and
7135 want to edit a UTF-8 file: >
7136 :let &termencoding = &encoding
7137 :set encoding=utf-8
7138< You need to do this when your system has no locale support for UTF-8.
7139
7140 *'terse'* *'noterse'*
7141'terse' boolean (default off)
7142 global
7143 When set: Add 's' flag to 'shortmess' option (this makes the message
7144 for a search that hits the start or end of the file not being
7145 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7146 shortens a lot of messages}
7147
7148 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7149'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7150 global
7151 {not in Vi}
7152 This option is obsolete. Use 'fileformats'.
7153 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7154 set to the default value for the current system. When 'textauto' is
7155 reset, 'fileformats' is made empty.
7156 NOTE: This option is set to the Vi default value when 'compatible' is
7157 set and to the Vim default value when 'compatible' is reset.
7158
7159 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7160'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7161 others: default off)
7162 local to buffer
7163 {not in Vi}
7164 This option is obsolete. Use 'fileformat'.
7165 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7166 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7167 "unix".
7168
7169 *'textwidth'* *'tw'*
7170'textwidth' 'tw' number (default 0)
7171 local to buffer
7172 {not in Vi}
7173 Maximum width of text that is being inserted. A longer line will be
7174 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007175 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7176 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007178 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 NOTE: This option is set to 0 when 'compatible' is set.
7180
7181 *'thesaurus'* *'tsr'*
7182'thesaurus' 'tsr' string (default "")
7183 global or local to buffer |global-local|
7184 {not in Vi}
7185 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007186 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187 the file should contain words with similar meaning, separated by
7188 non-keyword characters (white space is preferred). Maximum line
7189 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007190 To obtain a file to be used here, check out this ftp site:
7191 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007192 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 after a comma are ignored, otherwise spaces are included in the file
7194 name. See |option-backslash| about using backslashes.
7195 The use of |:set+=| and |:set-=| is preferred when adding or removing
7196 directories from the list. This avoids problems when a future version
7197 uses another default.
7198 Backticks cannot be used in this option for security reasons.
7199
7200 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7201'tildeop' 'top' boolean (default off)
7202 global
7203 {not in Vi}
7204 When on: The tilde command "~" behaves like an operator.
7205 NOTE: This option is reset when 'compatible' is set.
7206
7207 *'timeout'* *'to'* *'notimeout'* *'noto'*
7208'timeout' 'to' boolean (default on)
7209 global
7210 *'ttimeout'* *'nottimeout'*
7211'ttimeout' boolean (default off)
7212 global
7213 {not in Vi}
7214 These two options together determine the behavior when part of a
7215 mapped key sequence or keyboard code has been received:
7216
7217 'timeout' 'ttimeout' action ~
7218 off off do not time out
7219 on on or off time out on :mappings and key codes
7220 off on time out on key codes
7221
7222 If both options are off, Vim will wait until either the complete
7223 mapping or key sequence has been received, or it is clear that there
7224 is no mapping or key sequence for the received characters. For
7225 example: if you have mapped "vl" and Vim has received 'v', the next
7226 character is needed to see if the 'v' is followed by an 'l'.
7227 When one of the options is on, Vim will wait for about 1 second for
7228 the next character to arrive. After that the already received
7229 characters are interpreted as single characters. The waiting time can
7230 be changed with the 'timeoutlen' option.
7231 On slow terminals or very busy systems timing out may cause
7232 malfunctioning cursor keys. If both options are off, Vim waits
7233 forever after an entered <Esc> if there are key codes that start
7234 with <Esc>. You will have to type <Esc> twice. If you do not have
7235 problems with key codes, but would like to have :mapped key
7236 sequences not timing out in 1 second, set the 'ttimeout' option and
7237 reset the 'timeout' option.
7238
7239 NOTE: 'ttimeout' is reset when 'compatible' is set.
7240
7241 *'timeoutlen'* *'tm'*
7242'timeoutlen' 'tm' number (default 1000)
7243 global
7244 {not in all versions of Vi}
7245 *'ttimeoutlen'* *'ttm'*
7246'ttimeoutlen' 'ttm' number (default -1)
7247 global
7248 {not in Vi}
7249 The time in milliseconds that is waited for a key code or mapped key
7250 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7251 when part of a command has been typed.
7252 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7253 different timeout value for key codes is desired set 'ttimeoutlen' to
7254 a non-negative number.
7255
7256 ttimeoutlen mapping delay key code delay ~
7257 < 0 'timeoutlen' 'timeoutlen'
7258 >= 0 'timeoutlen' 'ttimeoutlen'
7259
7260 The timeout only happens when the 'timeout' and 'ttimeout' options
7261 tell so. A useful setting would be >
7262 :set timeout timeoutlen=3000 ttimeoutlen=100
7263< (time out on mapping after three seconds, time out on key codes after
7264 a tenth of a second).
7265
7266 *'title'* *'notitle'*
7267'title' boolean (default off, on when title can be restored)
7268 global
7269 {not in Vi}
7270 {not available when compiled without the |+title|
7271 feature}
7272 When on, the title of the window will be set to the value of
7273 'titlestring' (if it is not empty), or to:
7274 filename [+=-] (path) - VIM
7275 Where:
7276 filename the name of the file being edited
7277 - indicates the file cannot be modified, 'ma' off
7278 + indicates the file was modified
7279 = indicates the file is read-only
7280 =+ indicates the file is read-only and modified
7281 (path) is the path of the file being edited
7282 - VIM the server name |v:servername| or "VIM"
7283 Only works if the terminal supports setting window titles
7284 (currently Amiga console, Win32 console, all GUI versions and
7285 terminals with a non- empty 't_ts' option - these are Unix xterm and
7286 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7287 *X11*
7288 When Vim was compiled with HAVE_X11 defined, the original title will
7289 be restored if possible. The output of ":version" will include "+X11"
7290 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7291 works for the icon name |'icon'|.
7292 But: When Vim was started with the |-X| argument, restoring the title
7293 will not work (except in the GUI).
7294 If the title cannot be restored, it is set to the value of 'titleold'.
7295 You might want to restore the title outside of Vim then.
7296 When using an xterm from a remote machine you can use this command:
7297 rsh machine_name xterm -display $DISPLAY &
7298 then the WINDOWID environment variable should be inherited and the
7299 title of the window should change back to what it should be after
7300 exiting Vim.
7301
7302 *'titlelen'*
7303'titlelen' number (default 85)
7304 global
7305 {not in Vi}
7306 {not available when compiled without the |+title|
7307 feature}
7308 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007309 title. When the title is longer, only the end of the path name is
7310 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007311 Using a percentage makes this adapt to the width of the window. But
7312 it won't work perfectly, because the actual number of characters
7313 available also depends on the font used and other things in the title
7314 bar. When 'titlelen' is zero the full path is used. Otherwise,
7315 values from 1 to 30000 percent can be used.
7316 'titlelen' is also used for the 'titlestring' option.
7317
7318 *'titleold'*
7319'titleold' string (default "Thanks for flying Vim")
7320 global
7321 {not in Vi}
7322 {only available when compiled with the |+title|
7323 feature}
7324 This option will be used for the window title when exiting Vim if the
7325 original title cannot be restored. Only happens if 'title' is on or
7326 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007327 This option cannot be set from a |modeline| or in the |sandbox|, for
7328 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007329 *'titlestring'*
7330'titlestring' string (default "")
7331 global
7332 {not in Vi}
7333 {not available when compiled without the |+title|
7334 feature}
7335 When this option is not empty, it will be used for the title of the
7336 window. This happens only when the 'title' option is on.
7337 Only works if the terminal supports setting window titles (currently
7338 Amiga console, Win32 console, all GUI versions and terminals with a
7339 non-empty 't_ts' option).
7340 When Vim was compiled with HAVE_X11 defined, the original title will
7341 be restored if possible |X11|.
7342 When this option contains printf-style '%' items, they will be
7343 expanded according to the rules used for 'statusline'.
7344 Example: >
7345 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7346 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7347< The value of 'titlelen' is used to align items in the middle or right
7348 of the available space.
7349 Some people prefer to have the file name first: >
7350 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7351< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007352 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 separating space only when needed.
7354 NOTE: Use of special characters in 'titlestring' may cause the display
7355 to be garbled (e.g., when it contains a CR or NL character).
7356 {not available when compiled without the |+statusline| feature}
7357
7358 *'toolbar'* *'tb'*
7359'toolbar' 'tb' string (default "icons,tooltips")
7360 global
7361 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7362 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007363 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 possible values are:
7365 icons Toolbar buttons are shown with icons.
7366 text Toolbar buttons shown with text.
7367 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007368 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 tooltips Tooltips are active for toolbar buttons.
7370 Tooltips refer to the popup help text which appears after the mouse
7371 cursor is placed over a toolbar button for a brief moment.
7372
7373 If you want the toolbar to be shown with icons as well as text, do the
7374 following: >
7375 :set tb=icons,text
7376< Motif and Athena cannot display icons and text at the same time. They
7377 will show icons if both are requested.
7378
7379 If none of the strings specified in 'toolbar' are valid or if
7380 'toolbar' is empty, this option is ignored. If you want to disable
7381 the toolbar, you need to set the 'guioptions' option. For example: >
7382 :set guioptions-=T
7383< Also see |gui-toolbar|.
7384
7385 *'toolbariconsize'* *'tbis'*
7386'toolbariconsize' 'tbis' string (default "small")
7387 global
7388 {not in Vi}
7389 {only in the GTK+ 2 GUI}
7390 Controls the size of toolbar icons. The possible values are:
7391 tiny Use tiny toolbar icons.
7392 small Use small toolbar icons (default).
7393 medium Use medium-sized toolbar icons.
7394 large Use large toolbar icons.
7395 The exact dimensions in pixels of the various icon sizes depend on
7396 the current theme. Common dimensions are large=32x32, medium=24x24,
7397 small=20x20 and tiny=16x16.
7398
7399 If 'toolbariconsize' is empty, the global default size as determined
7400 by user preferences or the current theme is used.
7401
7402 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7403'ttybuiltin' 'tbi' boolean (default on)
7404 global
7405 {not in Vi}
7406 When on, the builtin termcaps are searched before the external ones.
7407 When off the builtin termcaps are searched after the external ones.
7408 When this option is changed, you should set the 'term' option next for
7409 the change to take effect, for example: >
7410 :set notbi term=$TERM
7411< See also |termcap|.
7412 Rationale: The default for this option is "on", because the builtin
7413 termcap entries are generally better (many systems contain faulty
7414 xterm entries...).
7415
7416 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7417'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7418 sun-cmd, screen, rxvt, dtterm or
7419 iris-ansi; also on when running Vim in
7420 a DOS console)
7421 global
7422 {not in Vi}
7423 Indicates a fast terminal connection. More characters will be sent to
7424 the screen for redrawing, instead of using insert/delete line
7425 commands. Improves smoothness of redrawing when there are multiple
7426 windows and the terminal does not support a scrolling region.
7427 Also enables the extra writing of characters at the end of each screen
7428 line for lines that wrap. This helps when using copy/paste with the
7429 mouse in an xterm and other terminals.
7430
7431 *'ttymouse'* *'ttym'*
7432'ttymouse' 'ttym' string (default depends on 'term')
7433 global
7434 {not in Vi}
7435 {only in Unix and VMS, doesn't work in the GUI; not
7436 available when compiled without |+mouse|}
7437 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007438 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007439 *xterm-mouse*
7440 xterm xterm-like mouse handling. The mouse generates
7441 "<Esc>[Mscr", where "scr" is three bytes:
7442 "s" = button state
7443 "c" = column plus 33
7444 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007445 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007446 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 xterm2 Works like "xterm", but with the xterm reporting the
7448 mouse position while the mouse is dragged. This works
7449 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007450 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 work. See below for how Vim detects this
7452 automatically.
7453 *netterm-mouse*
7454 netterm NetTerm mouse handling. The mouse generates
7455 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7456 for the row and column.
7457 *dec-mouse*
7458 dec DEC terminal mouse handling. The mouse generates a
7459 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007460 This is also available for an Xterm, if it was
7461 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007462 *jsbterm-mouse*
7463 jsbterm JSB term mouse handling.
7464 *pterm-mouse*
7465 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007466 *urxvt-mouse*
7467 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar9b451252012-08-15 17:43:31 +02007468 *sgr-mouse*
7469 sgr Mouse handling for the terminal that emits SGR-styled
7470 mouse reporting. Works with xterm version 277 or
7471 later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472
7473 The mouse handling must be enabled at compile time |+mouse_xterm|
7474 |+mouse_dec| |+mouse_netterm|.
7475 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7476 recognized, if enabled at compile time. DEC terminal mouse codes
7477 are recognized if enabled at compile time, and 'ttymouse' is not
7478 "xterm" (because the xterm and dec mouse codes conflict).
7479 This option is automatically set to "xterm", when the 'term' option is
7480 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7481 or "xterm2" already. The main use of this option is to set it to
7482 "xterm", when the terminal name doesn't start with "xterm", but it can
7483 handle xterm mouse codes.
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02007484 The "sgr" value will be set if the xterm version is 277 or later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007486 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 feature and if |t_RV| is set to the escape sequence to request the
7488 xterm version number. Otherwise "xterm2" must be set explicitly.
7489 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7490 t_RV to an empty string: >
7491 :set t_RV=
7492<
7493 *'ttyscroll'* *'tsl'*
7494'ttyscroll' 'tsl' number (default 999)
7495 global
7496 Maximum number of lines to scroll the screen. If there are more lines
7497 to scroll the window is redrawn. For terminals where scrolling is
7498 very slow and redrawing is not slow this can be set to a small number,
7499 e.g., 3, to speed up displaying.
7500
7501 *'ttytype'* *'tty'*
7502'ttytype' 'tty' string (default from $TERM)
7503 global
7504 Alias for 'term', see above.
7505
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007506 *'undodir'* *'udir'*
7507'undodir' 'udir' string (default ".")
7508 global
7509 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007510 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007511 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007512 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007513 "." means using the directory of the file. The undo file name for
7514 "file.txt" is ".file.txt.un~".
7515 For other directories the file name is the full path of the edited
7516 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007517 When writing: The first directory that exists is used. "." always
7518 works, no directories after "." will be used for writing.
7519 When reading all entries are tried to find an undo file. The first
7520 undo file that exists is used. When it cannot be read an error is
7521 given, no further entry is used.
7522 See |undo-persistence|.
7523
7524 *'undofile'* *'udf'*
7525'undofile' 'udf' boolean (default off)
7526 local to buffer
7527 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007528 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007529 When on, Vim automatically saves undo history to an undo file when
7530 writing a buffer to a file, and restores undo history from the same
7531 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007532 The directory where the undo file is stored is specified by 'undodir'.
7533 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007534 The undo file is not read when 'undoreload' causes the buffer from
7535 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007536 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007537
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 *'undolevels'* *'ul'*
7539'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7540 Win32 and OS/2)
7541 global
7542 {not in Vi}
7543 Maximum number of changes that can be undone. Since undo information
7544 is kept in memory, higher numbers will cause more memory to be used
7545 (nevertheless, a single change can use an unlimited amount of memory).
7546 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7547 itself: >
7548 set ul=0
7549< But you can also get Vi compatibility by including the 'u' flag in
7550 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007551 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 Set to a negative number for no undo at all: >
7553 set ul=-1
7554< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007555 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007557 *'undoreload'* *'ur'*
7558'undoreload' 'ur' number (default 10000)
7559 global
7560 {not in Vi}
7561 Save the whole buffer for undo when reloading it. This applies to the
7562 ":e!" command and reloading for when the buffer changed outside of
7563 Vim. |FileChangedShell|
7564 The save only happens when this options is negative or when the number
7565 of lines is smaller than the value of this option.
7566 Set this option to zero to disable undo for a reload.
7567
7568 When saving undo for a reload, any undo file is not read.
7569
7570 Note that this causes the whole buffer to be stored in memory. Set
7571 this option to a lower value if you run out of memory.
7572
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 *'updatecount'* *'uc'*
7574'updatecount' 'uc' number (default: 200)
7575 global
7576 {not in Vi}
7577 After typing this many characters the swap file will be written to
7578 disk. When zero, no swap file will be created at all (see chapter on
7579 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7580 Vim with the "-n" option, see |startup|. When editing in readonly
7581 mode this option will be initialized to 10000.
7582 The swapfile can be disabled per buffer with |'swapfile'|.
7583 When 'updatecount' is set from zero to non-zero, swap files are
7584 created for all buffers that have 'swapfile' set. When 'updatecount'
7585 is set to zero, existing swap files are not deleted.
7586 Also see |'swapsync'|.
7587 This option has no meaning in buffers where |'buftype'| is "nofile"
7588 or "nowrite".
7589
7590 *'updatetime'* *'ut'*
7591'updatetime' 'ut' number (default 4000)
7592 global
7593 {not in Vi}
7594 If this many milliseconds nothing is typed the swap file will be
7595 written to disk (see |crash-recovery|). Also used for the
7596 |CursorHold| autocommand event.
7597
7598 *'verbose'* *'vbs'*
7599'verbose' 'vbs' number (default 0)
7600 global
7601 {not in Vi, although some versions have a boolean
7602 verbose option}
7603 When bigger than zero, Vim will give messages about what it is doing.
7604 Currently, these messages are given:
7605 >= 1 When the viminfo file is read or written.
7606 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007607 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 >= 8 Files for which a group of autocommands is executed.
7609 >= 9 Every executed autocommand.
7610 >= 12 Every executed function.
7611 >= 13 When an exception is thrown, caught, finished, or discarded.
7612 >= 14 Anything pending in a ":finally" clause.
7613 >= 15 Every executed Ex command (truncated at 200 characters).
7614
7615 This option can also be set with the "-V" argument. See |-V|.
7616 This option is also set by the |:verbose| command.
7617
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007618 When the 'verbosefile' option is set then the verbose messages are not
7619 displayed.
7620
7621 *'verbosefile'* *'vfile'*
7622'verbosefile' 'vfile' string (default empty)
7623 global
7624 {not in Vi}
7625 When not empty all messages are written in a file with this name.
7626 When the file exists messages are appended.
7627 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007628 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007629 Setting 'verbosefile' to a new value is like making it empty first.
7630 The difference with |:redir| is that verbose messages are not
7631 displayed when 'verbosefile' is set.
7632
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 *'viewdir'* *'vdir'*
7634'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7635 "$VIM/vimfiles/view",
7636 for Unix: "~/.vim/view",
7637 for Macintosh: "$VIM:vimfiles:view"
7638 for VMS: "sys$login:vimfiles/view"
7639 for RiscOS: "Choices:vimfiles/view")
7640 global
7641 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007642 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 feature}
7644 Name of the directory where to store files for |:mkview|.
7645 This option cannot be set from a |modeline| or in the |sandbox|, for
7646 security reasons.
7647
7648 *'viewoptions'* *'vop'*
7649'viewoptions' 'vop' string (default: "folds,options,cursor")
7650 global
7651 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007652 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 feature}
7654 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007655 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 word save and restore ~
7657 cursor cursor position in file and in window
7658 folds manually created folds, opened/closed folds and local
7659 fold options
7660 options options and mappings local to a window or buffer (not
7661 global values for local options)
7662 slash backslashes in file names replaced with forward
7663 slashes
7664 unix with Unix end-of-line format (single <NL>), even when
7665 on Windows or DOS
7666
7667 "slash" and "unix" are useful on Windows when sharing view files
7668 with Unix. The Unix version of Vim cannot source dos format scripts,
7669 but the Windows version of Vim can source unix format scripts.
7670
7671 *'viminfo'* *'vi'* *E526* *E527* *E528*
7672'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007673 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7674 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7675 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676 global
7677 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007678 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 feature}
7680 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007681 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 separated list of parameters, each consisting of a single character
7683 identifying the particular parameter, followed by a number or string
7684 which specifies the value of that parameter. If a particular
7685 character is left out, then the default value is used for that
7686 parameter. The following is a list of the identifying characters and
7687 the effect of their value.
7688 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007689 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 ! When included, save and restore global variables that start
7691 with an uppercase letter, and don't contain a lowercase
7692 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007693 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007694 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007695 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 " Maximum number of lines saved for each register. Old name of
7697 the '<' item, with the disadvantage that you need to put a
7698 backslash before the ", otherwise it will be recognized as the
7699 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007700 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 % When included, save and restore the buffer list. If Vim is
7702 started with a file name argument, the buffer list is not
7703 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007704 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 without a file name and buffers for help files are not written
7706 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007707 When followed by a number, the number specifies the maximum
7708 number of buffers that are stored. Without a number all
7709 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007710 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007711 ' Maximum number of previously edited files for which the marks
7712 are remembered. This parameter must always be included when
7713 'viminfo' is non-empty.
7714 Including this item also means that the |jumplist| and the
7715 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007716 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007718 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 patterns are also saved. When not included, the value of
7720 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007721 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007723 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007724 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 < Maximum number of lines saved for each register. If zero then
7726 registers are not saved. When not included, all lines are
7727 saved. '"' is the old name for this item.
7728 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007729 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007731 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007732 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 c When included, convert the text in the viminfo file from the
7734 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007735 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007736 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 f Whether file marks need to be stored. If zero, file marks ('0
7738 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007739 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007740 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007741 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007742 h Disable the effect of 'hlsearch' when loading the viminfo
7743 file. When not included, it depends on whether ":nohlsearch"
7744 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007745 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 n Name of the viminfo file. The name must immediately follow
7747 the 'n'. Must be the last one! If the "-i" argument was
7748 given when starting Vim, that file name overrides the one
7749 given here with 'viminfo'. Environment variables are expanded
7750 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007751 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 r Removable media. The argument is a string (up to the next
7753 ','). This parameter can be given several times. Each
7754 specifies the start of a path for which no marks will be
7755 stored. This is to avoid removable media. For MS-DOS you
7756 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7757 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7758 ignored. Maximum length of each 'r' argument is 50
7759 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007760 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 s Maximum size of an item in Kbyte. If zero then registers are
7762 not saved. Currently only applies to registers. The default
7763 "s10" will exclude registers with more than 10 Kbyte of text.
7764 Also see the '<' item above: line count limit.
7765
7766 Example: >
7767 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7768<
7769 '50 Marks will be remembered for the last 50 files you
7770 edited.
7771 <1000 Contents of registers (up to 1000 lines each) will be
7772 remembered.
7773 s100 Registers with more than 100 Kbyte text are skipped.
7774 :0 Command-line history will not be saved.
7775 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7776 no / Since '/' is not specified, the default will be used,
7777 that is, save all of the search history, and also the
7778 previous search and substitute patterns.
7779 no % The buffer list will not be saved nor read back.
7780 no h 'hlsearch' highlighting will be restored.
7781
7782 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7783 load the contents of the file, this is not done automatically.
7784
7785 This option cannot be set from a |modeline| or in the |sandbox|, for
7786 security reasons.
7787
7788 *'virtualedit'* *'ve'*
7789'virtualedit' 've' string (default "")
7790 global
7791 {not in Vi}
7792 {not available when compiled without the
7793 |+virtualedit| feature}
7794 A comma separated list of these words:
7795 block Allow virtual editing in Visual block mode.
7796 insert Allow virtual editing in Insert mode.
7797 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007798 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007799
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007801 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 of the line. Useful for selecting a rectangle in Visual mode and
7803 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007804 "onemore" is not the same, it will only allow moving the cursor just
7805 after the last character of the line. This makes some commands more
7806 consistent. Previously the cursor was always past the end of the line
7807 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007808 break some plugins or Vim scripts. For example because |l| can move
7809 the cursor after the last character. Use with care!
7810 Using the |$| command will move to the last character in the line, not
7811 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007812 It doesn't make sense to combine "all" with "onemore", but you will
7813 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814
7815 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7816'visualbell' 'vb' boolean (default off)
7817 global
7818 {not in Vi}
7819 Use visual bell instead of beeping. The terminal code to display the
7820 visual bell is given with 't_vb'. When no beep or flash is wanted,
7821 use ":set vb t_vb=".
7822 Note: When the GUI starts, 't_vb' is reset to its default value. You
7823 might want to set it again in your |gvimrc|.
7824 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7825 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7826 where 40 is the time in msec.
7827 Does not work on the Amiga, you always get a screen flash.
7828 Also see 'errorbells'.
7829
7830 *'warn'* *'nowarn'*
7831'warn' boolean (default on)
7832 global
7833 Give a warning message when a shell command is used while the buffer
7834 has been changed.
7835
7836 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7837'weirdinvert' 'wiv' boolean (default off)
7838 global
7839 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007840 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 It is provided for backwards compatibility with version 4.x.
7842 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7843 vice versa. Has no effect when the GUI is running.
7844
7845 *'whichwrap'* *'ww'*
7846'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7847 global
7848 {not in Vi}
7849 Allow specified keys that move the cursor left/right to move to the
7850 previous/next line when the cursor is on the first/last character in
7851 the line. Concatenate characters to allow this for these keys:
7852 char key mode ~
7853 b <BS> Normal and Visual
7854 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007855 h "h" Normal and Visual (not recommended)
7856 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007857 < <Left> Normal and Visual
7858 > <Right> Normal and Visual
7859 ~ "~" Normal
7860 [ <Left> Insert and Replace
7861 ] <Right> Insert and Replace
7862 For example: >
7863 :set ww=<,>,[,]
7864< allows wrap only when cursor keys are used.
7865 When the movement keys are used in combination with a delete or change
7866 operator, the <EOL> also counts for a character. This makes "3h"
7867 different from "3dh" when the cursor crosses the end of a line. This
7868 is also true for "x" and "X", because they do the same as "dl" and
7869 "dh". If you use this, you may also want to use the mapping
7870 ":map <BS> X" to make backspace delete the character in front of the
7871 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007872 When 'l' is included and it is used after an operator at the end of a
7873 line then it will not move to the next line. This makes "dl", "cl",
7874 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 NOTE: This option is set to the Vi default value when 'compatible' is
7876 set and to the Vim default value when 'compatible' is reset.
7877
7878 *'wildchar'* *'wc'*
7879'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7880 global
7881 {not in Vi}
7882 Character you have to type to start wildcard expansion in the
7883 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007884 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 The character is not recognized when used inside a macro. See
7886 'wildcharm' for that.
7887 Although 'wc' is a number option, you can set it to a special key: >
7888 :set wc=<Esc>
7889< NOTE: This option is set to the Vi default value when 'compatible' is
7890 set and to the Vim default value when 'compatible' is reset.
7891
7892 *'wildcharm'* *'wcm'*
7893'wildcharm' 'wcm' number (default: none (0))
7894 global
7895 {not in Vi}
7896 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007897 recognized when used inside a macro. You can find "spare" command-line
7898 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 you'll never actually type 'wildcharm', just use it in mappings that
7900 automatically invoke completion mode, e.g.: >
7901 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007902 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903< Then after typing :ss you can use CTRL-P & CTRL-N.
7904
7905 *'wildignore'* *'wig'*
7906'wildignore' 'wig' string (default "")
7907 global
7908 {not in Vi}
7909 {not available when compiled without the |+wildignore|
7910 feature}
7911 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02007912 patterns is ignored when expanding |wildcards|, completing file or
7913 directory names, and influences the result of |expand()|, |glob()| and
7914 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7916 Also see 'suffixes'.
7917 Example: >
7918 :set wildignore=*.o,*.obj
7919< The use of |:set+=| and |:set-=| is preferred when adding or removing
7920 a pattern from the list. This avoids problems when a future version
7921 uses another default.
7922
Bram Moolenaar94950a92010-12-02 16:01:29 +01007923
Bram Moolenaar81af9252010-12-10 20:35:50 +01007924 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007925'wildignorecase' 'wic' boolean (default off)
7926 global
7927 {not in Vi}
7928 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01007929 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01007930 Does not apply when the shell is used to expand wildcards, which
7931 happens when there are special characters.
7932
7933
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7935'wildmenu' 'wmnu' boolean (default off)
7936 global
7937 {not in Vi}
7938 {not available if compiled without the |+wildmenu|
7939 feature}
7940 When 'wildmenu' is on, command-line completion operates in an enhanced
7941 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7942 the possible matches are shown just above the command line, with the
7943 first match highlighted (overwriting the status line, if there is
7944 one). Keys that show the previous/next match, such as <Tab> or
7945 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7946 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7947 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01007948 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 If there are more matches than can fit in the line, a ">" is shown on
7950 the right and/or a "<" is shown on the left. The status line scrolls
7951 as needed.
7952 The "wildmenu" mode is abandoned when a key is hit that is not used
7953 for selecting a completion.
7954 While the "wildmenu" is active the following keys have special
7955 meanings:
7956
7957 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7958 <Down> - in filename/menu name completion: move into a
7959 subdirectory or submenu.
7960 <CR> - in menu completion, when the cursor is just after a
7961 dot: move into a submenu.
7962 <Up> - in filename/menu name completion: move up into
7963 parent directory or parent menu.
7964
7965 This makes the menus accessible from the console |console-menus|.
7966
7967 If you prefer the <Left> and <Right> keys to move the cursor instead
7968 of selecting a different match, use this: >
7969 :cnoremap <Left> <Space><BS><Left>
7970 :cnoremap <Right> <Space><BS><Right>
7971<
7972 The "WildMenu" highlighting is used for displaying the current match
7973 |hl-WildMenu|.
7974
7975 *'wildmode'* *'wim'*
7976'wildmode' 'wim' string (Vim default: "full")
7977 global
7978 {not in Vi}
7979 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007980 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007981 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 first part specifies the behavior for the first use of 'wildchar',
7983 The second part for the second use, etc.
7984 These are the possible values for each part:
7985 "" Complete only the first match.
7986 "full" Complete the next full match. After the last match,
7987 the original string is used and then the first match
7988 again.
7989 "longest" Complete till longest common string. If this doesn't
7990 result in a longer string, use the next part.
7991 "longest:full" Like "longest", but also start 'wildmenu' if it is
7992 enabled.
7993 "list" When more than one match, list all matches.
7994 "list:full" When more than one match, list all matches and
7995 complete first match.
7996 "list:longest" When more than one match, list all matches and
7997 complete till longest common string.
7998 When there is only a single match, it is fully completed in all cases.
7999
8000 Examples: >
8001 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008002< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 :set wildmode=longest,full
8004< Complete longest common string, then each full match >
8005 :set wildmode=list:full
8006< List all matches and complete each full match >
8007 :set wildmode=list,full
8008< List all matches without completing, then each full match >
8009 :set wildmode=longest,list
8010< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008011 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008013 *'wildoptions'* *'wop'*
8014'wildoptions' 'wop' string (default "")
8015 global
8016 {not in Vi}
8017 {not available when compiled without the |+wildignore|
8018 feature}
8019 A list of words that change how command line completion is done.
8020 Currently only one word is allowed:
8021 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008022 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008023 is displayed per line. Often used tag kinds are:
8024 d #define
8025 f function
8026 Also see |cmdline-completion|.
8027
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 *'winaltkeys'* *'wak'*
8029'winaltkeys' 'wak' string (default "menu")
8030 global
8031 {not in Vi}
8032 {only used in Win32, Motif, GTK and Photon GUI}
8033 Some GUI versions allow the access to menu entries by using the ALT
8034 key in combination with a character that appears underlined in the
8035 menu. This conflicts with the use of the ALT key for mappings and
8036 entering special characters. This option tells what to do:
8037 no Don't use ALT keys for menus. ALT key combinations can be
8038 mapped, but there is no automatic handling. This can then be
8039 done with the |:simalt| command.
8040 yes ALT key handling is done by the windowing system. ALT key
8041 combinations cannot be mapped.
8042 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008043 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 keys can be mapped.
8045 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8046 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008047 This option is not used for <F10>; on Win32 and with GTK <F10> will
8048 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008050 *'window'* *'wi'*
8051'window' 'wi' number (default screen height - 1)
8052 global
8053 Window height. Do not confuse this with the height of the Vim window,
8054 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008055 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8056 value is smaller than 'lines' minus one. The screen will scroll
8057 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008058 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8059 in a much smarter way, taking care of wrapping lines.
8060 When resizing the Vim window, the value is smaller than 1 or more than
8061 or equal to 'lines' it will be set to 'lines' minus 1.
8062 {Vi also uses the option to specify the number of displayed lines}
8063
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 *'winheight'* *'wh'* *E591*
8065'winheight' 'wh' number (default 1)
8066 global
8067 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008068 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 feature}
8070 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008071 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008072 focus goes to a window that is smaller, its size is increased, at the
8073 cost of the height of other windows.
8074 Set 'winheight' to a small number for normal editing.
8075 Set it to 999 to make the current window fill most of the screen.
8076 Other windows will be only 'winminheight' high. This has the drawback
8077 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8078 to create only two windows, set the option after startup is done,
8079 using the |VimEnter| event: >
8080 au VimEnter * set winheight=999
8081< Minimum value is 1.
8082 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008083 height of the current window.
8084 'winheight' applies to the current window. Use 'winminheight' to set
8085 the minimal height for other windows.
8086
8087 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8088'winfixheight' 'wfh' boolean (default off)
8089 local to window
8090 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008091 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 feature}
8093 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008094 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8095 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096 The height may be changed anyway when running out of room.
8097
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008098 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8099'winfixwidth' 'wfw' boolean (default off)
8100 local to window
8101 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008102 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008103 feature}
8104 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008105 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008106 The width may be changed anyway when running out of room.
8107
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 *'winminheight'* *'wmh'*
8109'winminheight' 'wmh' number (default 1)
8110 global
8111 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008112 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 feature}
8114 The minimal height of a window, when it's not the current window.
8115 This is a hard minimum, windows will never become smaller.
8116 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8117 status bar) if necessary. They will return to at least one line when
8118 they become active (since the cursor has to have somewhere to go.)
8119 Use 'winheight' to set the minimal height of the current window.
8120 This option is only checked when making a window smaller. Don't use a
8121 large number, it will cause errors when opening more than a few
8122 windows. A value of 0 to 3 is reasonable.
8123
8124 *'winminwidth'* *'wmw'*
8125'winminwidth' 'wmw' number (default 1)
8126 global
8127 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008128 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 feature}
8130 The minimal width of a window, when it's not the current window.
8131 This is a hard minimum, windows will never become smaller.
8132 When set to zero, windows may be "squashed" to zero columns (i.e. just
8133 a vertical separator) if necessary. They will return to at least one
8134 line when they become active (since the cursor has to have somewhere
8135 to go.)
8136 Use 'winwidth' to set the minimal width of the current window.
8137 This option is only checked when making a window smaller. Don't use a
8138 large number, it will cause errors when opening more than a few
8139 windows. A value of 0 to 12 is reasonable.
8140
8141 *'winwidth'* *'wiw'* *E592*
8142'winwidth' 'wiw' number (default 20)
8143 global
8144 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008145 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008146 feature}
8147 Minimal number of columns for the current window. This is not a hard
8148 minimum, Vim will use fewer columns if there is not enough room. If
8149 the current window is smaller, its size is increased, at the cost of
8150 the width of other windows. Set it to 999 to make the current window
8151 always fill the screen. Set it to a small number for normal editing.
8152 The width is not adjusted after one of the commands to change the
8153 width of the current window.
8154 'winwidth' applies to the current window. Use 'winminwidth' to set
8155 the minimal width for other windows.
8156
8157 *'wrap'* *'nowrap'*
8158'wrap' boolean (default on)
8159 local to window
8160 {not in Vi}
8161 This option changes how text is displayed. It doesn't change the text
8162 in the buffer, see 'textwidth' for that.
8163 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008164 displaying continues on the next line. When off lines will not wrap
8165 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166 moved to a part that is not shown, the screen will scroll
8167 horizontally.
8168 The line will be broken in the middle of a word if necessary. See
8169 'linebreak' to get the break at a word boundary.
8170 To make scrolling horizontally a bit more useful, try this: >
8171 :set sidescroll=5
8172 :set listchars+=precedes:<,extends:>
8173< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008174 This option can't be set from a |modeline| when the 'diff' option is
8175 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176
8177 *'wrapmargin'* *'wm'*
8178'wrapmargin' 'wm' number (default 0)
8179 local to buffer
8180 Number of characters from the right window border where wrapping
8181 starts. When typing text beyond this limit, an <EOL> will be inserted
8182 and inserting continues on the next line.
8183 Options that add a margin, such as 'number' and 'foldcolumn', cause
8184 the text width to be further reduced. This is Vi compatible.
8185 When 'textwidth' is non-zero, this option is not used.
8186 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8187 and less usefully}
8188
8189 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8190'wrapscan' 'ws' boolean (default on) *E384* *E385*
8191 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008192 Searches wrap around the end of the file. Also applies to |]s| and
8193 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008194
8195 *'write'* *'nowrite'*
8196'write' boolean (default on)
8197 global
8198 {not in Vi}
8199 Allows writing files. When not set, writing a file is not allowed.
8200 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008201 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008202 argument. Filtering text is still possible, even though this requires
8203 writing a temporary file.
8204
8205 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8206'writeany' 'wa' boolean (default off)
8207 global
8208 Allows writing to any file with no need for "!" override.
8209
8210 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8211'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8212 otherwise)
8213 global
8214 {not in Vi}
8215 Make a backup before overwriting a file. The backup is removed after
8216 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008217 also on.
8218 WARNING: Switching this option off means that when Vim fails to write
8219 your buffer correctly and then, for whatever reason, Vim exits, you
8220 lose both the original file and what you were writing. Only reset
8221 this option if your file system is almost full and it makes the write
8222 fail (and make sure not to exit Vim until the write was successful).
8223 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 When the 'backupskip' pattern matches, a backup is not made anyway.
8225 NOTE: This option is set to the default value when 'compatible' is
8226 set.
8227
8228 *'writedelay'* *'wd'*
8229'writedelay' 'wd' number (default 0)
8230 global
8231 {not in Vi}
8232 The number of microseconds to wait for each character sent to the
8233 screen. When non-zero, characters are sent to the terminal one by
8234 one. For MS-DOS pcterm this does not work. For debugging purposes.
8235
8236 vim:tw=78:ts=8:ft=help:norl: