blob: b50711c69898b5b5a5b097104e426f0067702e44 [file] [log] [blame]
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02001*options.txt* For Vim version 7.4. Last change: 2014 Sep 23
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200280You will get back the 'list' value as it was the last time you edited "one".
281The options local to a window are remembered for each buffer. This also
282happens when the buffer is not loaded, but they are lost when the buffer is
283wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000284
285 *:setl* *:setlocal*
286:setl[ocal] ... Like ":set" but set only the value local to the
287 current buffer or window. Not all options have a
288 local value. If the option does not have a local
289 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200290 With the "all" argument: display local values for all
291 local options.
292 Without argument: Display local values for all local
293 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000294 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000295 local value. For a global/local boolean option, when
296 the global value is being used, "--" is displayed
297 before the option name.
298 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299 shown (but that might change in the future).
300 {not in Vi}
301
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000302:setl[ocal] {option}< Set the local value of {option} to its global value by
303 copying the value.
304 {not in Vi}
305
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100306:se[t] {option}< For |global-local| options: Remove the local value of
307 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308 {not in Vi}
309
310 *:setg* *:setglobal*
311:setg[lobal] ... Like ":set" but set only the global value for a local
312 option without changing the local value.
313 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200314 With the "all" argument: display global values for all
315 local options.
316 Without argument: display global values for all local
317 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000318 {not in Vi}
319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
349This only works for a string option. For a boolean option you need to use the
350"<" flag, like this: >
351 :setlocal autoread<
352Note that for non-boolean options using "<" copies the global value to the
353local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000354when the global value changes later). You can also use: >
355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
365:setf[iletype] {filetype} *:setf* *:setfiletype*
366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
375 {not in Vi}
376
Bram Moolenaard58e9292011-02-09 17:07:58 +0100377 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000378:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
379:opt[ions] Open a window for viewing and setting all options.
380 Options are grouped by function.
381 Offers short help for each option. Hit <CR> on the
382 short help to open a help window with more help for
383 the option.
384 Modify the value of the option and hit <CR> on the
385 "set" line to set the new value. For window and
386 buffer specific options, the last accessed window is
387 used to set the option value in, unless this is a help
388 window, in which case the window below help window is
389 used (skipping the option-window).
390 {not available when compiled without the |+eval| or
391 |+autocmd| features}
392
393 *$HOME*
394Using "~" is like using "$HOME", but it is only recognized at the start of an
395option and after a space or comma.
396
397On Unix systems "~user" can be used too. It is replaced by the home directory
398of user "user". Example: >
399 :set path=~mool/include,/usr/include,.
400
401On Unix systems the form "${HOME}" can be used too. The name between {} can
402contain non-id characters then. Note that if you want to use this for the
403"gf" command, you need to add the '{' and '}' characters to 'isfname'.
404
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100405On MS-Windows, if $HOME is not defined as an environment variable, then
406at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
407
Bram Moolenaar071d4272004-06-13 20:20:40 +0000408NOTE: expanding environment variables and "~/" is only done with the ":set"
409command, not when assigning a value to an option with ":let".
410
411
412Note the maximum length of an expanded option is limited. How much depends on
413the system, mostly it is something like 256 or 1024 characters.
414
415 *:fix* *:fixdel*
416:fix[del] Set the value of 't_kD':
417 't_kb' is 't_kD' becomes ~
418 CTRL-? CTRL-H
419 not CTRL-? CTRL-?
420
421 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
422
423 If your delete key terminal code is wrong, but the
424 code for backspace is alright, you can put this in
425 your .vimrc: >
426 :fixdel
427< This works no matter what the actual code for
428 backspace is.
429
430 If the backspace key terminal code is wrong you can
431 use this: >
432 :if &term == "termname"
433 : set t_kb=^V<BS>
434 : fixdel
435 :endif
436< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000437 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 with your terminal name.
439
440 If your <Delete> key sends a strange key sequence (not
441 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
442 :if &term == "termname"
443 : set t_kD=^V<Delete>
444 :endif
445< Where "^V" is CTRL-V and "<Delete>" is the delete key
446 (don't type eight characters!). Replace "termname"
447 with your terminal name.
448
449 *Linux-backspace*
450 Note about Linux: By default the backspace key
451 produces CTRL-?, which is wrong. You can fix it by
452 putting this line in your rc.local: >
453 echo "keycode 14 = BackSpace" | loadkeys
454<
455 *NetBSD-backspace*
456 Note about NetBSD: If your backspace doesn't produce
457 the right code, try this: >
458 xmodmap -e "keycode 22 = BackSpace"
459< If this works, add this in your .Xmodmap file: >
460 keysym 22 = BackSpace
461< You need to restart for this to take effect.
462
463==============================================================================
4642. Automatically setting options *auto-setting*
465
466Besides changing options with the ":set" command, there are three alternatives
467to set options automatically for one or more files:
468
4691. When starting Vim initializations are read from various places. See
470 |initialization|. Most of them are performed for all editing sessions,
471 and some of them depend on the directory where Vim is started.
472 You can create an initialization file with |:mkvimrc|, |:mkview| and
473 |:mksession|.
4742. If you start editing a new file, the automatic commands are executed.
475 This can be used to set options for files matching a particular pattern and
476 many other things. See |autocommand|.
4773. If you start editing a new file, and the 'modeline' option is on, a
478 number of lines at the beginning and end of the file are checked for
479 modelines. This is explained here.
480
481 *modeline* *vim:* *vi:* *ex:* *E520*
482There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200483 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200485[text] any text or empty
486{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200487{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200488[white] optional white space
489{options} a list of option settings, separated with white space
490 or ':', where each part between ':' is the argument
491 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000494 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496
497The second form (this is compatible with some versions of Vi):
498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
503{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
504[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200505se[t] the string "set " or "se " (note the space); When
506 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507{options} a list of options, separated with white space, which
508 is the argument for a ":set" command
509: a colon
510[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000511
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000513 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200514 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
517chance that a normal word like "lex:" is caught. There is one exception:
518"vi:" and "vim:" can also be at the start of the line (for compatibility with
519version 3.0). Using "ex:" at the start of the line will be ignored (this
520could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522 *modeline-local*
523The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000524buffer and window that contain the file. Although it's possible to set global
525options from a modeline, this is unusual. If you have two windows open and
526the files in it set the same global option to a different value, the result
527depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000529When editing a file that was already loaded, only the window-local options
530from the modeline are used. Thus if you manually changed a buffer-local
531option after opening the file, it won't be changed if you edit the same buffer
532in another window. But window-local options will be set.
533
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534 *modeline-version*
535If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200536number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537 vim{vers}: version {vers} or later
538 vim<{vers}: version before {vers}
539 vim={vers}: version {vers}
540 vim>{vers}: version after {vers}
541{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542For example, to use a modeline only for Vim 6.0 and later:
543 /* vim600: set foldmethod=marker: */ ~
544To use a modeline for Vim before version 5.7:
545 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000546There can be no blanks between "vim" and the ":".
547
548
549The number of lines that are checked can be set with the 'modelines' option.
550If 'modeline' is off or 'modelines' is 0 no lines are checked.
551
552Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000553like:
554 /* vi:ts=4: */ ~
555will give an error message for the trailing "*/". This line is OK:
556 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557
558If an error is detected the rest of the line is skipped.
559
560If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561backslash in front of the ':' will be removed. Example:
562 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563This sets the 'dir' option to "c:\tmp". Only a single backslash before the
564':' is removed. Thus to include "\:" you have to specify "\\:".
565
566No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000567might create a Trojan horse text file with modelines). And not all options
568can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000569|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000570causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
571are wrapped unexpectedly. So disable modelines before editing untrusted text.
572The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574Hint: If you would like to do something else than setting an option, you could
575define an autocommand that checks the file for a specific string. For
576example: >
577 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
578And define a function SetVar() that does something with the line containing
579"VAR".
580
581==============================================================================
5823. Options summary *option-summary*
583
584In the list below all the options are mentioned with their full name and with
585an abbreviation if there is one. Both forms may be used.
586
587In this document when a boolean option is "set" that means that ":set option"
588is entered. When an option is "reset", ":set nooption" is used.
589
590For some options there are two default values: The "Vim default", which is
591used when 'compatible' is not set, and the "Vi default", which is used when
592'compatible' is set.
593
594Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000595are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596different value in each window. For example the 'list' option can be set in
597one window and reset in another for the same text, giving both types of view
598at the same time. There are a few options that are specific to a certain
599file. These can have a different value for each file or buffer. For example
600the 'textwidth' option can be 78 for a normal text file and 0 for a C
601program.
602
603 global one option for all buffers and windows
604 local to window each window has its own copy of this option
605 local to buffer each buffer has its own copy of this option
606
607When creating a new window the option values from the currently active window
608are used as a default value for the window-specific options. For the
609buffer-specific options this depends on the 's' and 'S' flags in the
610'cpoptions' option. If 's' is included (which is the default) the values for
611buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000612first entered. If 'S' is present the options are copied each time the buffer
613is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614present, the options are copied from the currently active buffer when the
615buffer is created.
616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000619Not all options are supported in all versions. This depends on the supported
620features and sometimes on the system. A remark about this is in curly braces
621below. When an option is not supported it may still be set without getting an
622error, this is called a hidden option. You can't get the value of a hidden
623option though, it is not stored.
624
625To test if option "foo" can be used with ":set" use something like this: >
626 if exists('&foo')
627This also returns true for a hidden option. To test if option "foo" is really
628supported use something like this: >
629 if exists('+foo')
630<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 *E355*
632A jump table for the options with a short description can be found at |Q_op|.
633
634 *'aleph'* *'al'* *aleph* *Aleph*
635'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
636 global
637 {not in Vi}
638 {only available when compiled with the |+rightleft|
639 feature}
640 The ASCII code for the first letter of the Hebrew alphabet. The
641 routine that maps the keyboard in Hebrew mode, both in Insert mode
642 (when hkmap is set) and on the command-line (when hitting CTRL-_)
643 outputs the Hebrew characters in the range [aleph..aleph+26].
644 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
645 See |rileft.txt|.
646
647 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
648'allowrevins' 'ari' boolean (default off)
649 global
650 {not in Vi}
651 {only available when compiled with the |+rightleft|
652 feature}
653 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
654 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
655 into reverse Insert mode, and don't know how to get out. See
656 'revins'.
657 NOTE: This option is reset when 'compatible' is set.
658
659 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
660'altkeymap' 'akm' boolean (default off)
661 global
662 {not in Vi}
663 {only available when compiled with the |+farsi|
664 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 the keyboard map between Farsi and English, when 'allowrevins' set.
667
Bram Moolenaar582fd852005-03-28 20:58:01 +0000668 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 is useful to start the Vim in native mode i.e. English (left-to-right
670 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000671 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672
673 *'ambiwidth'* *'ambw'*
674'ambiwidth' 'ambw' string (default: "single")
675 global
676 {not in Vi}
677 {only available when compiled with the |+multi_byte|
678 feature}
679 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
680 Tells Vim what to do with characters with East Asian Width Class
681 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
682 letters, Cyrillic letters).
683
684 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000685 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686 expected by most users.
687 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200688 *E834* *E835*
689 The value "double" cannot be used if 'listchars' or 'fillchars'
690 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000691
692 There are a number of CJK fonts for which the width of glyphs for
693 those characters are solely based on how many octets they take in
694 legacy/traditional CJK encodings. In those encodings, Euro,
695 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000698 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699 Vim is running inside a terminal (emulators) that uses a CJK font
700 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
701 this option should be set to "double" to match the width perceived
702 by Vim with the width of glyphs in the font. Perhaps it also has
703 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
704 when the system locale is set to one of CJK locales. See Unicode
705 Standard Annex #11 (http://www.unicode.org/reports/tr11).
706
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100707 Vim may set this option automatically at startup time when Vim is
708 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200709 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100710
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
712'antialias' 'anti' boolean (default: off)
713 global
714 {not in Vi}
715 {only available when compiled with GUI enabled
716 on Mac OS X}
717 This option only has an effect in the GUI version of Vim on Mac OS X
718 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
719 which can be easier to read at certain sizes on certain displays.
720 Setting this option can sometimes cause problems if 'guifont' is set
721 to its default (empty string).
722
723 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
724'autochdir' 'acd' boolean (default off)
725 global
726 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200727 {only available when compiled with it, use
728 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000729 When on, Vim will change the current working directory whenever you
730 open a file, switch buffers, delete a buffer or open/close a window.
731 It will change to the directory containing the file which was opened
732 or selected.
733 This option is provided for backward compatibility with the Vim
734 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000735 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736
737 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
738'arabic' 'arab' boolean (default off)
739 local to window
740 {not in Vi}
741 {only available when compiled with the |+arabic|
742 feature}
743 This option can be set to start editing Arabic text.
744 Setting this option will:
745 - Set the 'rightleft' option, unless 'termbidi' is set.
746 - Set the 'arabicshape' option, unless 'termbidi' is set.
747 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
748 between typing English and Arabic key mapping.
749 - Set the 'delcombine' option
750 Note that 'encoding' must be "utf-8" for working with Arabic text.
751
752 Resetting this option will:
753 - Reset the 'rightleft' option.
754 - Disable the use of 'keymap' (without changing its value).
755 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200756 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000757 Also see |arabic.txt|.
758
759 *'arabicshape'* *'arshape'*
760 *'noarabicshape'* *'noarshape'*
761'arabicshape' 'arshape' boolean (default on)
762 global
763 {not in Vi}
764 {only available when compiled with the |+arabic|
765 feature}
766 When on and 'termbidi' is off, the required visual character
767 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200768 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 one which encompasses:
770 a) the changing/morphing of characters based on their location
771 within a word (initial, medial, final and stand-alone).
772 b) the enabling of the ability to compose characters
773 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100774 When disabled the display shows each character's true stand-alone
775 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 Arabic is a complex language which requires other settings, for
777 further details see |arabic.txt|.
778
779 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
780'autoindent' 'ai' boolean (default off)
781 local to buffer
782 Copy indent from current line when starting a new line (typing <CR>
783 in Insert mode or when using the "o" or "O" command). If you do not
784 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000785 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
786 to another line has the same effect, unless the 'I' flag is included
787 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000788 When autoindent is on, formatting (with the "gq" command or when you
789 reach 'textwidth' in Insert mode) uses the indentation of the first
790 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 When 'smartindent' or 'cindent' is on the indent is changed in
792 a different way.
793 The 'autoindent' option is reset when the 'paste' option is set.
794 {small difference from Vi: After the indent is deleted when typing
795 <Esc> or <CR>, the cursor position when moving up or down is after the
796 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
797
798 *'autoread'* *'ar'* *'noautoread'* *'noar'*
799'autoread' 'ar' boolean (default off)
800 global or local to buffer |global-local|
801 {not in Vi}
802 When a file has been detected to have been changed outside of Vim and
803 it has not been changed inside of Vim, automatically read it again.
804 When the file has been deleted this is not done. |timestamp|
805 If this option has a local value, use this command to switch back to
806 using the global value: >
807 :set autoread<
808<
809 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
810'autowrite' 'aw' boolean (default off)
811 global
812 Write the contents of the file, if it has been modified, on each
813 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000814 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
816 Note that for some commands the 'autowrite' option is not used, see
817 'autowriteall' for that.
818
819 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
820'autowriteall' 'awa' boolean (default off)
821 global
822 {not in Vi}
823 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
824 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
825 Setting this option also implies that Vim behaves like 'autowrite' has
826 been set.
827
828 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200829'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 global
831 {not in Vi}
832 When set to "dark", Vim will try to use colors that look good on a
833 dark background. When set to "light", Vim will try to use colors that
834 look good on a light background. Any other value is illegal.
835 Vim tries to set the default value according to the terminal used.
836 This will not always be correct.
837 Setting this option does not change the background color, it tells Vim
838 what the background color looks like. For changing the background
839 color, see |:hi-normal|.
840
841 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000842 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000843 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845 setting 'background' will cause the color scheme to be reloaded. If
846 the color scheme adjusts to the value of 'background' this will work.
847 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100848 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849
850 When setting 'background' to the default value with: >
851 :set background&
852< Vim will guess the value. In the GUI this should work correctly,
853 in other cases Vim might not be able to guess the right value.
854
855 When starting the GUI, the default value for 'background' will be
856 "light". When the value is not set in the .gvimrc, and Vim detects
857 that the background is actually quite dark, 'background' is set to
858 "dark". But this happens only AFTER the .gvimrc file has been read
859 (because the window needs to be opened to find the actual background
860 color). To get around this, force the GUI window to be opened by
861 putting a ":gui" command in the .gvimrc file, before where the value
862 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200863
864 For MS-DOS, Windows and OS/2 the default is "dark".
865 For other systems "dark" is used when 'term' is "linux",
866 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
867 background. Otherwise the default is "light".
868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 Normally this option would be set in the .vimrc file. Possibly
870 depending on the terminal name. Example: >
871 :if &term == "pcterm"
872 : set background=dark
873 :endif
874< When this option is set, the default settings for the highlight groups
875 will change. To use other settings, place ":highlight" commands AFTER
876 the setting of the 'background' option.
877 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
878 to select the colors for syntax highlighting. After changing this
879 option, you must load syntax.vim again to see the result. This can be
880 done with ":syntax on".
881
882 *'backspace'* *'bs'*
883'backspace' 'bs' string (default "")
884 global
885 {not in Vi}
886 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
887 mode. This is a list of items, separated by commas. Each item allows
888 a way to backspace over something:
889 value effect ~
890 indent allow backspacing over autoindent
891 eol allow backspacing over line breaks (join lines)
892 start allow backspacing over the start of insert; CTRL-W and CTRL-U
893 stop once at the start of insert.
894
895 When the value is empty, Vi compatible backspacing is used.
896
897 For backwards compatibility with version 5.4 and earlier:
898 value effect ~
899 0 same as ":set backspace=" (Vi compatible)
900 1 same as ":set backspace=indent,eol"
901 2 same as ":set backspace=indent,eol,start"
902
903 See |:fixdel| if your <BS> or <Del> key does not do what you want.
904 NOTE: This option is set to "" when 'compatible' is set.
905
906 *'backup'* *'bk'* *'nobackup'* *'nobk'*
907'backup' 'bk' boolean (default off)
908 global
909 {not in Vi}
910 Make a backup before overwriting a file. Leave it around after the
911 file has been successfully written. If you do not want to keep the
912 backup file, but you do want a backup while the file is being
913 written, reset this option and set the 'writebackup' option (this is
914 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000915 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000916 |backup-table| for more explanations.
917 When the 'backupskip' pattern matches, a backup is not made anyway.
918 When 'patchmode' is set, the backup may be renamed to become the
919 oldest version of a file.
920 NOTE: This option is reset when 'compatible' is set.
921
922 *'backupcopy'* *'bkc'*
923'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200924 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 {not in Vi}
926 When writing a file and a backup is made, this option tells how it's
927 done. This is a comma separated list of words.
928
929 The main values are:
930 "yes" make a copy of the file and overwrite the original one
931 "no" rename the file and write a new one
932 "auto" one of the previous, what works best
933
934 Extra values that can be combined with the ones above are:
935 "breaksymlink" always break symlinks when writing
936 "breakhardlink" always break hardlinks when writing
937
938 Making a copy and overwriting the original file:
939 - Takes extra time to copy the file.
940 + When the file has special attributes, is a (hard/symbolic) link or
941 has a resource fork, all this is preserved.
942 - When the file is a link the backup will have the name of the link,
943 not of the real file.
944
945 Renaming the file and writing a new one:
946 + It's fast.
947 - Sometimes not all attributes of the file can be copied to the new
948 file.
949 - When the file is a link the new file will not be a link.
950
951 The "auto" value is the middle way: When Vim sees that renaming file
952 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000953 the file is not a link) that is used. When problems are expected, a
954 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955
956 The "breaksymlink" and "breakhardlink" values can be used in
957 combination with any of "yes", "no" and "auto". When included, they
958 force Vim to always break either symbolic or hard links by doing
959 exactly what the "no" option does, renaming the original file to
960 become the backup and writing a new file in its place. This can be
961 useful for example in source trees where all the files are symbolic or
962 hard links and any changes should stay in the local source tree, not
963 be propagated back to the original source.
964 *crontab*
965 One situation where "no" and "auto" will cause problems: A program
966 that opens a file, invokes Vim to edit that file, and then tests if
967 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000968 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 example.
970
971 When a copy is made, the original file is truncated and then filled
972 with the new text. This means that protection bits, owner and
973 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000974 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 group of the backup is set to the group of the original file. If this
976 fails, the protection bits for the group are made the same as for
977 others.
978
979 When the file is renamed this is the other way around: The backup has
980 the same attributes of the original file, and the newly written file
981 is owned by the current user. When the file was a (hard/symbolic)
982 link, the new file will not! That's why the "auto" value doesn't
983 rename when the file is a link. The owner and group of the newly
984 written file will be set to the same ones as the original file, but
985 the system may refuse to do this. In that case the "auto" value will
986 again not rename the file.
987
988 *'backupdir'* *'bdir'*
989'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100990 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 for Unix: ".,~/tmp,~/")
992 global
993 {not in Vi}
994 List of directories for the backup file, separated with commas.
995 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100996 where this is possible. The directory must exist, Vim will not
997 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100998 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 impossible!). Writing may fail because of this.
1000 - A directory "." means to put the backup file in the same directory
1001 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001002 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001003 put the backup file relative to where the edited file is. The
1004 leading "." is replaced with the path name of the edited file.
1005 ("." inside a directory name has no special meaning).
1006 - Spaces after the comma are ignored, other spaces are considered part
1007 of the directory name. To have a space at the start of a directory
1008 name, precede it with a backslash.
1009 - To include a comma in a directory name precede it with a backslash.
1010 - A directory name may end in an '/'.
1011 - Environment variables are expanded |:set_env|.
1012 - Careful with '\' characters, type one before a space, type two to
1013 get one in the option (see |option-backslash|), for example: >
1014 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1015< - For backwards compatibility with Vim version 3.0 a '>' at the start
1016 of the option is removed.
1017 See also 'backup' and 'writebackup' options.
1018 If you want to hide your backup files on Unix, consider this value: >
1019 :set backupdir=./.backup,~/.backup,.,/tmp
1020< You must create a ".backup" directory in each directory and in your
1021 home directory for this to work properly.
1022 The use of |:set+=| and |:set-=| is preferred when adding or removing
1023 directories from the list. This avoids problems when a future version
1024 uses another default.
1025 This option cannot be set from a |modeline| or in the |sandbox|, for
1026 security reasons.
1027
1028 *'backupext'* *'bex'* *E589*
1029'backupext' 'bex' string (default "~", for VMS: "_")
1030 global
1031 {not in Vi}
1032 String which is appended to a file name to make the name of the
1033 backup file. The default is quite unusual, because this avoids
1034 accidentally overwriting existing files with a backup file. You might
1035 prefer using ".bak", but make sure that you don't have files with
1036 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001037 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001039 If you like to keep a lot of backups, you could use a BufWritePre
1040 autocommand to change 'backupext' just before writing the file to
1041 include a timestamp. >
1042 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1043< Use 'backupdir' to put the backup in a different directory.
1044
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 *'backupskip'* *'bsk'*
1046'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1047 global
1048 {not in Vi}
1049 {not available when compiled without the |+wildignore|
1050 feature}
1051 A list of file patterns. When one of the patterns matches with the
1052 name of the file which is written, no backup file is created. Both
1053 the specified file name and the full path name of the file are used.
1054 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1055 Watch out for special characters, see |option-backslash|.
1056 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001057 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001058
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001059 WARNING: Not having a backup file means that when Vim fails to write
1060 your buffer correctly and then, for whatever reason, Vim exits, you
1061 lose both the original file and what you were writing. Only disable
1062 backups if you don't care about losing the file.
1063
Bram Moolenaar02467872007-05-06 13:22:01 +00001064 Note that environment variables are not expanded. If you want to use
1065 $HOME you must expand it explicitly, e.g.: >
1066 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1067
1068< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001069 backup would be made by renaming the original file crontab won't see
1070 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071
1072 *'balloondelay'* *'bdlay'*
1073'balloondelay' 'bdlay' number (default: 600)
1074 global
1075 {not in Vi}
1076 {only available when compiled with the |+balloon_eval|
1077 feature}
1078 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1079
1080 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1081'ballooneval' 'beval' boolean (default off)
1082 global
1083 {not in Vi}
1084 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001085 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 Switch on the |balloon-eval| functionality.
1087
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001088 *'balloonexpr'* *'bexpr'*
1089'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001090 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091 {not in Vi}
1092 {only available when compiled with the |+balloon_eval|
1093 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001094 Expression for text to show in evaluation balloon. It is only used
1095 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001096
1097 v:beval_bufnr number of the buffer in which balloon is going to show
1098 v:beval_winnr number of the window
1099 v:beval_lnum line number
1100 v:beval_col column number (byte index)
1101 v:beval_text word under or after the mouse pointer
1102
1103 The evaluation of the expression must not have side effects!
1104 Example: >
1105 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001106 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 \', column ' . v:beval_col .
1108 \ ' of file ' . bufname(v:beval_bufnr) .
1109 \ ' on word "' . v:beval_text . '"'
1110 endfunction
1111 set bexpr=MyBalloonExpr()
1112 set ballooneval
1113<
1114 NOTE: The balloon is displayed only if the cursor is on a text
1115 character. If the result of evaluating 'balloonexpr' is not empty,
1116 Vim does not try to send a message to an external debugger (Netbeans
1117 or Sun Workshop).
1118
Bram Moolenaar30b65812012-07-12 22:01:11 +02001119 The expression will be evaluated in the |sandbox| when set from a
1120 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001121
1122 It is not allowed to change text or jump to another window while
1123 evaluating 'balloonexpr' |textlock|.
1124
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001125 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001126 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001127< When they are supported "\n" characters will start a new line. If the
1128 expression evaluates to a |List| this is equal to using each List item
1129 as a string and putting "\n" in between them.
1130
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1132'binary' 'bin' boolean (default off)
1133 local to buffer
1134 {not in Vi}
1135 This option should be set before editing a binary file. You can also
1136 use the |-b| Vim argument. When this option is switched on a few
1137 options will be changed (also when it already was on):
1138 'textwidth' will be set to 0
1139 'wrapmargin' will be set to 0
1140 'modeline' will be off
1141 'expandtab' will be off
1142 Also, 'fileformat' and 'fileformats' options will not be used, the
1143 file is read and written like 'fileformat' was "unix" (a single <NL>
1144 separates lines).
1145 The 'fileencoding' and 'fileencodings' options will not be used, the
1146 file is read without conversion.
1147 NOTE: When you start editing a(nother) file while the 'bin' option is
1148 on, settings from autocommands may change the settings again (e.g.,
1149 'textwidth'), causing trouble when editing. You might want to set
1150 'bin' again when the file has been loaded.
1151 The previous values of these options are remembered and restored when
1152 'bin' is switched from on to off. Each buffer has its own set of
1153 saved option values.
1154 To edit a file with 'binary' set you can use the |++bin| argument.
1155 This avoids you have to do ":set bin", which would have effect for all
1156 files you edit.
1157 When writing a file the <EOL> for the last line is only written if
1158 there was one in the original file (normally Vim appends an <EOL> to
1159 the last line if there is none; this would make the file longer). See
1160 the 'endofline' option.
1161
1162 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1163'bioskey' 'biosk' boolean (default on)
1164 global
1165 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 better to detect CTRL-C, but only works for the console. When using a
1168 terminal over a serial port reset this option.
1169 Also see |'conskey'|.
1170
1171 *'bomb'* *'nobomb'*
1172'bomb' boolean (default off)
1173 local to buffer
1174 {not in Vi}
1175 {only available when compiled with the |+multi_byte|
1176 feature}
1177 When writing a file and the following conditions are met, a BOM (Byte
1178 Order Mark) is prepended to the file:
1179 - this option is on
1180 - the 'binary' option is off
1181 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1182 endian variants.
1183 Some applications use the BOM to recognize the encoding of the file.
1184 Often used for UCS-2 files on MS-Windows. For other applications it
1185 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001186 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1188 check for the presence of the BOM is done and 'bomb' set accordingly.
1189 Unless 'binary' is set, it is removed from the first line, so that you
1190 don't see it when editing. When you don't change the options, the BOM
1191 will be restored when writing the file.
1192
1193 *'breakat'* *'brk'*
1194'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1195 global
1196 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001197 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198 feature}
1199 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001200 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1201 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001203 *'breakindent'* *'bri'*
1204'breakindent' 'bri' boolean (default off)
1205 local to window
1206 {not in Vi}
1207 {not available when compiled without the |+linebreak|
1208 feature}
1209 Every wrapped line will continue visually indented (same amount of
1210 space as the beginning of that line), thus preserving horizontal blocks
1211 of text.
1212
1213 *'breakindentopt'* *'briopt'*
1214'breakindentopt' 'briopt' string (default empty)
1215 local to window
1216 {not in Vi}
1217 {not available when compiled without the |+linebreak|
1218 feature}
1219 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001220 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001221 min:{n} Minimum text width that will be kept after
1222 applying 'breakindent', even if the resulting
1223 text should normally be narrower. This prevents
1224 text indented almost to the right window border
1225 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001226 shift:{n} After applying 'breakindent', the wrapped line's
1227 beginning will be shifted by the given number of
1228 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001229 indentation (negative) or emphasizing the line
1230 continuation (positive).
1231 sbr Display the 'showbreak' value before applying the
1232 additional indent.
1233 The default value for min is 20 and shift is 0.
1234
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001236'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001238 {not in Vi} {only for Motif, Athena, GTK, Mac and
1239 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001241 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001242 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243 buffer Use the directory of the related buffer.
1244 current Use the current directory.
1245 {path} Use the specified directory
1246
1247 *'bufhidden'* *'bh'*
1248'bufhidden' 'bh' string (default: "")
1249 local to buffer
1250 {not in Vi}
1251 {not available when compiled without the |+quickfix|
1252 feature}
1253 This option specifies what happens when a buffer is no longer
1254 displayed in a window:
1255 <empty> follow the global 'hidden' option
1256 hide hide the buffer (don't unload it), also when 'hidden'
1257 is not set
1258 unload unload the buffer, also when 'hidden' is set or using
1259 |:hide|
1260 delete delete the buffer from the buffer list, also when
1261 'hidden' is set or using |:hide|, like using
1262 |:bdelete|
1263 wipe wipe out the buffer from the buffer list, also when
1264 'hidden' is set or using |:hide|, like using
1265 |:bwipeout|
1266
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001267 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001268 are lost without a warning. Also, these values may break autocommands
1269 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 This option is used together with 'buftype' and 'swapfile' to specify
1271 special kinds of buffers. See |special-buffers|.
1272
1273 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1274'buflisted' 'bl' boolean (default: on)
1275 local to buffer
1276 {not in Vi}
1277 When this option is set, the buffer shows up in the buffer list. If
1278 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1279 This option is reset by Vim for buffers that are only used to remember
1280 a file name or marks. Vim sets it when starting to edit a buffer.
1281 But not when moving to a buffer with ":buffer".
1282
1283 *'buftype'* *'bt'* *E382*
1284'buftype' 'bt' string (default: "")
1285 local to buffer
1286 {not in Vi}
1287 {not available when compiled without the |+quickfix|
1288 feature}
1289 The value of this option specifies the type of a buffer:
1290 <empty> normal buffer
1291 nofile buffer which is not related to a file and will not be
1292 written
1293 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001294 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001295 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001296 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001297 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001298 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 help help buffer (you are not supposed to set this
1300 manually)
1301
1302 This option is used together with 'bufhidden' and 'swapfile' to
1303 specify special kinds of buffers. See |special-buffers|.
1304
1305 Be careful with changing this option, it can have many side effects!
1306
Bram Moolenaar280f1262006-01-30 00:14:18 +00001307 A "quickfix" buffer is only used for the error list and the location
1308 list. This value is set by the |:cwindow| and |:lwindow| commands and
1309 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310
1311 "nofile" and "nowrite" buffers are similar:
1312 both: The buffer is not to be written to disk, ":w" doesn't
1313 work (":w filename" does work though).
1314 both: The buffer is never considered to be |'modified'|.
1315 There is no warning when the changes will be lost, for
1316 example when you quit Vim.
1317 both: A swap file is only created when using too much memory
1318 (when 'swapfile' has been reset there is never a swap
1319 file).
1320 nofile only: The buffer name is fixed, it is not handled like a
1321 file name. It is not modified in response to a |:cd|
1322 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001323 *E676*
1324 "acwrite" implies that the buffer name is not related to a file, like
1325 "nofile", but it will be written. Thus, in contrast to "nofile" and
1326 "nowrite", ":w" does work and a modified buffer can't be abandoned
1327 without saving. For writing there must be matching |BufWriteCmd|,
1328 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329
1330 *'casemap'* *'cmp'*
1331'casemap' 'cmp' string (default: "internal,keepascii")
1332 global
1333 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001334 {only available when compiled with the |+multi_byte|
1335 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 Specifies details about changing the case of letters. It may contain
1337 these words, separated by a comma:
1338 internal Use internal case mapping functions, the current
1339 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001340 matters when 'encoding' is a Unicode encoding,
1341 "latin1" or "iso-8859-15". When "internal" is
1342 omitted, the towupper() and towlower() system library
1343 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1345 case mapping, the current locale is not effective.
1346 This probably only matters for Turkish.
1347
1348 *'cdpath'* *'cd'* *E344* *E346*
1349'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1350 global
1351 {not in Vi}
1352 {not available when compiled without the
1353 |+file_in_path| feature}
1354 This is a list of directories which will be searched when using the
1355 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001356 for has a relative path, not an absolute part starting with "/", "./"
1357 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 The 'cdpath' option's value has the same form and semantics as
1359 |'path'|. Also see |file-searching|.
1360 The default value is taken from $CDPATH, with a "," prepended to look
1361 in the current directory first.
1362 If the default value taken from $CDPATH is not what you want, include
1363 a modified version of the following command in your vimrc file to
1364 override it: >
1365 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1366< This option cannot be set from a |modeline| or in the |sandbox|, for
1367 security reasons.
1368 (parts of 'cdpath' can be passed to the shell to expand file names).
1369
1370 *'cedit'*
1371'cedit' string (Vi default: "", Vim default: CTRL-F)
1372 global
1373 {not in Vi}
1374 {not available when compiled without the |+vertsplit|
1375 feature}
1376 The key used in Command-line Mode to open the command-line window.
1377 The default is CTRL-F when 'compatible' is off.
1378 Only non-printable keys are allowed.
1379 The key can be specified as a single character, but it is difficult to
1380 type. The preferred way is to use the <> notation. Examples: >
1381 :set cedit=<C-Y>
1382 :set cedit=<Esc>
1383< |Nvi| also has this option, but it only uses the first character.
1384 See |cmdwin|.
1385
1386 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1387'charconvert' 'ccv' string (default "")
1388 global
1389 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001390 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001391 {not in Vi}
1392 An expression that is used for character encoding conversion. It is
1393 evaluated when a file that is to be read or has been written has a
1394 different encoding from what is desired.
1395 'charconvert' is not used when the internal iconv() function is
1396 supported and is able to do the conversion. Using iconv() is
1397 preferred, because it is much faster.
1398 'charconvert' is not used when reading stdin |--|, because there is no
1399 file to convert from. You will have to save the text in a file first.
1400 The expression must return zero or an empty string for success,
1401 non-zero for failure.
1402 The possible encoding names encountered are in 'encoding'.
1403 Additionally, names given in 'fileencodings' and 'fileencoding' are
1404 used.
1405 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1406 is done internally by Vim, 'charconvert' is not used for this.
1407 'charconvert' is also used to convert the viminfo file, if the 'c'
1408 flag is present in 'viminfo'. Also used for Unicode conversion.
1409 Example: >
1410 set charconvert=CharConvert()
1411 fun CharConvert()
1412 system("recode "
1413 \ . v:charconvert_from . ".." . v:charconvert_to
1414 \ . " <" . v:fname_in . " >" v:fname_out)
1415 return v:shell_error
1416 endfun
1417< The related Vim variables are:
1418 v:charconvert_from name of the current encoding
1419 v:charconvert_to name of the desired encoding
1420 v:fname_in name of the input file
1421 v:fname_out name of the output file
1422 Note that v:fname_in and v:fname_out will never be the same.
1423 Note that v:charconvert_from and v:charconvert_to may be different
1424 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1425 Encryption is not done by Vim when using 'charconvert'. If you want
1426 to encrypt the file after conversion, 'charconvert' should take care
1427 of this.
1428 This option cannot be set from a |modeline| or in the |sandbox|, for
1429 security reasons.
1430
1431 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1432'cindent' 'cin' boolean (default off)
1433 local to buffer
1434 {not in Vi}
1435 {not available when compiled without the |+cindent|
1436 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001437 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 that trigger reindenting in insert mode and 'cinoptions' to set your
1439 preferred indent style.
1440 If 'indentexpr' is not empty, it overrules 'cindent'.
1441 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1442 the "=" operator indents using this algorithm rather than calling an
1443 external program.
1444 See |C-indenting|.
1445 When you don't like the way 'cindent' works, try the 'smartindent'
1446 option or 'indentexpr'.
1447 This option is not used when 'paste' is set.
1448 NOTE: This option is reset when 'compatible' is set.
1449
1450 *'cinkeys'* *'cink'*
1451'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1452 local to buffer
1453 {not in Vi}
1454 {not available when compiled without the |+cindent|
1455 feature}
1456 A list of keys that, when typed in Insert mode, cause reindenting of
1457 the current line. Only used if 'cindent' is on and 'indentexpr' is
1458 empty.
1459 For the format of this option see |cinkeys-format|.
1460 See |C-indenting|.
1461
1462 *'cinoptions'* *'cino'*
1463'cinoptions' 'cino' string (default "")
1464 local to buffer
1465 {not in Vi}
1466 {not available when compiled without the |+cindent|
1467 feature}
1468 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1469 program. See |cinoptions-values| for the values of this option, and
1470 |C-indenting| for info on C indenting in general.
1471
1472
1473 *'cinwords'* *'cinw'*
1474'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1475 local to buffer
1476 {not in Vi}
1477 {not available when compiled without both the
1478 |+cindent| and the |+smartindent| features}
1479 These keywords start an extra indent in the next line when
1480 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1481 an appropriate place (inside {}).
1482 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1483 matter, include the keyword both the uppercase and lowercase:
1484 "if,If,IF".
1485
1486 *'clipboard'* *'cb'*
1487'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1488 for X-windows, "" otherwise)
1489 global
1490 {not in Vi}
1491 {only in GUI versions or when the |+xterm_clipboard|
1492 feature is included}
1493 This option is a list of comma separated names.
1494 These names are recognized:
1495
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001496 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 unnamed When included, Vim will use the clipboard register '*'
1498 for all yank, delete, change and put operations which
1499 would normally go to the unnamed register. When a
1500 register is explicitly specified, it will always be
1501 used regardless of whether "unnamed" is in 'clipboard'
1502 or not. The clipboard register can always be
1503 explicitly accessed using the "* notation. Also see
1504 |gui-clipboard|.
1505
Bram Moolenaar30b65812012-07-12 22:01:11 +02001506 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001507 unnamedplus A variant of the "unnamed" flag which uses the
1508 clipboard register '+' (|quoteplus|) instead of
1509 register '*' for all yank, delete, change and put
1510 operations which would normally go to the unnamed
1511 register. When "unnamed" is also included to the
1512 option, yank operations (but not delete, change or
1513 put) will additionally copy the text into register
1514 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001515 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001516 Availability can be checked with: >
1517 if has('unnamedplus')
1518<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001519 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 autoselect Works like the 'a' flag in 'guioptions': If present,
1521 then whenever Visual mode is started, or the Visual
1522 area extended, Vim tries to become the owner of the
1523 windowing system's global selection or put the
1524 selected text on the clipboard used by the selection
1525 register "*. See |guioptions_a| and |quotestar| for
1526 details. When the GUI is active, the 'a' flag in
1527 'guioptions' is used, when the GUI is not active, this
1528 "autoselect" flag is used.
1529 Also applies to the modeless selection.
1530
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001531 *clipboard-autoselectplus*
1532 autoselectplus Like "autoselect" but using the + register instead of
1533 the * register. Compare to the 'P' flag in
1534 'guioptions'.
1535
1536 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 autoselectml Like "autoselect", but for the modeless selection
1538 only. Compare to the 'A' flag in 'guioptions'.
1539
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001540 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001541 html When the clipboard contains HTML, use this when
1542 pasting. When putting text on the clipboard, mark it
1543 as HTML. This works to copy rendered HTML from
1544 Firefox, paste it as raw HTML in Vim, select the HTML
1545 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001546 You probably want to add this only temporarily,
1547 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001548 Only supported for GTK version 2 and later.
1549 Only available with the |+multi_byte| feature.
1550
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001551 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 exclude:{pattern}
1553 Defines a pattern that is matched against the name of
1554 the terminal 'term'. If there is a match, no
1555 connection will be made to the X server. This is
1556 useful in this situation:
1557 - Running Vim in a console.
1558 - $DISPLAY is set to start applications on another
1559 display.
1560 - You do not want to connect to the X server in the
1561 console, but do want this in a terminal emulator.
1562 To never connect to the X server use: >
1563 exclude:.*
1564< This has the same effect as using the |-X| argument.
1565 Note that when there is no connection to the X server
1566 the window title won't be restored and the clipboard
1567 cannot be accessed.
1568 The value of 'magic' is ignored, {pattern} is
1569 interpreted as if 'magic' was on.
1570 The rest of the option value will be used for
1571 {pattern}, this must be the last entry.
1572
1573 *'cmdheight'* *'ch'*
1574'cmdheight' 'ch' number (default 1)
1575 global
1576 {not in Vi}
1577 Number of screen lines to use for the command-line. Helps avoiding
1578 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001579 The value of this option is stored with the tab page, so that each tab
1580 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581
1582 *'cmdwinheight'* *'cwh'*
1583'cmdwinheight' 'cwh' number (default 7)
1584 global
1585 {not in Vi}
1586 {not available when compiled without the |+vertsplit|
1587 feature}
1588 Number of screen lines to use for the command-line window. |cmdwin|
1589
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001590 *'colorcolumn'* *'cc'*
1591'colorcolumn' 'cc' string (default "")
1592 local to window
1593 {not in Vi}
1594 {not available when compiled without the |+syntax|
1595 feature}
1596 'colorcolumn' is a comma separated list of screen columns that are
1597 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1598 text. Will make screen redrawing slower.
1599 The screen column can be an absolute number, or a number preceded with
1600 '+' or '-', which is added to or subtracted from 'textwidth'. >
1601
1602 :set cc=+1 " highlight column after 'textwidth'
1603 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1604 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1605<
1606 When 'textwidth' is zero then the items with '-' and '+' are not used.
1607 A maximum of 256 columns are highlighted.
1608
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 *'columns'* *'co'* *E594*
1610'columns' 'co' number (default 80 or terminal width)
1611 global
1612 {not in Vi}
1613 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001614 initialization and does not have to be set by hand. Also see
1615 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 When Vim is running in the GUI or in a resizable window, setting this
1617 option will cause the window size to be changed. When you only want
1618 to use the size for the GUI, put the command in your |gvimrc| file.
1619 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001620 number of columns of the display, the display may be messed up. For
1621 the GUI it is always possible and Vim limits the number of columns to
1622 what fits on the screen. You can use this command to get the widest
1623 window possible: >
1624 :set columns=9999
1625< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626
1627 *'comments'* *'com'* *E524* *E525*
1628'comments' 'com' string (default
1629 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1630 local to buffer
1631 {not in Vi}
1632 {not available when compiled without the |+comments|
1633 feature}
1634 A comma separated list of strings that can start a comment line. See
1635 |format-comments|. See |option-backslash| about using backslashes to
1636 insert a space.
1637
1638 *'commentstring'* *'cms'* *E537*
1639'commentstring' 'cms' string (default "/*%s*/")
1640 local to buffer
1641 {not in Vi}
1642 {not available when compiled without the |+folding|
1643 feature}
1644 A template for a comment. The "%s" in the value is replaced with the
1645 comment text. Currently only used to add markers for folding, see
1646 |fold-marker|.
1647
1648 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001649'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1650 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 global
1652 {not in Vi}
1653 This option has the effect of making Vim either more Vi-compatible, or
1654 make Vim behave in a more useful way.
1655 This is a special kind of option, because when it's set or reset,
1656 other options are also changed as a side effect. CAREFUL: Setting or
1657 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001658 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 set this option in your vimrc file, you should probably put it at the
1660 very start.
1661 By default this option is on and the Vi defaults are used for the
1662 options. This default was chosen for those people who want to use Vim
1663 just like Vi, and don't even (want to) know about the 'compatible'
1664 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001665 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001666 this option is switched off, and all options that have not been
1667 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001668 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001669 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001670 happen for the system-wide vimrc or gvimrc file, nor for a file given
1671 with the |-u| argument). Also see |compatible-default| and
1672 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 You can also set this option with the "-C" argument, and reset it with
1674 "-N". See |-C| and |-N|.
1675 Switching this option off makes the Vim defaults be used for options
1676 that have a different Vi and Vim default value. See the options
1677 marked with a '+' below. Other options are not modified.
1678 At the moment this option is set, several other options will be set
1679 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001680 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 editing.
1682 See also 'cpoptions'.
1683
1684 option + set value effect ~
1685
1686 'allowrevins' off no CTRL-_ command
1687 'backupcopy' Unix: "yes" backup file is a copy
1688 others: "auto" copy or rename backup file
1689 'backspace' "" normal backspace
1690 'backup' off no backup file
1691 'cindent' off no C code indentation
1692 'cedit' + "" no key to open the |cmdwin|
1693 'cpoptions' + (all flags) Vi-compatible flags
1694 'cscopetag' off don't use cscope for ":tag"
1695 'cscopetagorder' 0 see |cscopetagorder|
1696 'cscopeverbose' off see |cscopeverbose|
1697 'digraph' off no digraphs
1698 'esckeys' + off no <Esc>-keys in Insert mode
1699 'expandtab' off tabs not expanded to spaces
1700 'fileformats' + "" no automatic file format detection,
1701 "dos,unix" except for DOS, Windows and OS/2
1702 'formatoptions' + "vt" Vi compatible formatting
1703 'gdefault' off no default 'g' flag for ":s"
1704 'history' + 0 no commandline history
1705 'hkmap' off no Hebrew keyboard mapping
1706 'hkmapp' off no phonetic Hebrew keyboard mapping
1707 'hlsearch' off no highlighting of search matches
1708 'incsearch' off no incremental searching
1709 'indentexpr' "" no indenting by expression
1710 'insertmode' off do not start in Insert mode
1711 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1712 characters and '_'
1713 'joinspaces' on insert 2 spaces after period
1714 'modeline' + off no modelines
1715 'more' + off no pauses in listings
1716 'revins' off no reverse insert
1717 'ruler' off no ruler
1718 'scrolljump' 1 no jump scroll
1719 'scrolloff' 0 no scroll offset
1720 'shiftround' off indent not rounded to shiftwidth
1721 'shortmess' + "" no shortening of messages
1722 'showcmd' + off command characters not shown
1723 'showmode' + off current mode not shown
1724 'smartcase' off no automatic ignore case switch
1725 'smartindent' off no smart indentation
1726 'smarttab' off no smart tab size
1727 'softtabstop' 0 tabs are always 'tabstop' positions
1728 'startofline' on goto startofline with some commands
1729 'tagrelative' + off tag file names are not relative
1730 'textauto' + off no automatic textmode detection
1731 'textwidth' 0 no automatic line wrap
1732 'tildeop' off tilde is not an operator
1733 'ttimeout' off no terminal timeout
1734 'whichwrap' + "" left-right movements don't wrap
1735 'wildchar' + CTRL-E only when the current value is <Tab>
1736 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001737 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738
1739 *'complete'* *'cpt'* *E535*
1740'complete' 'cpt' string (default: ".,w,b,u,t,i")
1741 local to buffer
1742 {not in Vi}
1743 This option specifies how keyword completion |ins-completion| works
1744 when CTRL-P or CTRL-N are used. It is also used for whole-line
1745 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1746 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001747 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 w scan buffers from other windows
1749 b scan other loaded buffers that are in the buffer list
1750 u scan the unloaded buffers that are in the buffer list
1751 U scan the buffers that are not in the buffer list
1752 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001753 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001754 k{dict} scan the file {dict}. Several "k" flags can be given,
1755 patterns are valid too. For example: >
1756 :set cpt=k/usr/dict/*,k~/spanish
1757< s scan the files given with the 'thesaurus' option
1758 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1759 are valid too.
1760 i scan current and included files
1761 d scan current and included files for defined name or macro
1762 |i_CTRL-X_CTRL-D|
1763 ] tag completion
1764 t same as "]"
1765
1766 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1767 not executed, this may lead to unexpected completions from some files
1768 (gzipped files for example). Unloaded buffers are not scanned for
1769 whole-line completion.
1770
1771 The default is ".,w,b,u,t,i", which means to scan:
1772 1. the current buffer
1773 2. buffers in other windows
1774 3. other loaded buffers
1775 4. unloaded buffers
1776 5. tags
1777 6. included files
1778
1779 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001780 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1781 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001783 *'completefunc'* *'cfu'*
1784'completefunc' 'cfu' string (default: empty)
1785 local to buffer
1786 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001787 {not available when compiled without the |+eval|
1788 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001789 This option specifies a function to be used for Insert mode completion
1790 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001791 See |complete-functions| for an explanation of how the function is
1792 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001793 This option cannot be set from a |modeline| or in the |sandbox|, for
1794 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001795
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001796 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001797'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001798 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001799 {not available when compiled without the
1800 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001801 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001802 A comma separated list of options for Insert mode completion
1803 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001804
1805 menu Use a popup menu to show the possible completions. The
1806 menu is only shown when there is more than one match and
1807 sufficient colors are available. |ins-completion-menu|
1808
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001809 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001810 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001811 match, e.g., what file it comes from.
1812
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001813 longest Only insert the longest common text of the matches. If
1814 the menu is displayed you can use CTRL-L to add more
1815 characters. Whether case is ignored depends on the kind
1816 of completion. For buffer text the 'ignorecase' option is
1817 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001818
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001819 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001820 completion in the preview window. Only works in
1821 combination with "menu" or "menuone".
1822
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001823
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001824 *'concealcursor'* *'cocu'*
1825'concealcursor' 'cocu' string (default: "")
1826 local to window
1827 {not in Vi}
1828 {not available when compiled without the |+conceal|
1829 feature}
1830 Sets the modes in which text in the cursor line can also be concealed.
1831 When the current mode is listed then concealing happens just like in
1832 other lines.
1833 n Normal mode
1834 v Visual mode
1835 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001836 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001837
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001838 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001839 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001840 are moving around text is concealed, but when starting to insert text
1841 or selecting a Visual area the concealed text is displayed, so that
1842 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001843 Keep in mind that the cursor position is not always where it's
1844 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001845
1846
1847'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001848 number (default 0)
1849 local to window
1850 {not in Vi}
1851 {not available when compiled without the |+conceal|
1852 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001853 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1854 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001855
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001856 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001857 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001858 1 Each block of concealed text is replaced with one
1859 character. If the syntax item does not have a custom
1860 replacement character defined (see |:syn-cchar|) the
1861 character defined in 'listchars' is used (default is a
1862 space).
1863 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001864 2 Concealed text is completely hidden unless it has a
1865 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001866 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001867 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001868
Bram Moolenaara7781e02010-07-19 20:13:22 +02001869 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001870 edit and copy the text. This can be changed with the 'concealcursor'
1871 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001872
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1874'confirm' 'cf' boolean (default off)
1875 global
1876 {not in Vi}
1877 When 'confirm' is on, certain operations that would normally
1878 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1879 instead raise a |dialog| asking if you wish to save the current
1880 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1881 If 'confirm' is off you can still activate confirmation for one
1882 command only (this is most useful in mappings) with the |:confirm|
1883 command.
1884 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1885
1886 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1887'conskey' 'consk' boolean (default off)
1888 global
1889 {not in Vi} {only for MS-DOS}
1890 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001891 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 three methods of console input are available:
1893 'conskey' 'bioskey' action ~
1894 on on or off direct console input
1895 off on BIOS
1896 off off STDIN
1897
1898 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1899'copyindent' 'ci' boolean (default off)
1900 local to buffer
1901 {not in Vi}
1902 Copy the structure of the existing lines indent when autoindenting a
1903 new line. Normally the new indent is reconstructed by a series of
1904 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1905 in which case only spaces are used). Enabling this option makes the
1906 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001907 existing line. 'expandtab' has no effect on these characters, a Tab
1908 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 line, the remaining space is filled in the normal manner.
1910 NOTE: 'copyindent' is reset when 'compatible' is set.
1911 Also see 'preserveindent'.
1912
1913 *'cpoptions'* *'cpo'*
1914'cpoptions' 'cpo' string (Vim default: "aABceFs",
1915 Vi default: all flags)
1916 global
1917 {not in Vi}
1918 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001919 this indicates Vi-compatible behavior. This is used for things where
1920 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 'cpoptions' stands for "compatible-options".
1922 Commas can be added for readability.
1923 To avoid problems with flags that are added in the future, use the
1924 "+=" and "-=" feature of ":set" |add-option-flags|.
1925 NOTE: This option is set to the Vi default value when 'compatible' is
1926 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001927 NOTE: This option is set to the POSIX default value at startup when
1928 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001929 variable exists |posix|. This means Vim tries to behave like the
1930 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931
1932 contains behavior ~
1933 *cpo-a*
1934 a When included, a ":read" command with a file name
1935 argument will set the alternate file name for the
1936 current window.
1937 *cpo-A*
1938 A When included, a ":write" command with a file name
1939 argument will set the alternate file name for the
1940 current window.
1941 *cpo-b*
1942 b "\|" in a ":map" command is recognized as the end of
1943 the map command. The '\' is included in the mapping,
1944 the text after the '|' is interpreted as the next
1945 command. Use a CTRL-V instead of a backslash to
1946 include the '|' in the mapping. Applies to all
1947 mapping, abbreviation, menu and autocmd commands.
1948 See also |map_bar|.
1949 *cpo-B*
1950 B A backslash has no special meaning in mappings,
1951 abbreviations and the "to" part of the menu commands.
1952 Remove this flag to be able to use a backslash like a
1953 CTRL-V. For example, the command ":map X \<Esc>"
1954 results in X being mapped to:
1955 'B' included: "\^[" (^[ is a real <Esc>)
1956 'B' excluded: "<Esc>" (5 characters)
1957 ('<' excluded in both cases)
1958 *cpo-c*
1959 c Searching continues at the end of any match at the
1960 cursor position, but not further than the start of the
1961 next line. When not present searching continues
1962 one character from the cursor position. With 'c'
1963 "abababababab" only gets three matches when repeating
1964 "/abab", without 'c' there are five matches.
1965 *cpo-C*
1966 C Do not concatenate sourced lines that start with a
1967 backslash. See |line-continuation|.
1968 *cpo-d*
1969 d Using "./" in the 'tags' option doesn't mean to use
1970 the tags file relative to the current file, but the
1971 tags file in the current directory.
1972 *cpo-D*
1973 D Can't use CTRL-K to enter a digraph after Normal mode
1974 commands with a character argument, like |r|, |f| and
1975 |t|.
1976 *cpo-e*
1977 e When executing a register with ":@r", always add a
1978 <CR> to the last line, also when the register is not
1979 linewise. If this flag is not present, the register
1980 is not linewise and the last line does not end in a
1981 <CR>, then the last line is put on the command-line
1982 and can be edited before hitting <CR>.
1983 *cpo-E*
1984 E It is an error when using "y", "d", "c", "g~", "gu" or
1985 "gU" on an Empty region. The operators only work when
1986 at least one character is to be operate on. Example:
1987 This makes "y0" fail in the first column.
1988 *cpo-f*
1989 f When included, a ":read" command with a file name
1990 argument will set the file name for the current buffer,
1991 if the current buffer doesn't have a file name yet.
1992 *cpo-F*
1993 F When included, a ":write" command with a file name
1994 argument will set the file name for the current
1995 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001996 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 *cpo-g*
1998 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001999 *cpo-H*
2000 H When using "I" on a line with only blanks, insert
2001 before the last blank. Without this flag insert after
2002 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 *cpo-i*
2004 i When included, interrupting the reading of a file will
2005 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002006 *cpo-I*
2007 I When moving the cursor up or down just after inserting
2008 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 *cpo-j*
2010 j When joining lines, only add two spaces after a '.',
2011 not after '!' or '?'. Also see 'joinspaces'.
2012 *cpo-J*
2013 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002014 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002015 white space.
2016 *cpo-k*
2017 k Disable the recognition of raw key codes in
2018 mappings, abbreviations, and the "to" part of menu
2019 commands. For example, if <Key> sends ^[OA (where ^[
2020 is <Esc>), the command ":map X ^[OA" results in X
2021 being mapped to:
2022 'k' included: "^[OA" (3 characters)
2023 'k' excluded: "<Key>" (one key code)
2024 Also see the '<' flag below.
2025 *cpo-K*
2026 K Don't wait for a key code to complete when it is
2027 halfway a mapping. This breaks mapping <F1><F1> when
2028 only part of the second <F1> has been read. It
2029 enables cancelling the mapping by typing <F1><Esc>.
2030 *cpo-l*
2031 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002032 literally, only "\]", "\^", "\-" and "\\" are special.
2033 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2035 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002036 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 *cpo-L*
2038 L When the 'list' option is set, 'wrapmargin',
2039 'textwidth', 'softtabstop' and Virtual Replace mode
2040 (see |gR|) count a <Tab> as two characters, instead of
2041 the normal behavior of a <Tab>.
2042 *cpo-m*
2043 m When included, a showmatch will always wait half a
2044 second. When not included, a showmatch will wait half
2045 a second or until a character is typed. |'showmatch'|
2046 *cpo-M*
2047 M When excluded, "%" matching will take backslashes into
2048 account. Thus in "( \( )" and "\( ( \)" the outer
2049 parenthesis match. When included "%" ignores
2050 backslashes, which is Vi compatible.
2051 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002052 n When included, the column used for 'number' and
2053 'relativenumber' will also be used for text of wrapped
2054 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 *cpo-o*
2056 o Line offset to search command is not remembered for
2057 next search.
2058 *cpo-O*
2059 O Don't complain if a file is being overwritten, even
2060 when it didn't exist when editing it. This is a
2061 protection against a file unexpectedly created by
2062 someone else. Vi didn't complain about this.
2063 *cpo-p*
2064 p Vi compatible Lisp indenting. When not present, a
2065 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002066 *cpo-P*
2067 P When included, a ":write" command that appends to a
2068 file will set the file name for the current buffer, if
2069 the current buffer doesn't have a file name yet and
2070 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002071 *cpo-q*
2072 q When joining multiple lines leave the cursor at the
2073 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 *cpo-r*
2075 r Redo ("." command) uses "/" to repeat a search
2076 command, instead of the actually used search string.
2077 *cpo-R*
2078 R Remove marks from filtered lines. Without this flag
2079 marks are kept like |:keepmarks| was used.
2080 *cpo-s*
2081 s Set buffer options when entering the buffer for the
2082 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002083 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 set when the buffer is created.
2085 *cpo-S*
2086 S Set buffer options always when entering a buffer
2087 (except 'readonly', 'fileformat', 'filetype' and
2088 'syntax'). This is the (most) Vi compatible setting.
2089 The options are set to the values in the current
2090 buffer. When you change an option and go to another
2091 buffer, the value is copied. Effectively makes the
2092 buffer options global to all buffers.
2093
2094 's' 'S' copy buffer options
2095 no no when buffer created
2096 yes no when buffer first entered (default)
2097 X yes each time when buffer entered (vi comp.)
2098 *cpo-t*
2099 t Search pattern for the tag command is remembered for
2100 "n" command. Otherwise Vim only puts the pattern in
2101 the history for search pattern, but doesn't change the
2102 last used search pattern.
2103 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002104 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-v*
2106 v Backspaced characters remain visible on the screen in
2107 Insert mode. Without this flag the characters are
2108 erased from the screen right away. With this flag the
2109 screen newly typed text overwrites backspaced
2110 characters.
2111 *cpo-w*
2112 w When using "cw" on a blank character, only change one
2113 character and not all blanks until the start of the
2114 next word.
2115 *cpo-W*
2116 W Don't overwrite a readonly file. When omitted, ":w!"
2117 overwrites a readonly file, if possible.
2118 *cpo-x*
2119 x <Esc> on the command-line executes the command-line.
2120 The default in Vim is to abandon the command-line,
2121 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002122 *cpo-X*
2123 X When using a count with "R" the replaced text is
2124 deleted only once. Also when repeating "R" with "."
2125 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *cpo-y*
2127 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002128 *cpo-Z*
2129 Z When using "w!" while the 'readonly' option is set,
2130 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 *cpo-!*
2132 ! When redoing a filter command, use the last used
2133 external command, whatever it was. Otherwise the last
2134 used -filter- command is used.
2135 *cpo-$*
2136 $ When making a change to one line, don't redisplay the
2137 line, but put a '$' at the end of the changed text.
2138 The changed text will be overwritten when you type the
2139 new text. The line is redisplayed if you type any
2140 command that moves the cursor from the insertion
2141 point.
2142 *cpo-%*
2143 % Vi-compatible matching is done for the "%" command.
2144 Does not recognize "#if", "#endif", etc.
2145 Does not recognize "/*" and "*/".
2146 Parens inside single and double quotes are also
2147 counted, causing a string that contains a paren to
2148 disturb the matching. For example, in a line like
2149 "if (strcmp("foo(", s))" the first paren does not
2150 match the last one. When this flag is not included,
2151 parens inside single and double quotes are treated
2152 specially. When matching a paren outside of quotes,
2153 everything inside quotes is ignored. When matching a
2154 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002156 This flag is also used for other features, such as
2157 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002158 *cpo--*
2159 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002160 it would go above the first line or below the last
2161 line. Without it the cursor moves to the first or
2162 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002163 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002164 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002165 *cpo-+*
2166 + When included, a ":write file" command will reset the
2167 'modified' flag of the buffer, even though the buffer
2168 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002169 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 * Use ":*" in the same way as ":@". When not included,
2171 ":*" is an alias for ":'<,'>", select the Visual area.
2172 *cpo-<*
2173 < Disable the recognition of special key codes in |<>|
2174 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002175 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 ":map X <Tab>" results in X being mapped to:
2177 '<' included: "<Tab>" (5 characters)
2178 '<' excluded: "^I" (^I is a real <Tab>)
2179 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 *cpo->*
2181 > When appending to a register, put a line break before
2182 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002183 *cpo-;*
2184 ; When using |,| or |;| to repeat the last |t| search
2185 and the cursor is right in front of the searched
2186 character, the cursor won't move. When not included,
2187 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002188 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002189
2190 POSIX flags. These are not included in the Vi default value, except
2191 when $VIM_POSIX was set on startup. |posix|
2192
2193 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002194 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002195 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002196 *cpo-&*
2197 & When ":preserve" was used keep the swap file when
2198 exiting normally while this buffer is still loaded.
2199 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002200 *cpo-\*
2201 \ Backslash in a [] range in a search pattern is taken
2202 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002203 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2204 '\' excluded: "/[ \-]" finds <Space> and '-'
2205 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002206 *cpo-/*
2207 / When "%" is used as the replacement string in a |:s|
2208 command, use the previous replacement string. |:s%|
2209 *cpo-{*
2210 { The |{| and |}| commands also stop at a "{" character
2211 at the start of a line.
2212 *cpo-.*
2213 . The ":chdir" and ":cd" commands fail if the current
2214 buffer is modified, unless ! is used. Vim doesn't
2215 need this, since it remembers the full path of an
2216 opened file.
2217 *cpo-bar*
2218 | The value of the $LINES and $COLUMNS environment
2219 variables overrule the terminal size values obtained
2220 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002221
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002223 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002224'cryptmethod' string (default "zip")
2225 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002226 {not in Vi}
2227 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002228 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002229 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002230 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002231 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002232 blowfish Blowfish method. Medium strong encryption but it has
2233 an implementation flaw. Requires Vim 7.3 or later,
2234 files can NOT be read by Vim 7.2 and older. This adds
2235 a "seed" to the file, every time you write the file
2236 the encrypted bytes will be different.
2237 *blowfish2*
2238 blowfish2 Blowfish method. Medium strong encryption. Requires
2239 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2240 and older. This adds a "seed" to the file, every time
2241 you write the file the encrypted bytes will be
2242 different. The whole undo file is encrypted, not just
2243 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002244
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002245 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002246 to the detected method of the file being read. Thus if you write it
2247 without changing 'cryptmethod' the same method will be used.
2248 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002249 explicitly write it, you don't get a warning unless there are other
2250 modifications. Also see |:X|.
2251
2252 When setting the global value to an empty string, it will end up with
2253 the value "zip". When setting the local value to an empty string the
2254 buffer will use the global value.
2255
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002256 When a new encryption method is added in a later version of Vim, and
2257 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002258 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002259
2260
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 *'cscopepathcomp'* *'cspc'*
2262'cscopepathcomp' 'cspc' number (default 0)
2263 global
2264 {not available when compiled without the |+cscope|
2265 feature}
2266 {not in Vi}
2267 Determines how many components of the path to show in a list of tags.
2268 See |cscopepathcomp|.
2269
2270 *'cscopeprg'* *'csprg'*
2271'cscopeprg' 'csprg' string (default "cscope")
2272 global
2273 {not available when compiled without the |+cscope|
2274 feature}
2275 {not in Vi}
2276 Specifies the command to execute cscope. See |cscopeprg|.
2277 This option cannot be set from a |modeline| or in the |sandbox|, for
2278 security reasons.
2279
2280 *'cscopequickfix'* *'csqf'*
2281'cscopequickfix' 'csqf' string (default "")
2282 global
2283 {not available when compiled without the |+cscope|
2284 or |+quickfix| features}
2285 {not in Vi}
2286 Specifies whether to use quickfix window to show cscope results.
2287 See |cscopequickfix|.
2288
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002289 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002290'cscoperelative' 'csre' boolean (default off)
2291 global
2292 {not available when compiled without the |+cscope|
2293 feature}
2294 {not in Vi}
2295 In the absence of a prefix (-P) for cscope. setting this option enables
2296 to use the basename of cscope.out path as the prefix.
2297 See |cscoperelative|.
2298
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2300'cscopetag' 'cst' boolean (default off)
2301 global
2302 {not available when compiled without the |+cscope|
2303 feature}
2304 {not in Vi}
2305 Use cscope for tag commands. See |cscope-options|.
2306 NOTE: This option is reset when 'compatible' is set.
2307
2308 *'cscopetagorder'* *'csto'*
2309'cscopetagorder' 'csto' number (default 0)
2310 global
2311 {not available when compiled without the |+cscope|
2312 feature}
2313 {not in Vi}
2314 Determines the order in which ":cstag" performs a search. See
2315 |cscopetagorder|.
2316 NOTE: This option is set to 0 when 'compatible' is set.
2317
2318 *'cscopeverbose'* *'csverb'*
2319 *'nocscopeverbose'* *'nocsverb'*
2320'cscopeverbose' 'csverb' boolean (default off)
2321 global
2322 {not available when compiled without the |+cscope|
2323 feature}
2324 {not in Vi}
2325 Give messages when adding a cscope database. See |cscopeverbose|.
2326 NOTE: This option is reset when 'compatible' is set.
2327
Bram Moolenaar860cae12010-06-05 23:22:07 +02002328 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2329'cursorbind' 'crb' boolean (default off)
2330 local to window
2331 {not in Vi}
2332 {not available when compiled without the |+cursorbind|
2333 feature}
2334 When this option is set, as the cursor in the current
2335 window moves other cursorbound windows (windows that also have
2336 this option set) move their cursors to the corresponding line and
2337 column. This option is useful for viewing the
2338 differences between two versions of a file (see 'diff'); in diff mode,
2339 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002340 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002341
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002342
2343 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2344'cursorcolumn' 'cuc' boolean (default off)
2345 local to window
2346 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002347 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002348 feature}
2349 Highlight the screen column of the cursor with CursorColumn
2350 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2351 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002352 If you only want the highlighting in the current window you can use
2353 these autocommands: >
2354 au WinLeave * set nocursorline nocursorcolumn
2355 au WinEnter * set cursorline cursorcolumn
2356<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002357
2358 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2359'cursorline' 'cul' boolean (default off)
2360 local to window
2361 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002362 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002363 feature}
2364 Highlight the screen line of the cursor with CursorLine
2365 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2366 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002367 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002368 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002369
2370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *'debug'*
2372'debug' string (default "")
2373 global
2374 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002375 These values can be used:
2376 msg Error messages that would otherwise be omitted will be given
2377 anyway.
2378 throw Error messages that would otherwise be omitted will be given
2379 anyway and also throw an exception and set |v:errmsg|.
2380 beep A message will be given when otherwise only a beep would be
2381 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002382 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002383 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2384 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385
2386 *'define'* *'def'*
2387'define' 'def' string (default "^\s*#\s*define")
2388 global or local to buffer |global-local|
2389 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002390 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 pattern, just like for the "/" command. This option is used for the
2392 commands like "[i" and "[d" |include-search|. The 'isident' option is
2393 used to recognize the defined name after the match:
2394 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2395 See |option-backslash| about inserting backslashes to include a space
2396 or backslash.
2397 The default value is for C programs. For C++ this value would be
2398 useful, to include const type declarations: >
2399 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2400< When using the ":set" command, you need to double the backslashes!
2401
2402 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2403'delcombine' 'deco' boolean (default off)
2404 global
2405 {not in Vi}
2406 {only available when compiled with the |+multi_byte|
2407 feature}
2408 If editing Unicode and this option is set, backspace and Normal mode
2409 "x" delete each combining character on its own. When it is off (the
2410 default) the character along with its combining characters are
2411 deleted.
2412 Note: When 'delcombine' is set "xx" may work different from "2x"!
2413
2414 This is useful for Arabic, Hebrew and many other languages where one
2415 may have combining characters overtop of base characters, and want
2416 to remove only the combining ones.
2417
2418 *'dictionary'* *'dict'*
2419'dictionary' 'dict' string (default "")
2420 global or local to buffer |global-local|
2421 {not in Vi}
2422 List of file names, separated by commas, that are used to lookup words
2423 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2424 contain a list of words. This can be one word per line, or several
2425 words per line, separated by non-keyword characters (white space is
2426 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002427 When this option is empty, or an entry "spell" is present, spell
2428 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002429 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 after a comma are ignored, otherwise spaces are included in the file
2431 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002432 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 Where to find a list of words?
2434 - On FreeBSD, there is the file "/usr/share/dict/words".
2435 - In the Simtel archive, look in the "msdos/linguist" directory.
2436 - In "miscfiles" of the GNU collection.
2437 The use of |:set+=| and |:set-=| is preferred when adding or removing
2438 directories from the list. This avoids problems when a future version
2439 uses another default.
2440 Backticks cannot be used in this option for security reasons.
2441
2442 *'diff'* *'nodiff'*
2443'diff' boolean (default off)
2444 local to window
2445 {not in Vi}
2446 {not available when compiled without the |+diff|
2447 feature}
2448 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002449 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450
2451 *'dex'* *'diffexpr'*
2452'diffexpr' 'dex' string (default "")
2453 global
2454 {not in Vi}
2455 {not available when compiled without the |+diff|
2456 feature}
2457 Expression which is evaluated to obtain an ed-style diff file from two
2458 versions of a file. See |diff-diffexpr|.
2459 This option cannot be set from a |modeline| or in the |sandbox|, for
2460 security reasons.
2461
2462 *'dip'* *'diffopt'*
2463'diffopt' 'dip' string (default "filler")
2464 global
2465 {not in Vi}
2466 {not available when compiled without the |+diff|
2467 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002468 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 All are optional. Items must be separated by a comma.
2470
2471 filler Show filler lines, to keep the text
2472 synchronized with a window that has inserted
2473 lines at the same position. Mostly useful
2474 when windows are side-by-side and 'scrollbind'
2475 is set.
2476
2477 context:{n} Use a context of {n} lines between a change
2478 and a fold that contains unchanged lines.
2479 When omitted a context of six lines is used.
2480 See |fold-diff|.
2481
2482 icase Ignore changes in case of text. "a" and "A"
2483 are considered the same. Adds the "-i" flag
2484 to the "diff" command if 'diffexpr' is empty.
2485
2486 iwhite Ignore changes in amount of white space. Adds
2487 the "-b" flag to the "diff" command if
2488 'diffexpr' is empty. Check the documentation
2489 of the "diff" command for what this does
2490 exactly. It should ignore adding trailing
2491 white space, but not leading white space.
2492
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002493 horizontal Start diff mode with horizontal splits (unless
2494 explicitly specified otherwise).
2495
2496 vertical Start diff mode with vertical splits (unless
2497 explicitly specified otherwise).
2498
2499 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2500 starting diff mode. Without this 2 is used.
2501
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 Examples: >
2503
2504 :set diffopt=filler,context:4
2505 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002506 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507<
2508 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2509'digraph' 'dg' boolean (default off)
2510 global
2511 {not in Vi}
2512 {not available when compiled without the |+digraphs|
2513 feature}
2514 Enable the entering of digraphs in Insert mode with {char1} <BS>
2515 {char2}. See |digraphs|.
2516 NOTE: This option is reset when 'compatible' is set.
2517
2518 *'directory'* *'dir'*
2519'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002520 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 for Unix: ".,~/tmp,/var/tmp,/tmp")
2522 global
2523 List of directory names for the swap file, separated with commas.
2524 - The swap file will be created in the first directory where this is
2525 possible.
2526 - Empty means that no swap file will be used (recovery is
2527 impossible!).
2528 - A directory "." means to put the swap file in the same directory as
2529 the edited file. On Unix, a dot is prepended to the file name, so
2530 it doesn't show in a directory listing. On MS-Windows the "hidden"
2531 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002532 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 put the swap file relative to where the edited file is. The leading
2534 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002535 - For Unix and Win32, if a directory ends in two path separators "//"
2536 or "\\", the swap file name will be built from the complete path to
2537 the file with all path separators substituted to percent '%' signs.
2538 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002539 On Win32, when a separating comma is following, you must use "//",
2540 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 - Spaces after the comma are ignored, other spaces are considered part
2542 of the directory name. To have a space at the start of a directory
2543 name, precede it with a backslash.
2544 - To include a comma in a directory name precede it with a backslash.
2545 - A directory name may end in an ':' or '/'.
2546 - Environment variables are expanded |:set_env|.
2547 - Careful with '\' characters, type one before a space, type two to
2548 get one in the option (see |option-backslash|), for example: >
2549 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2550< - For backwards compatibility with Vim version 3.0 a '>' at the start
2551 of the option is removed.
2552 Using "." first in the list is recommended. This means that editing
2553 the same file twice will result in a warning. Using "/tmp" on Unix is
2554 discouraged: When the system crashes you lose the swap file.
2555 "/var/tmp" is often not cleared when rebooting, thus is a better
2556 choice than "/tmp". But it can contain a lot of files, your swap
2557 files get lost in the crowd. That is why a "tmp" directory in your
2558 home directory is tried first.
2559 The use of |:set+=| and |:set-=| is preferred when adding or removing
2560 directories from the list. This avoids problems when a future version
2561 uses another default.
2562 This option cannot be set from a |modeline| or in the |sandbox|, for
2563 security reasons.
2564 {Vi: directory to put temp file in, defaults to "/tmp"}
2565
2566 *'display'* *'dy'*
2567'display' 'dy' string (default "")
2568 global
2569 {not in Vi}
2570 Change the way text is displayed. This is comma separated list of
2571 flags:
2572 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002573 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 last line that doesn't fit is replaced with "@" lines.
2575 uhex Show unprintable characters hexadecimal as <xx>
2576 instead of using ^C and ~C.
2577
2578 *'eadirection'* *'ead'*
2579'eadirection' 'ead' string (default "both")
2580 global
2581 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002582 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 feature}
2584 Tells when the 'equalalways' option applies:
2585 ver vertically, width of windows is not affected
2586 hor horizontally, height of windows is not affected
2587 both width and height of windows is affected
2588
2589 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2590'edcompatible' 'ed' boolean (default off)
2591 global
2592 Makes the 'g' and 'c' flags of the ":substitute" command to be
2593 toggled each time the flag is given. See |complex-change|. See
2594 also 'gdefault' option.
2595 Switching this option on is discouraged!
2596
2597 *'encoding'* *'enc'* *E543*
2598'encoding' 'enc' string (default: "latin1" or value from $LANG)
2599 global
2600 {only available when compiled with the |+multi_byte|
2601 feature}
2602 {not in Vi}
2603 Sets the character encoding used inside Vim. It applies to text in
2604 the buffers, registers, Strings in expressions, text stored in the
2605 viminfo file, etc. It sets the kind of characters which Vim can work
2606 with. See |encoding-names| for the possible values.
2607
2608 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002609 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002611 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612
Bram Moolenaar865242e2010-07-14 21:12:05 +02002613 This option cannot be set from a |modeline|. It would most likely
2614 corrupt the text.
2615
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2617 "utf-8". Although care has been taken to allow different values of
2618 'encoding', "utf-8" is the natural choice for the environment and
2619 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002620 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 versions, and to avoid changing the encoding of newly created files
2622 without your knowledge (in case 'fileencodings' is empty).
2623
2624 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002625 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626 iconv() or as specified with 'charconvert'.
2627
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002628 If you need to know whether 'encoding' is a multi-byte encoding, you
2629 can use: >
2630 if has("multi_byte_encoding")
2631<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 Normally 'encoding' will be equal to your current locale. This will
2633 be the default if Vim recognizes your environment settings. If
2634 'encoding' is not set to the current locale, 'termencoding' must be
2635 set to convert typed and displayed text. See |encoding-table|.
2636
2637 When you set this option, it fires the |EncodingChanged| autocommand
2638 event so that you can set up fonts if necessary.
2639
2640 When the option is set, the value is converted to lowercase. Thus
2641 you can set it with uppercase values too. Underscores are translated
2642 to '-' signs.
2643 When the encoding is recognized, it is changed to the standard name.
2644 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2645 "iso-8859-2" and "utf8" becomes "utf-8".
2646
2647 Note: "latin1" is also used when the encoding could not be detected.
2648 This only works when editing files in the same encoding! When the
2649 actual character set is not latin1, make sure 'fileencoding' and
2650 'fileencodings' are empty. When conversion is needed, switch to using
2651 utf-8.
2652
2653 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2654 You don't notice this while editing, but it does matter for the
2655 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2656 setting 'encoding' to one of these values instead of utf-8 only has
2657 effect for encoding used for files when 'fileencoding' is empty.
2658
Bram Moolenaar661b1822005-07-28 22:36:45 +00002659 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2660 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661
2662 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2663'endofline' 'eol' boolean (default on)
2664 local to buffer
2665 {not in Vi}
2666 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002667 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 option is automatically set when starting to edit a new file, unless
2669 the file does not have an <EOL> for the last line in the file, in
2670 which case it is reset. Normally you don't have to set or reset this
2671 option. When 'binary' is off the value is not used when writing the
2672 file. When 'binary' is on it is used to remember the presence of a
2673 <EOL> for the last line in the file, so that when you write the file
2674 the situation from the original file can be kept. But you can change
2675 it if you want to.
2676
2677 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2678'equalalways' 'ea' boolean (default on)
2679 global
2680 {not in Vi}
2681 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002682 splitting or closing a window. This also happens the moment the
2683 option is switched on. When off, splitting a window will reduce the
2684 size of the current window and leave the other windows the same. When
2685 closing a window the extra lines are given to the window next to it
2686 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 When mixing vertically and horizontally split windows, a minimal size
2688 is computed and some windows may be larger if there is room. The
2689 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002690 Changing the height and width of a window can be avoided by setting
2691 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002692 If a window size is specified when creating a new window sizes are
2693 currently not equalized (it's complicated, but may be implemented in
2694 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695
2696 *'equalprg'* *'ep'*
2697'equalprg' 'ep' string (default "")
2698 global or local to buffer |global-local|
2699 {not in Vi}
2700 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002701 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002702 or 'indentexpr'. When Vim was compiled without internal formatting,
2703 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002704 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 about including spaces and backslashes.
2706 This option cannot be set from a |modeline| or in the |sandbox|, for
2707 security reasons.
2708
2709 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2710'errorbells' 'eb' boolean (default off)
2711 global
2712 Ring the bell (beep or screen flash) for error messages. This only
2713 makes a difference for error messages, the bell will be used always
2714 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002715 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 screen flash or do nothing.
2717
2718 *'errorfile'* *'ef'*
2719'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2720 others: "errors.err")
2721 global
2722 {not in Vi}
2723 {not available when compiled without the |+quickfix|
2724 feature}
2725 Name of the errorfile for the QuickFix mode (see |:cf|).
2726 When the "-q" command-line argument is used, 'errorfile' is set to the
2727 following argument. See |-q|.
2728 NOT used for the ":make" command. See 'makeef' for that.
2729 Environment variables are expanded |:set_env|.
2730 See |option-backslash| about including spaces and backslashes.
2731 This option cannot be set from a |modeline| or in the |sandbox|, for
2732 security reasons.
2733
2734 *'errorformat'* *'efm'*
2735'errorformat' 'efm' string (default is very long)
2736 global or local to buffer |global-local|
2737 {not in Vi}
2738 {not available when compiled without the |+quickfix|
2739 feature}
2740 Scanf-like description of the format for the lines in the error file
2741 (see |errorformat|).
2742
2743 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2744'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2745 global
2746 {not in Vi}
2747 Function keys that start with an <Esc> are recognized in Insert
2748 mode. When this option is off, the cursor and function keys cannot be
2749 used in Insert mode if they start with an <Esc>. The advantage of
2750 this is that the single <Esc> is recognized immediately, instead of
2751 after one second. Instead of resetting this option, you might want to
2752 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2753 when 'esckeys' is off, you can still map anything, but the cursor keys
2754 won't work by default.
2755 NOTE: This option is set to the Vi default value when 'compatible' is
2756 set and to the Vim default value when 'compatible' is reset.
2757
2758 *'eventignore'* *'ei'*
2759'eventignore' 'ei' string (default "")
2760 global
2761 {not in Vi}
2762 {not available when compiled without the |+autocmd|
2763 feature}
2764 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002765 When set to "all" or when "all" is one of the items, all autocommand
2766 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 Otherwise this is a comma separated list of event names. Example: >
2768 :set ei=WinEnter,WinLeave
2769<
2770 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2771'expandtab' 'et' boolean (default off)
2772 local to buffer
2773 {not in Vi}
2774 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002775 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2777 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2778 NOTE: This option is reset when 'compatible' is set.
2779
2780 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2781'exrc' 'ex' boolean (default off)
2782 global
2783 {not in Vi}
2784 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2785 directory. If you switch this option on you should also consider
2786 setting the 'secure' option (see |initialization|). Using a local
2787 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2788 also see |.vimrc| and |gui-init|.
2789 This option cannot be set from a |modeline| or in the |sandbox|, for
2790 security reasons.
2791
2792 *'fileencoding'* *'fenc'* *E213*
2793'fileencoding' 'fenc' string (default: "")
2794 local to buffer
2795 {only available when compiled with the |+multi_byte|
2796 feature}
2797 {not in Vi}
2798 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002799
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002801 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 When 'fileencoding' is empty, the same value as 'encoding' will be
2803 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002804 Conversion will also be done when 'encoding' and 'fileencoding' are
2805 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2806 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002808 'encoding' is "utf-8" or another Unicode encoding, conversion
2809 is most likely done in a way that the reverse conversion
2810 results in the same text. When 'encoding' is not "utf-8" some
2811 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002812
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 See 'encoding' for the possible values. Additionally, values may be
2814 specified that can be handled by the converter, see
2815 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002816
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 When reading a file 'fileencoding' will be set from 'fileencodings'.
2818 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002819 'fileencoding', use the |++enc| argument. One exception: when
2820 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002821 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002822
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2824 When the option is set, the value is converted to lowercase. Thus
2825 you can set it with uppercase values too. '_' characters are
2826 replaced with '-'. If a name is recognized from the list for
2827 'encoding', it is replaced by the standard name. For example
2828 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002829
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 When this option is set, after starting to edit a file, the 'modified'
2831 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002832
2833 Keep in mind that changing 'fenc' from a modeline happens
2834 AFTER the text has been read, thus it applies to when the file will be
2835 written. If you do set 'fenc' in a modeline, you might want to set
2836 'nomodified' to avoid not being able to ":q".
2837
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 This option can not be changed when 'modifiable' is off.
2839
2840 *'fe'*
2841 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002842 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 old short name was 'fe', which is no longer used.
2844
2845 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002846'fileencodings' 'fencs' string (default: "ucs-bom",
2847 "ucs-bom,utf-8,default,latin1" when
2848 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 global
2850 {only available when compiled with the |+multi_byte|
2851 feature}
2852 {not in Vi}
2853 This is a list of character encodings considered when starting to edit
2854 an existing file. When a file is read, Vim tries to use the first
2855 mentioned character encoding. If an error is detected, the next one
2856 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002857 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 an empty string, which means the value of 'encoding' is used.
2859 WARNING: Conversion can cause loss of information! When
2860 'encoding' is "utf-8" (or one of the other Unicode variants)
2861 conversion is most likely done in a way that the reverse
2862 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002863 "utf-8" some non-ASCII characters may be lost! You can use
2864 the |++bad| argument to specify what is done with characters
2865 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 For an empty file or a file with only ASCII characters most encodings
2867 will work and the first entry of 'fileencodings' will be used (except
2868 "ucs-bom", which requires the BOM to be present). If you prefer
2869 another encoding use an BufReadPost autocommand event to test if your
2870 preferred encoding is to be used. Example: >
2871 au BufReadPost * if search('\S', 'w') == 0 |
2872 \ set fenc=iso-2022-jp | endif
2873< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2874 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002875 When the |++enc| argument is used then the value of 'fileencodings' is
2876 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002877 Note that 'fileencodings' is not used for a new file, the global value
2878 of 'fileencoding' is used instead. You can set it with: >
2879 :setglobal fenc=iso-8859-2
2880< This means that a non-existing file may get a different encoding than
2881 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 The special value "ucs-bom" can be used to check for a Unicode BOM
2883 (Byte Order Mark) at the start of the file. It must not be preceded
2884 by "utf-8" or another Unicode encoding for this to work properly.
2885 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2886 because Vim cannot detect an error, thus the encoding is always
2887 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002888 The special value "default" can be used for the encoding from the
2889 environment. This is the default value for 'encoding'. It is useful
2890 when 'encoding' is set to "utf-8" and your environment uses a
2891 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002892 When 'encoding' is "utf-8" and a file contains an illegal byte
2893 sequence it won't be recognized as UTF-8. You can use the |8g8|
2894 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 WRONG VALUES: WHAT'S WRONG:
2896 latin1,utf-8 "latin1" will always be used
2897 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2898 file
2899 cp1250,latin1 "cp1250" will always be used
2900 If 'fileencodings' is empty, 'fileencoding' is not modified.
2901 See 'fileencoding' for the possible values.
2902 Setting this option does not have an effect until the next time a file
2903 is read.
2904
2905 *'fileformat'* *'ff'*
2906'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2907 Unix default: "unix",
2908 Macintosh default: "mac")
2909 local to buffer
2910 {not in Vi}
2911 This gives the <EOL> of the current buffer, which is used for
2912 reading/writing the buffer from/to a file:
2913 dos <CR> <NL>
2914 unix <NL>
2915 mac <CR>
2916 When "dos" is used, CTRL-Z at the end of a file is ignored.
2917 See |file-formats| and |file-read|.
2918 For the character encoding of the file see 'fileencoding'.
2919 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002920 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 This option is set automatically when starting to edit a file and
2922 'fileformats' is not empty and 'binary' is off.
2923 When this option is set, after starting to edit a file, the 'modified'
2924 option is set, because the file would be different when written.
2925 This option can not be changed when 'modifiable' is off.
2926 For backwards compatibility: When this option is set to "dos",
2927 'textmode' is set, otherwise 'textmode' is reset.
2928
2929 *'fileformats'* *'ffs'*
2930'fileformats' 'ffs' string (default:
2931 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2932 Vim Unix: "unix,dos",
2933 Vim Mac: "mac,unix,dos",
2934 Vi Cygwin: "unix,dos",
2935 Vi others: "")
2936 global
2937 {not in Vi}
2938 This gives the end-of-line (<EOL>) formats that will be tried when
2939 starting to edit a new buffer and when reading a file into an existing
2940 buffer:
2941 - When empty, the format defined with 'fileformat' will be used
2942 always. It is not set automatically.
2943 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002944 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 'fileformats' name will be used when a file is read into an existing
2946 buffer, no matter what 'fileformat' for that buffer is set to.
2947 - When more than one name is present, separated by commas, automatic
2948 <EOL> detection will be done when reading a file. When starting to
2949 edit a file, a check is done for the <EOL>:
2950 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2951 'fileformat' is set to "dos".
2952 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002955 3. If 'fileformat' has not yet been set, and if 'fileformats'
2956 includes "mac", 'fileformat' is set to "mac".
2957 This means that "mac" is only chosen when:
2958 "unix" is not present or no <NL> is found in the file, and
2959 "dos" is not present or no <CR><NL> is found in the file.
2960 Except: if "unix" was chosen, but there is a <CR> before
2961 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002962 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 4. If 'fileformat' is still not set, the first name from
2964 'fileformats' is used.
2965 When reading a file into an existing buffer, the same is done, but
2966 this happens like 'fileformat' has been set appropriately for that
2967 file only, the option is not changed.
2968 When 'binary' is set, the value of 'fileformats' is not used.
2969
Bram Moolenaar81af9252010-12-10 20:35:50 +01002970 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002971 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002972
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2974 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2975 done:
2976 - When 'fileformats' is empty, there is no automatic detection. Dos
2977 format will be used.
2978 - When 'fileformats' is set to one or more names, automatic detection
2979 is done. This is based on the first <NL> in the file: If there is a
2980 <CR> in front of it, Dos format is used, otherwise Unix format is
2981 used.
2982 Also see |file-formats|.
2983 For backwards compatibility: When this option is set to an empty
2984 string or one format (no comma is included), 'textauto' is reset,
2985 otherwise 'textauto' is set.
2986 NOTE: This option is set to the Vi default value when 'compatible' is
2987 set and to the Vim default value when 'compatible' is reset.
2988
Bram Moolenaarbf884932013-04-05 22:26:15 +02002989 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2990'fileignorecase' 'fic' boolean (default on for systems where case in file
2991 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002992 global
2993 {not in Vi}
2994 When set case is ignored when using file names and directories.
2995 See 'wildignorecase' for only ignoring case when doing completion.
2996
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 *'filetype'* *'ft'*
2998'filetype' 'ft' string (default: "")
2999 local to buffer
3000 {not in Vi}
3001 {not available when compiled without the |+autocmd|
3002 feature}
3003 When this option is set, the FileType autocommand event is triggered.
3004 All autocommands that match with the value of this option will be
3005 executed. Thus the value of 'filetype' is used in place of the file
3006 name.
3007 Otherwise this option does not always reflect the current file type.
3008 This option is normally set when the file type is detected. To enable
3009 this use the ":filetype on" command. |:filetype|
3010 Setting this option to a different value is most useful in a modeline,
3011 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003012 Example, for in an IDL file:
3013 /* vim: set filetype=idl : */ ~
3014 |FileType| |filetypes|
3015 When a dot appears in the value then this separates two filetype
3016 names. Example:
3017 /* vim: set filetype=c.doxygen : */ ~
3018 This will use the "c" filetype first, then the "doxygen" filetype.
3019 This works both for filetype plugins and for syntax files. More than
3020 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 This option is not copied to another buffer, independent of the 's' or
3022 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003023 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024
3025 *'fillchars'* *'fcs'*
3026'fillchars' 'fcs' string (default "vert:|,fold:-")
3027 global
3028 {not in Vi}
3029 {not available when compiled without the |+windows|
3030 and |+folding| features}
3031 Characters to fill the statuslines and vertical separators.
3032 It is a comma separated list of items:
3033
3034 item default Used for ~
3035 stl:c ' ' or '^' statusline of the current window
3036 stlnc:c ' ' or '-' statusline of the non-current windows
3037 vert:c '|' vertical separators |:vsplit|
3038 fold:c '-' filling 'foldtext'
3039 diff:c '-' deleted lines of the 'diff' option
3040
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003041 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 "stlnc" the space will be used when there is highlighting, '^' or '-'
3043 otherwise.
3044
3045 Example: >
3046 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3047< This is similar to the default, except that these characters will also
3048 be used when there is highlighting.
3049
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003050 for "stl" and "stlnc" only single-byte values are supported.
3051
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 The highlighting used for these items:
3053 item highlight group ~
3054 stl:c StatusLine |hl-StatusLine|
3055 stlnc:c StatusLineNC |hl-StatusLineNC|
3056 vert:c VertSplit |hl-VertSplit|
3057 fold:c Folded |hl-Folded|
3058 diff:c DiffDelete |hl-DiffDelete|
3059
3060 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3061'fkmap' 'fk' boolean (default off) *E198*
3062 global
3063 {not in Vi}
3064 {only available when compiled with the |+rightleft|
3065 feature}
3066 When on, the keyboard is mapped for the Farsi character set.
3067 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003068 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069
3070 *'foldclose'* *'fcl'*
3071'foldclose' 'fcl' string (default "")
3072 global
3073 {not in Vi}
3074 {not available when compiled without the |+folding|
3075 feature}
3076 When set to "all", a fold is closed when the cursor isn't in it and
3077 its level is higher than 'foldlevel'. Useful if you want folds to
3078 automatically close when moving out of them.
3079
3080 *'foldcolumn'* *'fdc'*
3081'foldcolumn' 'fdc' number (default 0)
3082 local to window
3083 {not in Vi}
3084 {not available when compiled without the |+folding|
3085 feature}
3086 When non-zero, a column with the specified width is shown at the side
3087 of the window which indicates open and closed folds. The maximum
3088 value is 12.
3089 See |folding|.
3090
3091 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3092'foldenable' 'fen' boolean (default on)
3093 local to window
3094 {not in Vi}
3095 {not available when compiled without the |+folding|
3096 feature}
3097 When off, all folds are open. This option can be used to quickly
3098 switch between showing all text unfolded and viewing the text with
3099 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003100 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 'foldenable' is off.
3102 This option is set by commands that create a new fold or close a fold.
3103 See |folding|.
3104
3105 *'foldexpr'* *'fde'*
3106'foldexpr' 'fde' string (default: "0")
3107 local to window
3108 {not in Vi}
3109 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003110 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003112 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003113
Bram Moolenaar30b65812012-07-12 22:01:11 +02003114 The expression will be evaluated in the |sandbox| if set from a
3115 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003116 This option can't be set from a |modeline| when the 'diff' option is
3117 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003118
3119 It is not allowed to change text or jump to another window while
3120 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121
3122 *'foldignore'* *'fdi'*
3123'foldignore' 'fdi' string (default: "#")
3124 local to window
3125 {not in Vi}
3126 {not available when compiled without the |+folding|
3127 feature}
3128 Used only when 'foldmethod' is "indent". Lines starting with
3129 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003130 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 The default "#" works well for C programs. See |fold-indent|.
3132
3133 *'foldlevel'* *'fdl'*
3134'foldlevel' 'fdl' number (default: 0)
3135 local to window
3136 {not in Vi}
3137 {not available when compiled without the |+folding|
3138 feature}
3139 Sets the fold level: Folds with a higher level will be closed.
3140 Setting this option to zero will close all folds. Higher numbers will
3141 close fewer folds.
3142 This option is set by commands like |zm|, |zM| and |zR|.
3143 See |fold-foldlevel|.
3144
3145 *'foldlevelstart'* *'fdls'*
3146'foldlevelstart' 'fdls' number (default: -1)
3147 global
3148 {not in Vi}
3149 {not available when compiled without the |+folding|
3150 feature}
3151 Sets 'foldlevel' when starting to edit another buffer in a window.
3152 Useful to always start editing with all folds closed (value zero),
3153 some folds closed (one) or no folds closed (99).
3154 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003155 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 ignores this option and closes all folds.
3157 It is also done before BufReadPre autocommands, to allow an autocmd to
3158 overrule the 'foldlevel' value for specific files.
3159 When the value is negative, it is not used.
3160
3161 *'foldmarker'* *'fmr'* *E536*
3162'foldmarker' 'fmr' string (default: "{{{,}}}")
3163 local to window
3164 {not in Vi}
3165 {not available when compiled without the |+folding|
3166 feature}
3167 The start and end marker used when 'foldmethod' is "marker". There
3168 must be one comma, which separates the start and end marker. The
3169 marker is a literal string (a regular expression would be too slow).
3170 See |fold-marker|.
3171
3172 *'foldmethod'* *'fdm'*
3173'foldmethod' 'fdm' string (default: "manual")
3174 local to window
3175 {not in Vi}
3176 {not available when compiled without the |+folding|
3177 feature}
3178 The kind of folding used for the current window. Possible values:
3179 |fold-manual| manual Folds are created manually.
3180 |fold-indent| indent Lines with equal indent form a fold.
3181 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3182 |fold-marker| marker Markers are used to specify folds.
3183 |fold-syntax| syntax Syntax highlighting items specify folds.
3184 |fold-diff| diff Fold text that is not changed.
3185
3186 *'foldminlines'* *'fml'*
3187'foldminlines' 'fml' number (default: 1)
3188 local to window
3189 {not in Vi}
3190 {not available when compiled without the |+folding|
3191 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003192 Sets the number of screen lines above which a fold can be displayed
3193 closed. Also for manually closed folds. With the default value of
3194 one a fold can only be closed if it takes up two or more screen lines.
3195 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003196 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 "zc" to close a fold, which is displayed open because it's smaller
3198 than 'foldminlines', a following "zc" may close a containing fold.
3199
3200 *'foldnestmax'* *'fdn'*
3201'foldnestmax' 'fdn' number (default: 20)
3202 local to window
3203 {not in Vi}
3204 {not available when compiled without the |+folding|
3205 feature}
3206 Sets the maximum nesting of folds for the "indent" and "syntax"
3207 methods. This avoids that too many folds will be created. Using more
3208 than 20 doesn't work, because the internal limit is 20.
3209
3210 *'foldopen'* *'fdo'*
3211'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3212 search,tag,undo")
3213 global
3214 {not in Vi}
3215 {not available when compiled without the |+folding|
3216 feature}
3217 Specifies for which type of commands folds will be opened, if the
3218 command moves the cursor into a closed fold. It is a comma separated
3219 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003220 NOTE: When the command is part of a mapping this option is not used.
3221 Add the |zv| command to the mapping to get the same effect.
3222 (rationale: the mapping may want to control opening folds itself)
3223
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 item commands ~
3225 all any
3226 block "(", "{", "[[", "[{", etc.
3227 hor horizontal movements: "l", "w", "fx", etc.
3228 insert any command in Insert mode
3229 jump far jumps: "G", "gg", etc.
3230 mark jumping to a mark: "'m", CTRL-O, etc.
3231 percent "%"
3232 quickfix ":cn", ":crew", ":make", etc.
3233 search search for a pattern: "/", "n", "*", "gd", etc.
3234 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003235 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 tag jumping to a tag: ":ta", CTRL-T, etc.
3237 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 When a movement command is used for an operator (e.g., "dl" or "y%")
3239 this option is not used. This means the operator will include the
3240 whole closed fold.
3241 Note that vertical movements are not here, because it would make it
3242 very difficult to move onto a closed fold.
3243 In insert mode the folds containing the cursor will always be open
3244 when text is inserted.
3245 To close folds you can re-apply 'foldlevel' with the |zx| command or
3246 set the 'foldclose' option to "all".
3247
3248 *'foldtext'* *'fdt'*
3249'foldtext' 'fdt' string (default: "foldtext()")
3250 local to window
3251 {not in Vi}
3252 {not available when compiled without the |+folding|
3253 feature}
3254 An expression which is used to specify the text displayed for a closed
3255 fold. See |fold-foldtext|.
3256
Bram Moolenaar30b65812012-07-12 22:01:11 +02003257 The expression will be evaluated in the |sandbox| if set from a
3258 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003259
3260 It is not allowed to change text or jump to another window while
3261 evaluating 'foldtext' |textlock|.
3262
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 *'formatoptions'* *'fo'*
3264'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3265 local to buffer
3266 {not in Vi}
3267 This is a sequence of letters which describes how automatic
3268 formatting is to be done. See |fo-table|. When the 'paste' option is
3269 on, no formatting is done (like 'formatoptions' is empty). Commas can
3270 be inserted for readability.
3271 To avoid problems with flags that are added in the future, use the
3272 "+=" and "-=" feature of ":set" |add-option-flags|.
3273 NOTE: This option is set to the Vi default value when 'compatible' is
3274 set and to the Vim default value when 'compatible' is reset.
3275
Bram Moolenaar86b68352004-12-27 21:59:20 +00003276 *'formatlistpat'* *'flp'*
3277'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3278 local to buffer
3279 {not in Vi}
3280 A pattern that is used to recognize a list header. This is used for
3281 the "n" flag in 'formatoptions'.
3282 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003283 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003284 while still checking more characters. There must be a character
3285 following the pattern, when it matches the whole line it is handled
3286 like there is no match.
3287 The default recognizes a number, followed by an optional punctuation
3288 character and white space.
3289
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 *'formatprg'* *'fp'*
3291'formatprg' 'fp' string (default "")
3292 global
3293 {not in Vi}
3294 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003295 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003297 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003298 If the 'formatexpr' option is not empty it will be used instead.
3299 Otherwise, if 'formatprg' option is an empty string, the internal
3300 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003301 Environment variables are expanded |:set_env|. See |option-backslash|
3302 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003303 This option cannot be set from a |modeline| or in the |sandbox|, for
3304 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003306 *'formatexpr'* *'fex'*
3307'formatexpr' 'fex' string (default "")
3308 local to buffer
3309 {not in Vi}
3310 {not available when compiled without the |+eval|
3311 feature}
3312 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003313 operator or automatic formatting (see 'formatoptions'). When this
3314 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003315
3316 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003317 The |v:count| variable holds the number of lines to be formatted.
3318 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003319 inserted if the expression is being evaluated due to
3320 automatic formatting. This can be empty. Don't insert
3321 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003322
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003323 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003324 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003325< This will invoke the mylang#Format() function in the
3326 autoload/mylang.vim file in 'runtimepath'. |autoload|
3327
3328 The expression is also evaluated when 'textwidth' is set and adding
3329 text beyond that limit. This happens under the same conditions as
3330 when internal formatting is used. Make sure the cursor is kept in the
3331 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003332 return "i" or "R" in this situation.
3333
3334 When the expression evaluates to non-zero Vim will fall back to using
3335 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003336
Bram Moolenaar30b65812012-07-12 22:01:11 +02003337 The expression will be evaluated in the |sandbox| when set from a
3338 modeline, see |sandbox-option|. That stops the option from working,
3339 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003340
3341 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003342'fsync' 'fs' boolean (default on)
3343 global
3344 {not in Vi}
3345 When on, the library function fsync() will be called after writing a
3346 file. This will flush a file to disk, ensuring that it is safely
3347 written even on filesystems which do metadata-only journaling. This
3348 will force the harddrive to spin up on Linux systems running in laptop
3349 mode, so it may be undesirable in some situations. Be warned that
3350 turning this off increases the chances of data loss after a crash. On
3351 systems without an fsync() implementation, this variable is always
3352 off.
3353 Also see 'swapsync' for controlling fsync() on swap files.
3354
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3356'gdefault' 'gd' boolean (default off)
3357 global
3358 {not in Vi}
3359 When on, the ":substitute" flag 'g' is default on. This means that
3360 all matches in a line are substituted instead of one. When a 'g' flag
3361 is given to a ":substitute" command, this will toggle the substitution
3362 of all or one match. See |complex-change|.
3363
3364 command 'gdefault' on 'gdefault' off ~
3365 :s/// subst. all subst. one
3366 :s///g subst. one subst. all
3367 :s///gg subst. all subst. one
3368
3369 NOTE: This option is reset when 'compatible' is set.
3370
3371 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003372'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 global
3374 {not in Vi}
3375 Format to recognize for the ":grep" command output.
3376 This is a scanf-like string that uses the same format as the
3377 'errorformat' option: see |errorformat|.
3378
3379 *'grepprg'* *'gp'*
3380'grepprg' 'gp' string (default "grep -n ",
3381 Unix: "grep -n $* /dev/null",
3382 Win32: "findstr /n" or "grep -n",
3383 VMS: "SEARCH/NUMBERS ")
3384 global or local to buffer |global-local|
3385 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003386 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 and '#' characters, which are expanded like when used in a command-
3388 line. The placeholder "$*" is allowed to specify where the arguments
3389 will be included. Environment variables are expanded |:set_env|. See
3390 |option-backslash| about including spaces and backslashes.
3391 When your "grep" accepts the "-H" argument, use this to make ":grep"
3392 also work well with a single file: >
3393 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003394< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003395 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3396 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003397 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 apply equally to 'grepprg'.
3399 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3400 otherwise it's "grep -n".
3401 This option cannot be set from a |modeline| or in the |sandbox|, for
3402 security reasons.
3403
3404 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3405'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3406 ve:ver35-Cursor,
3407 o:hor50-Cursor,
3408 i-ci:ver25-Cursor/lCursor,
3409 r-cr:hor20-Cursor/lCursor,
3410 sm:block-Cursor
3411 -blinkwait175-blinkoff150-blinkon175",
3412 for MS-DOS and Win32 console:
3413 "n-v-c:block,o:hor50,i-ci:hor15,
3414 r-cr:hor30,sm:block")
3415 global
3416 {not in Vi}
3417 {only available when compiled with GUI enabled, and
3418 for MS-DOS and Win32 console}
3419 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003420 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 the height of the cursor can be changed. This can be done by
3422 specifying a block cursor, or a percentage for a vertical or
3423 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003424 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003426 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 mode-list and an argument-list:
3428 mode-list:argument-list,mode-list:argument-list,..
3429 The mode-list is a dash separated list of these modes:
3430 n Normal mode
3431 v Visual mode
3432 ve Visual mode with 'selection' "exclusive" (same as 'v',
3433 if not specified)
3434 o Operator-pending mode
3435 i Insert mode
3436 r Replace mode
3437 c Command-line Normal (append) mode
3438 ci Command-line Insert mode
3439 cr Command-line Replace mode
3440 sm showmatch in Insert mode
3441 a all modes
3442 The argument-list is a dash separated list of these arguments:
3443 hor{N} horizontal bar, {N} percent of the character height
3444 ver{N} vertical bar, {N} percent of the character width
3445 block block cursor, fills the whole character
3446 [only one of the above three should be present]
3447 blinkwait{N} *cursor-blinking*
3448 blinkon{N}
3449 blinkoff{N}
3450 blink times for cursor: blinkwait is the delay before
3451 the cursor starts blinking, blinkon is the time that
3452 the cursor is shown and blinkoff is the time that the
3453 cursor is not shown. The times are in msec. When one
3454 of the numbers is zero, there is no blinking. The
3455 default is: "blinkwait700-blinkon400-blinkoff250".
3456 These numbers are used for a missing entry. This
3457 means that blinking is enabled by default. To switch
3458 blinking off you can use "blinkon0". The cursor only
3459 blinks when Vim is waiting for input, not while
3460 executing a command.
3461 To make the cursor blink in an xterm, see
3462 |xterm-blink|.
3463 {group-name}
3464 a highlight group name, that sets the color and font
3465 for the cursor
3466 {group-name}/{group-name}
3467 Two highlight group names, the first is used when
3468 no language mappings are used, the other when they
3469 are. |language-mapping|
3470
3471 Examples of parts:
3472 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3473 block cursor with colors from the "nCursor"
3474 highlight group
3475 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3476 In Insert and Command-line Insert mode, use a
3477 30% vertical bar cursor with colors from the
3478 "iCursor" highlight group. Blink a bit
3479 faster.
3480
3481 The 'a' mode is different. It will set the given argument-list for
3482 all modes. It does not reset anything to defaults. This can be used
3483 to do a common setting for all modes. For example, to switch off
3484 blinking: "a:blinkon0"
3485
3486 Examples of cursor highlighting: >
3487 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3488 :highlight Cursor gui=NONE guifg=bg guibg=fg
3489<
3490 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003491 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492'guifont' 'gfn' string (default "")
3493 global
3494 {not in Vi}
3495 {only available when compiled with GUI enabled}
3496 This is a list of fonts which will be used for the GUI version of Vim.
3497 In its simplest form the value is just one font name. When
3498 the font cannot be found you will get an error message. To try other
3499 font names a list can be specified, font names separated with commas.
3500 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003501
Bram Moolenaar05159a02005-02-26 23:04:13 +00003502 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3503 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003504
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 Spaces after a comma are ignored. To include a comma in a font name
3506 precede it with a backslash. Setting an option requires an extra
3507 backslash before a space and a backslash. See also
3508 |option-backslash|. For example: >
3509 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003510< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003512
3513 If none of the fonts can be loaded, Vim will keep the current setting.
3514 If an empty font list is given, Vim will try using other resource
3515 settings (for X, it will use the Vim.font resource), and finally it
3516 will try some builtin default which should always be there ("7x13" in
3517 the case of X). The font names given should be "normal" fonts. Vim
3518 will try to find the related bold and italic fonts.
3519
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003520 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003521 :set guifont=*
3522< will bring up a font requester, where you can pick the font you want.
3523
3524 The font name depends on the GUI used. See |setting-guifont| for a
3525 way to set 'guifont' for various systems.
3526
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 For the GTK+ 2 GUI the font name looks like this: >
3528 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003529< That's all. XLFDs are not used. For Chinese this is reported to work
3530 well: >
3531 if has("gui_gtk2")
3532 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3533 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3534 endif
3535<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003536 For Mac OSX you can use something like this: >
3537 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003538< Also see 'macatsui', it can help fix display problems.
3539 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003541 width). An exception is GTK 2: all fonts are accepted, but
3542 mono-spaced fonts look best.
3543
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 To preview a font on X11, you might be able to use the "xfontsel"
3545 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003546
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 For the Win32 GUI *E244* *E245*
3548 - takes these options in the font name:
3549 hXX - height is XX (points, can be floating-point)
3550 wXX - width is XX (points, can be floating-point)
3551 b - bold
3552 i - italic
3553 u - underline
3554 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003555 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3557 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3558 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003559 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 Use a ':' to separate the options.
3562 - A '_' can be used in the place of a space, so you don't need to use
3563 backslashes to escape the spaces.
3564 - Examples: >
3565 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3566 :set guifont=Andale_Mono:h7.5:w4.5
3567< See also |font-sizes|.
3568
3569 *'guifontset'* *'gfs'*
3570 *E250* *E252* *E234* *E597* *E598*
3571'guifontset' 'gfs' string (default "")
3572 global
3573 {not in Vi}
3574 {only available when compiled with GUI enabled and
3575 with the |+xfontset| feature}
3576 {not available in the GTK+ 2 GUI}
3577 When not empty, specifies two (or more) fonts to be used. The first
3578 one for normal English, the second one for your special language. See
3579 |xfontset|.
3580 Setting this option also means that all font names will be handled as
3581 a fontset name. Also the ones used for the "font" argument of the
3582 |:highlight| command.
3583 The fonts must match with the current locale. If fonts for the
3584 character sets that the current locale uses are not included, setting
3585 'guifontset' will fail.
3586 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3587 the comma-separated names are alternative names, one of which will be
3588 used. In 'guifontset' the whole string is one fontset name,
3589 including the commas. It is not possible to specify alternative
3590 fontset names.
3591 This example works on many X11 systems: >
3592 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3593<
3594 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3595'guifontwide' 'gfw' string (default "")
3596 global
3597 {not in Vi}
3598 {only available when compiled with GUI enabled}
3599 When not empty, specifies a comma-separated list of fonts to be used
3600 for double-width characters. The first font that can be loaded is
3601 used.
3602 Note: The size of these fonts must be exactly twice as wide as the one
3603 specified with 'guifont' and the same height.
3604
3605 All GUI versions but GTK+ 2:
3606
3607 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3608 'guifontset' is empty or invalid.
3609 When 'guifont' is set and a valid font is found in it and
3610 'guifontwide' is empty Vim will attempt to find a matching
3611 double-width font and set 'guifontwide' to it.
3612
3613 GTK+ 2 GUI only: *guifontwide_gtk2*
3614
3615 If set and valid, 'guifontwide' is always used for double width
3616 characters, even if 'encoding' is not set to "utf-8".
3617 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003618 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 font for characters not available in 'guifont'. Thus you do not need
3620 to set 'guifontwide' at all unless you want to override the choice
3621 made by Pango/Xft.
3622
Bram Moolenaar0f272122013-01-23 18:37:40 +01003623 Windows +multibyte only: *guifontwide_win_mbyte*
3624
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003625 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003626
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 *'guiheadroom'* *'ghr'*
3628'guiheadroom' 'ghr' number (default 50)
3629 global
3630 {not in Vi} {only for GTK and X11 GUI}
3631 The number of pixels subtracted from the screen height when fitting
3632 the GUI window on the screen. Set this before the GUI is started,
3633 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003634 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 lines will be left for window decorations and other items on the
3636 screen. Set it to a negative value to allow windows taller than the
3637 screen.
3638
3639 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003640'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3641 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 global
3643 {not in Vi}
3644 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003645 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 sequence of letters which describes what components and options of the
3647 GUI should be used.
3648 To avoid problems with flags that are added in the future, use the
3649 "+=" and "-=" feature of ":set" |add-option-flags|.
3650
3651 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003652 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'a' Autoselect: If present, then whenever VISUAL mode is started,
3654 or the Visual area extended, Vim tries to become the owner of
3655 the windowing system's global selection. This means that the
3656 Visually highlighted text is available for pasting into other
3657 applications as well as into Vim itself. When the Visual mode
3658 ends, possibly due to an operation on the text, or when an
3659 application wants to paste the selection, the highlighted text
3660 is automatically yanked into the "* selection register.
3661 Thus the selection is still available for pasting into other
3662 applications after the VISUAL mode has ended.
3663 If not present, then Vim won't become the owner of the
3664 windowing system's global selection unless explicitly told to
3665 by a yank or delete operation for the "* register.
3666 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003667 *'go-P'*
3668 'P' Like autoselect but using the "+ register instead of the "*
3669 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003670 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003671 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 applies to the modeless selection.
3673
3674 'guioptions' autoselect Visual autoselect modeless ~
3675 "" - -
3676 "a" yes yes
3677 "A" - yes
3678 "aA" yes yes
3679
Bram Moolenaar02467872007-05-06 13:22:01 +00003680 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 'c' Use console dialogs instead of popup dialogs for simple
3682 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003683 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003684 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003685 'guitablabel' can be used to change the text in the labels.
3686 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003687 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003688 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003689 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 'f' Foreground: Don't use fork() to detach the GUI from the shell
3691 where it was started. Use this for programs that wait for the
3692 editor to finish (e.g., an e-mail program). Alternatively you
3693 can use "gvim -f" or ":gui -f" to start the GUI in the
3694 foreground. |gui-fork|
3695 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003696 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003697 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3699 corner of the window. It's black&white on non-GTK, because of
3700 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003701 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003703 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003704 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003706 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 file is sourced the system menu has already been loaded; the
3708 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003709 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 'g' Grey menu items: Make menu items that are not active grey. If
3711 'g' is not included inactive menu items are not shown at all.
3712 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003713 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 't' Include tearoff menu items. Currently only works for Win32,
3715 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003716 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003717 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003718 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003719 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003721 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 'R' Right-hand scrollbar is present when there is a vertically
3723 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003724 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003726 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 'L' Left-hand scrollbar is present when there is a vertically
3728 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003729 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3731 the longest visible line, or on the cursor line if the 'h'
3732 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003733 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 'h' Limit horizontal scrollbar size to the length of the cursor
3735 line. Reduces computations. |gui-horiz-scroll|
3736
3737 And yes, you may even have scrollbars on the left AND the right if
3738 you really want to :-). See |gui-scrollbars| for more information.
3739
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003740 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 'v' Use a vertical button layout for dialogs. When not included,
3742 a horizontal layout is preferred, but when it doesn't fit a
3743 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003744 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 'p' Use Pointer callbacks for X11 GUI. This is required for some
3746 window managers. If the cursor is not blinking or hollow at
3747 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003748 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003750 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003751 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752
Bram Moolenaar02467872007-05-06 13:22:01 +00003753
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754 *'guipty'* *'noguipty'*
3755'guipty' boolean (default on)
3756 global
3757 {not in Vi}
3758 {only available when compiled with GUI enabled}
3759 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3760 I/O to/from shell commands. See |gui-pty|.
3761
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003762 *'guitablabel'* *'gtl'*
3763'guitablabel' 'gtl' string (default empty)
3764 global
3765 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003766 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003767 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003768 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003769 pages line. When empty and when the result is empty Vim will use a
3770 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003771
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003772 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003773 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003774
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003775 Only used when the GUI tab pages line is displayed. 'e' must be
3776 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3777 used.
3778
Bram Moolenaar57657d82006-04-21 22:12:41 +00003779 *'guitabtooltip'* *'gtt'*
3780'guitabtooltip' 'gtt' string (default empty)
3781 global
3782 {not in Vi}
3783 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003784 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003785 When nonempty describes the text to use in a tooltip for the GUI tab
3786 pages line. When empty Vim will use a default tooltip.
3787 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003788 You can include a line break. Simplest method is to use |:let|: >
3789 :let &guitabtooltip = "line one\nline two"
3790<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003791
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 *'helpfile'* *'hf'*
3793'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3794 (others) "$VIMRUNTIME/doc/help.txt")
3795 global
3796 {not in Vi}
3797 Name of the main help file. All distributed help files should be
3798 placed together in one directory. Additionally, all "doc" directories
3799 in 'runtimepath' will be used.
3800 Environment variables are expanded |:set_env|. For example:
3801 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003802 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 spaces and backslashes.
3804 This option cannot be set from a |modeline| or in the |sandbox|, for
3805 security reasons.
3806
3807 *'helpheight'* *'hh'*
3808'helpheight' 'hh' number (default 20)
3809 global
3810 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003811 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 feature}
3813 Minimal initial height of the help window when it is opened with the
3814 ":help" command. The initial height of the help window is half of the
3815 current window, or (when the 'ea' option is on) the same as other
3816 windows. When the height is less than 'helpheight', the height is
3817 set to 'helpheight'. Set to zero to disable.
3818
3819 *'helplang'* *'hlg'*
3820'helplang' 'hlg' string (default: messages language or empty)
3821 global
3822 {only available when compiled with the |+multi_lang|
3823 feature}
3824 {not in Vi}
3825 Comma separated list of languages. Vim will use the first language
3826 for which the desired help can be found. The English help will always
3827 be used as a last resort. You can add "en" to prefer English over
3828 another language, but that will only find tags that exist in that
3829 language and not in the English help.
3830 Example: >
3831 :set helplang=de,it
3832< This will first search German, then Italian and finally English help
3833 files.
3834 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3835 try to find the tag in the current language before using this option.
3836 See |help-translated|.
3837
3838 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3839'hidden' 'hid' boolean (default off)
3840 global
3841 {not in Vi}
3842 When off a buffer is unloaded when it is |abandon|ed. When on a
3843 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3844 displayed in another window, it does not become hidden, of course.
3845 The commands that move through the buffer list sometimes make a buffer
3846 hidden although the 'hidden' option is off: When the buffer is
3847 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003848 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003849 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 This option is set for one command with ":hide {command}" |:hide|.
3851 WARNING: It's easy to forget that you have changes in hidden buffers.
3852 Think twice when using ":q!" or ":qa!".
3853
3854 *'highlight'* *'hl'*
3855'highlight' 'hl' string (default (as a single string):
3856 "8:SpecialKey,@:NonText,d:Directory,
3857 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003858 M:ModeMsg,n:LineNr,N:CursorLineNr,
3859 r:Question,s:StatusLine,S:StatusLineNC,
3860 c:VertSplit, t:Title,v:Visual,
3861 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862 f:Folded,F:FoldColumn,A:DiffAdd,
3863 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003864 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003865 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003866 +:Pmenu,=:PmenuSel,
3867 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 global
3869 {not in Vi}
3870 This option can be used to set highlighting mode for various
3871 occasions. It is a comma separated list of character pairs. The
3872 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003873 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3875 |hl-NonText| @ '~' and '@' at the end of the window and
3876 characters from 'showbreak'
3877 |hl-Directory| d directories in CTRL-D listing and other special
3878 things in listings
3879 |hl-ErrorMsg| e error messages
3880 h (obsolete, ignored)
3881 |hl-IncSearch| i 'incsearch' highlighting
3882 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3883 |hl-MoreMsg| m |more-prompt|
3884 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003885 |hl-LineNr| n line number for ":number" and ":#" commands, and
3886 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003887 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3888 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 |hl-Question| r |hit-enter| prompt and yes/no questions
3890 |hl-StatusLine| s status line of current window |status-line|
3891 |hl-StatusLineNC| S status lines of not-current windows
3892 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3893 |hl-VertSplit| c column used to separate vertically split windows
3894 |hl-Visual| v Visual mode
3895 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3896 Selection" Only X11 Gui's |gui-x11| and
3897 |xterm-clipboard|.
3898 |hl-WarningMsg| w warning messages
3899 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3900 |hl-Folded| f line used for closed folds
3901 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003902 |hl-DiffAdd| A added line in diff mode
3903 |hl-DiffChange| C changed line in diff mode
3904 |hl-DiffDelete| D deleted line in diff mode
3905 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003907 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003908 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003909 |hl-SpellRare| R rare word |spell|
3910 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003911 |hl-Conceal| - the placeholders used for concealed characters
3912 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003913 |hl-Pmenu| + popup menu normal line
3914 |hl-PmenuSel| = popup menu normal line
3915 |hl-PmenuSbar| x popup menu scrollbar
3916 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917
3918 The display modes are:
3919 r reverse (termcap entry "mr" and "me")
3920 i italic (termcap entry "ZH" and "ZR")
3921 b bold (termcap entry "md" and "me")
3922 s standout (termcap entry "so" and "se")
3923 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003924 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 n no highlighting
3926 - no highlighting
3927 : use a highlight group
3928 The default is used for occasions that are not included.
3929 If you want to change what the display modes do, see |dos-colors|
3930 for an example.
3931 When using the ':' display mode, this must be followed by the name of
3932 a highlight group. A highlight group can be used to define any type
3933 of highlighting, including using color. See |:highlight| on how to
3934 define one. The default uses a different group for each occasion.
3935 See |highlight-default| for the default highlight groups.
3936
3937 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3938'hlsearch' 'hls' boolean (default off)
3939 global
3940 {not in Vi}
3941 {not available when compiled without the
3942 |+extra_search| feature}
3943 When there is a previous search pattern, highlight all its matches.
3944 The type of highlighting used can be set with the 'l' occasion in the
3945 'highlight' option. This uses the "Search" highlight group by
3946 default. Note that only the matching text is highlighted, any offsets
3947 are not applied.
3948 See also: 'incsearch' and |:match|.
3949 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003950 off with |:nohlsearch|. This does not change the option value, as
3951 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003952 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 When the search pattern can match an end-of-line, Vim will try to
3954 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003955 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003957 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003958 You can specify whether the highlight status is restored on startup
3959 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 NOTE: This option is reset when 'compatible' is set.
3961
3962 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003963'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 global
3965 {not in Vi}
3966 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003967 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003969 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 NOTE: This option is set to the Vi default value when 'compatible' is
3971 set and to the Vim default value when 'compatible' is reset.
3972
3973 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3974'hkmap' 'hk' boolean (default off)
3975 global
3976 {not in Vi}
3977 {only available when compiled with the |+rightleft|
3978 feature}
3979 When on, the keyboard is mapped for the Hebrew character set.
3980 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3981 toggle this option. See |rileft.txt|.
3982 NOTE: This option is reset when 'compatible' is set.
3983
3984 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3985'hkmapp' 'hkp' boolean (default off)
3986 global
3987 {not in Vi}
3988 {only available when compiled with the |+rightleft|
3989 feature}
3990 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3991 This is useful if you have a non-Hebrew keyboard.
3992 See |rileft.txt|.
3993 NOTE: This option is reset when 'compatible' is set.
3994
3995 *'icon'* *'noicon'*
3996'icon' boolean (default off, on when title can be restored)
3997 global
3998 {not in Vi}
3999 {not available when compiled without the |+title|
4000 feature}
4001 When on, the icon text of the window will be set to the value of
4002 'iconstring' (if it is not empty), or to the name of the file
4003 currently being edited. Only the last part of the name is used.
4004 Overridden by the 'iconstring' option.
4005 Only works if the terminal supports setting window icons (currently
4006 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4007 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4008 builtin termcap).
4009 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004010 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004012 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013
4014 *'iconstring'*
4015'iconstring' string (default "")
4016 global
4017 {not in Vi}
4018 {not available when compiled without the |+title|
4019 feature}
4020 When this option is not empty, it will be used for the icon text of
4021 the window. This happens only when the 'icon' option is on.
4022 Only works if the terminal supports setting window icon text
4023 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4024 Does not work for MS Windows.
4025 When Vim was compiled with HAVE_X11 defined, the original icon will be
4026 restored if possible |X11|.
4027 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004028 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 'titlestring' for example settings.
4030 {not available when compiled without the |+statusline| feature}
4031
4032 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4033'ignorecase' 'ic' boolean (default off)
4034 global
4035 Ignore case in search patterns. Also used when searching in the tags
4036 file.
4037 Also see 'smartcase'.
4038 Can be overruled by using "\c" or "\C" in the pattern, see
4039 |/ignorecase|.
4040
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004041 *'imactivatefunc'* *'imaf'*
4042'imactivatefunc' 'imaf' string (default "")
4043 global
4044 {not in Vi}
4045 {only available when compiled with |+xim| and
4046 |+GUI_GTK|}
4047 This option specifies a function that will be called to
4048 activate/inactivate Input Method.
4049
4050 Example: >
4051 function ImActivateFunc(active)
4052 if a:active
4053 ... do something
4054 else
4055 ... do something
4056 endif
4057 " return value is not used
4058 endfunction
4059 set imactivatefunc=ImActivateFunc
4060<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 *'imactivatekey'* *'imak'*
4062'imactivatekey' 'imak' string (default "")
4063 global
4064 {not in Vi}
4065 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004066 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 Specifies the key that your Input Method in X-Windows uses for
4068 activation. When this is specified correctly, vim can fully control
4069 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4070 You can't use this option to change the activation key, the option
4071 tells Vim what the key is.
4072 Format:
4073 [MODIFIER_FLAG-]KEY_STRING
4074
4075 These characters can be used for MODIFIER_FLAG (case is ignored):
4076 S Shift key
4077 L Lock key
4078 C Control key
4079 1 Mod1 key
4080 2 Mod2 key
4081 3 Mod3 key
4082 4 Mod4 key
4083 5 Mod5 key
4084 Combinations are allowed, for example "S-C-space" or "SC-space" are
4085 both shift+ctrl+space.
4086 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4087
4088 Example: >
4089 :set imactivatekey=S-space
4090< "S-space" means shift+space. This is the activation key for kinput2 +
4091 canna (Japanese), and ami (Korean).
4092
4093 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4094'imcmdline' 'imc' boolean (default off)
4095 global
4096 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004097 {only available when compiled with the |+xim|,
4098 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 When set the Input Method is always on when starting to edit a command
4100 line, unless entering a search pattern (see 'imsearch' for that).
4101 Setting this option is useful when your input method allows entering
4102 English characters directly, e.g., when it's used to type accented
4103 characters with dead keys.
4104
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004105 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4107 global
4108 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004109 {only available when compiled with the |+xim|,
4110 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 When set the Input Method is never used. This is useful to disable
4112 the IM when it doesn't work properly.
4113 Currently this option is on by default for SGI/IRIX machines. This
4114 may change in later releases.
4115
4116 *'iminsert'* *'imi'*
4117'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4118 local to buffer
4119 {not in Vi}
4120 Specifies whether :lmap or an Input Method (IM) is to be used in
4121 Insert mode. Valid values:
4122 0 :lmap is off and IM is off
4123 1 :lmap is ON and IM is off
4124 2 :lmap is off and IM is ON
4125 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4126 or |global-ime|.
4127 To always reset the option to zero when leaving Insert mode with <Esc>
4128 this can be used: >
4129 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4130< This makes :lmap and IM turn off automatically when leaving Insert
4131 mode.
4132 Note that this option changes when using CTRL-^ in Insert mode
4133 |i_CTRL-^|.
4134 The value is set to 1 when setting 'keymap' to a valid keymap name.
4135 It is also used for the argument of commands like "r" and "f".
4136 The value 0 may not work correctly with Athena and Motif with some XIM
4137 methods. Use 'imdisable' to disable XIM then.
4138
4139 *'imsearch'* *'ims'*
4140'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4141 local to buffer
4142 {not in Vi}
4143 Specifies whether :lmap or an Input Method (IM) is to be used when
4144 entering a search pattern. Valid values:
4145 -1 the value of 'iminsert' is used, makes it look like
4146 'iminsert' is also used when typing a search pattern
4147 0 :lmap is off and IM is off
4148 1 :lmap is ON and IM is off
4149 2 :lmap is off and IM is ON
4150 Note that this option changes when using CTRL-^ in Command-line mode
4151 |c_CTRL-^|.
4152 The value is set to 1 when it is not -1 and setting the 'keymap'
4153 option to a valid keymap name.
4154 The value 0 may not work correctly with Athena and Motif with some XIM
4155 methods. Use 'imdisable' to disable XIM then.
4156
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004157 *'imstatusfunc'* *'imsf'*
4158'imstatusfunc' 'imsf' string (default "")
4159 global
4160 {not in Vi}
4161 {only available when compiled with |+xim| and
4162 |+GUI_GTK|}
4163 This option specifies a function that is called to obtain the status
4164 of Input Method. It must return a positive number when IME is active.
4165
4166 Example: >
4167 function ImStatusFunc()
4168 let is_active = ...do something
4169 return is_active ? 1 : 0
4170 endfunction
4171 set imstatusfunc=ImStatusFunc
4172<
4173 NOTE: This function is invoked very often. Keep it fast.
4174
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 *'include'* *'inc'*
4176'include' 'inc' string (default "^\s*#\s*include")
4177 global or local to buffer |global-local|
4178 {not in Vi}
4179 {not available when compiled without the
4180 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004181 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 pattern, just like for the "/" command (See |pattern|). The default
4183 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004184 "]I", "[d", etc.
4185 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004186 comes after the matched pattern. But if "\zs" appears in the pattern
4187 then the text matched from "\zs" to the end, or until "\ze" if it
4188 appears, is used as the file name. Use this to include characters
4189 that are not in 'isfname', such as a space. You can then use
4190 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004191 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192
4193 *'includeexpr'* *'inex'*
4194'includeexpr' 'inex' string (default "")
4195 local to buffer
4196 {not in Vi}
4197 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004198 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004200 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 :set includeexpr=substitute(v:fname,'\\.','/','g')
4202< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004203
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004205 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 Also used for |<cfile>|.
4207
Bram Moolenaar30b65812012-07-12 22:01:11 +02004208 The expression will be evaluated in the |sandbox| when set from a
4209 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004210
4211 It is not allowed to change text or jump to another window while
4212 evaluating 'includeexpr' |textlock|.
4213
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4215'incsearch' 'is' boolean (default off)
4216 global
4217 {not in Vi}
4218 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004219 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004220 While typing a search command, show where the pattern, as it was typed
4221 so far, matches. The matched string is highlighted. If the pattern
4222 is invalid or not found, nothing is shown. The screen will be updated
4223 often, this is only useful on fast terminals.
4224 Note that the match will be shown, but the cursor will return to its
4225 original position when no match is found and when pressing <Esc>. You
4226 still need to finish the search command with <Enter> to move the
4227 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004228 When compiled with the |+reltime| feature Vim only searches for about
4229 half a second. With a complicated pattern and/or a lot of text the
4230 match may not be found. This is to avoid that Vim hangs while you
4231 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004232 The highlighting can be set with the 'i' flag in 'highlight'.
4233 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004234 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004235 to the command line. If 'ignorecase' and 'smartcase' are set and the
4236 command line has no uppercase characters, the added character is
4237 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004238 CTRL-R CTRL-W can be used to add the word at the end of the current
4239 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 NOTE: This option is reset when 'compatible' is set.
4241
4242 *'indentexpr'* *'inde'*
4243'indentexpr' 'inde' string (default "")
4244 local to buffer
4245 {not in Vi}
4246 {not available when compiled without the |+cindent|
4247 or |+eval| features}
4248 Expression which is evaluated to obtain the proper indent for a line.
4249 It is used when a new line is created, for the |=| operator and
4250 in Insert mode as specified with the 'indentkeys' option.
4251 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004252 'smartindent' indenting. When 'lisp' is set, this option is
4253 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 When 'paste' is set this option is not used for indenting.
4255 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004256 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 when the expression is evaluated (but it may be moved around).
4258 The expression must return the number of spaces worth of indent. It
4259 can return "-1" to keep the current indent (this means 'autoindent' is
4260 used for the indent).
4261 Functions useful for computing the indent are |indent()|, |cindent()|
4262 and |lispindent()|.
4263 The evaluation of the expression must not have side effects! It must
4264 not change the text, jump to another window, etc. Afterwards the
4265 cursor position is always restored, thus the cursor may be moved.
4266 Normally this option would be set to call a function: >
4267 :set indentexpr=GetMyIndent()
4268< Error messages will be suppressed, unless the 'debug' option contains
4269 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004270 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 NOTE: This option is made empty when 'compatible' is set.
4272
Bram Moolenaar30b65812012-07-12 22:01:11 +02004273 The expression will be evaluated in the |sandbox| when set from a
4274 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004275
4276 It is not allowed to change text or jump to another window while
4277 evaluating 'indentexpr' |textlock|.
4278
4279
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 *'indentkeys'* *'indk'*
4281'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4282 local to buffer
4283 {not in Vi}
4284 {not available when compiled without the |+cindent|
4285 feature}
4286 A list of keys that, when typed in Insert mode, cause reindenting of
4287 the current line. Only happens if 'indentexpr' isn't empty.
4288 The format is identical to 'cinkeys', see |indentkeys-format|.
4289 See |C-indenting| and |indent-expression|.
4290
4291 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4292'infercase' 'inf' boolean (default off)
4293 local to buffer
4294 {not in Vi}
4295 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004296 'ignorecase' is also on, the case of the match is adjusted depending
4297 on the typed text. If the typed text contains a lowercase letter
4298 where the match has an upper case letter, the completed part is made
4299 lowercase. If the typed text has no lowercase letters and the match
4300 has a lowercase letter where the typed text has an uppercase letter,
4301 and there is a letter before it, the completed part is made uppercase.
4302 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303
4304 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4305'insertmode' 'im' boolean (default off)
4306 global
4307 {not in Vi}
4308 Makes Vim work in a way that Insert mode is the default mode. Useful
4309 if you want to use Vim as a modeless editor. Used for |evim|.
4310 These Insert mode commands will be useful:
4311 - Use the cursor keys to move around.
4312 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4313 this is a mapping, it is executed as if 'insertmode' was off.
4314 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004316 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4317 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318
4319 These items change when 'insertmode' is set:
4320 - when starting to edit of a file, Vim goes to Insert mode.
4321 - <Esc> in Insert mode is a no-op and beeps.
4322 - <Esc> in Normal mode makes Vim go to Insert mode.
4323 - CTRL-L in Insert mode is a command, it is not inserted.
4324 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4325 However, when <Esc> is used inside a mapping, it behaves like
4326 'insertmode' was not set. This was done to be able to use the same
4327 mappings with 'insertmode' set or not set.
4328 When executing commands with |:normal| 'insertmode' is not used.
4329
4330 NOTE: This option is reset when 'compatible' is set.
4331
4332 *'isfname'* *'isf'*
4333'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4334 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4335 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4336 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4337 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4338 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4339 global
4340 {not in Vi}
4341 The characters specified by this option are included in file names and
4342 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004343 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344 Multi-byte characters 256 and above are always included, only the
4345 characters up to 255 are specified with this option.
4346 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004347 Think twice before adding white space to this option. Although a
4348 space may appear inside a file name, the effect will be that Vim
4349 doesn't know where a file name starts or ends when doing completion.
4350 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351
4352 Note that on systems using a backslash as path separator, Vim tries to
4353 do its best to make it work as you would expect. That is a bit
4354 tricky, since Vi originally used the backslash to escape special
4355 characters. Vim will not remove a backslash in front of a normal file
4356 name character on these systems, but it will on Unix and alikes. The
4357 '&' and '^' are not included by default, because these are special for
4358 cmd.exe.
4359
4360 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004361 Each part can be a single character number or a range. A range is two
4362 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 decimal number between 0 and 255 or the ASCII character itself (does
4364 not work for digits). Example:
4365 "_,-,128-140,#-43" (include '_' and '-' and the range
4366 128 to 140 and '#' to 43)
4367 If a part starts with '^', the following character number or range
4368 will be excluded from the option. The option is interpreted from left
4369 to right. Put the excluded character after the range where it is
4370 included. To include '^' itself use it as the last character of the
4371 option or the end of a range. Example:
4372 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4373 If the character is '@', all characters where isalpha() returns TRUE
4374 are included. Normally these are the characters a to z and A to Z,
4375 plus accented characters. To include '@' itself use "@-@". Examples:
4376 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004377 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 "a-z,A-Z,@-@" All letters plus the '@' character.
4379 A comma can be included by using it where a character number is
4380 expected. Example:
4381 "48-57,,,_" Digits, comma and underscore.
4382 A comma can be excluded by prepending a '^'. Example:
4383 " -~,^,,9" All characters from space to '~', excluding
4384 comma, plus <Tab>.
4385 See |option-backslash| about including spaces and backslashes.
4386
4387 *'isident'* *'isi'*
4388'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4389 "@,48-57,_,128-167,224-235"
4390 otherwise: "@,48-57,_,192-255")
4391 global
4392 {not in Vi}
4393 The characters given by this option are included in identifiers.
4394 Identifiers are used in recognizing environment variables and after a
4395 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004396 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 option.
4398 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004399 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4401
4402 *'iskeyword'* *'isk'*
4403'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4404 "@,48-57,_,128-167,224-235"
4405 otherwise: "@,48-57,_,192-255"
4406 Vi default: "@,48-57,_")
4407 local to buffer
4408 {not in Vi}
4409 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004410 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 'isfname' for a description of the format of this option. For C
4412 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4413 For a help file it is set to all non-blank printable characters except
4414 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4415 command).
4416 When the 'lisp' option is on the '-' character is always included.
4417 NOTE: This option is set to the Vi default value when 'compatible' is
4418 set and to the Vim default value when 'compatible' is reset.
4419
4420 *'isprint'* *'isp'*
4421'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4422 "@,~-255"; otherwise: "@,161-255")
4423 global
4424 {not in Vi}
4425 The characters given by this option are displayed directly on the
4426 screen. It is also used for "\p" in a |pattern|. The characters from
4427 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4428 even when they are not included in 'isprint' or excluded. See
4429 'isfname' for a description of the format of this option.
4430
4431 Non-printable characters are displayed with two characters:
4432 0 - 31 "^@" - "^_"
4433 32 - 126 always single characters
4434 127 "^?"
4435 128 - 159 "~@" - "~_"
4436 160 - 254 "| " - "|~"
4437 255 "~?"
4438 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4439 displayed as <xx>, with the hexadecimal value of the byte.
4440 When 'display' contains "uhex" all unprintable characters are
4441 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004442 The SpecialKey highlighting will be used for unprintable characters.
4443 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444
4445 Multi-byte characters 256 and above are always included, only the
4446 characters up to 255 are specified with this option. When a character
4447 is printable but it is not available in the current font, a
4448 replacement character will be shown.
4449 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4450 There is no option to specify these characters.
4451
4452 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4453'joinspaces' 'js' boolean (default on)
4454 global
4455 {not in Vi}
4456 Insert two spaces after a '.', '?' and '!' with a join command.
4457 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4458 Otherwise only one space is inserted.
4459 NOTE: This option is set when 'compatible' is set.
4460
4461 *'key'*
4462'key' string (default "")
4463 local to buffer
4464 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004465 {only available when compiled with the |+cryptv|
4466 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004468 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 Careful: Do not set the key value by hand, someone might see the typed
4470 key. Use the |:X| command. But you can make 'key' empty: >
4471 :set key=
4472< It is not possible to get the value of this option with ":set key" or
4473 "echo &key". This is to avoid showing it to someone who shouldn't
4474 know. It also means you cannot see it yourself once you have set it,
4475 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004476 You can use "&key" in an expression to detect whether encryption is
4477 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478
4479 *'keymap'* *'kmp'* *E544*
4480'keymap' 'kmp' string (default "")
4481 local to buffer
4482 {not in Vi}
4483 {only available when compiled with the |+keymap|
4484 feature}
4485 Name of a keyboard mapping. See |mbyte-keymap|.
4486 Setting this option to a valid keymap name has the side effect of
4487 setting 'iminsert' to one, so that the keymap becomes effective.
4488 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004489 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490
4491 *'keymodel'* *'km'*
4492'keymodel' 'km' string (default "")
4493 global
4494 {not in Vi}
4495 List of comma separated words, which enable special things that keys
4496 can do. These values can be used:
4497 startsel Using a shifted special key starts selection (either
4498 Select mode or Visual mode, depending on "key" being
4499 present in 'selectmode').
4500 stopsel Using a not-shifted special key stops selection.
4501 Special keys in this context are the cursor keys, <End>, <Home>,
4502 <PageUp> and <PageDown>.
4503 The 'keymodel' option is set by the |:behave| command.
4504
4505 *'keywordprg'* *'kp'*
4506'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4507 OS/2: "view /", VMS: "help")
4508 global or local to buffer |global-local|
4509 {not in Vi}
4510 Program to use for the |K| command. Environment variables are
4511 expanded |:set_env|. ":help" may be used to access the Vim internal
4512 help. (Note that previously setting the global option to the empty
4513 value did this, which is now deprecated.)
4514 When "man" is used, Vim will automatically translate a count for the
4515 "K" command to a section number. Also for "man -s", in which case the
4516 "-s" is removed when there is no count.
4517 See |option-backslash| about including spaces and backslashes.
4518 Example: >
4519 :set keywordprg=man\ -s
4520< This option cannot be set from a |modeline| or in the |sandbox|, for
4521 security reasons.
4522
4523 *'langmap'* *'lmap'* *E357* *E358*
4524'langmap' 'lmap' string (default "")
4525 global
4526 {not in Vi}
4527 {only available when compiled with the |+langmap|
4528 feature}
4529 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004530 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 inserted directly. When in command mode the 'langmap' option takes
4532 care of translating these special characters to the original meaning
4533 of the key. This means you don't have to change the keyboard mode to
4534 be able to execute Normal mode commands.
4535 This is the opposite of the 'keymap' option, where characters are
4536 mapped in Insert mode.
Bram Moolenaare968e362014-05-13 20:23:24 +02004537 This option cannot be set from a |modeline| or in the |sandbox|, for
4538 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004540 Example (for Greek, in UTF-8): *greek* >
4541 :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 +00004542< Example (exchanges meaning of z and y for commands): >
4543 :set langmap=zy,yz,ZY,YZ
4544<
4545 The 'langmap' option is a list of parts, separated with commas. Each
4546 part can be in one of two forms:
4547 1. A list of pairs. Each pair is a "from" character immediately
4548 followed by the "to" character. Examples: "aA", "aAbBcC".
4549 2. A list of "from" characters, a semi-colon and a list of "to"
4550 characters. Example: "abc;ABC"
4551 Example: "aA,fgh;FGH,cCdDeE"
4552 Special characters need to be preceded with a backslash. These are
4553 ";", ',' and backslash itself.
4554
4555 This will allow you to activate vim actions without having to switch
4556 back and forth between the languages. Your language characters will
4557 be understood as normal vim English characters (according to the
4558 langmap mappings) in the following cases:
4559 o Normal/Visual mode (commands, buffer/register names, user mappings)
4560 o Insert/Replace Mode: Register names after CTRL-R
4561 o Insert/Replace Mode: Mappings
4562 Characters entered in Command-line mode will NOT be affected by
4563 this option. Note that this option can be changed at any time
4564 allowing to switch between mappings for different languages/encodings.
4565 Use a mapping to avoid having to type it each time!
4566
4567 *'langmenu'* *'lm'*
4568'langmenu' 'lm' string (default "")
4569 global
4570 {not in Vi}
4571 {only available when compiled with the |+menu| and
4572 |+multi_lang| features}
4573 Language to use for menu translation. Tells which file is loaded
4574 from the "lang" directory in 'runtimepath': >
4575 "lang/menu_" . &langmenu . ".vim"
4576< (without the spaces). For example, to always use the Dutch menus, no
4577 matter what $LANG is set to: >
4578 :set langmenu=nl_NL.ISO_8859-1
4579< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004580 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 If your $LANG is set to a non-English language but you do want to use
4582 the English menus: >
4583 :set langmenu=none
4584< This option must be set before loading menus, switching on filetype
4585 detection or syntax highlighting. Once the menus are defined setting
4586 this option has no effect. But you could do this: >
4587 :source $VIMRUNTIME/delmenu.vim
4588 :set langmenu=de_DE.ISO_8859-1
4589 :source $VIMRUNTIME/menu.vim
4590< Warning: This deletes all menus that you defined yourself!
4591
4592 *'laststatus'* *'ls'*
4593'laststatus' 'ls' number (default 1)
4594 global
4595 {not in Vi}
4596 The value of this option influences when the last window will have a
4597 status line:
4598 0: never
4599 1: only if there are at least two windows
4600 2: always
4601 The screen looks nicer with a status line if you have several
4602 windows, but it takes another screen line. |status-line|
4603
4604 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4605'lazyredraw' 'lz' boolean (default off)
4606 global
4607 {not in Vi}
4608 When this option is set, the screen will not be redrawn while
4609 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004610 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 update use |:redraw|.
4612
4613 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4614'linebreak' 'lbr' boolean (default off)
4615 local to window
4616 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004617 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004619 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 than at the last character that fits on the screen. Unlike
4621 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004622 it only affects the way the file is displayed, not its contents.
4623 If 'breakindent' is set, line is visually indented. Then, the value
4624 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004625 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 Note that <Tab> characters after an <EOL> are mostly not displayed
4627 with the right amount of white space.
4628
4629 *'lines'* *E593*
4630'lines' number (default 24 or terminal height)
4631 global
4632 Number of lines of the Vim window.
4633 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004634 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 When Vim is running in the GUI or in a resizable window, setting this
4636 option will cause the window size to be changed. When you only want
4637 to use the size for the GUI, put the command in your |gvimrc| file.
4638 Vim limits the number of lines to what fits on the screen. You can
4639 use this command to get the tallest window possible: >
4640 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004641< Minimum value is 2, maximum value is 1000.
4642 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 When you set this option and Vim is unable to change the physical
4644 number of lines of the display, the display may be messed up.
4645
4646 *'linespace'* *'lsp'*
4647'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4648 global
4649 {not in Vi}
4650 {only in the GUI}
4651 Number of pixel lines inserted between characters. Useful if the font
4652 uses the full character cell height, making lines touch each other.
4653 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004654 With some fonts there can be too much room between lines (to have
4655 space for ascents and descents). Then it makes sense to set
4656 'linespace' to a negative value. This may cause display problems
4657 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658
4659 *'lisp'* *'nolisp'*
4660'lisp' boolean (default off)
4661 local to buffer
4662 {not available when compiled without the |+lispindent|
4663 feature}
4664 Lisp mode: When <Enter> is typed in insert mode set the indent for
4665 the next line to Lisp standards (well, sort of). Also happens with
4666 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4667 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4668 better. Also see 'lispwords'.
4669 The '-' character is included in keyword characters. Redefines the
4670 "=" operator to use this same indentation algorithm rather than
4671 calling an external program if 'equalprg' is empty.
4672 This option is not used when 'paste' is set.
4673 {Vi: Does it a little bit differently}
4674
4675 *'lispwords'* *'lw'*
4676'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004677 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 {not in Vi}
4679 {not available when compiled without the |+lispindent|
4680 feature}
4681 Comma separated list of words that influence the Lisp indenting.
4682 |'lisp'|
4683
4684 *'list'* *'nolist'*
4685'list' boolean (default off)
4686 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004687 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4688 line. Useful to see the difference between tabs and spaces and for
4689 trailing blanks. Further changed by the 'listchars' option.
4690
4691 The cursor is displayed at the start of the space a Tab character
4692 occupies, not at the end as usual in Normal mode. To get this cursor
4693 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004694 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004695<
4696 Note that list mode will also affect formatting (set with 'textwidth'
4697 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004698 changing the way tabs are displayed.
4699
4700 *'listchars'* *'lcs'*
4701'listchars' 'lcs' string (default "eol:$")
4702 global
4703 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004704 Strings to use in 'list' mode and for the |:list| command. It is a
4705 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004706 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 eol:c Character to show at the end of each line. When
4708 omitted, there is no extra character at the end of the
4709 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004710 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004711 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004713 fill the space that the tab normally occupies.
4714 "tab:>-" will show a tab that takes four spaces as
4715 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004716 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004717 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004719 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 extends:c Character to show in the last column, when 'wrap' is
4721 off and the line continues beyond the right of the
4722 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004723 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 precedes:c Character to show in the first column, when 'wrap'
4725 is off and there is text preceding the character
4726 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004727 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004728 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004729 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004730 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004731 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004732 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004734 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004736 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737
4738 Examples: >
4739 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004740 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 :set lcs=extends:>,precedes:<
4742< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004743 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004744 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745
4746 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4747'loadplugins' 'lpl' boolean (default on)
4748 global
4749 {not in Vi}
4750 When on the plugin scripts are loaded when starting up |load-plugins|.
4751 This option can be reset in your |vimrc| file to disable the loading
4752 of plugins.
4753 Note that using the "-u NONE" and "--noplugin" command line arguments
4754 reset this option. |-u| |--noplugin|
4755
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004756 *'macatsui'* *'nomacatsui'*
4757'macatsui' boolean (default on)
4758 global
4759 {only available in Mac GUI version}
4760 This is a workaround for when drawing doesn't work properly. When set
4761 and compiled with multi-byte support ATSUI text drawing is used. When
4762 not set ATSUI text drawing is not used. Switch this option off when
4763 you experience drawing problems. In a future version the problems may
4764 be solved and this option becomes obsolete. Therefore use this method
4765 to unset it: >
4766 if exists('&macatsui')
4767 set nomacatsui
4768 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004769< Another option to check if you have drawing problems is
4770 'termencoding'.
4771
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 *'magic'* *'nomagic'*
4773'magic' boolean (default on)
4774 global
4775 Changes the special characters that can be used in search patterns.
4776 See |pattern|.
4777 NOTE: To avoid portability problems with using patterns, always keep
4778 this option at the default "on". Only switch it off when working with
4779 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004780 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781
4782 *'makeef'* *'mef'*
4783'makeef' 'mef' string (default: "")
4784 global
4785 {not in Vi}
4786 {not available when compiled without the |+quickfix|
4787 feature}
4788 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4789 and the |:grep| command.
4790 When it is empty, an internally generated temp file will be used.
4791 When "##" is included, it is replaced by a number to make the name
4792 unique. This makes sure that the ":make" command doesn't overwrite an
4793 existing file.
4794 NOT used for the ":cf" command. See 'errorfile' for that.
4795 Environment variables are expanded |:set_env|.
4796 See |option-backslash| about including spaces and backslashes.
4797 This option cannot be set from a |modeline| or in the |sandbox|, for
4798 security reasons.
4799
4800 *'makeprg'* *'mp'*
4801'makeprg' 'mp' string (default "make", VMS: "MMS")
4802 global or local to buffer |global-local|
4803 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004804 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004805 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4806 which are expanded to the current and alternate file name. Use |::S|
4807 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004808 Environment variables are expanded |:set_env|. See |option-backslash|
4809 about including spaces and backslashes.
4810 Note that a '|' must be escaped twice: once for ":set" and once for
4811 the interpretation of a command. When you use a filter called
4812 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 :set makeprg=gmake\ \\\|\ myfilter
4814< The placeholder "$*" can be given (even multiple times) to specify
4815 where the arguments will be included, for example: >
4816 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4817< This option cannot be set from a |modeline| or in the |sandbox|, for
4818 security reasons.
4819
4820 *'matchpairs'* *'mps'*
4821'matchpairs' 'mps' string (default "(:),{:},[:]")
4822 local to buffer
4823 {not in Vi}
4824 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004825 other.
4826 Only character pairs are allowed that are different, thus you cannot
4827 jump between two double quotes.
4828 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004829 The pairs must be separated by a comma. Example for including '<' and
4830 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 :set mps+=<:>
4832
4833< A more exotic example, to jump between the '=' and ';' in an
4834 assignment, useful for languages like C and Java: >
4835 :au FileType c,cpp,java set mps+==:;
4836
4837< For a more advanced way of using "%", see the matchit.vim plugin in
4838 the $VIMRUNTIME/macros directory. |add-local-help|
4839
4840 *'matchtime'* *'mat'*
4841'matchtime' 'mat' number (default 5)
4842 global
4843 {not in Vi}{in Nvi}
4844 Tenths of a second to show the matching paren, when 'showmatch' is
4845 set. Note that this is not in milliseconds, like other options that
4846 set a time. This is to be compatible with Nvi.
4847
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004848 *'maxcombine'* *'mco'*
4849'maxcombine' 'mco' number (default 2)
4850 global
4851 {not in Vi}
4852 {only available when compiled with the |+multi_byte|
4853 feature}
4854 The maximum number of combining characters supported for displaying.
4855 Only used when 'encoding' is "utf-8".
4856 The default is OK for most languages. Hebrew may require 4.
4857 Maximum value is 6.
4858 Even when this option is set to 2 you can still edit text with more
4859 combining characters, you just can't see them. Use |g8| or |ga|.
4860 See |mbyte-combining|.
4861
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862 *'maxfuncdepth'* *'mfd'*
4863'maxfuncdepth' 'mfd' number (default 100)
4864 global
4865 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004866 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004867 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868 Maximum depth of function calls for user functions. This normally
4869 catches endless recursion. When using a recursive function with
4870 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4871 more memory, there is the danger of failing when memory is exhausted.
4872 See also |:function|.
4873
4874 *'maxmapdepth'* *'mmd'* *E223*
4875'maxmapdepth' 'mmd' number (default 1000)
4876 global
4877 {not in Vi}
4878 Maximum number of times a mapping is done without resulting in a
4879 character to be used. This normally catches endless mappings, like
4880 ":map x y" with ":map y x". It still does not catch ":map g wg",
4881 because the 'w' is used before the next mapping is done. See also
4882 |key-mapping|.
4883
4884 *'maxmem'* *'mm'*
4885'maxmem' 'mm' number (default between 256 to 5120 (system
4886 dependent) or half the amount of memory
4887 available)
4888 global
4889 {not in Vi}
4890 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4891 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004892 other memory to be freed. The maximum usable value is about 2000000.
4893 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004895 *'maxmempattern'* *'mmp'*
4896'maxmempattern' 'mmp' number (default 1000)
4897 global
4898 {not in Vi}
4899 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004900 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004901 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004902 When Vim runs into the limit it gives an error message and mostly
4903 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004904 Running into the limit often means that the pattern is very
4905 inefficient or too complex. This may already happen with the pattern
4906 "\(.\)*" on a very long line. ".*" works much better.
4907 Vim may run out of memory before hitting the 'maxmempattern' limit.
4908
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 *'maxmemtot'* *'mmt'*
4910'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4911 dependent) or half the amount of memory
4912 available)
4913 global
4914 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004915 Maximum amount of memory in Kbyte to use for all buffers together.
4916 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4917 without a limit. On 64 bit machines higher values might work. But
4918 hey, do you really need more than 2 Gbyte for text editing?
4919 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920
4921 *'menuitems'* *'mis'*
4922'menuitems' 'mis' number (default 25)
4923 global
4924 {not in Vi}
4925 {not available when compiled without the |+menu|
4926 feature}
4927 Maximum number of items to use in a menu. Used for menus that are
4928 generated from a list of items, e.g., the Buffers menu. Changing this
4929 option has no direct effect, the menu must be refreshed first.
4930
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004931 *'mkspellmem'* *'msm'*
4932'mkspellmem' 'msm' string (default "460000,2000,500")
4933 global
4934 {not in Vi}
4935 {not available when compiled without the |+syntax|
4936 feature}
4937 Parameters for |:mkspell|. This tunes when to start compressing the
4938 word tree. Compression can be slow when there are many words, but
4939 it's needed to avoid running out of memory. The amount of memory used
4940 per word depends very much on how similar the words are, that's why
4941 this tuning is complicated.
4942
4943 There are three numbers, separated by commas:
4944 {start},{inc},{added}
4945
4946 For most languages the uncompressed word tree fits in memory. {start}
4947 gives the amount of memory in Kbyte that can be used before any
4948 compression is done. It should be a bit smaller than the amount of
4949 memory that is available to Vim.
4950
4951 When going over the {start} limit the {inc} number specifies the
4952 amount of memory in Kbyte that can be allocated before another
4953 compression is done. A low number means compression is done after
4954 less words are added, which is slow. A high number means more memory
4955 will be allocated.
4956
4957 After doing compression, {added} times 1024 words can be added before
4958 the {inc} limit is ignored and compression is done when any extra
4959 amount of memory is needed. A low number means there is a smaller
4960 chance of hitting the {inc} limit, less memory is used but it's
4961 slower.
4962
4963 The languages for which these numbers are important are Italian and
4964 Hungarian. The default works for when you have about 512 Mbyte. If
4965 you have 1 Gbyte you could use: >
4966 :set mkspellmem=900000,3000,800
4967< If you have less than 512 Mbyte |:mkspell| may fail for some
4968 languages, no matter what you set 'mkspellmem' to.
4969
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004971'modeline' 'ml' boolean (Vim default: on (off for root),
4972 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 local to buffer
4974 *'modelines'* *'mls'*
4975'modelines' 'mls' number (default 5)
4976 global
4977 {not in Vi}
4978 If 'modeline' is on 'modelines' gives the number of lines that is
4979 checked for set commands. If 'modeline' is off or 'modelines' is zero
4980 no lines are checked. See |modeline|.
4981 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4982 set and to the Vim default value when 'compatible' is reset.
4983
4984 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4985'modifiable' 'ma' boolean (default on)
4986 local to buffer
4987 {not in Vi} *E21*
4988 When off the buffer contents cannot be changed. The 'fileformat' and
4989 'fileencoding' options also can't be changed.
4990 Can be reset with the |-M| command line argument.
4991
4992 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4993'modified' 'mod' boolean (default off)
4994 local to buffer
4995 {not in Vi}
4996 When on, the buffer is considered to be modified. This option is set
4997 when:
4998 1. A change was made to the text since it was last written. Using the
4999 |undo| command to go back to the original text will reset the
5000 option. But undoing changes that were made before writing the
5001 buffer will set the option again, since the text is different from
5002 when it was written.
5003 2. 'fileformat' or 'fileencoding' is different from its original
5004 value. The original value is set when the buffer is read or
5005 written. A ":set nomodified" command also resets the original
5006 values to the current values and the 'modified' option will be
5007 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005008 This option is not set when a change is made to the buffer as the
5009 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5010 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5011 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5013 will be ignored.
5014
5015 *'more'* *'nomore'*
5016'more' boolean (Vim default: on, Vi default: off)
5017 global
5018 {not in Vi}
5019 When on, listings pause when the whole screen is filled. You will get
5020 the |more-prompt|. When this option is off there are no pauses, the
5021 listing continues until finished.
5022 NOTE: This option is set to the Vi default value when 'compatible' is
5023 set and to the Vim default value when 'compatible' is reset.
5024
5025 *'mouse'* *E538*
5026'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5027 global
5028 {not in Vi}
5029 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005030 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5031 sysmouse and Linux console with gpm). For using the mouse in the
5032 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 The mouse can be enabled for different modes:
5034 n Normal mode
5035 v Visual mode
5036 i Insert mode
5037 c Command-line mode
5038 h all previous modes when editing a help file
5039 a all previous modes
5040 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041 Normally you would enable the mouse in all four modes with: >
5042 :set mouse=a
5043< When the mouse is not enabled, the GUI will still use the mouse for
5044 modeless selection. This doesn't move the text cursor.
5045
5046 See |mouse-using|. Also see |'clipboard'|.
5047
5048 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005049 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 the mouse buttons can still be used by keeping the shift key pressed.
5051 Also see the 'clipboard' option.
5052
5053 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5054'mousefocus' 'mousef' boolean (default off)
5055 global
5056 {not in Vi}
5057 {only works in the GUI}
5058 The window that the mouse pointer is on is automatically activated.
5059 When changing the window layout or window focus in another way, the
5060 mouse pointer is moved to the window with keyboard focus. Off is the
5061 default because it makes using the pull down menus a little goofy, as
5062 a pointer transit may activate a window unintentionally.
5063
5064 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5065'mousehide' 'mh' boolean (default on)
5066 global
5067 {not in Vi}
5068 {only works in the GUI}
5069 When on, the mouse pointer is hidden when characters are typed.
5070 The mouse pointer is restored when the mouse is moved.
5071
5072 *'mousemodel'* *'mousem'*
5073'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5074 global
5075 {not in Vi}
5076 Sets the model to use for the mouse. The name mostly specifies what
5077 the right mouse button is used for:
5078 extend Right mouse button extends a selection. This works
5079 like in an xterm.
5080 popup Right mouse button pops up a menu. The shifted left
5081 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005082 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083 popup_setpos Like "popup", but the cursor will be moved to the
5084 position where the mouse was clicked, and thus the
5085 selected operation will act upon the clicked object.
5086 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005087 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 course, that right clicking outside a selection will
5089 end Visual mode.
5090 Overview of what button does what for each model:
5091 mouse extend popup(_setpos) ~
5092 left click place cursor place cursor
5093 left drag start selection start selection
5094 shift-left search word extend selection
5095 right click extend selection popup menu (place cursor)
5096 right drag extend selection -
5097 middle click paste paste
5098
5099 In the "popup" model the right mouse button produces a pop-up menu.
5100 You need to define this first, see |popup-menu|.
5101
5102 Note that you can further refine the meaning of buttons with mappings.
5103 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5104 selection (because that's handled in the GUI code directly).
5105
5106 The 'mousemodel' option is set by the |:behave| command.
5107
5108 *'mouseshape'* *'mouses'* *E547*
5109'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005110 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 global
5112 {not in Vi}
5113 {only available when compiled with the |+mouseshape|
5114 feature}
5115 This option tells Vim what the mouse pointer should look like in
5116 different modes. The option is a comma separated list of parts, much
5117 like used for 'guicursor'. Each part consist of a mode/location-list
5118 and an argument-list:
5119 mode-list:shape,mode-list:shape,..
5120 The mode-list is a dash separated list of these modes/locations:
5121 In a normal window: ~
5122 n Normal mode
5123 v Visual mode
5124 ve Visual mode with 'selection' "exclusive" (same as 'v',
5125 if not specified)
5126 o Operator-pending mode
5127 i Insert mode
5128 r Replace mode
5129
5130 Others: ~
5131 c appending to the command-line
5132 ci inserting in the command-line
5133 cr replacing in the command-line
5134 m at the 'Hit ENTER' or 'More' prompts
5135 ml idem, but cursor in the last line
5136 e any mode, pointer below last window
5137 s any mode, pointer on a status line
5138 sd any mode, while dragging a status line
5139 vs any mode, pointer on a vertical separator line
5140 vd any mode, while dragging a vertical separator line
5141 a everywhere
5142
5143 The shape is one of the following:
5144 avail name looks like ~
5145 w x arrow Normal mouse pointer
5146 w x blank no pointer at all (use with care!)
5147 w x beam I-beam
5148 w x updown up-down sizing arrows
5149 w x leftright left-right sizing arrows
5150 w x busy The system's usual busy pointer
5151 w x no The system's usual 'no input' pointer
5152 x udsizing indicates up-down resizing
5153 x lrsizing indicates left-right resizing
5154 x crosshair like a big thin +
5155 x hand1 black hand
5156 x hand2 white hand
5157 x pencil what you write with
5158 x question big ?
5159 x rightup-arrow arrow pointing right-up
5160 w x up-arrow arrow pointing up
5161 x <number> any X11 pointer number (see X11/cursorfont.h)
5162
5163 The "avail" column contains a 'w' if the shape is available for Win32,
5164 x for X11.
5165 Any modes not specified or shapes not available use the normal mouse
5166 pointer.
5167
5168 Example: >
5169 :set mouseshape=s:udsizing,m:no
5170< will make the mouse turn to a sizing arrow over the status lines and
5171 indicate no input when the hit-enter prompt is displayed (since
5172 clicking the mouse has no effect in this state.)
5173
5174 *'mousetime'* *'mouset'*
5175'mousetime' 'mouset' number (default 500)
5176 global
5177 {not in Vi}
5178 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5179 time in msec between two mouse clicks for the second click to be
5180 recognized as a multi click.
5181
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005182 *'mzquantum'* *'mzq'*
5183'mzquantum' 'mzq' number (default 100)
5184 global
5185 {not in Vi}
5186 {not available when compiled without the |+mzscheme|
5187 feature}
5188 The number of milliseconds between polls for MzScheme threads.
5189 Negative or zero value means no thread scheduling.
5190
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 *'nrformats'* *'nf'*
5192'nrformats' 'nf' string (default "octal,hex")
5193 local to buffer
5194 {not in Vi}
5195 This defines what bases Vim will consider for numbers when using the
5196 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5197 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005198 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005200 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005201 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005203 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 considered to be hexadecimal. Example: Using CTRL-X on
5205 "0x100" results in "0x0ff".
5206 Numbers which simply begin with a digit in the range 1-9 are always
5207 considered decimal. This also happens for numbers that are not
5208 recognized as octal or hex.
5209
5210 *'number'* *'nu'* *'nonumber'* *'nonu'*
5211'number' 'nu' boolean (default off)
5212 local to window
5213 Print the line number in front of each line. When the 'n' option is
5214 excluded from 'cpoptions' a wrapped line will not use the column of
5215 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005216 The 'numberwidth' option can be used to set the room used for the line
5217 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 When a long, wrapped line doesn't start with the first character, '-'
5219 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005220 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5221 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005222 *number_relativenumber*
5223 The 'relativenumber' option changes the displayed number to be
5224 relative to the cursor. Together with 'number' there are these
5225 four combinations (cursor in line 3):
5226
5227 'nonu' 'nu' 'nonu' 'nu'
5228 'nornu' 'nornu' 'rnu' 'rnu'
5229
5230 |apple | 1 apple | 2 apple | 2 apple
5231 |pear | 2 pear | 1 pear | 1 pear
5232 |nobody | 3 nobody | 0 nobody |3 nobody
5233 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005235 *'numberwidth'* *'nuw'*
5236'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5237 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005238 {not in Vi}
5239 {only available when compiled with the |+linebreak|
5240 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005241 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005242 when the 'number' or 'relativenumber' option is set or printing lines
5243 with a line number. Since one space is always between the number and
5244 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005245 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005246 fit the highest line number in the buffer respectively the number of
5247 rows in the window, depending on whether 'number' or 'relativenumber'
5248 is set. Thus with the Vim default of 4 there is room for a line number
5249 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005250 The minimum value is 1, the maximum value is 10.
5251 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5252
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005253 *'omnifunc'* *'ofu'*
5254'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005255 local to buffer
5256 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005257 {not available when compiled without the |+eval|
5258 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005259 This option specifies a function to be used for Insert mode omni
5260 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005261 See |complete-functions| for an explanation of how the function is
5262 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005263 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005264 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005265 This option cannot be set from a |modeline| or in the |sandbox|, for
5266 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005267
5268
Bram Moolenaar02467872007-05-06 13:22:01 +00005269 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005270'opendevice' 'odev' boolean (default off)
5271 global
5272 {not in Vi}
5273 {only for MS-DOS, MS-Windows and OS/2}
5274 Enable reading and writing from devices. This may get Vim stuck on a
5275 device that can be opened but doesn't actually do the I/O. Therefore
5276 it is off by default.
5277 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5278 result in editing a device.
5279
5280
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005281 *'operatorfunc'* *'opfunc'*
5282'operatorfunc' 'opfunc' string (default: empty)
5283 global
5284 {not in Vi}
5285 This option specifies a function to be called by the |g@| operator.
5286 See |:map-operator| for more info and an example.
5287
5288 This option cannot be set from a |modeline| or in the |sandbox|, for
5289 security reasons.
5290
5291
Bram Moolenaar251e1912011-06-19 05:09:16 +02005292 *'osfiletype'* *'oft'*
5293'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 local to buffer
5295 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005296 This option was supported on RISC OS, which has been removed.
5297
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
5299 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005300'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 global
5302 Specifies the nroff macros that separate paragraphs. These are pairs
5303 of two letters (see |object-motions|).
5304
5305 *'paste'* *'nopaste'*
5306'paste' boolean (default off)
5307 global
5308 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005309 Put Vim in Paste mode. This is useful if you want to cut or copy
5310 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 unexpected effects.
5312 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005313 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 knows about pasting and will mostly do the right thing without 'paste'
5315 being set. The same is true for a terminal where Vim handles the
5316 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005317 This option is reset when starting the GUI. Thus if you set it in
5318 your .vimrc it will work in a terminal, but not in the GUI. Setting
5319 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5320 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 When the 'paste' option is switched on (also when it was already on):
5322 - mapping in Insert mode and Command-line mode is disabled
5323 - abbreviations are disabled
5324 - 'textwidth' is set to 0
5325 - 'wrapmargin' is set to 0
5326 - 'autoindent' is reset
5327 - 'smartindent' is reset
5328 - 'softtabstop' is set to 0
5329 - 'revins' is reset
5330 - 'ruler' is reset
5331 - 'showmatch' is reset
5332 - 'formatoptions' is used like it is empty
5333 These options keep their value, but their effect is disabled:
5334 - 'lisp'
5335 - 'indentexpr'
5336 - 'cindent'
5337 NOTE: When you start editing another file while the 'paste' option is
5338 on, settings from the modelines or autocommands may change the
5339 settings again, causing trouble when pasting text. You might want to
5340 set the 'paste' option again.
5341 When the 'paste' option is reset the mentioned options are restored to
5342 the value before the moment 'paste' was switched from off to on.
5343 Resetting 'paste' before ever setting it does not have any effect.
5344 Since mapping doesn't work while 'paste' is active, you need to use
5345 the 'pastetoggle' option to toggle the 'paste' option with some key.
5346
5347 *'pastetoggle'* *'pt'*
5348'pastetoggle' 'pt' string (default "")
5349 global
5350 {not in Vi}
5351 When non-empty, specifies the key sequence that toggles the 'paste'
5352 option. This is like specifying a mapping: >
5353 :map {keys} :set invpaste<CR>
5354< Where {keys} is the value of 'pastetoggle'.
5355 The difference is that it will work even when 'paste' is set.
5356 'pastetoggle' works in Insert mode and Normal mode, but not in
5357 Command-line mode.
5358 Mappings are checked first, thus overrule 'pastetoggle'. However,
5359 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5360 this: >
5361 :map <F10> :set paste<CR>
5362 :map <F11> :set nopaste<CR>
5363 :imap <F10> <C-O>:set paste<CR>
5364 :imap <F11> <nop>
5365 :set pastetoggle=<F11>
5366< This will make <F10> start paste mode and <F11> stop paste mode.
5367 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5368 mode everything is inserted literally, except the 'pastetoggle' key
5369 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005370 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371
5372 *'pex'* *'patchexpr'*
5373'patchexpr' 'pex' string (default "")
5374 global
5375 {not in Vi}
5376 {not available when compiled without the |+diff|
5377 feature}
5378 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005379 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380
Bram Moolenaardbc28022014-07-26 13:40:44 +02005381 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382'patchmode' 'pm' string (default "")
5383 global
5384 {not in Vi}
5385 When non-empty the oldest version of a file is kept. This can be used
5386 to keep the original version of a file if you are changing files in a
5387 source distribution. Only the first time that a file is written a
5388 copy of the original file will be kept. The name of the copy is the
5389 name of the original file with the string in the 'patchmode' option
5390 appended. This option should start with a dot. Use a string like
5391 ".org". 'backupdir' must not be empty for this to work (Detail: The
5392 backup file is renamed to the patchmode file after the new file has
5393 been successfully written, that's why it must be possible to write a
5394 backup file). If there was no file to be backed up, an empty file is
5395 created.
5396 When the 'backupskip' pattern matches, a patchmode file is not made.
5397 Using 'patchmode' for compressed files appends the extension at the
5398 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5399 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005400 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005402 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403'path' 'pa' string (default on Unix: ".,/usr/include,,"
5404 on OS/2: ".,/emx/include,,"
5405 other systems: ".,,")
5406 global or local to buffer |global-local|
5407 {not in Vi}
5408 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005409 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5410 provided that the file being searched for has a relative path (not
5411 starting with "/", "./" or "../"). The directories in the 'path'
5412 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 - Use commas to separate directory names: >
5414 :set path=.,/usr/local/include,/usr/include
5415< - Spaces can also be used to separate directory names (for backwards
5416 compatibility with version 3.0). To have a space in a directory
5417 name, precede it with an extra backslash, and escape the space: >
5418 :set path=.,/dir/with\\\ space
5419< - To include a comma in a directory name precede it with an extra
5420 backslash: >
5421 :set path=.,/dir/with\\,comma
5422< - To search relative to the directory of the current file, use: >
5423 :set path=.
5424< - To search in the current directory use an empty string between two
5425 commas: >
5426 :set path=,,
5427< - A directory name may end in a ':' or '/'.
5428 - Environment variables are expanded |:set_env|.
5429 - When using |netrw.vim| URLs can be used. For example, adding
5430 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005431 - Search upwards and downwards in a directory tree using "*", "**" and
5432 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 {not available when compiled without the |+path_extra| feature}
5434 - Careful with '\' characters, type two to get one in the option: >
5435 :set path=.,c:\\include
5436< Or just use '/' instead: >
5437 :set path=.,c:/include
5438< Don't forget "." or files won't even be found in the same directory as
5439 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005440 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 it is something like 256 or 1024 characters.
5442 You can check if all the include files are found, using the value of
5443 'path', see |:checkpath|.
5444 The use of |:set+=| and |:set-=| is preferred when adding or removing
5445 directories from the list. This avoids problems when a future version
5446 uses another default. To remove the current directory use: >
5447 :set path-=
5448< To add the current directory use: >
5449 :set path+=
5450< To use an environment variable, you probably need to replace the
5451 separator. Here is an example to append $INCL, in which directory
5452 names are separated with a semi-colon: >
5453 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5454< Replace the ';' with a ':' or whatever separator is used. Note that
5455 this doesn't work when $INCL contains a comma or white space.
5456
5457 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5458'preserveindent' 'pi' boolean (default off)
5459 local to buffer
5460 {not in Vi}
5461 When changing the indent of the current line, preserve as much of the
5462 indent structure as possible. Normally the indent is replaced by a
5463 series of tabs followed by spaces as required (unless |'expandtab'| is
5464 enabled, in which case only spaces are used). Enabling this option
5465 means the indent will preserve as many existing characters as possible
5466 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005467 'expandtab' does not apply to the preserved white space, a Tab remains
5468 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 NOTE: When using ">>" multiple times the resulting indent is a mix of
5470 tabs and spaces. You might not like this.
5471 NOTE: 'preserveindent' is reset when 'compatible' is set.
5472 Also see 'copyindent'.
5473 Use |:retab| to clean up white space.
5474
5475 *'previewheight'* *'pvh'*
5476'previewheight' 'pvh' number (default 12)
5477 global
5478 {not in Vi}
5479 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005480 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 Default height for a preview window. Used for |:ptag| and associated
5482 commands. Used for |CTRL-W_}| when no count is given.
5483
5484 *'previewwindow'* *'nopreviewwindow'*
5485 *'pvw'* *'nopvw'* *E590*
5486'previewwindow' 'pvw' boolean (default off)
5487 local to window
5488 {not in Vi}
5489 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005490 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005491 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 set. It's normally not set directly, but by using one of the commands
5493 |:ptag|, |:pedit|, etc.
5494
5495 *'printdevice'* *'pdev'*
5496'printdevice' 'pdev' string (default empty)
5497 global
5498 {not in Vi}
5499 {only available when compiled with the |+printer|
5500 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005501 The name of the printer to be used for |:hardcopy|.
5502 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005503 This option cannot be set from a |modeline| or in the |sandbox|, for
5504 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505
Bram Moolenaar8299df92004-07-10 09:47:34 +00005506 *'printencoding'* *'penc'*
5507'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 global
5509 {not in Vi}
5510 {only available when compiled with the |+printer|
5511 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005512 Sets the character encoding used when printing.
5513 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514
5515 *'printexpr'* *'pexpr'*
5516'printexpr' 'pexpr' String (default: see below)
5517 global
5518 {not in Vi}
5519 {only available when compiled with the |+printer|
5520 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005521 Expression used to print the PostScript produced with |:hardcopy|.
5522 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523
Bram Moolenaar8299df92004-07-10 09:47:34 +00005524 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525'printfont' 'pfn' string (default "courier")
5526 global
5527 {not in Vi}
5528 {only available when compiled with the |+printer|
5529 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005530 The name of the font that will be used for |:hardcopy|.
5531 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532
5533 *'printheader'* *'pheader'*
5534'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5535 global
5536 {not in Vi}
5537 {only available when compiled with the |+printer|
5538 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005539 The format of the header produced in |:hardcopy| output.
5540 See |pheader-option|.
5541
5542 *'printmbcharset'* *'pmbcs'*
5543'printmbcharset' 'pmbcs' string (default "")
5544 global
5545 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005546 {only available when compiled with the |+printer|,
5547 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005548 The CJK character set to be used for CJK output from |:hardcopy|.
5549 See |pmbcs-option|.
5550
5551 *'printmbfont'* *'pmbfn'*
5552'printmbfont' 'pmbfn' string (default "")
5553 global
5554 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005555 {only available when compiled with the |+printer|,
5556 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005557 List of font names to be used for CJK output from |:hardcopy|.
5558 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559
5560 *'printoptions'* *'popt'*
5561'printoptions' 'popt' string (default "")
5562 global
5563 {not in Vi}
5564 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005565 List of items that control the format of the output of |:hardcopy|.
5566 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005568 *'prompt'* *'noprompt'*
5569'prompt' boolean (default on)
5570 global
5571 When on a ":" prompt is used in Ex mode.
5572
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005573 *'pumheight'* *'ph'*
5574'pumheight' 'ph' number (default 0)
5575 global
5576 {not available when compiled without the
5577 |+insert_expand| feature}
5578 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005579 Determines the maximum number of items to show in the popup menu for
5580 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005581 |ins-completion-menu|.
5582
5583
Bram Moolenaar677ee682005-01-27 14:41:15 +00005584 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005585'quoteescape' 'qe' string (default "\")
5586 local to buffer
5587 {not in Vi}
5588 The characters that are used to escape quotes in a string. Used for
5589 objects like a', a" and a` |a'|.
5590 When one of the characters in this option is found inside a string,
5591 the following character will be skipped. The default value makes the
5592 text "foo\"bar\\" considered to be one string.
5593
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5595'readonly' 'ro' boolean (default off)
5596 local to buffer
5597 If on, writes fail unless you use a '!'. Protects you from
5598 accidentally overwriting a file. Default on when Vim is started
5599 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005600 When using ":w!" the 'readonly' option is reset for the current
5601 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005602 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005603 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005605 *'redrawtime'* *'rdt'*
5606'redrawtime' 'rdt' number (default 2000)
5607 global
5608 {not in Vi}
5609 {only available when compiled with the |+reltime|
5610 feature}
5611 The time in milliseconds for redrawing the display. This applies to
5612 searching for patterns for 'hlsearch' and |:match| highlighting.
5613 When redrawing takes more than this many milliseconds no further
5614 matches will be highlighted. This is used to avoid that Vim hangs
5615 when using a very complicated pattern.
5616
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005617 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005618'regexpengine' 're' number (default 0)
5619 global
5620 {not in Vi}
5621 This selects the default regexp engine. |two-engines|
5622 The possible values are:
5623 0 automatic selection
5624 1 old engine
5625 2 NFA engine
5626 Note that when using the NFA engine and the pattern contains something
5627 that is not supported the pattern will not match. This is only useful
5628 for debugging the regexp engine.
5629
Bram Moolenaar64486672010-05-16 15:46:46 +02005630 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5631'relativenumber' 'rnu' boolean (default off)
5632 local to window
5633 {not in Vi}
5634 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005635 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005636 precede some vertical motion commands (e.g. j k + -) with, without
5637 having to calculate it yourself. Especially useful in combination with
5638 other commands (e.g. y d c < > gq gw =).
5639 When the 'n' option is excluded from 'cpoptions' a wrapped
5640 line will not use the column of line numbers (this is the default when
5641 'compatible' isn't set).
5642 The 'numberwidth' option can be used to set the room used for the line
5643 number.
5644 When a long, wrapped line doesn't start with the first character, '-'
5645 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005646 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5647 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005648
5649 The number in front of the cursor line also depends on the value of
5650 'number', see |number_relativenumber| for all combinations of the two
5651 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005652
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 *'remap'* *'noremap'*
5654'remap' boolean (default on)
5655 global
5656 Allows for mappings to work recursively. If you do not want this for
5657 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005658 NOTE: To avoid portability problems with Vim scripts, always keep
5659 this option at the default "on". Only switch it off when working with
5660 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005662 *'renderoptions'* *'rop'*
5663'renderoptions' 'rop' string (default: empty)
5664 global
5665 {not in Vi}
5666 {only available when compiled with GUI and DIRECTX on
5667 MS-Windows}
5668 Select a text renderer and set its options. The options depend on the
5669 renderer.
5670
5671 Syntax: >
5672 set rop=type:{renderer}(,{name}:{value})*
5673<
5674 Currently, only one optional renderer is available.
5675
5676 render behavior ~
5677 directx Vim will draw text using DirectX (DirectWrite). It makes
5678 drawn glyphs more beautiful than default GDI.
5679 It requires 'encoding' is "utf-8", and only works on
5680 MS-Windows Vista or newer version.
5681
5682 Options:
5683 name meaning type value ~
5684 gamma gamma float 1.0 - 2.2 (maybe)
5685 contrast enhancedContrast float (unknown)
5686 level clearTypeLevel float (unknown)
5687 geom pixelGeometry int 0 - 2 (see below)
5688 renmode renderingMode int 0 - 6 (see below)
5689 taamode textAntialiasMode int 0 - 3 (see below)
5690
5691 See this URL for detail:
5692 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5693
5694 For geom: structure of a device pixel.
5695 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5696 1 - DWRITE_PIXEL_GEOMETRY_RGB
5697 2 - DWRITE_PIXEL_GEOMETRY_BGR
5698
5699 See this URL for detail:
5700 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5701
5702 For renmode: method of rendering glyphs.
5703 0 - DWRITE_RENDERING_MODE_DEFAULT
5704 1 - DWRITE_RENDERING_MODE_ALIASED
5705 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5706 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5707 4 - DWRITE_RENDERING_MODE_NATURAL
5708 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5709 6 - DWRITE_RENDERING_MODE_OUTLINE
5710
5711 See this URL for detail:
5712 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5713
5714 For taamode: antialiasing mode used for drawing text.
5715 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5716 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5717 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5718 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5719
5720 See this URL for detail:
5721 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5722
5723 Example: >
5724 set encoding=utf-8
5725 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5726 set rop=type:directx
5727<
5728 If select a raster font (Courier, Terminal or FixedSys) to
5729 'guifont', it fallbacks to be drawn by GDI automatically.
5730
5731 Other render types are currently not supported.
5732
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733 *'report'*
5734'report' number (default 2)
5735 global
5736 Threshold for reporting number of lines changed. When the number of
5737 changed lines is more than 'report' a message will be given for most
5738 ":" commands. If you want it always, set 'report' to 0.
5739 For the ":substitute" command the number of substitutions is used
5740 instead of the number of lines.
5741
5742 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5743'restorescreen' 'rs' boolean (default on)
5744 global
5745 {not in Vi} {only in Windows 95/NT console version}
5746 When set, the screen contents is restored when exiting Vim. This also
5747 happens when executing external commands.
5748
5749 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5750 options in your .vimrc. To disable restoring:
5751 set t_ti= t_te=
5752 To enable restoring (for an xterm):
5753 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5754 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5755
5756 *'revins'* *'ri'* *'norevins'* *'nori'*
5757'revins' 'ri' boolean (default off)
5758 global
5759 {not in Vi}
5760 {only available when compiled with the |+rightleft|
5761 feature}
5762 Inserting characters in Insert mode will work backwards. See "typing
5763 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5764 command in Insert mode, when 'allowrevins' is set.
5765 NOTE: This option is reset when 'compatible' or 'paste' is set.
5766
5767 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5768'rightleft' 'rl' boolean (default off)
5769 local to window
5770 {not in Vi}
5771 {only available when compiled with the |+rightleft|
5772 feature}
5773 When on, display orientation becomes right-to-left, i.e., characters
5774 that are stored in the file appear from the right to the left.
5775 Using this option, it is possible to edit files for languages that
5776 are written from the right to the left such as Hebrew and Arabic.
5777 This option is per window, so it is possible to edit mixed files
5778 simultaneously, or to view the same file in both ways (this is
5779 useful whenever you have a mixed text file with both right-to-left
5780 and left-to-right strings so that both sets are displayed properly
5781 in different windows). Also see |rileft.txt|.
5782
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005783 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784'rightleftcmd' 'rlc' string (default "search")
5785 local to window
5786 {not in Vi}
5787 {only available when compiled with the |+rightleft|
5788 feature}
5789 Each word in this option enables the command line editing to work in
5790 right-to-left mode for a group of commands:
5791
5792 search "/" and "?" commands
5793
5794 This is useful for languages such as Hebrew, Arabic and Farsi.
5795 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5796
5797 *'ruler'* *'ru'* *'noruler'* *'noru'*
5798'ruler' 'ru' boolean (default off)
5799 global
5800 {not in Vi}
5801 {not available when compiled without the
5802 |+cmdline_info| feature}
5803 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005804 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 text in the file is shown on the far right:
5806 Top first line is visible
5807 Bot last line is visible
5808 All first and last line are visible
5809 45% relative position in the file
5810 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005811 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005812 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005813 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005814 this option takes precedence over 'ruler' and 'rulerformat'
5815 If the number of characters displayed is different from the number of
5816 bytes in the text (e.g., for a TAB or a multi-byte character), both
5817 the text column (byte number) and the screen column are shown,
5818 separated with a dash.
5819 For an empty line "0-1" is shown.
5820 For an empty buffer the line number will also be zero: "0,0-1".
5821 This option is reset when the 'paste' option is set.
5822 If you don't want to see the ruler all the time but want to know where
5823 you are, use "g CTRL-G" |g_CTRL-G|.
5824 NOTE: This option is reset when 'compatible' is set.
5825
5826 *'rulerformat'* *'ruf'*
5827'rulerformat' 'ruf' string (default empty)
5828 global
5829 {not in Vi}
5830 {not available when compiled without the |+statusline|
5831 feature}
5832 When this option is not empty, it determines the content of the ruler
5833 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005834 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 The default ruler width is 17 characters. To make the ruler 15
5836 characters wide, put "%15(" at the start and "%)" at the end.
5837 Example: >
5838 :set rulerformat=%15(%c%V\ %p%%%)
5839<
5840 *'runtimepath'* *'rtp'* *vimfiles*
5841'runtimepath' 'rtp' string (default:
5842 Unix: "$HOME/.vim,
5843 $VIM/vimfiles,
5844 $VIMRUNTIME,
5845 $VIM/vimfiles/after,
5846 $HOME/.vim/after"
5847 Amiga: "home:vimfiles,
5848 $VIM/vimfiles,
5849 $VIMRUNTIME,
5850 $VIM/vimfiles/after,
5851 home:vimfiles/after"
5852 PC, OS/2: "$HOME/vimfiles,
5853 $VIM/vimfiles,
5854 $VIMRUNTIME,
5855 $VIM/vimfiles/after,
5856 $HOME/vimfiles/after"
5857 Macintosh: "$VIM:vimfiles,
5858 $VIMRUNTIME,
5859 $VIM:vimfiles:after"
5860 RISC-OS: "Choices:vimfiles,
5861 $VIMRUNTIME,
5862 Choices:vimfiles/after"
5863 VMS: "sys$login:vimfiles,
5864 $VIM/vimfiles,
5865 $VIMRUNTIME,
5866 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005867 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 global
5869 {not in Vi}
5870 This is a list of directories which will be searched for runtime
5871 files:
5872 filetype.vim filetypes by file name |new-filetype|
5873 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005874 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 colors/ color scheme files |:colorscheme|
5876 compiler/ compiler files |:compiler|
5877 doc/ documentation |write-local-help|
5878 ftplugin/ filetype plugins |write-filetype-plugin|
5879 indent/ indent scripts |indent-expression|
5880 keymap/ key mapping files |mbyte-keymap|
5881 lang/ menu translations |:menutrans|
5882 menu.vim GUI menus |menu.vim|
5883 plugin/ plugin scripts |write-plugin|
5884 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005885 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 syntax/ syntax files |mysyntaxfile|
5887 tutor/ files for vimtutor |tutor|
5888
5889 And any other file searched for with the |:runtime| command.
5890
5891 The defaults for most systems are setup to search five locations:
5892 1. In your home directory, for your personal preferences.
5893 2. In a system-wide Vim directory, for preferences from the system
5894 administrator.
5895 3. In $VIMRUNTIME, for files distributed with Vim.
5896 *after-directory*
5897 4. In the "after" directory in the system-wide Vim directory. This is
5898 for the system administrator to overrule or add to the distributed
5899 defaults (rarely needed)
5900 5. In the "after" directory in your home directory. This is for
5901 personal preferences to overrule or add to the distributed defaults
5902 or system-wide settings (rarely needed).
5903
5904 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5905 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005906 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 wildcards.
5908 See |:runtime|.
5909 Example: >
5910 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5911< This will use the directory "~/vimruntime" first (containing your
5912 personal Vim runtime files), then "/mygroup/vim" (shared between a
5913 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5914 files).
5915 You probably should always include $VIMRUNTIME somewhere, to use the
5916 distributed runtime files. You can put a directory before $VIMRUNTIME
5917 to find files which replace a distributed runtime files. You can put
5918 a directory after $VIMRUNTIME to find files which add to distributed
5919 runtime files.
5920 This option cannot be set from a |modeline| or in the |sandbox|, for
5921 security reasons.
5922
5923 *'scroll'* *'scr'*
5924'scroll' 'scr' number (default: half the window height)
5925 local to window
5926 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5927 set to half the number of lines in the window when the window size
5928 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005929 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5931 the number of screen lines instead of file lines, makes a difference
5932 when lines wrap}
5933
5934 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5935'scrollbind' 'scb' boolean (default off)
5936 local to window
5937 {not in Vi}
5938 {not available when compiled without the |+scrollbind|
5939 feature}
5940 See also |scroll-binding|. When this option is set, the current
5941 window scrolls as other scrollbind windows (windows that also have
5942 this option set) scroll. This option is useful for viewing the
5943 differences between two versions of a file, see 'diff'.
5944 See |'scrollopt'| for options that determine how this option should be
5945 interpreted.
5946 This option is mostly reset when splitting a window to edit another
5947 file. This means that ":split | edit file" results in two windows
5948 with scroll-binding, but ":split file" does not.
5949
5950 *'scrolljump'* *'sj'*
5951'scrolljump' 'sj' number (default 1)
5952 global
5953 {not in Vi}
5954 Minimal number of lines to scroll when the cursor gets off the
5955 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5956 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005957 When set to a negative number from -1 to -100 this is used as the
5958 percentage of the window height. Thus -50 scrolls half the window
5959 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 NOTE: This option is set to 1 when 'compatible' is set.
5961
5962 *'scrolloff'* *'so'*
5963'scrolloff' 'so' number (default 0)
5964 global
5965 {not in Vi}
5966 Minimal number of screen lines to keep above and below the cursor.
5967 This will make some context visible around where you are working. If
5968 you set it to a very large value (999) the cursor line will always be
5969 in the middle of the window (except at the start or end of the file or
5970 when long lines wrap).
5971 For scrolling horizontally see 'sidescrolloff'.
5972 NOTE: This option is set to 0 when 'compatible' is set.
5973
5974 *'scrollopt'* *'sbo'*
5975'scrollopt' 'sbo' string (default "ver,jump")
5976 global
5977 {not available when compiled without the |+scrollbind|
5978 feature}
5979 {not in Vi}
5980 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005981 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5982 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 The following words are available:
5984 ver Bind vertical scrolling for 'scrollbind' windows
5985 hor Bind horizontal scrolling for 'scrollbind' windows
5986 jump Applies to the offset between two windows for vertical
5987 scrolling. This offset is the difference in the first
5988 displayed line of the bound windows. When moving
5989 around in a window, another 'scrollbind' window may
5990 reach a position before the start or after the end of
5991 the buffer. The offset is not changed though, when
5992 moving back the 'scrollbind' window will try to scroll
5993 to the desired position when possible.
5994 When now making that window the current one, two
5995 things can be done with the relative offset:
5996 1. When "jump" is not included, the relative offset is
5997 adjusted for the scroll position in the new current
5998 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005999 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 2. When "jump" is included, the other windows are
6001 scrolled to keep the same relative offset. When
6002 going back to the other window, it still uses the
6003 same relative offset.
6004 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006005 When 'diff' mode is active there always is vertical scroll binding,
6006 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007
6008 *'sections'* *'sect'*
6009'sections' 'sect' string (default "SHNHH HUnhsh")
6010 global
6011 Specifies the nroff macros that separate sections. These are pairs of
6012 two letters (See |object-motions|). The default makes a section start
6013 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6014
6015 *'secure'* *'nosecure'* *E523*
6016'secure' boolean (default off)
6017 global
6018 {not in Vi}
6019 When on, ":autocmd", shell and write commands are not allowed in
6020 ".vimrc" and ".exrc" in the current directory and map commands are
6021 displayed. Switch it off only if you know that you will not run into
6022 problems, or when the 'exrc' option is off. On Unix this option is
6023 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006024 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 'secure' at the end of your ~/.vimrc then.
6026 This option cannot be set from a |modeline| or in the |sandbox|, for
6027 security reasons.
6028
6029 *'selection'* *'sel'*
6030'selection' 'sel' string (default "inclusive")
6031 global
6032 {not in Vi}
6033 This option defines the behavior of the selection. It is only used
6034 in Visual and Select mode.
6035 Possible values:
6036 value past line inclusive ~
6037 old no yes
6038 inclusive yes yes
6039 exclusive yes no
6040 "past line" means that the cursor is allowed to be positioned one
6041 character past the line.
6042 "inclusive" means that the last character of the selection is included
6043 in an operation. For example, when "x" is used to delete the
6044 selection.
6045 Note that when "exclusive" is used and selecting from the end
6046 backwards, you cannot include the last character of a line, when
6047 starting in Normal mode and 'virtualedit' empty.
6048
6049 The 'selection' option is set by the |:behave| command.
6050
6051 *'selectmode'* *'slm'*
6052'selectmode' 'slm' string (default "")
6053 global
6054 {not in Vi}
6055 This is a comma separated list of words, which specifies when to start
6056 Select mode instead of Visual mode, when a selection is started.
6057 Possible values:
6058 mouse when using the mouse
6059 key when using shifted special keys
6060 cmd when using "v", "V" or CTRL-V
6061 See |Select-mode|.
6062 The 'selectmode' option is set by the |:behave| command.
6063
6064 *'sessionoptions'* *'ssop'*
6065'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006066 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 global
6068 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006069 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 feature}
6071 Changes the effect of the |:mksession| command. It is a comma
6072 separated list of words. Each word enables saving and restoring
6073 something:
6074 word save and restore ~
6075 blank empty windows
6076 buffers hidden and unloaded buffers, not just those in windows
6077 curdir the current directory
6078 folds manually created folds, opened/closed folds and local
6079 fold options
6080 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006081 and contain at least one lowercase letter. Only
6082 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 help the help window
6084 localoptions options and mappings local to a window or buffer (not
6085 global values for local options)
6086 options all options and mappings (also global values for local
6087 options)
6088 resize size of the Vim window: 'lines' and 'columns'
6089 sesdir the directory in which the session file is located
6090 will become the current directory (useful with
6091 projects accessed over a network from different
6092 systems)
6093 slash backslashes in file names replaced with forward
6094 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006095 tabpages all tab pages; without this only the current tab page
6096 is restored, so that you can make a session for each
6097 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 unix with Unix end-of-line format (single <NL>), even when
6099 on Windows or DOS
6100 winpos position of the whole Vim window
6101 winsize window sizes
6102
6103 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006104 When neither "curdir" nor "sesdir" is included, file names are stored
6105 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 "slash" and "unix" are useful on Windows when sharing session files
6107 with Unix. The Unix version of Vim cannot source dos format scripts,
6108 but the Windows version of Vim can source unix format scripts.
6109
6110 *'shell'* *'sh'* *E91*
6111'shell' 'sh' string (default $SHELL or "sh",
6112 MS-DOS and Win32: "command.com" or
6113 "cmd.exe", OS/2: "cmd")
6114 global
6115 Name of the shell to use for ! and :! commands. When changing the
6116 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6117 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006118 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 See |option-backslash| about including spaces and backslashes.
6120 Environment variables are expanded |:set_env|.
6121 If the name of the shell contains a space, you might need to enclose
6122 it in quotes. Example: >
6123 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6124< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006125 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006126 "-f" is not inside the quotes, because it is not part of the command
6127 name. And Vim automagically recognizes the backslashes that are path
6128 separators.
6129 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6130 variable to change the way external commands are executed. See the
6131 libc.inf file of DJGPP.
6132 Under MS-Windows, when the executable ends in ".com" it must be
6133 included. Thus setting the shell to "command.com" or "4dos.com"
6134 works, but "command" and "4dos" do not work for all commands (e.g.,
6135 filtering).
6136 For unknown reasons, when using "4dos.com" the current directory is
6137 changed to "C:\". To avoid this set 'shell' like this: >
6138 :set shell=command.com\ /c\ 4dos
6139< This option cannot be set from a |modeline| or in the |sandbox|, for
6140 security reasons.
6141
6142 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006143'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006144 MS-DOS and Win32, when 'shell' does not
6145 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 global
6147 {not in Vi}
6148 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6149 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6150 systems, the default is set according to the value of 'shell', to
6151 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006152 OS/2 (EMX figures this out itself).
6153 On Unix it can have more than one flag. Each white space separated
6154 part is passed as an argument to the shell command.
6155 See |option-backslash| about including spaces and backslashes.
6156 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 This option cannot be set from a |modeline| or in the |sandbox|, for
6158 security reasons.
6159
6160 *'shellpipe'* *'sp'*
6161'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6162 global
6163 {not in Vi}
6164 {not available when compiled without the |+quickfix|
6165 feature}
6166 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006167 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 including spaces and backslashes.
6169 The name of the temporary file can be represented by "%s" if necessary
6170 (the file name is appended automatically if no %s appears in the value
6171 of this option).
6172 For the Amiga and MS-DOS the default is ">". The output is directly
6173 saved in a file and not echoed to the screen.
6174 For Unix the default it "| tee". The stdout of the compiler is saved
6175 in a file and echoed to the screen. If the 'shell' option is "csh" or
6176 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006177 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6178 default becomes "2>&1| tee". This means that stderr is also included.
6179 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6180 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 The initialization of this option is done after reading the ".vimrc"
6182 and the other initializations, so that when the 'shell' option is set
6183 there, the 'shellpipe' option changes automatically, unless it was
6184 explicitly set before.
6185 When 'shellpipe' is set to an empty string, no redirection of the
6186 ":make" output will be done. This is useful if you use a 'makeprg'
6187 that writes to 'makeef' by itself. If you want no piping, but do
6188 want to include the 'makeef', set 'shellpipe' to a single space.
6189 Don't forget to precede the space with a backslash: ":set sp=\ ".
6190 In the future pipes may be used for filtering and this option will
6191 become obsolete (at least for Unix).
6192 This option cannot be set from a |modeline| or in the |sandbox|, for
6193 security reasons.
6194
6195 *'shellquote'* *'shq'*
6196'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6197 contains "sh" somewhere: "\"")
6198 global
6199 {not in Vi}
6200 Quoting character(s), put around the command passed to the shell, for
6201 the "!" and ":!" commands. The redirection is kept outside of the
6202 quoting. See 'shellxquote' to include the redirection. It's
6203 probably not useful to set both options.
6204 This is an empty string by default. Only known to be useful for
6205 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6206 or bash, where it should be "\"". The default is adjusted according
6207 the value of 'shell', to reduce the need to set this option by the
6208 user. See |dos-shell|.
6209 This option cannot be set from a |modeline| or in the |sandbox|, for
6210 security reasons.
6211
6212 *'shellredir'* *'srr'*
6213'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6214 global
6215 {not in Vi}
6216 String to be used to put the output of a filter command in a temporary
6217 file. See also |:!|. See |option-backslash| about including spaces
6218 and backslashes.
6219 The name of the temporary file can be represented by "%s" if necessary
6220 (the file name is appended automatically if no %s appears in the value
6221 of this option).
6222 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6223 or "zsh" during initializations, the default becomes ">&". If the
6224 'shell' option is "sh", "ksh" or "bash" the default becomes
6225 ">%s 2>&1". This means that stderr is also included.
6226 For Win32, the Unix checks are done and additionally "cmd" is checked
6227 for, which makes the default ">%s 2>&1". Also, the same names with
6228 ".exe" appended are checked for.
6229 The initialization of this option is done after reading the ".vimrc"
6230 and the other initializations, so that when the 'shell' option is set
6231 there, the 'shellredir' option changes automatically unless it was
6232 explicitly set before.
6233 In the future pipes may be used for filtering and this option will
6234 become obsolete (at least for Unix).
6235 This option cannot be set from a |modeline| or in the |sandbox|, for
6236 security reasons.
6237
6238 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6239'shellslash' 'ssl' boolean (default off)
6240 global
6241 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6242 When set, a forward slash is used when expanding file names. This is
6243 useful when a Unix-like shell is used instead of command.com or
6244 cmd.exe. Backward slashes can still be typed, but they are changed to
6245 forward slashes by Vim.
6246 Note that setting or resetting this option has no effect for some
6247 existing file names, thus this option needs to be set before opening
6248 any file for best results. This might change in the future.
6249 'shellslash' only works when a backslash can be used as a path
6250 separator. To test if this is so use: >
6251 if exists('+shellslash')
6252<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006253 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6254'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6255 global
6256 {not in Vi}
6257 When on, use temp files for shell commands. When off use a pipe.
6258 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006259 Currently a pipe is only supported on Unix and MS-Windows 2K and
6260 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006261 :if has("filterpipe")
6262< The advantage of using a pipe is that nobody can read the temp file
6263 and the 'shell' command does not need to support redirection.
6264 The advantage of using a temp file is that the file type and encoding
6265 can be detected.
6266 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6267 |FilterWritePost| autocommands event are not triggered when
6268 'shelltemp' is off.
6269
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 *'shelltype'* *'st'*
6271'shelltype' 'st' number (default 0)
6272 global
6273 {not in Vi} {only for the Amiga}
6274 On the Amiga this option influences the way how the commands work
6275 which use a shell.
6276 0 and 1: always use the shell
6277 2 and 3: use the shell only to filter lines
6278 4 and 5: use shell only for ':sh' command
6279 When not using the shell, the command is executed directly.
6280
6281 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6282 1 and 3: use "shell cmd" to start external commands
6283
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006284 *'shellxescape'* *'sxe'*
6285'shellxescape' 'sxe' string (default: "";
6286 for MS-DOS and MS-Windows: "\"&|<>()@^")
6287 global
6288 {not in Vi}
6289 When 'shellxquote' is set to "(" then the characters listed in this
6290 option will be escaped with a '^' character. This makes it possible
6291 to execute most external commands with cmd.exe.
6292
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 *'shellxquote'* *'sxq'*
6294'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006295 for Win32, when 'shell' is cmd.exe: "("
6296 for Win32, when 'shell' contains "sh"
6297 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 for Unix, when using system(): "\"")
6299 global
6300 {not in Vi}
6301 Quoting character(s), put around the command passed to the shell, for
6302 the "!" and ":!" commands. Includes the redirection. See
6303 'shellquote' to exclude the redirection. It's probably not useful
6304 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006305 When the value is '(' then ')' is appended. When the value is '"('
6306 then ')"' is appended.
6307 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006308 This is an empty string by default on most systems, but is known to be
6309 useful for on Win32 version, either for cmd.exe which automatically
6310 strips off the first and last quote on a command, or 3rd-party shells
6311 such as the MKS Korn Shell or bash, where it should be "\"". The
6312 default is adjusted according the value of 'shell', to reduce the need
6313 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 This option cannot be set from a |modeline| or in the |sandbox|, for
6315 security reasons.
6316
6317 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6318'shiftround' 'sr' boolean (default off)
6319 global
6320 {not in Vi}
6321 Round indent to multiple of 'shiftwidth'. Applies to > and <
6322 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6323 a multiple of 'shiftwidth' (this is Vi compatible).
6324 NOTE: This option is reset when 'compatible' is set.
6325
6326 *'shiftwidth'* *'sw'*
6327'shiftwidth' 'sw' number (default 8)
6328 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006329 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006331 When zero the 'ts' value will be used. Use the |shiftwidth()|
6332 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333
6334 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006335'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6336 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 global
6338 {not in Vi}
6339 This option helps to avoid all the |hit-enter| prompts caused by file
6340 messages, for example with CTRL-G, and to avoid some other messages.
6341 It is a list of flags:
6342 flag meaning when present ~
6343 f use "(3 of 5)" instead of "(file 3 of 5)"
6344 i use "[noeol]" instead of "[Incomplete last line]"
6345 l use "999L, 888C" instead of "999 lines, 888 characters"
6346 m use "[+]" instead of "[Modified]"
6347 n use "[New]" instead of "[New File]"
6348 r use "[RO]" instead of "[readonly]"
6349 w use "[w]" instead of "written" for file write message
6350 and "[a]" instead of "appended" for ':w >> file' command
6351 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6352 "[unix format]" and "[mac]" instead of "[mac format]".
6353 a all of the above abbreviations
6354
6355 o overwrite message for writing a file with subsequent message
6356 for reading a file (useful for ":wn" or when 'autowrite' on)
6357 O message for reading a file overwrites any previous message.
6358 Also for quickfix message (e.g., ":cn").
6359 s don't give "search hit BOTTOM, continuing at TOP" or "search
6360 hit TOP, continuing at BOTTOM" messages
6361 t truncate file message at the start if it is too long to fit
6362 on the command-line, "<" will appear in the left most column.
6363 Ignored in Ex mode.
6364 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006365 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 Ignored in Ex mode.
6367 W don't give "written" or "[w]" when writing a file
6368 A don't give the "ATTENTION" message when an existing swap file
6369 is found.
6370 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006371 c don't give |ins-completion-menu| messages. For example,
6372 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6373 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374
6375 This gives you the opportunity to avoid that a change between buffers
6376 requires you to hit <Enter>, but still gives as useful a message as
6377 possible for the space available. To get the whole message that you
6378 would have got with 'shm' empty, use ":file!"
6379 Useful values:
6380 shm= No abbreviation of message.
6381 shm=a Abbreviation, but no loss of information.
6382 shm=at Abbreviation, and truncate message when necessary.
6383
6384 NOTE: This option is set to the Vi default value when 'compatible' is
6385 set and to the Vim default value when 'compatible' is reset.
6386
6387 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6388'shortname' 'sn' boolean (default off)
6389 local to buffer
6390 {not in Vi, not in MS-DOS versions}
6391 Filenames are assumed to be 8 characters plus one extension of 3
6392 characters. Multiple dots in file names are not allowed. When this
6393 option is on, dots in file names are replaced with underscores when
6394 adding an extension (".~" or ".swp"). This option is not available
6395 for MS-DOS, because then it would always be on. This option is useful
6396 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6397 or crossdos. When running the Win32 GUI version under Win32s, this
6398 option is always on by default.
6399
6400 *'showbreak'* *'sbr'* *E595*
6401'showbreak' 'sbr' string (default "")
6402 global
6403 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006404 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 feature}
6406 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006407 values are "> " or "+++ ": >
6408 :set showbreak=>\
6409< Note the backslash to escape the trailing space. It's easier like
6410 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006411 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006412< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006413 comma (in a future version the comma might be used to separate the
6414 part that is shown at the end and at the start of a line).
6415 The characters are highlighted according to the '@' flag in
6416 'highlight'.
6417 Note that tabs after the showbreak will be displayed differently.
6418 If you want the 'showbreak' to appear in between line numbers, add the
6419 "n" flag to 'cpoptions'.
6420
6421 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6422'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6423 off)
6424 global
6425 {not in Vi}
6426 {not available when compiled without the
6427 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006428 Show (partial) command in the last line of the screen. Set this
6429 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 In Visual mode the size of the selected area is shown:
6431 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006432 If the number of bytes is different it is also displayed: "2-6"
6433 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006435 - When selecting a block, the size in screen characters:
6436 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 NOTE: This option is set to the Vi default value when 'compatible' is
6438 set and to the Vim default value when 'compatible' is reset.
6439
6440 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6441'showfulltag' 'sft' boolean (default off)
6442 global
6443 {not in Vi}
6444 When completing a word in insert mode (see |ins-completion|) from the
6445 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006446 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 matched a C function, you can see a template for what arguments are
6448 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006449 Note that this doesn't work well together with having "longest" in
6450 'completeopt', because the completion from the search pattern may not
6451 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452
6453 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6454'showmatch' 'sm' boolean (default off)
6455 global
6456 When a bracket is inserted, briefly jump to the matching one. The
6457 jump is only done if the match can be seen on the screen. The time to
6458 show the match can be set with 'matchtime'.
6459 A Beep is given if there is no match (no matter if the match can be
6460 seen or not). This option is reset when the 'paste' option is set.
6461 When the 'm' flag is not included in 'cpoptions', typing a character
6462 will immediately move the cursor back to where it belongs.
6463 See the "sm" field in 'guicursor' for setting the cursor shape and
6464 blinking when showing the match.
6465 The 'matchpairs' option can be used to specify the characters to show
6466 matches for. 'rightleft' and 'revins' are used to look for opposite
6467 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006468 Also see the matchparen plugin for highlighting the match when moving
6469 around |pi_paren.txt|.
6470 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471
6472 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6473'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6474 global
6475 If in Insert, Replace or Visual mode put a message on the last line.
6476 Use the 'M' flag in 'highlight' to set the type of highlighting for
6477 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 doesn't mean XIM is really active, especially when 'imactivatekey' is
6480 not set.
6481 NOTE: This option is set to the Vi default value when 'compatible' is
6482 set and to the Vim default value when 'compatible' is reset.
6483
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006484 *'showtabline'* *'stal'*
6485'showtabline' 'stal' number (default 1)
6486 global
6487 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006488 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006489 feature}
6490 The value of this option specifies when the line with tab page labels
6491 will be displayed:
6492 0: never
6493 1: only if there are at least two tab pages
6494 2: always
6495 This is both for the GUI and non-GUI implementation of the tab pages
6496 line.
6497 See |tab-page| for more information about tab pages.
6498
Bram Moolenaar071d4272004-06-13 20:20:40 +00006499 *'sidescroll'* *'ss'*
6500'sidescroll' 'ss' number (default 0)
6501 global
6502 {not in Vi}
6503 The minimal number of columns to scroll horizontally. Used only when
6504 the 'wrap' option is off and the cursor is moved off of the screen.
6505 When it is zero the cursor will be put in the middle of the screen.
6506 When using a slow terminal set it to a large number or 0. When using
6507 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6508 commands.
6509
6510 *'sidescrolloff'* *'siso'*
6511'sidescrolloff' 'siso' number (default 0)
6512 global
6513 {not in Vi}
6514 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006515 right of the cursor if 'nowrap' is set. Setting this option to a
6516 value greater than 0 while having |'sidescroll'| also at a non-zero
6517 value makes some context visible in the line you are scrolling in
6518 horizontally (except at beginning of the line). Setting this option
6519 to a large value (like 999) has the effect of keeping the cursor
6520 horizontally centered in the window, as long as one does not come too
6521 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 NOTE: This option is set to 0 when 'compatible' is set.
6523
6524 Example: Try this together with 'sidescroll' and 'listchars' as
6525 in the following example to never allow the cursor to move
6526 onto the "extends" character:
6527
6528 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6529 :set sidescrolloff=1
6530
6531
6532 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6533'smartcase' 'scs' boolean (default off)
6534 global
6535 {not in Vi}
6536 Override the 'ignorecase' option if the search pattern contains upper
6537 case characters. Only used when the search pattern is typed and
6538 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006539 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6541 recalling the search pattern from history and hitting <Enter>.
6542 NOTE: This option is reset when 'compatible' is set.
6543
6544 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6545'smartindent' 'si' boolean (default off)
6546 local to buffer
6547 {not in Vi}
6548 {not available when compiled without the
6549 |+smartindent| feature}
6550 Do smart autoindenting when starting a new line. Works for C-like
6551 programs, but can also be used for other languages. 'cindent' does
6552 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006553 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006554 setting 'si' has no effect. 'indentexpr' is a more advanced
6555 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 Normally 'autoindent' should also be on when using 'smartindent'.
6557 An indent is automatically inserted:
6558 - After a line ending in '{'.
6559 - After a line starting with a keyword from 'cinwords'.
6560 - Before a line starting with '}' (only with the "O" command).
6561 When typing '}' as the first character in a new line, that line is
6562 given the same indent as the matching '{'.
6563 When typing '#' as the first character in a new line, the indent for
6564 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006565 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6567 When using the ">>" command, lines starting with '#' are not shifted
6568 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006569 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 is set smart indenting is disabled.
6571
6572 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6573'smarttab' 'sta' boolean (default off)
6574 global
6575 {not in Vi}
6576 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006577 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6578 <BS> will delete a 'shiftwidth' worth of space at the start of the
6579 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006580 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006581 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6582 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006583 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006585 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 NOTE: This option is reset when 'compatible' is set.
6587
6588 *'softtabstop'* *'sts'*
6589'softtabstop' 'sts' number (default 0)
6590 local to buffer
6591 {not in Vi}
6592 Number of spaces that a <Tab> counts for while performing editing
6593 operations, like inserting a <Tab> or using <BS>. It "feels" like
6594 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6595 used. This is useful to keep the 'ts' setting at its standard value
6596 of 8, while being able to edit like it is set to 'sts'. However,
6597 commands like "x" still work on the actual characters.
6598 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006599 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 'softtabstop' is set to 0 when the 'paste' option is set.
6601 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6602 spaces is minimized by using <Tab>s.
6603 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6604 set.
6605 NOTE: This option is set to 0 when 'compatible' is set.
6606
Bram Moolenaar217ad922005-03-20 22:37:15 +00006607 *'spell'* *'nospell'*
6608'spell' boolean (default off)
6609 local to window
6610 {not in Vi}
6611 {not available when compiled without the |+syntax|
6612 feature}
6613 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006614 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006615
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006616 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006617'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006618 local to buffer
6619 {not in Vi}
6620 {not available when compiled without the |+syntax|
6621 feature}
6622 Pattern to locate the end of a sentence. The following word will be
6623 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006624 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006625 When this check is not wanted make this option empty.
6626 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006627 Be careful with special characters, see |option-backslash| about
6628 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006629 To set this option automatically depending on the language, see
6630 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006631
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006632 *'spellfile'* *'spf'*
6633'spellfile' 'spf' string (default empty)
6634 local to buffer
6635 {not in Vi}
6636 {not available when compiled without the |+syntax|
6637 feature}
6638 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006639 commands. It must end in ".{encoding}.add". You need to include the
6640 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006641 *E765*
6642 It may also be a comma separated list of names. A count before the
6643 |zg| and |zw| commands can be used to access each. This allows using
6644 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006645 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006646 you: Using the first directory in 'runtimepath' that is writable. If
6647 there is no "spell" directory yet it will be created. For the file
6648 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006649 ignoring the region.
6650 The resulting ".spl" file will be used for spell checking, it does not
6651 have to appear in 'spelllang'.
6652 Normally one file is used for all regions, but you can add the region
6653 name if you want to. However, it will then only be used when
6654 'spellfile' is set to it, for entries in 'spelllang' only files
6655 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006656 This option cannot be set from a |modeline| or in the |sandbox|, for
6657 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006658
Bram Moolenaar217ad922005-03-20 22:37:15 +00006659 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006660'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006661 local to buffer
6662 {not in Vi}
6663 {not available when compiled without the |+syntax|
6664 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006665 A comma separated list of word list names. When the 'spell' option is
6666 on spellchecking will be done for these languages. Example: >
6667 set spelllang=en_us,nl,medical
6668< This means US English, Dutch and medical words are recognized. Words
6669 that are not recognized will be highlighted.
6670 The word list name must not include a comma or dot. Using a dash is
6671 recommended to separate the two letter language name from a
6672 specification. Thus "en-rare" is used for rare English words.
6673 A region name must come last and have the form "_xx", where "xx" is
6674 the two-letter, lower case region name. You can use more than one
6675 region by listing them: "en_us,en_ca" supports both US and Canadian
6676 English, but not words specific for Australia, New Zealand or Great
6677 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006678 If the name "cjk" is included East Asian characters are excluded from
6679 spell checking. This is useful when editing text that also has Asian
6680 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006681 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006682 As a special case the name of a .spl file can be given as-is. The
6683 first "_xx" in the name is removed and used as the region name
6684 (_xx is an underscore, two letters and followed by a non-letter).
6685 This is mainly for testing purposes. You must make sure the correct
6686 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006687 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006688 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6689 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006690 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006691
Bram Moolenaar98692072006-02-04 00:57:42 +00006692 If the |spellfile.vim| plugin is active and you use a language name
6693 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6694 will ask you if you want to download the file.
6695
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006696 After this option has been set successfully, Vim will source the files
6697 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006698 up to the first comma, dot or underscore.
6699 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006700
6701
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006702 *'spellsuggest'* *'sps'*
6703'spellsuggest' 'sps' string (default "best")
6704 global
6705 {not in Vi}
6706 {not available when compiled without the |+syntax|
6707 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006708 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006709 the |spellsuggest()| function. This is a comma-separated list of
6710 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006711
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006712 best Internal method that works best for English. Finds
6713 changes like "fast" and uses a bit of sound-a-like
6714 scoring to improve the ordering.
6715
6716 double Internal method that uses two methods and mixes the
6717 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006718 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006719 word. That only works when the language specifies
6720 sound folding. Can be slow and doesn't always give
6721 better results.
6722
6723 fast Internal method that only checks for simple changes:
6724 character inserts/deletes/swaps. Works well for
6725 simple typing mistakes.
6726
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006727 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006728 Not used for |spellsuggest()|. The number of
6729 suggestions is never more than the value of 'lines'
6730 minus two.
6731
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006732 file:{filename} Read file {filename}, which must have two columns,
6733 separated by a slash. The first column contains the
6734 bad word, the second column the suggested good word.
6735 Example:
6736 theribal/terrible ~
6737 Use this for common mistakes that do not appear at the
6738 top of the suggestion list with the internal methods.
6739 Lines without a slash are ignored, use this for
6740 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006741 The word in the second column must be correct,
6742 otherwise it will not be used. Add the word to an
6743 ".add" file if it is currently flagged as a spelling
6744 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006745 The file is used for all languages.
6746
6747 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6748 trouble with spaces. |v:val| holds the badly spelled
6749 word. The expression must evaluate to a List of
6750 Lists, each with a suggestion and a score.
6751 Example:
6752 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006753 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006754 internal methods use. A lower score is better.
6755 This may invoke |spellsuggest()| if you temporarily
6756 set 'spellsuggest' to exclude the "expr:" part.
6757 Errors are silently ignored, unless you set the
6758 'verbose' option to a non-zero value.
6759
6760 Only one of "best", "double" or "fast" may be used. The others may
6761 appear several times in any order. Example: >
6762 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6763<
6764 This option cannot be set from a |modeline| or in the |sandbox|, for
6765 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006766
6767
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6769'splitbelow' 'sb' boolean (default off)
6770 global
6771 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006772 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 feature}
6774 When on, splitting a window will put the new window below the current
6775 one. |:split|
6776
6777 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6778'splitright' 'spr' boolean (default off)
6779 global
6780 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006781 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 feature}
6783 When on, splitting a window will put the new window right of the
6784 current one. |:vsplit|
6785
6786 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6787'startofline' 'sol' boolean (default on)
6788 global
6789 {not in Vi}
6790 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006791 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006792 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006793 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006794 with a linewise operator, with "%" with a count and to buffer changing
6795 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6796 only has a line number, e.g., ":25" or ":+".
6797 In case of buffer changing commands the cursor is placed at the column
6798 where it was the last time the buffer was edited.
6799 NOTE: This option is set when 'compatible' is set.
6800
Bram Moolenaar00654022011-02-25 14:42:19 +01006801 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006803 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 {not in Vi}
6805 {not available when compiled without the |+statusline|
6806 feature}
6807 When nonempty, this option determines the content of the status line.
6808 Also see |status-line|.
6809
6810 The option consists of printf style '%' items interspersed with
6811 normal text. Each status line item is of the form:
6812 %-0{minwid}.{maxwid}{item}
6813 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006814 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815
Bram Moolenaar238a5642006-02-21 22:12:05 +00006816 When the option starts with "%!" then it is used as an expression,
6817 evaluated and the result is used as the option value. Example: >
6818 :set statusline=%!MyStatusLine()
6819< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006820 Note that the "%!" expression is evaluated in the context of the
6821 current window and buffer, while %{} items are evaluated in the
6822 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006823
6824 When there is error while evaluating the option then it will be made
6825 empty to avoid further errors. Otherwise screen updating would loop.
6826
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 Note that the only effect of 'ruler' when this option is set (and
6828 'laststatus' is 2) is controlling the output of |CTRL-G|.
6829
6830 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006831 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006833 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834 minwid Minimum width of the item, padding as set by '-' & '0'.
6835 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006836 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 on the left for text items. Numeric items will be
6838 shifted down to maxwid-2 digits followed by '>'number
6839 where number is the amount of missing digits, much like
6840 an exponential notation.
6841 item A one letter code as described below.
6842
6843 Following is a description of the possible statusline items. The
6844 second character in "item" is the type:
6845 N for number
6846 S for string
6847 F for flags as described below
6848 - not applicable
6849
6850 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006851 f S Path to the file in the buffer, as typed or relative to current
6852 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 F S Full path to the file in the buffer.
6854 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006855 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006857 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006859 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006861 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006862 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006863 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6865 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006866 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6868 being used: "<keymap>"
6869 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006870 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 B N As above, in hexadecimal.
6872 o N Byte number in file of byte under cursor, first byte is 1.
6873 Mnemonic: Offset from start of file (with one added)
6874 {not available when compiled without |+byte_offset| feature}
6875 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006876 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 l N Line number.
6878 L N Number of lines in buffer.
6879 c N Column number.
6880 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006881 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882 p N Percentage through file in lines as in |CTRL-G|.
6883 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006884 percentage described for 'ruler'. Always 3 in length, unless
6885 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006886 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006888 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006889 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006890 ( - Start of item group. Can be used for setting the width and
6891 alignment of a section. Must be followed by %) somewhere.
6892 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006893 T N For 'tabline': start of tab page N label. Use %T after the last
6894 label. This information is used for mouse clicks.
6895 X N For 'tabline': start of close tab N label. Use %X after the
6896 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6897 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 < - Where to truncate line if too long. Default is at the start.
6899 No width fields allowed.
6900 = - Separation point between left and right aligned items.
6901 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006902 # - Set highlight group. The name must follow and then a # again.
6903 Thus use %#HLname# for highlight group HLname. The same
6904 highlighting is used, also for the statusline of non-current
6905 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006907 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 The difference between User{N} and StatusLine will be applied
6909 to StatusLineNC for the statusline of non-current windows.
6910 The number N must be between 1 and 9. See |hl-User1..9|
6911
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006912 When displaying a flag, Vim removes the leading comma, if any, when
6913 that flag comes right after plaintext. This will make a nice display
6914 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915
Bram Moolenaar582fd852005-03-28 20:58:01 +00006916 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 not set) and a minwid is not set for the group, the whole group will
6918 become empty. This will make a group like the following disappear
6919 completely from the statusline when none of the flags are set. >
6920 :set statusline=...%(\ [%M%R%H]%)...
6921<
6922 Beware that an expression is evaluated each and every time the status
6923 line is displayed. The current buffer and current window will be set
6924 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006925 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006927 real current buffer.
6928
Bram Moolenaar30b65812012-07-12 22:01:11 +02006929 The 'statusline' option will be evaluated in the |sandbox| if set from
6930 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006931
6932 It is not allowed to change text or jump to another window while
6933 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934
6935 If the statusline is not updated when you want it (e.g., after setting
6936 a variable that's used in an expression), you can force an update by
6937 setting an option without changing its value. Example: >
6938 :let &ro = &ro
6939
6940< A result of all digits is regarded a number for display purposes.
6941 Otherwise the result is taken as flag text and applied to the rules
6942 described above.
6943
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006944 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6946 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6947
6948 Examples:
6949 Emulate standard status line with 'ruler' set >
6950 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6951< Similar, but add ASCII value of char under the cursor (like "ga") >
6952 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6953< Display byte count and byte value, modified flag in red. >
6954 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6955 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6956< Display a ,GZ flag if a compressed file is loaded >
6957 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6958< In the |:autocmd|'s: >
6959 :let b:gzflag = 1
6960< And: >
6961 :unlet b:gzflag
6962< And define this function: >
6963 :function VarExists(var, val)
6964 : if exists(a:var) | return a:val | else | return '' | endif
6965 :endfunction
6966<
6967 *'suffixes'* *'su'*
6968'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6969 global
6970 {not in Vi}
6971 Files with these suffixes get a lower priority when multiple files
6972 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006973 suffixes. Spaces after the comma are ignored. A dot is also seen as
6974 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 separator, precede it with a backslash (see |option-backslash| about
6976 including spaces and backslashes).
6977 See 'wildignore' for completely ignoring files.
6978 The use of |:set+=| and |:set-=| is preferred when adding or removing
6979 suffixes from the list. This avoids problems when a future version
6980 uses another default.
6981
6982 *'suffixesadd'* *'sua'*
6983'suffixesadd' 'sua' string (default "")
6984 local to buffer
6985 {not in Vi}
6986 {not available when compiled without the
6987 |+file_in_path| feature}
6988 Comma separated list of suffixes, which are used when searching for a
6989 file for the "gf", "[I", etc. commands. Example: >
6990 :set suffixesadd=.java
6991<
6992 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6993'swapfile' 'swf' boolean (default on)
6994 local to buffer
6995 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006996 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 swapfile is not wanted for a specific buffer. For example, with
6998 confidential information that even root must not be able to access.
6999 Careful: All text will be in memory:
7000 - Don't use this for big files.
7001 - Recovery will be impossible!
7002 A swapfile will only be present when |'updatecount'| is non-zero and
7003 'swapfile' is set.
7004 When 'swapfile' is reset, the swap file for the current buffer is
7005 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7006 non-zero, a swap file is immediately created.
7007 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007008 If you want to open a new buffer without creating a swap file for it,
7009 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010
7011 This option is used together with 'bufhidden' and 'buftype' to
7012 specify special kinds of buffers. See |special-buffers|.
7013
7014 *'swapsync'* *'sws'*
7015'swapsync' 'sws' string (default "fsync")
7016 global
7017 {not in Vi}
7018 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007019 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 When this option is empty parts of the swap file may be in memory and
7021 not written to disk. When the system crashes you may lose more work.
7022 On Unix the system does a sync now and then without Vim asking for it,
7023 so the disadvantage of setting this option off is small. On some
7024 systems the swap file will not be written at all. For a unix system
7025 setting it to "sync" will use the sync() call instead of the default
7026 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007027 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028
7029 *'switchbuf'* *'swb'*
7030'switchbuf' 'swb' string (default "")
7031 global
7032 {not in Vi}
7033 This option controls the behavior when switching between buffers.
7034 Possible values (comma separated list):
7035 useopen If included, jump to the first open window that
7036 contains the specified buffer (if there is one).
7037 Otherwise: Do not examine other windows.
7038 This setting is checked with |quickfix| commands, when
7039 jumping to errors (":cc", ":cn", "cp", etc.). It is
7040 also used in all buffer related split commands, for
7041 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007042 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007043 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007045 a buffer for a |quickfix| command that display errors.
7046 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007047 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007048 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007049
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007050 *'synmaxcol'* *'smc'*
7051'synmaxcol' 'smc' number (default 3000)
7052 local to buffer
7053 {not in Vi}
7054 {not available when compiled without the |+syntax|
7055 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007056 Maximum column in which to search for syntax items. In long lines the
7057 text after this column is not highlighted and following lines may not
7058 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007059 This helps to avoid very slow redrawing for an XML file that is one
7060 long line.
7061 Set to zero to remove the limit.
7062
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063 *'syntax'* *'syn'*
7064'syntax' 'syn' string (default empty)
7065 local to buffer
7066 {not in Vi}
7067 {not available when compiled without the |+syntax|
7068 feature}
7069 When this option is set, the syntax with this name is loaded, unless
7070 syntax highlighting has been switched off with ":syntax off".
7071 Otherwise this option does not always reflect the current syntax (the
7072 b:current_syntax variable does).
7073 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007074 not automatically recognized. Example, in an IDL file:
7075 /* vim: set syntax=idl : */ ~
7076 When a dot appears in the value then this separates two filetype
7077 names. Example:
7078 /* vim: set syntax=c.doxygen : */ ~
7079 This will use the "c" syntax first, then the "doxygen" syntax.
7080 Note that the second one must be prepared to be loaded as an addition,
7081 otherwise it will be skipped. More than one dot may appear.
7082 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007083 :set syntax=OFF
7084< To switch syntax highlighting on according to the current value of the
7085 'filetype' option: >
7086 :set syntax=ON
7087< What actually happens when setting the 'syntax' option is that the
7088 Syntax autocommand event is triggered with the value as argument.
7089 This option is not copied to another buffer, independent of the 's' or
7090 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007091 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007093 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007094'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007095 global
7096 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007097 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007098 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007099 When nonempty, this option determines the content of the tab pages
7100 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007101 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007102
7103 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007104 option and only when there is no GUI tab line. When 'e' is in
7105 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007106 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007107
7108 The value is evaluated like with 'statusline'. You can use
7109 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007110 the text to be displayed. Use "%1T" for the first label, "%2T" for
7111 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007112
7113 Keep in mind that only one of the tab pages is the current one, others
7114 are invisible and you can't jump to their windows.
7115
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007116
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007117 *'tabpagemax'* *'tpm'*
7118'tabpagemax' 'tpm' number (default 10)
7119 global
7120 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007121 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007122 feature}
7123 Maximum number of tab pages to be opened by the |-p| command line
7124 argument or the ":tab all" command. |tabpage|
7125
7126
7127 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128'tabstop' 'ts' number (default 8)
7129 local to buffer
7130 Number of spaces that a <Tab> in the file counts for. Also see
7131 |:retab| command, and 'softtabstop' option.
7132
7133 Note: Setting 'tabstop' to any other value than 8 can make your file
7134 appear wrong in many places (e.g., when printing it).
7135
7136 There are four main ways to use tabs in Vim:
7137 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7138 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007139 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 behave like a tab appears every 4 (or 3) characters.
7141 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7142 'expandtab'. This way you will always insert spaces. The
7143 formatting will never be messed up when 'tabstop' is changed.
7144 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 works when using Vim to edit the file.
7147 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7148 'noexpandtab'. This should then work (for initial indents only)
7149 for any tabstop setting that people use. It might be nice to have
7150 tabs after the first non-blank inserted as spaces if you do this
7151 though. Otherwise aligned comments will be wrong when 'tabstop' is
7152 changed.
7153
7154 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7155'tagbsearch' 'tbs' boolean (default on)
7156 global
7157 {not in Vi}
7158 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 searching makes searching for a tag a LOT faster, but a linear search
7161 will find more tags if the tags file wasn't properly sorted.
7162 Vim normally assumes that your tags files are sorted, or indicate that
7163 they are not sorted. Only when this is not the case does the
7164 'tagbsearch' option need to be switched off.
7165
7166 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007167 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 certain files, or retry all files with a linear search. When
7169 'tagbsearch' is off, only a linear search is done.
7170
7171 Linear searching is done anyway, for one file, when Vim finds a line
7172 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007173 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174< [The whitespace before and after the '0' must be a single <Tab>]
7175
7176 When a binary search was done and no match was found in any of the
7177 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7178 instead of a normal tag name, a retry is done with a linear search.
7179 Tags in unsorted tags files, and matches with different case will only
7180 be found in the retry.
7181
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007182 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007183 linear search can be avoided for the 'ignorecase' case. Use a value
7184 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7185 case-fold sorted with the -f switch to "sort" in most unices, as in
7186 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007187 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7188 for this as well. Note that case must be folded to uppercase for this
7189 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190
7191 When 'tagbsearch' is off, tags searching is slower when a full match
7192 exists, but faster when no full match exists. Tags in unsorted tags
7193 files may only be found with 'tagbsearch' off.
7194 When the tags file is not sorted, or sorted in a wrong way (not on
7195 ASCII byte value), 'tagbsearch' should be off, or the line given above
7196 must be included in the tags file.
7197 This option doesn't affect commands that find all matching tags (e.g.,
7198 command-line completion and ":help").
7199 {Vi: always uses binary search in some versions}
7200
7201 *'taglength'* *'tl'*
7202'taglength' 'tl' number (default 0)
7203 global
7204 If non-zero, tags are significant up to this number of characters.
7205
7206 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7207'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7208 global
7209 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007210 If on and using a tags file in another directory, file names in that
7211 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 NOTE: This option is set to the Vi default value when 'compatible' is
7213 set and to the Vim default value when 'compatible' is reset.
7214
7215 *'tags'* *'tag'* *E433*
7216'tags' 'tag' string (default "./tags,tags", when compiled with
7217 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7218 global or local to buffer |global-local|
7219 Filenames for the tag command, separated by spaces or commas. To
7220 include a space or comma in a file name, precede it with a backslash
7221 (see |option-backslash| about including spaces and backslashes).
7222 When a file name starts with "./", the '.' is replaced with the path
7223 of the current file. But only when the 'd' flag is not included in
7224 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7225 |tags-option|.
7226 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007227 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7228 find all files named "tags" below "/lib". The filename itself cannot
7229 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7230 files called "tags?". {not available when compiled without the
7231 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007232 The |tagfiles()| function can be used to get a list of the file names
7233 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7235 files are also supported. They are automatically recognized. The
7236 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7237 differences are ignored (MS-Windows). |emacs-tags|
7238 The use of |:set+=| and |:set-=| is preferred when adding or removing
7239 file names from the list. This avoids problems when a future version
7240 uses another default.
7241 {Vi: default is "tags /usr/lib/tags"}
7242
7243 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7244'tagstack' 'tgst' boolean (default on)
7245 global
7246 {not in all versions of Vi}
7247 When on, the |tagstack| is used normally. When off, a ":tag" or
7248 ":tselect" command with an argument will not push the tag onto the
7249 tagstack. A following ":tag" without an argument, a ":pop" command or
7250 any other command that uses the tagstack will use the unmodified
7251 tagstack, but does change the pointer to the active entry.
7252 Resetting this option is useful when using a ":tag" command in a
7253 mapping which should not change the tagstack.
7254
7255 *'term'* *E529* *E530* *E531*
7256'term' string (default is $TERM, if that fails:
7257 in the GUI: "builtin_gui"
7258 on Amiga: "amiga"
7259 on BeOS: "beos-ansi"
7260 on Mac: "mac-ansi"
7261 on MiNT: "vt52"
7262 on MS-DOS: "pcterm"
7263 on OS/2: "os2ansi"
7264 on Unix: "ansi"
7265 on VMS: "ansi"
7266 on Win 32: "win32")
7267 global
7268 Name of the terminal. Used for choosing the terminal control
7269 characters. Environment variables are expanded |:set_env|.
7270 For example: >
7271 :set term=$TERM
7272< See |termcap|.
7273
7274 *'termbidi'* *'tbidi'*
7275 *'notermbidi'* *'notbidi'*
7276'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7277 global
7278 {not in Vi}
7279 {only available when compiled with the |+arabic|
7280 feature}
7281 The terminal is in charge of Bi-directionality of text (as specified
7282 by Unicode). The terminal is also expected to do the required shaping
7283 that some languages (such as Arabic) require.
7284 Setting this option implies that 'rightleft' will not be set when
7285 'arabic' is set and the value of 'arabicshape' will be ignored.
7286 Note that setting 'termbidi' has the immediate effect that
7287 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7288 This option is reset when the GUI is started.
7289 For further details see |arabic.txt|.
7290
7291 *'termencoding'* *'tenc'*
7292'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7293 Macintosh GUI: "macroman")
7294 global
7295 {only available when compiled with the |+multi_byte|
7296 feature}
7297 {not in Vi}
7298 Encoding used for the terminal. This specifies what character
7299 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007300 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007301 display). Except for the Mac when 'macatsui' is off, then
7302 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 In the Win32 console version the default value is the console codepage
7304 when it differs from the ANSI codepage.
7305 *E617*
7306 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7307 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7308 Any attempts to set a different value will be rejected, and an error
7309 message is shown.
7310 For the Win32 GUI 'termencoding' is not used for typed characters,
7311 because the Win32 system always passes Unicode characters.
7312 When empty, the same encoding is used as for the 'encoding' option.
7313 This is the normal value.
7314 Not all combinations for 'termencoding' and 'encoding' are valid. See
7315 |encoding-table|.
7316 The value for this option must be supported by internal conversions or
7317 iconv(). When this is not possible no conversion will be done and you
7318 will probably experience problems with non-ASCII characters.
7319 Example: You are working with the locale set to euc-jp (Japanese) and
7320 want to edit a UTF-8 file: >
7321 :let &termencoding = &encoding
7322 :set encoding=utf-8
7323< You need to do this when your system has no locale support for UTF-8.
7324
7325 *'terse'* *'noterse'*
7326'terse' boolean (default off)
7327 global
7328 When set: Add 's' flag to 'shortmess' option (this makes the message
7329 for a search that hits the start or end of the file not being
7330 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7331 shortens a lot of messages}
7332
7333 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7334'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7335 global
7336 {not in Vi}
7337 This option is obsolete. Use 'fileformats'.
7338 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7339 set to the default value for the current system. When 'textauto' is
7340 reset, 'fileformats' is made empty.
7341 NOTE: This option is set to the Vi default value when 'compatible' is
7342 set and to the Vim default value when 'compatible' is reset.
7343
7344 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7345'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7346 others: default off)
7347 local to buffer
7348 {not in Vi}
7349 This option is obsolete. Use 'fileformat'.
7350 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7351 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7352 "unix".
7353
7354 *'textwidth'* *'tw'*
7355'textwidth' 'tw' number (default 0)
7356 local to buffer
7357 {not in Vi}
7358 Maximum width of text that is being inserted. A longer line will be
7359 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007360 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7361 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007363 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 NOTE: This option is set to 0 when 'compatible' is set.
7365
7366 *'thesaurus'* *'tsr'*
7367'thesaurus' 'tsr' string (default "")
7368 global or local to buffer |global-local|
7369 {not in Vi}
7370 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007371 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 the file should contain words with similar meaning, separated by
7373 non-keyword characters (white space is preferred). Maximum line
7374 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007375 To obtain a file to be used here, check out this ftp site:
7376 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007377 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 after a comma are ignored, otherwise spaces are included in the file
7379 name. See |option-backslash| about using backslashes.
7380 The use of |:set+=| and |:set-=| is preferred when adding or removing
7381 directories from the list. This avoids problems when a future version
7382 uses another default.
7383 Backticks cannot be used in this option for security reasons.
7384
7385 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7386'tildeop' 'top' boolean (default off)
7387 global
7388 {not in Vi}
7389 When on: The tilde command "~" behaves like an operator.
7390 NOTE: This option is reset when 'compatible' is set.
7391
7392 *'timeout'* *'to'* *'notimeout'* *'noto'*
7393'timeout' 'to' boolean (default on)
7394 global
7395 *'ttimeout'* *'nottimeout'*
7396'ttimeout' boolean (default off)
7397 global
7398 {not in Vi}
7399 These two options together determine the behavior when part of a
7400 mapped key sequence or keyboard code has been received:
7401
7402 'timeout' 'ttimeout' action ~
7403 off off do not time out
7404 on on or off time out on :mappings and key codes
7405 off on time out on key codes
7406
7407 If both options are off, Vim will wait until either the complete
7408 mapping or key sequence has been received, or it is clear that there
7409 is no mapping or key sequence for the received characters. For
7410 example: if you have mapped "vl" and Vim has received 'v', the next
7411 character is needed to see if the 'v' is followed by an 'l'.
7412 When one of the options is on, Vim will wait for about 1 second for
7413 the next character to arrive. After that the already received
7414 characters are interpreted as single characters. The waiting time can
7415 be changed with the 'timeoutlen' option.
7416 On slow terminals or very busy systems timing out may cause
7417 malfunctioning cursor keys. If both options are off, Vim waits
7418 forever after an entered <Esc> if there are key codes that start
7419 with <Esc>. You will have to type <Esc> twice. If you do not have
7420 problems with key codes, but would like to have :mapped key
7421 sequences not timing out in 1 second, set the 'ttimeout' option and
7422 reset the 'timeout' option.
7423
7424 NOTE: 'ttimeout' is reset when 'compatible' is set.
7425
7426 *'timeoutlen'* *'tm'*
7427'timeoutlen' 'tm' number (default 1000)
7428 global
7429 {not in all versions of Vi}
7430 *'ttimeoutlen'* *'ttm'*
7431'ttimeoutlen' 'ttm' number (default -1)
7432 global
7433 {not in Vi}
7434 The time in milliseconds that is waited for a key code or mapped key
7435 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7436 when part of a command has been typed.
7437 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7438 different timeout value for key codes is desired set 'ttimeoutlen' to
7439 a non-negative number.
7440
7441 ttimeoutlen mapping delay key code delay ~
7442 < 0 'timeoutlen' 'timeoutlen'
7443 >= 0 'timeoutlen' 'ttimeoutlen'
7444
7445 The timeout only happens when the 'timeout' and 'ttimeout' options
7446 tell so. A useful setting would be >
7447 :set timeout timeoutlen=3000 ttimeoutlen=100
7448< (time out on mapping after three seconds, time out on key codes after
7449 a tenth of a second).
7450
7451 *'title'* *'notitle'*
7452'title' boolean (default off, on when title can be restored)
7453 global
7454 {not in Vi}
7455 {not available when compiled without the |+title|
7456 feature}
7457 When on, the title of the window will be set to the value of
7458 'titlestring' (if it is not empty), or to:
7459 filename [+=-] (path) - VIM
7460 Where:
7461 filename the name of the file being edited
7462 - indicates the file cannot be modified, 'ma' off
7463 + indicates the file was modified
7464 = indicates the file is read-only
7465 =+ indicates the file is read-only and modified
7466 (path) is the path of the file being edited
7467 - VIM the server name |v:servername| or "VIM"
7468 Only works if the terminal supports setting window titles
7469 (currently Amiga console, Win32 console, all GUI versions and
7470 terminals with a non- empty 't_ts' option - these are Unix xterm and
7471 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7472 *X11*
7473 When Vim was compiled with HAVE_X11 defined, the original title will
7474 be restored if possible. The output of ":version" will include "+X11"
7475 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7476 works for the icon name |'icon'|.
7477 But: When Vim was started with the |-X| argument, restoring the title
7478 will not work (except in the GUI).
7479 If the title cannot be restored, it is set to the value of 'titleold'.
7480 You might want to restore the title outside of Vim then.
7481 When using an xterm from a remote machine you can use this command:
7482 rsh machine_name xterm -display $DISPLAY &
7483 then the WINDOWID environment variable should be inherited and the
7484 title of the window should change back to what it should be after
7485 exiting Vim.
7486
7487 *'titlelen'*
7488'titlelen' number (default 85)
7489 global
7490 {not in Vi}
7491 {not available when compiled without the |+title|
7492 feature}
7493 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007494 title. When the title is longer, only the end of the path name is
7495 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 Using a percentage makes this adapt to the width of the window. But
7497 it won't work perfectly, because the actual number of characters
7498 available also depends on the font used and other things in the title
7499 bar. When 'titlelen' is zero the full path is used. Otherwise,
7500 values from 1 to 30000 percent can be used.
7501 'titlelen' is also used for the 'titlestring' option.
7502
7503 *'titleold'*
7504'titleold' string (default "Thanks for flying Vim")
7505 global
7506 {not in Vi}
7507 {only available when compiled with the |+title|
7508 feature}
7509 This option will be used for the window title when exiting Vim if the
7510 original title cannot be restored. Only happens if 'title' is on or
7511 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007512 This option cannot be set from a |modeline| or in the |sandbox|, for
7513 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 *'titlestring'*
7515'titlestring' string (default "")
7516 global
7517 {not in Vi}
7518 {not available when compiled without the |+title|
7519 feature}
7520 When this option is not empty, it will be used for the title of the
7521 window. This happens only when the 'title' option is on.
7522 Only works if the terminal supports setting window titles (currently
7523 Amiga console, Win32 console, all GUI versions and terminals with a
7524 non-empty 't_ts' option).
7525 When Vim was compiled with HAVE_X11 defined, the original title will
7526 be restored if possible |X11|.
7527 When this option contains printf-style '%' items, they will be
7528 expanded according to the rules used for 'statusline'.
7529 Example: >
7530 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7531 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7532< The value of 'titlelen' is used to align items in the middle or right
7533 of the available space.
7534 Some people prefer to have the file name first: >
7535 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7536< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007537 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 separating space only when needed.
7539 NOTE: Use of special characters in 'titlestring' may cause the display
7540 to be garbled (e.g., when it contains a CR or NL character).
7541 {not available when compiled without the |+statusline| feature}
7542
7543 *'toolbar'* *'tb'*
7544'toolbar' 'tb' string (default "icons,tooltips")
7545 global
7546 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7547 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007548 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007549 possible values are:
7550 icons Toolbar buttons are shown with icons.
7551 text Toolbar buttons shown with text.
7552 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007553 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 tooltips Tooltips are active for toolbar buttons.
7555 Tooltips refer to the popup help text which appears after the mouse
7556 cursor is placed over a toolbar button for a brief moment.
7557
7558 If you want the toolbar to be shown with icons as well as text, do the
7559 following: >
7560 :set tb=icons,text
7561< Motif and Athena cannot display icons and text at the same time. They
7562 will show icons if both are requested.
7563
7564 If none of the strings specified in 'toolbar' are valid or if
7565 'toolbar' is empty, this option is ignored. If you want to disable
7566 the toolbar, you need to set the 'guioptions' option. For example: >
7567 :set guioptions-=T
7568< Also see |gui-toolbar|.
7569
7570 *'toolbariconsize'* *'tbis'*
7571'toolbariconsize' 'tbis' string (default "small")
7572 global
7573 {not in Vi}
7574 {only in the GTK+ 2 GUI}
7575 Controls the size of toolbar icons. The possible values are:
7576 tiny Use tiny toolbar icons.
7577 small Use small toolbar icons (default).
7578 medium Use medium-sized toolbar icons.
7579 large Use large toolbar icons.
7580 The exact dimensions in pixels of the various icon sizes depend on
7581 the current theme. Common dimensions are large=32x32, medium=24x24,
7582 small=20x20 and tiny=16x16.
7583
7584 If 'toolbariconsize' is empty, the global default size as determined
7585 by user preferences or the current theme is used.
7586
7587 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7588'ttybuiltin' 'tbi' boolean (default on)
7589 global
7590 {not in Vi}
7591 When on, the builtin termcaps are searched before the external ones.
7592 When off the builtin termcaps are searched after the external ones.
7593 When this option is changed, you should set the 'term' option next for
7594 the change to take effect, for example: >
7595 :set notbi term=$TERM
7596< See also |termcap|.
7597 Rationale: The default for this option is "on", because the builtin
7598 termcap entries are generally better (many systems contain faulty
7599 xterm entries...).
7600
7601 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7602'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7603 sun-cmd, screen, rxvt, dtterm or
7604 iris-ansi; also on when running Vim in
7605 a DOS console)
7606 global
7607 {not in Vi}
7608 Indicates a fast terminal connection. More characters will be sent to
7609 the screen for redrawing, instead of using insert/delete line
7610 commands. Improves smoothness of redrawing when there are multiple
7611 windows and the terminal does not support a scrolling region.
7612 Also enables the extra writing of characters at the end of each screen
7613 line for lines that wrap. This helps when using copy/paste with the
7614 mouse in an xterm and other terminals.
7615
7616 *'ttymouse'* *'ttym'*
7617'ttymouse' 'ttym' string (default depends on 'term')
7618 global
7619 {not in Vi}
7620 {only in Unix and VMS, doesn't work in the GUI; not
7621 available when compiled without |+mouse|}
7622 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007623 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 *xterm-mouse*
7625 xterm xterm-like mouse handling. The mouse generates
7626 "<Esc>[Mscr", where "scr" is three bytes:
7627 "s" = button state
7628 "c" = column plus 33
7629 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007630 This only works up to 223 columns! See "dec",
7631 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 xterm2 Works like "xterm", but with the xterm reporting the
7633 mouse position while the mouse is dragged. This works
7634 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007635 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636 work. See below for how Vim detects this
7637 automatically.
7638 *netterm-mouse*
7639 netterm NetTerm mouse handling. The mouse generates
7640 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7641 for the row and column.
7642 *dec-mouse*
7643 dec DEC terminal mouse handling. The mouse generates a
7644 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007645 This is also available for an Xterm, if it was
7646 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 *jsbterm-mouse*
7648 jsbterm JSB term mouse handling.
7649 *pterm-mouse*
7650 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007651 *urxvt-mouse*
7652 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007653 The mouse works only if the terminal supports this
7654 encoding style, but it does not have 223 columns limit
7655 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007656 *sgr-mouse*
7657 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007658 mouse reporting. The mouse works even in columns
7659 beyond 223. This option is backward compatible with
7660 "xterm2" because it can also decode "xterm2" style
7661 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662
7663 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007664 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7665 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7667 recognized, if enabled at compile time. DEC terminal mouse codes
7668 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007669 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7670 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007672 set to a name that starts with "xterm", "mlterm", or "screen", and
7673 'ttymouse' is not set already.
7674 Additionally, if vim is compiled with the |+termresponse| feature and
7675 |t_RV| is set to the escape sequence to request the xterm version
7676 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007678 from 95 to 276. The "sgr" value will be set if the xterm version is
7679 277 or highter.
7680 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7681 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 :set t_RV=
7683<
7684 *'ttyscroll'* *'tsl'*
7685'ttyscroll' 'tsl' number (default 999)
7686 global
7687 Maximum number of lines to scroll the screen. If there are more lines
7688 to scroll the window is redrawn. For terminals where scrolling is
7689 very slow and redrawing is not slow this can be set to a small number,
7690 e.g., 3, to speed up displaying.
7691
7692 *'ttytype'* *'tty'*
7693'ttytype' 'tty' string (default from $TERM)
7694 global
7695 Alias for 'term', see above.
7696
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007697 *'undodir'* *'udir'*
7698'undodir' 'udir' string (default ".")
7699 global
7700 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007701 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007702 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007703 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007704 "." means using the directory of the file. The undo file name for
7705 "file.txt" is ".file.txt.un~".
7706 For other directories the file name is the full path of the edited
7707 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007708 When writing: The first directory that exists is used. "." always
7709 works, no directories after "." will be used for writing.
7710 When reading all entries are tried to find an undo file. The first
7711 undo file that exists is used. When it cannot be read an error is
7712 given, no further entry is used.
7713 See |undo-persistence|.
7714
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007715 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007716'undofile' 'udf' boolean (default off)
7717 local to buffer
7718 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007719 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007720 When on, Vim automatically saves undo history to an undo file when
7721 writing a buffer to a file, and restores undo history from the same
7722 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007723 The directory where the undo file is stored is specified by 'undodir'.
7724 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007725 The undo file is not read when 'undoreload' causes the buffer from
7726 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007727 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007728
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 *'undolevels'* *'ul'*
7730'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7731 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007732 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 {not in Vi}
7734 Maximum number of changes that can be undone. Since undo information
7735 is kept in memory, higher numbers will cause more memory to be used
7736 (nevertheless, a single change can use an unlimited amount of memory).
7737 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7738 itself: >
7739 set ul=0
7740< But you can also get Vi compatibility by including the 'u' flag in
7741 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007742 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007743 Set to -1 for no undo at all. You might want to do this only for the
7744 current buffer: >
7745 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007747 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007749 *'undoreload'* *'ur'*
7750'undoreload' 'ur' number (default 10000)
7751 global
7752 {not in Vi}
7753 Save the whole buffer for undo when reloading it. This applies to the
7754 ":e!" command and reloading for when the buffer changed outside of
7755 Vim. |FileChangedShell|
7756 The save only happens when this options is negative or when the number
7757 of lines is smaller than the value of this option.
7758 Set this option to zero to disable undo for a reload.
7759
7760 When saving undo for a reload, any undo file is not read.
7761
7762 Note that this causes the whole buffer to be stored in memory. Set
7763 this option to a lower value if you run out of memory.
7764
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 *'updatecount'* *'uc'*
7766'updatecount' 'uc' number (default: 200)
7767 global
7768 {not in Vi}
7769 After typing this many characters the swap file will be written to
7770 disk. When zero, no swap file will be created at all (see chapter on
7771 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7772 Vim with the "-n" option, see |startup|. When editing in readonly
7773 mode this option will be initialized to 10000.
7774 The swapfile can be disabled per buffer with |'swapfile'|.
7775 When 'updatecount' is set from zero to non-zero, swap files are
7776 created for all buffers that have 'swapfile' set. When 'updatecount'
7777 is set to zero, existing swap files are not deleted.
7778 Also see |'swapsync'|.
7779 This option has no meaning in buffers where |'buftype'| is "nofile"
7780 or "nowrite".
7781
7782 *'updatetime'* *'ut'*
7783'updatetime' 'ut' number (default 4000)
7784 global
7785 {not in Vi}
7786 If this many milliseconds nothing is typed the swap file will be
7787 written to disk (see |crash-recovery|). Also used for the
7788 |CursorHold| autocommand event.
7789
7790 *'verbose'* *'vbs'*
7791'verbose' 'vbs' number (default 0)
7792 global
7793 {not in Vi, although some versions have a boolean
7794 verbose option}
7795 When bigger than zero, Vim will give messages about what it is doing.
7796 Currently, these messages are given:
7797 >= 1 When the viminfo file is read or written.
7798 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007799 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 >= 8 Files for which a group of autocommands is executed.
7801 >= 9 Every executed autocommand.
7802 >= 12 Every executed function.
7803 >= 13 When an exception is thrown, caught, finished, or discarded.
7804 >= 14 Anything pending in a ":finally" clause.
7805 >= 15 Every executed Ex command (truncated at 200 characters).
7806
7807 This option can also be set with the "-V" argument. See |-V|.
7808 This option is also set by the |:verbose| command.
7809
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007810 When the 'verbosefile' option is set then the verbose messages are not
7811 displayed.
7812
7813 *'verbosefile'* *'vfile'*
7814'verbosefile' 'vfile' string (default empty)
7815 global
7816 {not in Vi}
7817 When not empty all messages are written in a file with this name.
7818 When the file exists messages are appended.
7819 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007820 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007821 Setting 'verbosefile' to a new value is like making it empty first.
7822 The difference with |:redir| is that verbose messages are not
7823 displayed when 'verbosefile' is set.
7824
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 *'viewdir'* *'vdir'*
7826'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7827 "$VIM/vimfiles/view",
7828 for Unix: "~/.vim/view",
7829 for Macintosh: "$VIM:vimfiles:view"
7830 for VMS: "sys$login:vimfiles/view"
7831 for RiscOS: "Choices:vimfiles/view")
7832 global
7833 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007834 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 feature}
7836 Name of the directory where to store files for |:mkview|.
7837 This option cannot be set from a |modeline| or in the |sandbox|, for
7838 security reasons.
7839
7840 *'viewoptions'* *'vop'*
7841'viewoptions' 'vop' string (default: "folds,options,cursor")
7842 global
7843 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007844 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 feature}
7846 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007847 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 word save and restore ~
7849 cursor cursor position in file and in window
7850 folds manually created folds, opened/closed folds and local
7851 fold options
7852 options options and mappings local to a window or buffer (not
7853 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007854 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 slash backslashes in file names replaced with forward
7856 slashes
7857 unix with Unix end-of-line format (single <NL>), even when
7858 on Windows or DOS
7859
7860 "slash" and "unix" are useful on Windows when sharing view files
7861 with Unix. The Unix version of Vim cannot source dos format scripts,
7862 but the Windows version of Vim can source unix format scripts.
7863
7864 *'viminfo'* *'vi'* *E526* *E527* *E528*
7865'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007866 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7867 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7868 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 global
7870 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007871 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 feature}
7873 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007874 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 separated list of parameters, each consisting of a single character
7876 identifying the particular parameter, followed by a number or string
7877 which specifies the value of that parameter. If a particular
7878 character is left out, then the default value is used for that
7879 parameter. The following is a list of the identifying characters and
7880 the effect of their value.
7881 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007882 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 ! When included, save and restore global variables that start
7884 with an uppercase letter, and don't contain a lowercase
7885 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007886 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007887 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007888 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 " Maximum number of lines saved for each register. Old name of
7890 the '<' item, with the disadvantage that you need to put a
7891 backslash before the ", otherwise it will be recognized as the
7892 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007893 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007894 % When included, save and restore the buffer list. If Vim is
7895 started with a file name argument, the buffer list is not
7896 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007897 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007898 without a file name and buffers for help files are not written
7899 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007900 When followed by a number, the number specifies the maximum
7901 number of buffers that are stored. Without a number all
7902 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007903 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 ' Maximum number of previously edited files for which the marks
7905 are remembered. This parameter must always be included when
7906 'viminfo' is non-empty.
7907 Including this item also means that the |jumplist| and the
7908 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007909 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007911 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 patterns are also saved. When not included, the value of
7913 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007914 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007916 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007917 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 < Maximum number of lines saved for each register. If zero then
7919 registers are not saved. When not included, all lines are
7920 saved. '"' is the old name for this item.
7921 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007922 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007923 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007924 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007925 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 c When included, convert the text in the viminfo file from the
7927 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007928 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007929 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 f Whether file marks need to be stored. If zero, file marks ('0
7931 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007932 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007934 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 h Disable the effect of 'hlsearch' when loading the viminfo
7936 file. When not included, it depends on whether ":nohlsearch"
7937 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007938 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 n Name of the viminfo file. The name must immediately follow
7940 the 'n'. Must be the last one! If the "-i" argument was
7941 given when starting Vim, that file name overrides the one
7942 given here with 'viminfo'. Environment variables are expanded
7943 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007944 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 r Removable media. The argument is a string (up to the next
7946 ','). This parameter can be given several times. Each
7947 specifies the start of a path for which no marks will be
7948 stored. This is to avoid removable media. For MS-DOS you
7949 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7950 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7951 ignored. Maximum length of each 'r' argument is 50
7952 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007953 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 s Maximum size of an item in Kbyte. If zero then registers are
7955 not saved. Currently only applies to registers. The default
7956 "s10" will exclude registers with more than 10 Kbyte of text.
7957 Also see the '<' item above: line count limit.
7958
7959 Example: >
7960 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7961<
7962 '50 Marks will be remembered for the last 50 files you
7963 edited.
7964 <1000 Contents of registers (up to 1000 lines each) will be
7965 remembered.
7966 s100 Registers with more than 100 Kbyte text are skipped.
7967 :0 Command-line history will not be saved.
7968 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7969 no / Since '/' is not specified, the default will be used,
7970 that is, save all of the search history, and also the
7971 previous search and substitute patterns.
7972 no % The buffer list will not be saved nor read back.
7973 no h 'hlsearch' highlighting will be restored.
7974
7975 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7976 load the contents of the file, this is not done automatically.
7977
7978 This option cannot be set from a |modeline| or in the |sandbox|, for
7979 security reasons.
7980
7981 *'virtualedit'* *'ve'*
7982'virtualedit' 've' string (default "")
7983 global
7984 {not in Vi}
7985 {not available when compiled without the
7986 |+virtualedit| feature}
7987 A comma separated list of these words:
7988 block Allow virtual editing in Visual block mode.
7989 insert Allow virtual editing in Insert mode.
7990 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007991 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007992
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007994 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 of the line. Useful for selecting a rectangle in Visual mode and
7996 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007997 "onemore" is not the same, it will only allow moving the cursor just
7998 after the last character of the line. This makes some commands more
7999 consistent. Previously the cursor was always past the end of the line
8000 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008001 break some plugins or Vim scripts. For example because |l| can move
8002 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008003 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008004 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008005 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008006 It doesn't make sense to combine "all" with "onemore", but you will
8007 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008008
8009 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8010'visualbell' 'vb' boolean (default off)
8011 global
8012 {not in Vi}
8013 Use visual bell instead of beeping. The terminal code to display the
8014 visual bell is given with 't_vb'. When no beep or flash is wanted,
8015 use ":set vb t_vb=".
8016 Note: When the GUI starts, 't_vb' is reset to its default value. You
8017 might want to set it again in your |gvimrc|.
8018 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8019 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8020 where 40 is the time in msec.
8021 Does not work on the Amiga, you always get a screen flash.
8022 Also see 'errorbells'.
8023
8024 *'warn'* *'nowarn'*
8025'warn' boolean (default on)
8026 global
8027 Give a warning message when a shell command is used while the buffer
8028 has been changed.
8029
8030 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8031'weirdinvert' 'wiv' boolean (default off)
8032 global
8033 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008034 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 It is provided for backwards compatibility with version 4.x.
8036 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8037 vice versa. Has no effect when the GUI is running.
8038
8039 *'whichwrap'* *'ww'*
8040'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8041 global
8042 {not in Vi}
8043 Allow specified keys that move the cursor left/right to move to the
8044 previous/next line when the cursor is on the first/last character in
8045 the line. Concatenate characters to allow this for these keys:
8046 char key mode ~
8047 b <BS> Normal and Visual
8048 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008049 h "h" Normal and Visual (not recommended)
8050 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 < <Left> Normal and Visual
8052 > <Right> Normal and Visual
8053 ~ "~" Normal
8054 [ <Left> Insert and Replace
8055 ] <Right> Insert and Replace
8056 For example: >
8057 :set ww=<,>,[,]
8058< allows wrap only when cursor keys are used.
8059 When the movement keys are used in combination with a delete or change
8060 operator, the <EOL> also counts for a character. This makes "3h"
8061 different from "3dh" when the cursor crosses the end of a line. This
8062 is also true for "x" and "X", because they do the same as "dl" and
8063 "dh". If you use this, you may also want to use the mapping
8064 ":map <BS> X" to make backspace delete the character in front of the
8065 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008066 When 'l' is included and it is used after an operator at the end of a
8067 line then it will not move to the next line. This makes "dl", "cl",
8068 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008069 NOTE: This option is set to the Vi default value when 'compatible' is
8070 set and to the Vim default value when 'compatible' is reset.
8071
8072 *'wildchar'* *'wc'*
8073'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8074 global
8075 {not in Vi}
8076 Character you have to type to start wildcard expansion in the
8077 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008078 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008079 The character is not recognized when used inside a macro. See
8080 'wildcharm' for that.
8081 Although 'wc' is a number option, you can set it to a special key: >
8082 :set wc=<Esc>
8083< NOTE: This option is set to the Vi default value when 'compatible' is
8084 set and to the Vim default value when 'compatible' is reset.
8085
8086 *'wildcharm'* *'wcm'*
8087'wildcharm' 'wcm' number (default: none (0))
8088 global
8089 {not in Vi}
8090 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008091 recognized when used inside a macro. You can find "spare" command-line
8092 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 you'll never actually type 'wildcharm', just use it in mappings that
8094 automatically invoke completion mode, e.g.: >
8095 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008096 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097< Then after typing :ss you can use CTRL-P & CTRL-N.
8098
8099 *'wildignore'* *'wig'*
8100'wildignore' 'wig' string (default "")
8101 global
8102 {not in Vi}
8103 {not available when compiled without the |+wildignore|
8104 feature}
8105 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008106 patterns is ignored when expanding |wildcards|, completing file or
8107 directory names, and influences the result of |expand()|, |glob()| and
8108 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8110 Also see 'suffixes'.
8111 Example: >
8112 :set wildignore=*.o,*.obj
8113< The use of |:set+=| and |:set-=| is preferred when adding or removing
8114 a pattern from the list. This avoids problems when a future version
8115 uses another default.
8116
Bram Moolenaar94950a92010-12-02 16:01:29 +01008117
Bram Moolenaar81af9252010-12-10 20:35:50 +01008118 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008119'wildignorecase' 'wic' boolean (default off)
8120 global
8121 {not in Vi}
8122 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008123 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008124 Does not apply when the shell is used to expand wildcards, which
8125 happens when there are special characters.
8126
8127
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8129'wildmenu' 'wmnu' boolean (default off)
8130 global
8131 {not in Vi}
8132 {not available if compiled without the |+wildmenu|
8133 feature}
8134 When 'wildmenu' is on, command-line completion operates in an enhanced
8135 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8136 the possible matches are shown just above the command line, with the
8137 first match highlighted (overwriting the status line, if there is
8138 one). Keys that show the previous/next match, such as <Tab> or
8139 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8140 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8141 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008142 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143 If there are more matches than can fit in the line, a ">" is shown on
8144 the right and/or a "<" is shown on the left. The status line scrolls
8145 as needed.
8146 The "wildmenu" mode is abandoned when a key is hit that is not used
8147 for selecting a completion.
8148 While the "wildmenu" is active the following keys have special
8149 meanings:
8150
8151 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8152 <Down> - in filename/menu name completion: move into a
8153 subdirectory or submenu.
8154 <CR> - in menu completion, when the cursor is just after a
8155 dot: move into a submenu.
8156 <Up> - in filename/menu name completion: move up into
8157 parent directory or parent menu.
8158
8159 This makes the menus accessible from the console |console-menus|.
8160
8161 If you prefer the <Left> and <Right> keys to move the cursor instead
8162 of selecting a different match, use this: >
8163 :cnoremap <Left> <Space><BS><Left>
8164 :cnoremap <Right> <Space><BS><Right>
8165<
8166 The "WildMenu" highlighting is used for displaying the current match
8167 |hl-WildMenu|.
8168
8169 *'wildmode'* *'wim'*
8170'wildmode' 'wim' string (Vim default: "full")
8171 global
8172 {not in Vi}
8173 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008174 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008175 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008176 first part specifies the behavior for the first use of 'wildchar',
8177 The second part for the second use, etc.
8178 These are the possible values for each part:
8179 "" Complete only the first match.
8180 "full" Complete the next full match. After the last match,
8181 the original string is used and then the first match
8182 again.
8183 "longest" Complete till longest common string. If this doesn't
8184 result in a longer string, use the next part.
8185 "longest:full" Like "longest", but also start 'wildmenu' if it is
8186 enabled.
8187 "list" When more than one match, list all matches.
8188 "list:full" When more than one match, list all matches and
8189 complete first match.
8190 "list:longest" When more than one match, list all matches and
8191 complete till longest common string.
8192 When there is only a single match, it is fully completed in all cases.
8193
8194 Examples: >
8195 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008196< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008197 :set wildmode=longest,full
8198< Complete longest common string, then each full match >
8199 :set wildmode=list:full
8200< List all matches and complete each full match >
8201 :set wildmode=list,full
8202< List all matches without completing, then each full match >
8203 :set wildmode=longest,list
8204< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008205 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008206
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008207 *'wildoptions'* *'wop'*
8208'wildoptions' 'wop' string (default "")
8209 global
8210 {not in Vi}
8211 {not available when compiled without the |+wildignore|
8212 feature}
8213 A list of words that change how command line completion is done.
8214 Currently only one word is allowed:
8215 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008216 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008217 is displayed per line. Often used tag kinds are:
8218 d #define
8219 f function
8220 Also see |cmdline-completion|.
8221
Bram Moolenaar071d4272004-06-13 20:20:40 +00008222 *'winaltkeys'* *'wak'*
8223'winaltkeys' 'wak' string (default "menu")
8224 global
8225 {not in Vi}
8226 {only used in Win32, Motif, GTK and Photon GUI}
8227 Some GUI versions allow the access to menu entries by using the ALT
8228 key in combination with a character that appears underlined in the
8229 menu. This conflicts with the use of the ALT key for mappings and
8230 entering special characters. This option tells what to do:
8231 no Don't use ALT keys for menus. ALT key combinations can be
8232 mapped, but there is no automatic handling. This can then be
8233 done with the |:simalt| command.
8234 yes ALT key handling is done by the windowing system. ALT key
8235 combinations cannot be mapped.
8236 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008237 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238 keys can be mapped.
8239 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8240 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008241 This option is not used for <F10>; on Win32 and with GTK <F10> will
8242 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008243
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008244 *'window'* *'wi'*
8245'window' 'wi' number (default screen height - 1)
8246 global
8247 Window height. Do not confuse this with the height of the Vim window,
8248 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008249 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8250 value is smaller than 'lines' minus one. The screen will scroll
8251 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008252 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8253 in a much smarter way, taking care of wrapping lines.
8254 When resizing the Vim window, the value is smaller than 1 or more than
8255 or equal to 'lines' it will be set to 'lines' minus 1.
8256 {Vi also uses the option to specify the number of displayed lines}
8257
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 *'winheight'* *'wh'* *E591*
8259'winheight' 'wh' number (default 1)
8260 global
8261 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008262 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263 feature}
8264 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008265 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008266 focus goes to a window that is smaller, its size is increased, at the
8267 cost of the height of other windows.
8268 Set 'winheight' to a small number for normal editing.
8269 Set it to 999 to make the current window fill most of the screen.
8270 Other windows will be only 'winminheight' high. This has the drawback
8271 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8272 to create only two windows, set the option after startup is done,
8273 using the |VimEnter| event: >
8274 au VimEnter * set winheight=999
8275< Minimum value is 1.
8276 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008277 height of the current window.
8278 'winheight' applies to the current window. Use 'winminheight' to set
8279 the minimal height for other windows.
8280
8281 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8282'winfixheight' 'wfh' boolean (default off)
8283 local to window
8284 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008285 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 feature}
8287 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008288 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8289 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008290 The height may be changed anyway when running out of room.
8291
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008292 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8293'winfixwidth' 'wfw' boolean (default off)
8294 local to window
8295 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008296 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008297 feature}
8298 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008299 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008300 The width may be changed anyway when running out of room.
8301
Bram Moolenaar071d4272004-06-13 20:20:40 +00008302 *'winminheight'* *'wmh'*
8303'winminheight' 'wmh' number (default 1)
8304 global
8305 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008306 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 feature}
8308 The minimal height of a window, when it's not the current window.
8309 This is a hard minimum, windows will never become smaller.
8310 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8311 status bar) if necessary. They will return to at least one line when
8312 they become active (since the cursor has to have somewhere to go.)
8313 Use 'winheight' to set the minimal height of the current window.
8314 This option is only checked when making a window smaller. Don't use a
8315 large number, it will cause errors when opening more than a few
8316 windows. A value of 0 to 3 is reasonable.
8317
8318 *'winminwidth'* *'wmw'*
8319'winminwidth' 'wmw' number (default 1)
8320 global
8321 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008322 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 feature}
8324 The minimal width of a window, when it's not the current window.
8325 This is a hard minimum, windows will never become smaller.
8326 When set to zero, windows may be "squashed" to zero columns (i.e. just
8327 a vertical separator) if necessary. They will return to at least one
8328 line when they become active (since the cursor has to have somewhere
8329 to go.)
8330 Use 'winwidth' to set the minimal width of the current window.
8331 This option is only checked when making a window smaller. Don't use a
8332 large number, it will cause errors when opening more than a few
8333 windows. A value of 0 to 12 is reasonable.
8334
8335 *'winwidth'* *'wiw'* *E592*
8336'winwidth' 'wiw' number (default 20)
8337 global
8338 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008339 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 feature}
8341 Minimal number of columns for the current window. This is not a hard
8342 minimum, Vim will use fewer columns if there is not enough room. If
8343 the current window is smaller, its size is increased, at the cost of
8344 the width of other windows. Set it to 999 to make the current window
8345 always fill the screen. Set it to a small number for normal editing.
8346 The width is not adjusted after one of the commands to change the
8347 width of the current window.
8348 'winwidth' applies to the current window. Use 'winminwidth' to set
8349 the minimal width for other windows.
8350
8351 *'wrap'* *'nowrap'*
8352'wrap' boolean (default on)
8353 local to window
8354 {not in Vi}
8355 This option changes how text is displayed. It doesn't change the text
8356 in the buffer, see 'textwidth' for that.
8357 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008358 displaying continues on the next line. When off lines will not wrap
8359 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 moved to a part that is not shown, the screen will scroll
8361 horizontally.
8362 The line will be broken in the middle of a word if necessary. See
8363 'linebreak' to get the break at a word boundary.
8364 To make scrolling horizontally a bit more useful, try this: >
8365 :set sidescroll=5
8366 :set listchars+=precedes:<,extends:>
8367< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008368 This option can't be set from a |modeline| when the 'diff' option is
8369 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370
8371 *'wrapmargin'* *'wm'*
8372'wrapmargin' 'wm' number (default 0)
8373 local to buffer
8374 Number of characters from the right window border where wrapping
8375 starts. When typing text beyond this limit, an <EOL> will be inserted
8376 and inserting continues on the next line.
8377 Options that add a margin, such as 'number' and 'foldcolumn', cause
8378 the text width to be further reduced. This is Vi compatible.
8379 When 'textwidth' is non-zero, this option is not used.
8380 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8381 and less usefully}
8382
8383 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8384'wrapscan' 'ws' boolean (default on) *E384* *E385*
8385 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008386 Searches wrap around the end of the file. Also applies to |]s| and
8387 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388
8389 *'write'* *'nowrite'*
8390'write' boolean (default on)
8391 global
8392 {not in Vi}
8393 Allows writing files. When not set, writing a file is not allowed.
8394 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008395 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 argument. Filtering text is still possible, even though this requires
8397 writing a temporary file.
8398
8399 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8400'writeany' 'wa' boolean (default off)
8401 global
8402 Allows writing to any file with no need for "!" override.
8403
8404 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8405'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8406 otherwise)
8407 global
8408 {not in Vi}
8409 Make a backup before overwriting a file. The backup is removed after
8410 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008411 also on.
8412 WARNING: Switching this option off means that when Vim fails to write
8413 your buffer correctly and then, for whatever reason, Vim exits, you
8414 lose both the original file and what you were writing. Only reset
8415 this option if your file system is almost full and it makes the write
8416 fail (and make sure not to exit Vim until the write was successful).
8417 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008418 When the 'backupskip' pattern matches, a backup is not made anyway.
8419 NOTE: This option is set to the default value when 'compatible' is
8420 set.
8421
8422 *'writedelay'* *'wd'*
8423'writedelay' 'wd' number (default 0)
8424 global
8425 {not in Vi}
8426 The number of microseconds to wait for each character sent to the
8427 screen. When non-zero, characters are sent to the terminal one by
8428 one. For MS-DOS pcterm this does not work. For debugging purposes.
8429
8430 vim:tw=78:ts=8:ft=help:norl: