blob: 8a6316fab35215ec4ba7d6b18c852e99aceeaaca [file] [log] [blame]
Bram Moolenaar34d72d42015-07-17 14:18:08 +02001*options.txt* For Vim version 7.4. Last change: 2015 Jul 17
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
Bram Moolenaar18400e62015-01-27 15:58:40 +010062 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000063 The old value can be inserted by typing 'wildchar' (by
64 default this is a <Tab> or CTRL-E if 'compatible' is
65 set). See |cmdline-completion|.
66 White space between {option} and '=' is allowed and
67 will be ignored. White space between '=' and {value}
68 is not allowed.
69 See |option-backslash| for using white space and
70 backslashes in {value}.
71
72:se[t] {option}+={value} *:set+=*
73 Add the {value} to a number option, or append the
74 {value} to a string option. When the option is a
75 comma separated list, a comma is added, unless the
76 value was empty.
77 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000078 are removed. When adding a flag that was already
79 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000080 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 {not in Vi}
82
83:se[t] {option}^={value} *:set^=*
84 Multiply the {value} to a number option, or prepend
85 the {value} to a string option. When the option is a
86 comma separated list, a comma is added, unless the
87 value was empty.
88 Also see |:set-args| above.
89 {not in Vi}
90
91:se[t] {option}-={value} *:set-=*
92 Subtract the {value} from a number option, or remove
93 the {value} from a string option, if it is there.
94 If the {value} is not found in a string option, there
95 is no error or warning. When the option is a comma
96 separated list, a comma is deleted, unless the option
97 becomes empty.
98 When the option is a list of flags, {value} must be
99 exactly as they appear in the option. Remove flags
100 one by one to avoid problems.
101 Also see |:set-args| above.
102 {not in Vi}
103
104The {option} arguments to ":set" may be repeated. For example: >
105 :set ai nosi sw=3 ts=3
106If you make an error in one of the arguments, an error message will be given
107and the following arguments will be ignored.
108
109 *:set-verbose*
110When 'verbose' is non-zero, displaying an option value will also tell where it
111was last set. Example: >
112 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000113< shiftwidth=4 ~
114 Last set from modeline ~
115 cindent ~
116 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
117This is only done when specific option values are requested, not for ":verbose
118set all" or ":verbose set" without an argument.
119When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120When the option was set while executing a function, user command or
121autocommand, the script in which it was defined is reported.
122Note that an option may also have been set as a side effect of setting
123'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000124A few special texts:
125 Last set from modeline ~
126 Option was set in a |modeline|.
127 Last set from --cmd argument ~
128 Option was set with command line argument |--cmd| or +.
129 Last set from -c argument ~
130 Option was set with command line argument |-c|, +, |-S| or
131 |-q|.
132 Last set from environment variable ~
133 Option was set from an environment variable, $VIMINIT,
134 $GVIMINIT or $EXINIT.
135 Last set from error handler ~
136 Option was cleared when evaluating it resulted in an error.
137
Bram Moolenaardb84e452010-08-15 13:50:43 +0200138{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139
140 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000141For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142override the value from the termcap. You can then use it in a mapping. If
143the "xx" part contains special characters, use the <t_xx> form: >
144 :set <t_#4>=^[Ot
145This can also be used to translate a special code for a normal key. For
146example, if Alt-b produces <Esc>b, use this: >
147 :set <M-b>=^[b
148(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
149The advantage over a mapping is that it works in all situations.
150
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100151You can define any key codes, e.g.: >
152 :set t_xy=^[foo;
153There is no warning for using a name that isn't recognized. You can map these
154codes as you like: >
155 :map <t_xy> something
156< *E846*
157When a key code is not set, it's like it does not exist. Trying to get its
158value will result in an error: >
159 :set t_kb=
160 :set t_kb
161 E846: Key code not set: t_kb
162
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000163The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
164security reasons.
165
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000167at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168"set all" probably does not fit on the screen, causing Vim to give the
169|more-prompt|.
170
171 *option-backslash*
172To include white space in a string option value it has to be preceded with a
173backslash. To include a backslash you have to use two. Effectively this
174means that the number of backslashes in an option value is halved (rounded
175down).
176A few examples: >
177 :set tags=tags\ /usr/tags results in "tags /usr/tags"
178 :set tags=tags\\,file results in "tags\,file"
179 :set tags=tags\\\ file results in "tags\ file"
180
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181The "|" character separates a ":set" command from a following command. To
182include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183'titlestring' option to "hi|there": >
184 :set titlestring=hi\|there
185This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
186 :set titlestring=hi|set iconstring=there
187
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000188Similarly, the double quote character starts a comment. To include the '"' in
189the option value, use '\"' instead. This example sets the 'titlestring'
190option to 'hi "there"': >
191 :set titlestring=hi\ \"there\"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194precise: For options that expect a file name (those where environment
195variables are expanded) a backslash before a normal file name character is not
196removed. But a backslash before a special character (space, backslash, comma,
197etc.) is used like explained above.
198There is one special situation, when the value starts with "\\": >
199 :set dir=\\machine\path results in "\\machine\path"
200 :set dir=\\\\machine\\path results in "\\machine\path"
201 :set dir=\\path\\file results in "\\path\file" (wrong!)
202For the first one the start is kept, but for the second one the backslashes
203are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000204halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205result which is probably not what you want. Avoid it.
206
207 *add-option-flags* *remove-option-flags*
208 *E539* *E550* *E551* *E552*
209Some options are a list of flags. When you want to add a flag to such an
210option, without changing the existing ones, you can do it like this: >
211 :set guioptions+=a
212Remove a flag from an option like this: >
213 :set guioptions-=a
214This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000215Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
217doesn't appear.
218
219 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000220Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221environment variable exists the '$' and the following environment variable
222name is replaced with its value. If it does not exist the '$' and the name
223are not modified. Any non-id character (not a letter, digit or '_') may
224follow the environment variable name. That character and what follows is
225appended to the value of the environment variable. Examples: >
226 :set term=$TERM.new
227 :set path=/usr/$INCLUDE,$HOME/include,.
228When adding or removing a string from an option with ":set opt-=val" or ":set
229opt+=val" the expansion is done before the adding or removing.
230
231
232Handling of local options *local-options*
233
234Some of the options only apply to a window or buffer. Each window or buffer
235has its own copy of this option, thus can each have their own value. This
236allows you to set 'list' in one window but not in another. And set
237'shiftwidth' to 3 in one buffer and 4 in another.
238
239The following explains what happens to these local options in specific
240situations. You don't really need to know all of this, since Vim mostly uses
241the option values you would expect. Unfortunately, doing what the user
242expects is a bit complicated...
243
244When splitting a window, the local options are copied to the new window. Thus
245right after the split the contents of the two windows look the same.
246
247When editing a new buffer, its local option values must be initialized. Since
248the local options of the current buffer might be specifically for that buffer,
249these are not used. Instead, for each buffer-local option there also is a
250global value, which is used for new buffers. With ":set" both the local and
251global value is changed. With "setlocal" only the local value is changed,
252thus this value is not used when editing a new buffer.
253
254When editing a buffer that has been edited before, the last used window
255options are used again. If this buffer has been edited in this window, the
256values from back then are used. Otherwise the values from the window where
257the buffer was edited last are used.
258
259It's possible to set a local window option specifically for a type of buffer.
260When you edit another buffer in the same window, you don't want to keep
261using these local window options. Therefore Vim keeps a global value of the
262local window options, which is used when editing another buffer. Each window
263has its own copy of these values. Thus these are local to the window, but
264global to all buffers in the window. With this you can do: >
265 :e one
266 :set list
267 :e two
268Now the 'list' option will also be set in "two", since with the ":set list"
269command you have also set the global value. >
270 :set nolist
271 :e one
272 :setlocal list
273 :e two
274Now the 'list' option is not set, because ":set nolist" resets the global
275value, ":setlocal list" only changes the local value and ":e two" gets the
276global value. Note that if you do this next: >
277 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200278You will get back the 'list' value as it was the last time you edited "one".
279The options local to a window are remembered for each buffer. This also
280happens when the buffer is not loaded, but they are lost when the buffer is
281wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100304:se[t] {option}< For |global-local| options: Remove the local value of
305 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {not in Vi}
307
308 *:setg* *:setglobal*
309:setg[lobal] ... Like ":set" but set only the global value for a local
310 option without changing the local value.
311 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200312 With the "all" argument: display global values for all
313 local options.
314 Without argument: display global values for all local
315 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318For buffer-local and window-local options:
319 Command global value local value ~
320 :set option=value set set
321 :setlocal option=value - set
322:setglobal option=value set -
323 :set option? - display
324 :setlocal option? - display
325:setglobal option? display -
326
327
328Global options with a local value *global-local*
329
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000330Options are global when you mostly use one value for all buffers and windows.
331For some global options it's useful to sometimes have a different local value.
332You can set the local value with ":setlocal". That buffer or window will then
333use the local value, while other buffers and windows continue using the global
334value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336For example, you have two windows, both on C source code. They use the global
337'makeprg' option. If you do this in one of the two windows: >
338 :set makeprg=gmake
339then the other window will switch to the same value. There is no need to set
340the 'makeprg' option in the other C source window too.
341However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000342another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000343files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 :setlocal makeprg=perlmake
345You can switch back to using the global value by making the local value empty: >
346 :setlocal makeprg=
347This only works for a string option. For a boolean option you need to use the
348"<" flag, like this: >
349 :setlocal autoread<
350Note that for non-boolean options using "<" copies the global value to the
351local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000352when the global value changes later). You can also use: >
353 :set path<
354This will make the local value of 'path' empty, so that the global value is
355used. Thus it does the same as: >
356 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357Note: In the future more global options can be made global-local. Using
358":setlocal" on a global option might work differently then.
359
360
361Setting the filetype
362
363:setf[iletype] {filetype} *:setf* *:setfiletype*
364 Set the 'filetype' option to {filetype}, but only if
365 not done yet in a sequence of (nested) autocommands.
366 This is short for: >
367 :if !did_filetype()
368 : setlocal filetype={filetype}
369 :endif
370< This command is used in a filetype.vim file to avoid
371 setting the 'filetype' option twice, causing different
372 settings and syntax files to be loaded.
373 {not in Vi}
374
Bram Moolenaard58e9292011-02-09 17:07:58 +0100375 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
377:opt[ions] Open a window for viewing and setting all options.
378 Options are grouped by function.
379 Offers short help for each option. Hit <CR> on the
380 short help to open a help window with more help for
381 the option.
382 Modify the value of the option and hit <CR> on the
383 "set" line to set the new value. For window and
384 buffer specific options, the last accessed window is
385 used to set the option value in, unless this is a help
386 window, in which case the window below help window is
387 used (skipping the option-window).
388 {not available when compiled without the |+eval| or
389 |+autocmd| features}
390
391 *$HOME*
392Using "~" is like using "$HOME", but it is only recognized at the start of an
393option and after a space or comma.
394
395On Unix systems "~user" can be used too. It is replaced by the home directory
396of user "user". Example: >
397 :set path=~mool/include,/usr/include,.
398
399On Unix systems the form "${HOME}" can be used too. The name between {} can
400contain non-id characters then. Note that if you want to use this for the
401"gf" command, you need to add the '{' and '}' characters to 'isfname'.
402
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100403On MS-Windows, if $HOME is not defined as an environment variable, then
404at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406NOTE: expanding environment variables and "~/" is only done with the ":set"
407command, not when assigning a value to an option with ":let".
408
409
410Note the maximum length of an expanded option is limited. How much depends on
411the system, mostly it is something like 256 or 1024 characters.
412
413 *:fix* *:fixdel*
414:fix[del] Set the value of 't_kD':
415 't_kb' is 't_kD' becomes ~
416 CTRL-? CTRL-H
417 not CTRL-? CTRL-?
418
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
420
421 If your delete key terminal code is wrong, but the
422 code for backspace is alright, you can put this in
423 your .vimrc: >
424 :fixdel
425< This works no matter what the actual code for
426 backspace is.
427
428 If the backspace key terminal code is wrong you can
429 use this: >
430 :if &term == "termname"
431 : set t_kb=^V<BS>
432 : fixdel
433 :endif
434< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000435 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 with your terminal name.
437
438 If your <Delete> key sends a strange key sequence (not
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
440 :if &term == "termname"
441 : set t_kD=^V<Delete>
442 :endif
443< Where "^V" is CTRL-V and "<Delete>" is the delete key
444 (don't type eight characters!). Replace "termname"
445 with your terminal name.
446
447 *Linux-backspace*
448 Note about Linux: By default the backspace key
449 produces CTRL-?, which is wrong. You can fix it by
450 putting this line in your rc.local: >
451 echo "keycode 14 = BackSpace" | loadkeys
452<
453 *NetBSD-backspace*
454 Note about NetBSD: If your backspace doesn't produce
455 the right code, try this: >
456 xmodmap -e "keycode 22 = BackSpace"
457< If this works, add this in your .Xmodmap file: >
458 keysym 22 = BackSpace
459< You need to restart for this to take effect.
460
461==============================================================================
4622. Automatically setting options *auto-setting*
463
464Besides changing options with the ":set" command, there are three alternatives
465to set options automatically for one or more files:
466
4671. When starting Vim initializations are read from various places. See
468 |initialization|. Most of them are performed for all editing sessions,
469 and some of them depend on the directory where Vim is started.
470 You can create an initialization file with |:mkvimrc|, |:mkview| and
471 |:mksession|.
4722. If you start editing a new file, the automatic commands are executed.
473 This can be used to set options for files matching a particular pattern and
474 many other things. See |autocommand|.
4753. If you start editing a new file, and the 'modeline' option is on, a
476 number of lines at the beginning and end of the file are checked for
477 modelines. This is explained here.
478
479 *modeline* *vim:* *vi:* *ex:* *E520*
480There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200481 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200486[white] optional white space
487{options} a list of option settings, separated with white space
488 or ':', where each part between ':' is the argument
489 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494
495The second form (this is compatible with some versions of Vi):
496
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200497 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499[text] any text or empty
500{white} at least one blank character (<Space> or <Tab>)
501{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
502[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503se[t] the string "set " or "se " (note the space); When
504 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200505{options} a list of options, separated with white space, which
506 is the argument for a ":set" command
507: a colon
508[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000511 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
515chance that a normal word like "lex:" is caught. There is one exception:
516"vi:" and "vim:" can also be at the start of the line (for compatibility with
517version 3.0). Using "ex:" at the start of the line will be ignored (this
518could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
520 *modeline-local*
521The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000522buffer and window that contain the file. Although it's possible to set global
523options from a modeline, this is unusual. If you have two windows open and
524the files in it set the same global option to a different value, the result
525depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000527When editing a file that was already loaded, only the window-local options
528from the modeline are used. Thus if you manually changed a buffer-local
529option after opening the file, it won't be changed if you edit the same buffer
530in another window. But window-local options will be set.
531
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 *modeline-version*
533If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200534number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535 vim{vers}: version {vers} or later
536 vim<{vers}: version before {vers}
537 vim={vers}: version {vers}
538 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100539{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
540For example, to use a modeline only for Vim 7.0:
541 /* vim700: set foldmethod=marker */ ~
542To use a modeline for Vim after version 7.2:
543 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544There can be no blanks between "vim" and the ":".
545
546
547The number of lines that are checked can be set with the 'modelines' option.
548If 'modeline' is off or 'modelines' is 0 no lines are checked.
549
550Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000551like:
552 /* vi:ts=4: */ ~
553will give an error message for the trailing "*/". This line is OK:
554 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555
556If an error is detected the rest of the line is skipped.
557
558If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000559backslash in front of the ':' will be removed. Example:
560 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561This sets the 'dir' option to "c:\tmp". Only a single backslash before the
562':' is removed. Thus to include "\:" you have to specify "\\:".
563
564No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565might create a Trojan horse text file with modelines). And not all options
566can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000567|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000568causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
569are wrapped unexpectedly. So disable modelines before editing untrusted text.
570The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571
572Hint: If you would like to do something else than setting an option, you could
573define an autocommand that checks the file for a specific string. For
574example: >
575 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
576And define a function SetVar() that does something with the line containing
577"VAR".
578
579==============================================================================
5803. Options summary *option-summary*
581
582In the list below all the options are mentioned with their full name and with
583an abbreviation if there is one. Both forms may be used.
584
585In this document when a boolean option is "set" that means that ":set option"
586is entered. When an option is "reset", ":set nooption" is used.
587
588For some options there are two default values: The "Vim default", which is
589used when 'compatible' is not set, and the "Vi default", which is used when
590'compatible' is set.
591
592Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594different value in each window. For example the 'list' option can be set in
595one window and reset in another for the same text, giving both types of view
596at the same time. There are a few options that are specific to a certain
597file. These can have a different value for each file or buffer. For example
598the 'textwidth' option can be 78 for a normal text file and 0 for a C
599program.
600
601 global one option for all buffers and windows
602 local to window each window has its own copy of this option
603 local to buffer each buffer has its own copy of this option
604
605When creating a new window the option values from the currently active window
606are used as a default value for the window-specific options. For the
607buffer-specific options this depends on the 's' and 'S' flags in the
608'cpoptions' option. If 's' is included (which is the default) the values for
609buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000610first entered. If 'S' is present the options are copied each time the buffer
611is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612present, the options are copied from the currently active buffer when the
613buffer is created.
614
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000615Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Not all options are supported in all versions. This depends on the supported
618features and sometimes on the system. A remark about this is in curly braces
619below. When an option is not supported it may still be set without getting an
620error, this is called a hidden option. You can't get the value of a hidden
621option though, it is not stored.
622
623To test if option "foo" can be used with ":set" use something like this: >
624 if exists('&foo')
625This also returns true for a hidden option. To test if option "foo" is really
626supported use something like this: >
627 if exists('+foo')
628<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 *E355*
630A jump table for the options with a short description can be found at |Q_op|.
631
632 *'aleph'* *'al'* *aleph* *Aleph*
633'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
634 global
635 {not in Vi}
636 {only available when compiled with the |+rightleft|
637 feature}
638 The ASCII code for the first letter of the Hebrew alphabet. The
639 routine that maps the keyboard in Hebrew mode, both in Insert mode
640 (when hkmap is set) and on the command-line (when hitting CTRL-_)
641 outputs the Hebrew characters in the range [aleph..aleph+26].
642 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
643 See |rileft.txt|.
644
645 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
646'allowrevins' 'ari' boolean (default off)
647 global
648 {not in Vi}
649 {only available when compiled with the |+rightleft|
650 feature}
651 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
652 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
653 into reverse Insert mode, and don't know how to get out. See
654 'revins'.
655 NOTE: This option is reset when 'compatible' is set.
656
657 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
658'altkeymap' 'akm' boolean (default off)
659 global
660 {not in Vi}
661 {only available when compiled with the |+farsi|
662 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 the keyboard map between Farsi and English, when 'allowrevins' set.
665
Bram Moolenaar582fd852005-03-28 20:58:01 +0000666 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 is useful to start the Vim in native mode i.e. English (left-to-right
668 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000669 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670
671 *'ambiwidth'* *'ambw'*
672'ambiwidth' 'ambw' string (default: "single")
673 global
674 {not in Vi}
675 {only available when compiled with the |+multi_byte|
676 feature}
677 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
678 Tells Vim what to do with characters with East Asian Width Class
679 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
680 letters, Cyrillic letters).
681
682 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000683 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 expected by most users.
685 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200686 *E834* *E835*
687 The value "double" cannot be used if 'listchars' or 'fillchars'
688 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 There are a number of CJK fonts for which the width of glyphs for
691 those characters are solely based on how many octets they take in
692 legacy/traditional CJK encodings. In those encodings, Euro,
693 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 Vim is running inside a terminal (emulators) that uses a CJK font
698 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
699 this option should be set to "double" to match the width perceived
700 by Vim with the width of glyphs in the font. Perhaps it also has
701 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
702 when the system locale is set to one of CJK locales. See Unicode
703 Standard Annex #11 (http://www.unicode.org/reports/tr11).
704
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100705 Vim may set this option automatically at startup time when Vim is
706 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200707 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100708
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
710'antialias' 'anti' boolean (default: off)
711 global
712 {not in Vi}
713 {only available when compiled with GUI enabled
714 on Mac OS X}
715 This option only has an effect in the GUI version of Vim on Mac OS X
716 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
717 which can be easier to read at certain sizes on certain displays.
718 Setting this option can sometimes cause problems if 'guifont' is set
719 to its default (empty string).
720
721 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
722'autochdir' 'acd' boolean (default off)
723 global
724 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200725 {only available when compiled with it, use
726 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000727 When on, Vim will change the current working directory whenever you
728 open a file, switch buffers, delete a buffer or open/close a window.
729 It will change to the directory containing the file which was opened
730 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000731 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
734'arabic' 'arab' boolean (default off)
735 local to window
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 This option can be set to start editing Arabic text.
740 Setting this option will:
741 - Set the 'rightleft' option, unless 'termbidi' is set.
742 - Set the 'arabicshape' option, unless 'termbidi' is set.
743 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
744 between typing English and Arabic key mapping.
745 - Set the 'delcombine' option
746 Note that 'encoding' must be "utf-8" for working with Arabic text.
747
748 Resetting this option will:
749 - Reset the 'rightleft' option.
750 - Disable the use of 'keymap' (without changing its value).
751 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200752 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 Also see |arabic.txt|.
754
755 *'arabicshape'* *'arshape'*
756 *'noarabicshape'* *'noarshape'*
757'arabicshape' 'arshape' boolean (default on)
758 global
759 {not in Vi}
760 {only available when compiled with the |+arabic|
761 feature}
762 When on and 'termbidi' is off, the required visual character
763 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200764 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 one which encompasses:
766 a) the changing/morphing of characters based on their location
767 within a word (initial, medial, final and stand-alone).
768 b) the enabling of the ability to compose characters
769 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100770 When disabled the display shows each character's true stand-alone
771 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Arabic is a complex language which requires other settings, for
773 further details see |arabic.txt|.
774
775 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
776'autoindent' 'ai' boolean (default off)
777 local to buffer
778 Copy indent from current line when starting a new line (typing <CR>
779 in Insert mode or when using the "o" or "O" command). If you do not
780 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000781 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
782 to another line has the same effect, unless the 'I' flag is included
783 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000784 When autoindent is on, formatting (with the "gq" command or when you
785 reach 'textwidth' in Insert mode) uses the indentation of the first
786 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 When 'smartindent' or 'cindent' is on the indent is changed in
788 a different way.
789 The 'autoindent' option is reset when the 'paste' option is set.
790 {small difference from Vi: After the indent is deleted when typing
791 <Esc> or <CR>, the cursor position when moving up or down is after the
792 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
793
794 *'autoread'* *'ar'* *'noautoread'* *'noar'*
795'autoread' 'ar' boolean (default off)
796 global or local to buffer |global-local|
797 {not in Vi}
798 When a file has been detected to have been changed outside of Vim and
799 it has not been changed inside of Vim, automatically read it again.
800 When the file has been deleted this is not done. |timestamp|
801 If this option has a local value, use this command to switch back to
802 using the global value: >
803 :set autoread<
804<
805 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
806'autowrite' 'aw' boolean (default off)
807 global
808 Write the contents of the file, if it has been modified, on each
809 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000810 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
812 Note that for some commands the 'autowrite' option is not used, see
813 'autowriteall' for that.
814
815 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
816'autowriteall' 'awa' boolean (default off)
817 global
818 {not in Vi}
819 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
820 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
821 Setting this option also implies that Vim behaves like 'autowrite' has
822 been set.
823
824 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200825'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 global
827 {not in Vi}
828 When set to "dark", Vim will try to use colors that look good on a
829 dark background. When set to "light", Vim will try to use colors that
830 look good on a light background. Any other value is illegal.
831 Vim tries to set the default value according to the terminal used.
832 This will not always be correct.
833 Setting this option does not change the background color, it tells Vim
834 what the background color looks like. For changing the background
835 color, see |:hi-normal|.
836
837 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000838 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000839 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100840 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 setting 'background' will cause the color scheme to be reloaded. If
842 the color scheme adjusts to the value of 'background' this will work.
843 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 When setting 'background' to the default value with: >
847 :set background&
848< Vim will guess the value. In the GUI this should work correctly,
849 in other cases Vim might not be able to guess the right value.
850
851 When starting the GUI, the default value for 'background' will be
852 "light". When the value is not set in the .gvimrc, and Vim detects
853 that the background is actually quite dark, 'background' is set to
854 "dark". But this happens only AFTER the .gvimrc file has been read
855 (because the window needs to be opened to find the actual background
856 color). To get around this, force the GUI window to be opened by
857 putting a ":gui" command in the .gvimrc file, before where the value
858 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200859
860 For MS-DOS, Windows and OS/2 the default is "dark".
861 For other systems "dark" is used when 'term' is "linux",
862 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
863 background. Otherwise the default is "light".
864
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 Normally this option would be set in the .vimrc file. Possibly
866 depending on the terminal name. Example: >
867 :if &term == "pcterm"
868 : set background=dark
869 :endif
870< When this option is set, the default settings for the highlight groups
871 will change. To use other settings, place ":highlight" commands AFTER
872 the setting of the 'background' option.
873 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
874 to select the colors for syntax highlighting. After changing this
875 option, you must load syntax.vim again to see the result. This can be
876 done with ":syntax on".
877
878 *'backspace'* *'bs'*
879'backspace' 'bs' string (default "")
880 global
881 {not in Vi}
882 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
883 mode. This is a list of items, separated by commas. Each item allows
884 a way to backspace over something:
885 value effect ~
886 indent allow backspacing over autoindent
887 eol allow backspacing over line breaks (join lines)
888 start allow backspacing over the start of insert; CTRL-W and CTRL-U
889 stop once at the start of insert.
890
891 When the value is empty, Vi compatible backspacing is used.
892
893 For backwards compatibility with version 5.4 and earlier:
894 value effect ~
895 0 same as ":set backspace=" (Vi compatible)
896 1 same as ":set backspace=indent,eol"
897 2 same as ":set backspace=indent,eol,start"
898
899 See |:fixdel| if your <BS> or <Del> key does not do what you want.
900 NOTE: This option is set to "" when 'compatible' is set.
901
902 *'backup'* *'bk'* *'nobackup'* *'nobk'*
903'backup' 'bk' boolean (default off)
904 global
905 {not in Vi}
906 Make a backup before overwriting a file. Leave it around after the
907 file has been successfully written. If you do not want to keep the
908 backup file, but you do want a backup while the file is being
909 written, reset this option and set the 'writebackup' option (this is
910 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 |backup-table| for more explanations.
913 When the 'backupskip' pattern matches, a backup is not made anyway.
914 When 'patchmode' is set, the backup may be renamed to become the
915 oldest version of a file.
916 NOTE: This option is reset when 'compatible' is set.
917
918 *'backupcopy'* *'bkc'*
919'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200920 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 {not in Vi}
922 When writing a file and a backup is made, this option tells how it's
923 done. This is a comma separated list of words.
924
925 The main values are:
926 "yes" make a copy of the file and overwrite the original one
927 "no" rename the file and write a new one
928 "auto" one of the previous, what works best
929
930 Extra values that can be combined with the ones above are:
931 "breaksymlink" always break symlinks when writing
932 "breakhardlink" always break hardlinks when writing
933
934 Making a copy and overwriting the original file:
935 - Takes extra time to copy the file.
936 + When the file has special attributes, is a (hard/symbolic) link or
937 has a resource fork, all this is preserved.
938 - When the file is a link the backup will have the name of the link,
939 not of the real file.
940
941 Renaming the file and writing a new one:
942 + It's fast.
943 - Sometimes not all attributes of the file can be copied to the new
944 file.
945 - When the file is a link the new file will not be a link.
946
947 The "auto" value is the middle way: When Vim sees that renaming file
948 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000949 the file is not a link) that is used. When problems are expected, a
950 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952 The "breaksymlink" and "breakhardlink" values can be used in
953 combination with any of "yes", "no" and "auto". When included, they
954 force Vim to always break either symbolic or hard links by doing
955 exactly what the "no" option does, renaming the original file to
956 become the backup and writing a new file in its place. This can be
957 useful for example in source trees where all the files are symbolic or
958 hard links and any changes should stay in the local source tree, not
959 be propagated back to the original source.
960 *crontab*
961 One situation where "no" and "auto" will cause problems: A program
962 that opens a file, invokes Vim to edit that file, and then tests if
963 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000964 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 example.
966
967 When a copy is made, the original file is truncated and then filled
968 with the new text. This means that protection bits, owner and
969 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000970 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 group of the backup is set to the group of the original file. If this
972 fails, the protection bits for the group are made the same as for
973 others.
974
975 When the file is renamed this is the other way around: The backup has
976 the same attributes of the original file, and the newly written file
977 is owned by the current user. When the file was a (hard/symbolic)
978 link, the new file will not! That's why the "auto" value doesn't
979 rename when the file is a link. The owner and group of the newly
980 written file will be set to the same ones as the original file, but
981 the system may refuse to do this. In that case the "auto" value will
982 again not rename the file.
983
984 *'backupdir'* *'bdir'*
985'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100986 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 for Unix: ".,~/tmp,~/")
988 global
989 {not in Vi}
990 List of directories for the backup file, separated with commas.
991 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100992 where this is possible. The directory must exist, Vim will not
993 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100994 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 impossible!). Writing may fail because of this.
996 - A directory "." means to put the backup file in the same directory
997 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000998 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 put the backup file relative to where the edited file is. The
1000 leading "." is replaced with the path name of the edited file.
1001 ("." inside a directory name has no special meaning).
1002 - Spaces after the comma are ignored, other spaces are considered part
1003 of the directory name. To have a space at the start of a directory
1004 name, precede it with a backslash.
1005 - To include a comma in a directory name precede it with a backslash.
1006 - A directory name may end in an '/'.
1007 - Environment variables are expanded |:set_env|.
1008 - Careful with '\' characters, type one before a space, type two to
1009 get one in the option (see |option-backslash|), for example: >
1010 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1011< - For backwards compatibility with Vim version 3.0 a '>' at the start
1012 of the option is removed.
1013 See also 'backup' and 'writebackup' options.
1014 If you want to hide your backup files on Unix, consider this value: >
1015 :set backupdir=./.backup,~/.backup,.,/tmp
1016< You must create a ".backup" directory in each directory and in your
1017 home directory for this to work properly.
1018 The use of |:set+=| and |:set-=| is preferred when adding or removing
1019 directories from the list. This avoids problems when a future version
1020 uses another default.
1021 This option cannot be set from a |modeline| or in the |sandbox|, for
1022 security reasons.
1023
1024 *'backupext'* *'bex'* *E589*
1025'backupext' 'bex' string (default "~", for VMS: "_")
1026 global
1027 {not in Vi}
1028 String which is appended to a file name to make the name of the
1029 backup file. The default is quite unusual, because this avoids
1030 accidentally overwriting existing files with a backup file. You might
1031 prefer using ".bak", but make sure that you don't have files with
1032 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001033 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001035 If you like to keep a lot of backups, you could use a BufWritePre
1036 autocommand to change 'backupext' just before writing the file to
1037 include a timestamp. >
1038 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1039< Use 'backupdir' to put the backup in a different directory.
1040
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 *'backupskip'* *'bsk'*
1042'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1043 global
1044 {not in Vi}
1045 {not available when compiled without the |+wildignore|
1046 feature}
1047 A list of file patterns. When one of the patterns matches with the
1048 name of the file which is written, no backup file is created. Both
1049 the specified file name and the full path name of the file are used.
1050 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1051 Watch out for special characters, see |option-backslash|.
1052 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001053 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001054
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001055 WARNING: Not having a backup file means that when Vim fails to write
1056 your buffer correctly and then, for whatever reason, Vim exits, you
1057 lose both the original file and what you were writing. Only disable
1058 backups if you don't care about losing the file.
1059
Bram Moolenaar02467872007-05-06 13:22:01 +00001060 Note that environment variables are not expanded. If you want to use
1061 $HOME you must expand it explicitly, e.g.: >
1062 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1063
1064< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001065 backup would be made by renaming the original file crontab won't see
1066 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
1068 *'balloondelay'* *'bdlay'*
1069'balloondelay' 'bdlay' number (default: 600)
1070 global
1071 {not in Vi}
1072 {only available when compiled with the |+balloon_eval|
1073 feature}
1074 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1075
1076 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1077'ballooneval' 'beval' boolean (default off)
1078 global
1079 {not in Vi}
1080 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001081 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 Switch on the |balloon-eval| functionality.
1083
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001084 *'balloonexpr'* *'bexpr'*
1085'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001086 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001087 {not in Vi}
1088 {only available when compiled with the |+balloon_eval|
1089 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001090 Expression for text to show in evaluation balloon. It is only used
1091 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001092
1093 v:beval_bufnr number of the buffer in which balloon is going to show
1094 v:beval_winnr number of the window
1095 v:beval_lnum line number
1096 v:beval_col column number (byte index)
1097 v:beval_text word under or after the mouse pointer
1098
1099 The evaluation of the expression must not have side effects!
1100 Example: >
1101 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001102 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001103 \', column ' . v:beval_col .
1104 \ ' of file ' . bufname(v:beval_bufnr) .
1105 \ ' on word "' . v:beval_text . '"'
1106 endfunction
1107 set bexpr=MyBalloonExpr()
1108 set ballooneval
1109<
1110 NOTE: The balloon is displayed only if the cursor is on a text
1111 character. If the result of evaluating 'balloonexpr' is not empty,
1112 Vim does not try to send a message to an external debugger (Netbeans
1113 or Sun Workshop).
1114
Bram Moolenaar30b65812012-07-12 22:01:11 +02001115 The expression will be evaluated in the |sandbox| when set from a
1116 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001117
1118 It is not allowed to change text or jump to another window while
1119 evaluating 'balloonexpr' |textlock|.
1120
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001121 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001122 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001123< When they are supported "\n" characters will start a new line. If the
1124 expression evaluates to a |List| this is equal to using each List item
1125 as a string and putting "\n" in between them.
1126
Bram Moolenaar165bc692015-07-21 17:53:25 +02001127 *'belloff'* *'bo'*
1128'belloff' 'bo' string (default "")
1129 global
1130 {not in Vi}
1131 Specifies for which events the bell will not be rung. It is a comma
1132 separated list of items. For each item that is present, the bell
1133 will be silenced. This is most useful to specify specific events in
1134 insert mode to be silenced.
1135
1136 item meaning when present ~
1137 all All events.
1138 backspace When hitting <BS> or <Del> and deleting results in an
1139 error.
1140 cursor Fail to move around using the cursor keys or
1141 <PageUp>/<PageDown> in |Insert-mode|.
1142 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1143 |i_CTRL-X_CTRL-T|.
1144 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1145 |i_CTRL-E|.
1146 ctrlg Unknown Char after <C-G> in Insert mode.
1147 error Other Error occurred (e.g. try to join last line)
1148 (mostly used in |Normal-mode| or |Cmdline-mode|).
1149 esc hitting <Esc> in |Normal-mode|.
1150 ex In |Visual-mode|, hitting |Q| results in an error.
1151 hangul Error occurred when using hangul input.
1152 insertmode Pressing <Esc> in 'insertmode'.
1153 lang Calling the beep module for Lua/Mzscheme/TCL.
1154 mess No output available for |g<|.
1155 showmatch Error occurred for 'showmatch' function.
1156 operator Empty region error |cpo-E|.
1157 register Unknown register after <C-R> in |Insert-mode|.
1158 shell Bell from shell output |:!|.
1159 spell Error happened on spell suggest.
1160 wildmode More matches in |cmdline-completion| available
1161 (depends on the 'wildmode' setting).
1162
1163 This is most useful, to fine tune when in insert mode the bell should
1164 be rung. For normal mode and ex commands, the bell is often rung to
1165 indicate that an error occurred. It can be silenced by adding the
1166 "error" keyword.
1167
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1169'binary' 'bin' boolean (default off)
1170 local to buffer
1171 {not in Vi}
1172 This option should be set before editing a binary file. You can also
1173 use the |-b| Vim argument. When this option is switched on a few
1174 options will be changed (also when it already was on):
1175 'textwidth' will be set to 0
1176 'wrapmargin' will be set to 0
1177 'modeline' will be off
1178 'expandtab' will be off
1179 Also, 'fileformat' and 'fileformats' options will not be used, the
1180 file is read and written like 'fileformat' was "unix" (a single <NL>
1181 separates lines).
1182 The 'fileencoding' and 'fileencodings' options will not be used, the
1183 file is read without conversion.
1184 NOTE: When you start editing a(nother) file while the 'bin' option is
1185 on, settings from autocommands may change the settings again (e.g.,
1186 'textwidth'), causing trouble when editing. You might want to set
1187 'bin' again when the file has been loaded.
1188 The previous values of these options are remembered and restored when
1189 'bin' is switched from on to off. Each buffer has its own set of
1190 saved option values.
1191 To edit a file with 'binary' set you can use the |++bin| argument.
1192 This avoids you have to do ":set bin", which would have effect for all
1193 files you edit.
1194 When writing a file the <EOL> for the last line is only written if
1195 there was one in the original file (normally Vim appends an <EOL> to
1196 the last line if there is none; this would make the file longer). See
1197 the 'endofline' option.
1198
1199 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1200'bioskey' 'biosk' boolean (default on)
1201 global
1202 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001203 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 better to detect CTRL-C, but only works for the console. When using a
1205 terminal over a serial port reset this option.
1206 Also see |'conskey'|.
1207
1208 *'bomb'* *'nobomb'*
1209'bomb' boolean (default off)
1210 local to buffer
1211 {not in Vi}
1212 {only available when compiled with the |+multi_byte|
1213 feature}
1214 When writing a file and the following conditions are met, a BOM (Byte
1215 Order Mark) is prepended to the file:
1216 - this option is on
1217 - the 'binary' option is off
1218 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1219 endian variants.
1220 Some applications use the BOM to recognize the encoding of the file.
1221 Often used for UCS-2 files on MS-Windows. For other applications it
1222 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001223 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1225 check for the presence of the BOM is done and 'bomb' set accordingly.
1226 Unless 'binary' is set, it is removed from the first line, so that you
1227 don't see it when editing. When you don't change the options, the BOM
1228 will be restored when writing the file.
1229
1230 *'breakat'* *'brk'*
1231'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1232 global
1233 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001234 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 feature}
1236 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001237 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1238 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001240 *'breakindent'* *'bri'*
1241'breakindent' 'bri' boolean (default off)
1242 local to window
1243 {not in Vi}
1244 {not available when compiled without the |+linebreak|
1245 feature}
1246 Every wrapped line will continue visually indented (same amount of
1247 space as the beginning of that line), thus preserving horizontal blocks
1248 of text.
1249
1250 *'breakindentopt'* *'briopt'*
1251'breakindentopt' 'briopt' string (default empty)
1252 local to window
1253 {not in Vi}
1254 {not available when compiled without the |+linebreak|
1255 feature}
1256 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001257 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001258 min:{n} Minimum text width that will be kept after
1259 applying 'breakindent', even if the resulting
1260 text should normally be narrower. This prevents
1261 text indented almost to the right window border
1262 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001263 shift:{n} After applying 'breakindent', the wrapped line's
1264 beginning will be shifted by the given number of
1265 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001266 indentation (negative) or emphasizing the line
1267 continuation (positive).
1268 sbr Display the 'showbreak' value before applying the
1269 additional indent.
1270 The default value for min is 20 and shift is 0.
1271
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001273'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001275 {not in Vi} {only for Motif, Athena, GTK, Mac and
1276 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001278 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001279 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 buffer Use the directory of the related buffer.
1281 current Use the current directory.
1282 {path} Use the specified directory
1283
1284 *'bufhidden'* *'bh'*
1285'bufhidden' 'bh' string (default: "")
1286 local to buffer
1287 {not in Vi}
1288 {not available when compiled without the |+quickfix|
1289 feature}
1290 This option specifies what happens when a buffer is no longer
1291 displayed in a window:
1292 <empty> follow the global 'hidden' option
1293 hide hide the buffer (don't unload it), also when 'hidden'
1294 is not set
1295 unload unload the buffer, also when 'hidden' is set or using
1296 |:hide|
1297 delete delete the buffer from the buffer list, also when
1298 'hidden' is set or using |:hide|, like using
1299 |:bdelete|
1300 wipe wipe out the buffer from the buffer list, also when
1301 'hidden' is set or using |:hide|, like using
1302 |:bwipeout|
1303
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001304 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001305 are lost without a warning. Also, these values may break autocommands
1306 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 This option is used together with 'buftype' and 'swapfile' to specify
1308 special kinds of buffers. See |special-buffers|.
1309
1310 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1311'buflisted' 'bl' boolean (default: on)
1312 local to buffer
1313 {not in Vi}
1314 When this option is set, the buffer shows up in the buffer list. If
1315 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1316 This option is reset by Vim for buffers that are only used to remember
1317 a file name or marks. Vim sets it when starting to edit a buffer.
1318 But not when moving to a buffer with ":buffer".
1319
1320 *'buftype'* *'bt'* *E382*
1321'buftype' 'bt' string (default: "")
1322 local to buffer
1323 {not in Vi}
1324 {not available when compiled without the |+quickfix|
1325 feature}
1326 The value of this option specifies the type of a buffer:
1327 <empty> normal buffer
1328 nofile buffer which is not related to a file and will not be
1329 written
1330 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001331 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001332 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001333 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001334 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001335 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 help help buffer (you are not supposed to set this
1337 manually)
1338
1339 This option is used together with 'bufhidden' and 'swapfile' to
1340 specify special kinds of buffers. See |special-buffers|.
1341
1342 Be careful with changing this option, it can have many side effects!
1343
Bram Moolenaar280f1262006-01-30 00:14:18 +00001344 A "quickfix" buffer is only used for the error list and the location
1345 list. This value is set by the |:cwindow| and |:lwindow| commands and
1346 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
1348 "nofile" and "nowrite" buffers are similar:
1349 both: The buffer is not to be written to disk, ":w" doesn't
1350 work (":w filename" does work though).
1351 both: The buffer is never considered to be |'modified'|.
1352 There is no warning when the changes will be lost, for
1353 example when you quit Vim.
1354 both: A swap file is only created when using too much memory
1355 (when 'swapfile' has been reset there is never a swap
1356 file).
1357 nofile only: The buffer name is fixed, it is not handled like a
1358 file name. It is not modified in response to a |:cd|
1359 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001360 both: When using ":e bufname" and already editing "bufname"
1361 the buffer is made empty and autocommands are
1362 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001363 *E676*
1364 "acwrite" implies that the buffer name is not related to a file, like
1365 "nofile", but it will be written. Thus, in contrast to "nofile" and
1366 "nowrite", ":w" does work and a modified buffer can't be abandoned
1367 without saving. For writing there must be matching |BufWriteCmd|,
1368 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369
1370 *'casemap'* *'cmp'*
1371'casemap' 'cmp' string (default: "internal,keepascii")
1372 global
1373 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001374 {only available when compiled with the |+multi_byte|
1375 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001376 Specifies details about changing the case of letters. It may contain
1377 these words, separated by a comma:
1378 internal Use internal case mapping functions, the current
1379 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001380 matters when 'encoding' is a Unicode encoding,
1381 "latin1" or "iso-8859-15". When "internal" is
1382 omitted, the towupper() and towlower() system library
1383 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1385 case mapping, the current locale is not effective.
1386 This probably only matters for Turkish.
1387
1388 *'cdpath'* *'cd'* *E344* *E346*
1389'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1390 global
1391 {not in Vi}
1392 {not available when compiled without the
1393 |+file_in_path| feature}
1394 This is a list of directories which will be searched when using the
1395 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001396 for has a relative path, not an absolute part starting with "/", "./"
1397 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001398 The 'cdpath' option's value has the same form and semantics as
1399 |'path'|. Also see |file-searching|.
1400 The default value is taken from $CDPATH, with a "," prepended to look
1401 in the current directory first.
1402 If the default value taken from $CDPATH is not what you want, include
1403 a modified version of the following command in your vimrc file to
1404 override it: >
1405 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1406< This option cannot be set from a |modeline| or in the |sandbox|, for
1407 security reasons.
1408 (parts of 'cdpath' can be passed to the shell to expand file names).
1409
1410 *'cedit'*
1411'cedit' string (Vi default: "", Vim default: CTRL-F)
1412 global
1413 {not in Vi}
1414 {not available when compiled without the |+vertsplit|
1415 feature}
1416 The key used in Command-line Mode to open the command-line window.
1417 The default is CTRL-F when 'compatible' is off.
1418 Only non-printable keys are allowed.
1419 The key can be specified as a single character, but it is difficult to
1420 type. The preferred way is to use the <> notation. Examples: >
1421 :set cedit=<C-Y>
1422 :set cedit=<Esc>
1423< |Nvi| also has this option, but it only uses the first character.
1424 See |cmdwin|.
1425
1426 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1427'charconvert' 'ccv' string (default "")
1428 global
1429 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001430 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 {not in Vi}
1432 An expression that is used for character encoding conversion. It is
1433 evaluated when a file that is to be read or has been written has a
1434 different encoding from what is desired.
1435 'charconvert' is not used when the internal iconv() function is
1436 supported and is able to do the conversion. Using iconv() is
1437 preferred, because it is much faster.
1438 'charconvert' is not used when reading stdin |--|, because there is no
1439 file to convert from. You will have to save the text in a file first.
1440 The expression must return zero or an empty string for success,
1441 non-zero for failure.
1442 The possible encoding names encountered are in 'encoding'.
1443 Additionally, names given in 'fileencodings' and 'fileencoding' are
1444 used.
1445 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1446 is done internally by Vim, 'charconvert' is not used for this.
1447 'charconvert' is also used to convert the viminfo file, if the 'c'
1448 flag is present in 'viminfo'. Also used for Unicode conversion.
1449 Example: >
1450 set charconvert=CharConvert()
1451 fun CharConvert()
1452 system("recode "
1453 \ . v:charconvert_from . ".." . v:charconvert_to
1454 \ . " <" . v:fname_in . " >" v:fname_out)
1455 return v:shell_error
1456 endfun
1457< The related Vim variables are:
1458 v:charconvert_from name of the current encoding
1459 v:charconvert_to name of the desired encoding
1460 v:fname_in name of the input file
1461 v:fname_out name of the output file
1462 Note that v:fname_in and v:fname_out will never be the same.
1463 Note that v:charconvert_from and v:charconvert_to may be different
1464 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1465 Encryption is not done by Vim when using 'charconvert'. If you want
1466 to encrypt the file after conversion, 'charconvert' should take care
1467 of this.
1468 This option cannot be set from a |modeline| or in the |sandbox|, for
1469 security reasons.
1470
1471 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1472'cindent' 'cin' boolean (default off)
1473 local to buffer
1474 {not in Vi}
1475 {not available when compiled without the |+cindent|
1476 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001477 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 that trigger reindenting in insert mode and 'cinoptions' to set your
1479 preferred indent style.
1480 If 'indentexpr' is not empty, it overrules 'cindent'.
1481 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1482 the "=" operator indents using this algorithm rather than calling an
1483 external program.
1484 See |C-indenting|.
1485 When you don't like the way 'cindent' works, try the 'smartindent'
1486 option or 'indentexpr'.
1487 This option is not used when 'paste' is set.
1488 NOTE: This option is reset when 'compatible' is set.
1489
1490 *'cinkeys'* *'cink'*
1491'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1492 local to buffer
1493 {not in Vi}
1494 {not available when compiled without the |+cindent|
1495 feature}
1496 A list of keys that, when typed in Insert mode, cause reindenting of
1497 the current line. Only used if 'cindent' is on and 'indentexpr' is
1498 empty.
1499 For the format of this option see |cinkeys-format|.
1500 See |C-indenting|.
1501
1502 *'cinoptions'* *'cino'*
1503'cinoptions' 'cino' string (default "")
1504 local to buffer
1505 {not in Vi}
1506 {not available when compiled without the |+cindent|
1507 feature}
1508 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1509 program. See |cinoptions-values| for the values of this option, and
1510 |C-indenting| for info on C indenting in general.
1511
1512
1513 *'cinwords'* *'cinw'*
1514'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without both the
1518 |+cindent| and the |+smartindent| features}
1519 These keywords start an extra indent in the next line when
1520 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1521 an appropriate place (inside {}).
1522 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1523 matter, include the keyword both the uppercase and lowercase:
1524 "if,If,IF".
1525
1526 *'clipboard'* *'cb'*
1527'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1528 for X-windows, "" otherwise)
1529 global
1530 {not in Vi}
1531 {only in GUI versions or when the |+xterm_clipboard|
1532 feature is included}
1533 This option is a list of comma separated names.
1534 These names are recognized:
1535
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001536 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 unnamed When included, Vim will use the clipboard register '*'
1538 for all yank, delete, change and put operations which
1539 would normally go to the unnamed register. When a
1540 register is explicitly specified, it will always be
1541 used regardless of whether "unnamed" is in 'clipboard'
1542 or not. The clipboard register can always be
1543 explicitly accessed using the "* notation. Also see
1544 |gui-clipboard|.
1545
Bram Moolenaar30b65812012-07-12 22:01:11 +02001546 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001547 unnamedplus A variant of the "unnamed" flag which uses the
1548 clipboard register '+' (|quoteplus|) instead of
1549 register '*' for all yank, delete, change and put
1550 operations which would normally go to the unnamed
1551 register. When "unnamed" is also included to the
1552 option, yank operations (but not delete, change or
1553 put) will additionally copy the text into register
1554 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001555 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001556 Availability can be checked with: >
1557 if has('unnamedplus')
1558<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001559 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 autoselect Works like the 'a' flag in 'guioptions': If present,
1561 then whenever Visual mode is started, or the Visual
1562 area extended, Vim tries to become the owner of the
1563 windowing system's global selection or put the
1564 selected text on the clipboard used by the selection
1565 register "*. See |guioptions_a| and |quotestar| for
1566 details. When the GUI is active, the 'a' flag in
1567 'guioptions' is used, when the GUI is not active, this
1568 "autoselect" flag is used.
1569 Also applies to the modeless selection.
1570
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001571 *clipboard-autoselectplus*
1572 autoselectplus Like "autoselect" but using the + register instead of
1573 the * register. Compare to the 'P' flag in
1574 'guioptions'.
1575
1576 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 autoselectml Like "autoselect", but for the modeless selection
1578 only. Compare to the 'A' flag in 'guioptions'.
1579
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001580 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001581 html When the clipboard contains HTML, use this when
1582 pasting. When putting text on the clipboard, mark it
1583 as HTML. This works to copy rendered HTML from
1584 Firefox, paste it as raw HTML in Vim, select the HTML
1585 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001586 You probably want to add this only temporarily,
1587 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001588 Only supported for GTK version 2 and later.
1589 Only available with the |+multi_byte| feature.
1590
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001591 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 exclude:{pattern}
1593 Defines a pattern that is matched against the name of
1594 the terminal 'term'. If there is a match, no
1595 connection will be made to the X server. This is
1596 useful in this situation:
1597 - Running Vim in a console.
1598 - $DISPLAY is set to start applications on another
1599 display.
1600 - You do not want to connect to the X server in the
1601 console, but do want this in a terminal emulator.
1602 To never connect to the X server use: >
1603 exclude:.*
1604< This has the same effect as using the |-X| argument.
1605 Note that when there is no connection to the X server
1606 the window title won't be restored and the clipboard
1607 cannot be accessed.
1608 The value of 'magic' is ignored, {pattern} is
1609 interpreted as if 'magic' was on.
1610 The rest of the option value will be used for
1611 {pattern}, this must be the last entry.
1612
1613 *'cmdheight'* *'ch'*
1614'cmdheight' 'ch' number (default 1)
1615 global
1616 {not in Vi}
1617 Number of screen lines to use for the command-line. Helps avoiding
1618 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001619 The value of this option is stored with the tab page, so that each tab
1620 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621
1622 *'cmdwinheight'* *'cwh'*
1623'cmdwinheight' 'cwh' number (default 7)
1624 global
1625 {not in Vi}
1626 {not available when compiled without the |+vertsplit|
1627 feature}
1628 Number of screen lines to use for the command-line window. |cmdwin|
1629
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001630 *'colorcolumn'* *'cc'*
1631'colorcolumn' 'cc' string (default "")
1632 local to window
1633 {not in Vi}
1634 {not available when compiled without the |+syntax|
1635 feature}
1636 'colorcolumn' is a comma separated list of screen columns that are
1637 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1638 text. Will make screen redrawing slower.
1639 The screen column can be an absolute number, or a number preceded with
1640 '+' or '-', which is added to or subtracted from 'textwidth'. >
1641
1642 :set cc=+1 " highlight column after 'textwidth'
1643 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1644 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1645<
1646 When 'textwidth' is zero then the items with '-' and '+' are not used.
1647 A maximum of 256 columns are highlighted.
1648
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649 *'columns'* *'co'* *E594*
1650'columns' 'co' number (default 80 or terminal width)
1651 global
1652 {not in Vi}
1653 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001654 initialization and does not have to be set by hand. Also see
1655 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 When Vim is running in the GUI or in a resizable window, setting this
1657 option will cause the window size to be changed. When you only want
1658 to use the size for the GUI, put the command in your |gvimrc| file.
1659 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001660 number of columns of the display, the display may be messed up. For
1661 the GUI it is always possible and Vim limits the number of columns to
1662 what fits on the screen. You can use this command to get the widest
1663 window possible: >
1664 :set columns=9999
1665< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666
1667 *'comments'* *'com'* *E524* *E525*
1668'comments' 'com' string (default
1669 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1670 local to buffer
1671 {not in Vi}
1672 {not available when compiled without the |+comments|
1673 feature}
1674 A comma separated list of strings that can start a comment line. See
1675 |format-comments|. See |option-backslash| about using backslashes to
1676 insert a space.
1677
1678 *'commentstring'* *'cms'* *E537*
1679'commentstring' 'cms' string (default "/*%s*/")
1680 local to buffer
1681 {not in Vi}
1682 {not available when compiled without the |+folding|
1683 feature}
1684 A template for a comment. The "%s" in the value is replaced with the
1685 comment text. Currently only used to add markers for folding, see
1686 |fold-marker|.
1687
1688 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001689'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1690 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 global
1692 {not in Vi}
1693 This option has the effect of making Vim either more Vi-compatible, or
1694 make Vim behave in a more useful way.
1695 This is a special kind of option, because when it's set or reset,
1696 other options are also changed as a side effect. CAREFUL: Setting or
1697 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001698 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 set this option in your vimrc file, you should probably put it at the
1700 very start.
1701 By default this option is on and the Vi defaults are used for the
1702 options. This default was chosen for those people who want to use Vim
1703 just like Vi, and don't even (want to) know about the 'compatible'
1704 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001705 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001706 this option is switched off, and all options that have not been
1707 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001708 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001709 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001710 happen for the system-wide vimrc or gvimrc file, nor for a file given
1711 with the |-u| argument). Also see |compatible-default| and
1712 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 You can also set this option with the "-C" argument, and reset it with
1714 "-N". See |-C| and |-N|.
1715 Switching this option off makes the Vim defaults be used for options
1716 that have a different Vi and Vim default value. See the options
1717 marked with a '+' below. Other options are not modified.
1718 At the moment this option is set, several other options will be set
1719 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001720 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 editing.
1722 See also 'cpoptions'.
1723
1724 option + set value effect ~
1725
1726 'allowrevins' off no CTRL-_ command
1727 'backupcopy' Unix: "yes" backup file is a copy
1728 others: "auto" copy or rename backup file
1729 'backspace' "" normal backspace
1730 'backup' off no backup file
1731 'cindent' off no C code indentation
1732 'cedit' + "" no key to open the |cmdwin|
1733 'cpoptions' + (all flags) Vi-compatible flags
1734 'cscopetag' off don't use cscope for ":tag"
1735 'cscopetagorder' 0 see |cscopetagorder|
1736 'cscopeverbose' off see |cscopeverbose|
1737 'digraph' off no digraphs
1738 'esckeys' + off no <Esc>-keys in Insert mode
1739 'expandtab' off tabs not expanded to spaces
1740 'fileformats' + "" no automatic file format detection,
1741 "dos,unix" except for DOS, Windows and OS/2
1742 'formatoptions' + "vt" Vi compatible formatting
1743 'gdefault' off no default 'g' flag for ":s"
1744 'history' + 0 no commandline history
1745 'hkmap' off no Hebrew keyboard mapping
1746 'hkmapp' off no phonetic Hebrew keyboard mapping
1747 'hlsearch' off no highlighting of search matches
1748 'incsearch' off no incremental searching
1749 'indentexpr' "" no indenting by expression
1750 'insertmode' off do not start in Insert mode
1751 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1752 characters and '_'
1753 'joinspaces' on insert 2 spaces after period
1754 'modeline' + off no modelines
1755 'more' + off no pauses in listings
1756 'revins' off no reverse insert
1757 'ruler' off no ruler
1758 'scrolljump' 1 no jump scroll
1759 'scrolloff' 0 no scroll offset
1760 'shiftround' off indent not rounded to shiftwidth
1761 'shortmess' + "" no shortening of messages
1762 'showcmd' + off command characters not shown
1763 'showmode' + off current mode not shown
1764 'smartcase' off no automatic ignore case switch
1765 'smartindent' off no smart indentation
1766 'smarttab' off no smart tab size
1767 'softtabstop' 0 tabs are always 'tabstop' positions
1768 'startofline' on goto startofline with some commands
1769 'tagrelative' + off tag file names are not relative
1770 'textauto' + off no automatic textmode detection
1771 'textwidth' 0 no automatic line wrap
1772 'tildeop' off tilde is not an operator
1773 'ttimeout' off no terminal timeout
1774 'whichwrap' + "" left-right movements don't wrap
1775 'wildchar' + CTRL-E only when the current value is <Tab>
1776 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001777 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
1779 *'complete'* *'cpt'* *E535*
1780'complete' 'cpt' string (default: ".,w,b,u,t,i")
1781 local to buffer
1782 {not in Vi}
1783 This option specifies how keyword completion |ins-completion| works
1784 when CTRL-P or CTRL-N are used. It is also used for whole-line
1785 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1786 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001787 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 w scan buffers from other windows
1789 b scan other loaded buffers that are in the buffer list
1790 u scan the unloaded buffers that are in the buffer list
1791 U scan the buffers that are not in the buffer list
1792 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001793 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 k{dict} scan the file {dict}. Several "k" flags can be given,
1795 patterns are valid too. For example: >
1796 :set cpt=k/usr/dict/*,k~/spanish
1797< s scan the files given with the 'thesaurus' option
1798 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1799 are valid too.
1800 i scan current and included files
1801 d scan current and included files for defined name or macro
1802 |i_CTRL-X_CTRL-D|
1803 ] tag completion
1804 t same as "]"
1805
1806 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1807 not executed, this may lead to unexpected completions from some files
1808 (gzipped files for example). Unloaded buffers are not scanned for
1809 whole-line completion.
1810
1811 The default is ".,w,b,u,t,i", which means to scan:
1812 1. the current buffer
1813 2. buffers in other windows
1814 3. other loaded buffers
1815 4. unloaded buffers
1816 5. tags
1817 6. included files
1818
1819 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001820 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1821 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001823 *'completefunc'* *'cfu'*
1824'completefunc' 'cfu' string (default: empty)
1825 local to buffer
1826 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001827 {not available when compiled without the |+eval|
1828 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001829 This option specifies a function to be used for Insert mode completion
1830 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001831 See |complete-functions| for an explanation of how the function is
1832 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001833 This option cannot be set from a |modeline| or in the |sandbox|, for
1834 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001835
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001836 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001837'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001838 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001839 {not available when compiled without the
1840 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001841 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001842 A comma separated list of options for Insert mode completion
1843 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001844
1845 menu Use a popup menu to show the possible completions. The
1846 menu is only shown when there is more than one match and
1847 sufficient colors are available. |ins-completion-menu|
1848
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001849 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001850 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001851 match, e.g., what file it comes from.
1852
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001853 longest Only insert the longest common text of the matches. If
1854 the menu is displayed you can use CTRL-L to add more
1855 characters. Whether case is ignored depends on the kind
1856 of completion. For buffer text the 'ignorecase' option is
1857 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001858
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001859 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001860 completion in the preview window. Only works in
1861 combination with "menu" or "menuone".
1862
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001863 noinsert Do not insert any text for a match until the user selects
1864 a match from the menu. Only works in combination with
1865 "menu" or "menuone". No effect if "longest" is present.
1866
1867 noselect Do not select a match in the menu, force the user to
1868 select one from the menu. Only works in combination with
1869 "menu" or "menuone".
1870
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001871
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001872 *'concealcursor'* *'cocu'*
1873'concealcursor' 'cocu' string (default: "")
1874 local to window
1875 {not in Vi}
1876 {not available when compiled without the |+conceal|
1877 feature}
1878 Sets the modes in which text in the cursor line can also be concealed.
1879 When the current mode is listed then concealing happens just like in
1880 other lines.
1881 n Normal mode
1882 v Visual mode
1883 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001884 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001885
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001886 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001887 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001888 are moving around text is concealed, but when starting to insert text
1889 or selecting a Visual area the concealed text is displayed, so that
1890 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001891 Keep in mind that the cursor position is not always where it's
1892 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001893
1894
1895'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001896 number (default 0)
1897 local to window
1898 {not in Vi}
1899 {not available when compiled without the |+conceal|
1900 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001901 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1902 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001903
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001904 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001905 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001906 1 Each block of concealed text is replaced with one
1907 character. If the syntax item does not have a custom
1908 replacement character defined (see |:syn-cchar|) the
1909 character defined in 'listchars' is used (default is a
1910 space).
1911 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001912 2 Concealed text is completely hidden unless it has a
1913 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001914 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001915 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001916
Bram Moolenaara7781e02010-07-19 20:13:22 +02001917 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001918 edit and copy the text. This can be changed with the 'concealcursor'
1919 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001920
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1922'confirm' 'cf' boolean (default off)
1923 global
1924 {not in Vi}
1925 When 'confirm' is on, certain operations that would normally
1926 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1927 instead raise a |dialog| asking if you wish to save the current
1928 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1929 If 'confirm' is off you can still activate confirmation for one
1930 command only (this is most useful in mappings) with the |:confirm|
1931 command.
1932 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1933
1934 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1935'conskey' 'consk' boolean (default off)
1936 global
1937 {not in Vi} {only for MS-DOS}
1938 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001939 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 three methods of console input are available:
1941 'conskey' 'bioskey' action ~
1942 on on or off direct console input
1943 off on BIOS
1944 off off STDIN
1945
1946 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1947'copyindent' 'ci' boolean (default off)
1948 local to buffer
1949 {not in Vi}
1950 Copy the structure of the existing lines indent when autoindenting a
1951 new line. Normally the new indent is reconstructed by a series of
1952 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1953 in which case only spaces are used). Enabling this option makes the
1954 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001955 existing line. 'expandtab' has no effect on these characters, a Tab
1956 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 line, the remaining space is filled in the normal manner.
1958 NOTE: 'copyindent' is reset when 'compatible' is set.
1959 Also see 'preserveindent'.
1960
1961 *'cpoptions'* *'cpo'*
1962'cpoptions' 'cpo' string (Vim default: "aABceFs",
1963 Vi default: all flags)
1964 global
1965 {not in Vi}
1966 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001967 this indicates Vi-compatible behavior. This is used for things where
1968 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969 'cpoptions' stands for "compatible-options".
1970 Commas can be added for readability.
1971 To avoid problems with flags that are added in the future, use the
1972 "+=" and "-=" feature of ":set" |add-option-flags|.
1973 NOTE: This option is set to the Vi default value when 'compatible' is
1974 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001975 NOTE: This option is set to the POSIX default value at startup when
1976 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001977 variable exists |posix|. This means Vim tries to behave like the
1978 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979
1980 contains behavior ~
1981 *cpo-a*
1982 a When included, a ":read" command with a file name
1983 argument will set the alternate file name for the
1984 current window.
1985 *cpo-A*
1986 A When included, a ":write" command with a file name
1987 argument will set the alternate file name for the
1988 current window.
1989 *cpo-b*
1990 b "\|" in a ":map" command is recognized as the end of
1991 the map command. The '\' is included in the mapping,
1992 the text after the '|' is interpreted as the next
1993 command. Use a CTRL-V instead of a backslash to
1994 include the '|' in the mapping. Applies to all
1995 mapping, abbreviation, menu and autocmd commands.
1996 See also |map_bar|.
1997 *cpo-B*
1998 B A backslash has no special meaning in mappings,
1999 abbreviations and the "to" part of the menu commands.
2000 Remove this flag to be able to use a backslash like a
2001 CTRL-V. For example, the command ":map X \<Esc>"
2002 results in X being mapped to:
2003 'B' included: "\^[" (^[ is a real <Esc>)
2004 'B' excluded: "<Esc>" (5 characters)
2005 ('<' excluded in both cases)
2006 *cpo-c*
2007 c Searching continues at the end of any match at the
2008 cursor position, but not further than the start of the
2009 next line. When not present searching continues
2010 one character from the cursor position. With 'c'
2011 "abababababab" only gets three matches when repeating
2012 "/abab", without 'c' there are five matches.
2013 *cpo-C*
2014 C Do not concatenate sourced lines that start with a
2015 backslash. See |line-continuation|.
2016 *cpo-d*
2017 d Using "./" in the 'tags' option doesn't mean to use
2018 the tags file relative to the current file, but the
2019 tags file in the current directory.
2020 *cpo-D*
2021 D Can't use CTRL-K to enter a digraph after Normal mode
2022 commands with a character argument, like |r|, |f| and
2023 |t|.
2024 *cpo-e*
2025 e When executing a register with ":@r", always add a
2026 <CR> to the last line, also when the register is not
2027 linewise. If this flag is not present, the register
2028 is not linewise and the last line does not end in a
2029 <CR>, then the last line is put on the command-line
2030 and can be edited before hitting <CR>.
2031 *cpo-E*
2032 E It is an error when using "y", "d", "c", "g~", "gu" or
2033 "gU" on an Empty region. The operators only work when
2034 at least one character is to be operate on. Example:
2035 This makes "y0" fail in the first column.
2036 *cpo-f*
2037 f When included, a ":read" command with a file name
2038 argument will set the file name for the current buffer,
2039 if the current buffer doesn't have a file name yet.
2040 *cpo-F*
2041 F When included, a ":write" command with a file name
2042 argument will set the file name for the current
2043 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002044 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 *cpo-g*
2046 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002047 *cpo-H*
2048 H When using "I" on a line with only blanks, insert
2049 before the last blank. Without this flag insert after
2050 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 *cpo-i*
2052 i When included, interrupting the reading of a file will
2053 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002054 *cpo-I*
2055 I When moving the cursor up or down just after inserting
2056 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 *cpo-j*
2058 j When joining lines, only add two spaces after a '.',
2059 not after '!' or '?'. Also see 'joinspaces'.
2060 *cpo-J*
2061 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002062 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 white space.
2064 *cpo-k*
2065 k Disable the recognition of raw key codes in
2066 mappings, abbreviations, and the "to" part of menu
2067 commands. For example, if <Key> sends ^[OA (where ^[
2068 is <Esc>), the command ":map X ^[OA" results in X
2069 being mapped to:
2070 'k' included: "^[OA" (3 characters)
2071 'k' excluded: "<Key>" (one key code)
2072 Also see the '<' flag below.
2073 *cpo-K*
2074 K Don't wait for a key code to complete when it is
2075 halfway a mapping. This breaks mapping <F1><F1> when
2076 only part of the second <F1> has been read. It
2077 enables cancelling the mapping by typing <F1><Esc>.
2078 *cpo-l*
2079 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002080 literally, only "\]", "\^", "\-" and "\\" are special.
2081 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2083 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002084 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 *cpo-L*
2086 L When the 'list' option is set, 'wrapmargin',
2087 'textwidth', 'softtabstop' and Virtual Replace mode
2088 (see |gR|) count a <Tab> as two characters, instead of
2089 the normal behavior of a <Tab>.
2090 *cpo-m*
2091 m When included, a showmatch will always wait half a
2092 second. When not included, a showmatch will wait half
2093 a second or until a character is typed. |'showmatch'|
2094 *cpo-M*
2095 M When excluded, "%" matching will take backslashes into
2096 account. Thus in "( \( )" and "\( ( \)" the outer
2097 parenthesis match. When included "%" ignores
2098 backslashes, which is Vi compatible.
2099 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002100 n When included, the column used for 'number' and
2101 'relativenumber' will also be used for text of wrapped
2102 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 *cpo-o*
2104 o Line offset to search command is not remembered for
2105 next search.
2106 *cpo-O*
2107 O Don't complain if a file is being overwritten, even
2108 when it didn't exist when editing it. This is a
2109 protection against a file unexpectedly created by
2110 someone else. Vi didn't complain about this.
2111 *cpo-p*
2112 p Vi compatible Lisp indenting. When not present, a
2113 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002114 *cpo-P*
2115 P When included, a ":write" command that appends to a
2116 file will set the file name for the current buffer, if
2117 the current buffer doesn't have a file name yet and
2118 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002119 *cpo-q*
2120 q When joining multiple lines leave the cursor at the
2121 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-r*
2123 r Redo ("." command) uses "/" to repeat a search
2124 command, instead of the actually used search string.
2125 *cpo-R*
2126 R Remove marks from filtered lines. Without this flag
2127 marks are kept like |:keepmarks| was used.
2128 *cpo-s*
2129 s Set buffer options when entering the buffer for the
2130 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002131 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 set when the buffer is created.
2133 *cpo-S*
2134 S Set buffer options always when entering a buffer
2135 (except 'readonly', 'fileformat', 'filetype' and
2136 'syntax'). This is the (most) Vi compatible setting.
2137 The options are set to the values in the current
2138 buffer. When you change an option and go to another
2139 buffer, the value is copied. Effectively makes the
2140 buffer options global to all buffers.
2141
2142 's' 'S' copy buffer options
2143 no no when buffer created
2144 yes no when buffer first entered (default)
2145 X yes each time when buffer entered (vi comp.)
2146 *cpo-t*
2147 t Search pattern for the tag command is remembered for
2148 "n" command. Otherwise Vim only puts the pattern in
2149 the history for search pattern, but doesn't change the
2150 last used search pattern.
2151 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002152 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 *cpo-v*
2154 v Backspaced characters remain visible on the screen in
2155 Insert mode. Without this flag the characters are
2156 erased from the screen right away. With this flag the
2157 screen newly typed text overwrites backspaced
2158 characters.
2159 *cpo-w*
2160 w When using "cw" on a blank character, only change one
2161 character and not all blanks until the start of the
2162 next word.
2163 *cpo-W*
2164 W Don't overwrite a readonly file. When omitted, ":w!"
2165 overwrites a readonly file, if possible.
2166 *cpo-x*
2167 x <Esc> on the command-line executes the command-line.
2168 The default in Vim is to abandon the command-line,
2169 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002170 *cpo-X*
2171 X When using a count with "R" the replaced text is
2172 deleted only once. Also when repeating "R" with "."
2173 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 *cpo-y*
2175 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002176 *cpo-Z*
2177 Z When using "w!" while the 'readonly' option is set,
2178 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 *cpo-!*
2180 ! When redoing a filter command, use the last used
2181 external command, whatever it was. Otherwise the last
2182 used -filter- command is used.
2183 *cpo-$*
2184 $ When making a change to one line, don't redisplay the
2185 line, but put a '$' at the end of the changed text.
2186 The changed text will be overwritten when you type the
2187 new text. The line is redisplayed if you type any
2188 command that moves the cursor from the insertion
2189 point.
2190 *cpo-%*
2191 % Vi-compatible matching is done for the "%" command.
2192 Does not recognize "#if", "#endif", etc.
2193 Does not recognize "/*" and "*/".
2194 Parens inside single and double quotes are also
2195 counted, causing a string that contains a paren to
2196 disturb the matching. For example, in a line like
2197 "if (strcmp("foo(", s))" the first paren does not
2198 match the last one. When this flag is not included,
2199 parens inside single and double quotes are treated
2200 specially. When matching a paren outside of quotes,
2201 everything inside quotes is ignored. When matching a
2202 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002203 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002204 This flag is also used for other features, such as
2205 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002206 *cpo--*
2207 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002208 it would go above the first line or below the last
2209 line. Without it the cursor moves to the first or
2210 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002211 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002212 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002213 *cpo-+*
2214 + When included, a ":write file" command will reset the
2215 'modified' flag of the buffer, even though the buffer
2216 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002217 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 * Use ":*" in the same way as ":@". When not included,
2219 ":*" is an alias for ":'<,'>", select the Visual area.
2220 *cpo-<*
2221 < Disable the recognition of special key codes in |<>|
2222 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002223 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 ":map X <Tab>" results in X being mapped to:
2225 '<' included: "<Tab>" (5 characters)
2226 '<' excluded: "^I" (^I is a real <Tab>)
2227 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002228 *cpo->*
2229 > When appending to a register, put a line break before
2230 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002231 *cpo-;*
2232 ; When using |,| or |;| to repeat the last |t| search
2233 and the cursor is right in front of the searched
2234 character, the cursor won't move. When not included,
2235 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002236 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002237
2238 POSIX flags. These are not included in the Vi default value, except
2239 when $VIM_POSIX was set on startup. |posix|
2240
2241 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002242 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002243 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002244 *cpo-&*
2245 & When ":preserve" was used keep the swap file when
2246 exiting normally while this buffer is still loaded.
2247 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002248 *cpo-\*
2249 \ Backslash in a [] range in a search pattern is taken
2250 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002251 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2252 '\' excluded: "/[ \-]" finds <Space> and '-'
2253 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002254 *cpo-/*
2255 / When "%" is used as the replacement string in a |:s|
2256 command, use the previous replacement string. |:s%|
2257 *cpo-{*
2258 { The |{| and |}| commands also stop at a "{" character
2259 at the start of a line.
2260 *cpo-.*
2261 . The ":chdir" and ":cd" commands fail if the current
2262 buffer is modified, unless ! is used. Vim doesn't
2263 need this, since it remembers the full path of an
2264 opened file.
2265 *cpo-bar*
2266 | The value of the $LINES and $COLUMNS environment
2267 variables overrule the terminal size values obtained
2268 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002269
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002271 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002272'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002273 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002274 {not in Vi}
2275 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002276 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002277 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002278 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002279 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002280 blowfish Blowfish method. Medium strong encryption but it has
2281 an implementation flaw. Requires Vim 7.3 or later,
2282 files can NOT be read by Vim 7.2 and older. This adds
2283 a "seed" to the file, every time you write the file
2284 the encrypted bytes will be different.
2285 *blowfish2*
2286 blowfish2 Blowfish method. Medium strong encryption. Requires
2287 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2288 and older. This adds a "seed" to the file, every time
2289 you write the file the encrypted bytes will be
2290 different. The whole undo file is encrypted, not just
2291 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002292
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002293 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002294 to the detected method of the file being read. Thus if you write it
2295 without changing 'cryptmethod' the same method will be used.
2296 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002297 explicitly write it, you don't get a warning unless there are other
2298 modifications. Also see |:X|.
2299
2300 When setting the global value to an empty string, it will end up with
2301 the value "zip". When setting the local value to an empty string the
2302 buffer will use the global value.
2303
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002304 When a new encryption method is added in a later version of Vim, and
2305 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002306 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002307
2308
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 *'cscopepathcomp'* *'cspc'*
2310'cscopepathcomp' 'cspc' number (default 0)
2311 global
2312 {not available when compiled without the |+cscope|
2313 feature}
2314 {not in Vi}
2315 Determines how many components of the path to show in a list of tags.
2316 See |cscopepathcomp|.
2317
2318 *'cscopeprg'* *'csprg'*
2319'cscopeprg' 'csprg' string (default "cscope")
2320 global
2321 {not available when compiled without the |+cscope|
2322 feature}
2323 {not in Vi}
2324 Specifies the command to execute cscope. See |cscopeprg|.
2325 This option cannot be set from a |modeline| or in the |sandbox|, for
2326 security reasons.
2327
2328 *'cscopequickfix'* *'csqf'*
2329'cscopequickfix' 'csqf' string (default "")
2330 global
2331 {not available when compiled without the |+cscope|
2332 or |+quickfix| features}
2333 {not in Vi}
2334 Specifies whether to use quickfix window to show cscope results.
2335 See |cscopequickfix|.
2336
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002337 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002338'cscoperelative' 'csre' boolean (default off)
2339 global
2340 {not available when compiled without the |+cscope|
2341 feature}
2342 {not in Vi}
2343 In the absence of a prefix (-P) for cscope. setting this option enables
2344 to use the basename of cscope.out path as the prefix.
2345 See |cscoperelative|.
2346
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2348'cscopetag' 'cst' boolean (default off)
2349 global
2350 {not available when compiled without the |+cscope|
2351 feature}
2352 {not in Vi}
2353 Use cscope for tag commands. See |cscope-options|.
2354 NOTE: This option is reset when 'compatible' is set.
2355
2356 *'cscopetagorder'* *'csto'*
2357'cscopetagorder' 'csto' number (default 0)
2358 global
2359 {not available when compiled without the |+cscope|
2360 feature}
2361 {not in Vi}
2362 Determines the order in which ":cstag" performs a search. See
2363 |cscopetagorder|.
2364 NOTE: This option is set to 0 when 'compatible' is set.
2365
2366 *'cscopeverbose'* *'csverb'*
2367 *'nocscopeverbose'* *'nocsverb'*
2368'cscopeverbose' 'csverb' boolean (default off)
2369 global
2370 {not available when compiled without the |+cscope|
2371 feature}
2372 {not in Vi}
2373 Give messages when adding a cscope database. See |cscopeverbose|.
2374 NOTE: This option is reset when 'compatible' is set.
2375
Bram Moolenaar860cae12010-06-05 23:22:07 +02002376 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2377'cursorbind' 'crb' boolean (default off)
2378 local to window
2379 {not in Vi}
2380 {not available when compiled without the |+cursorbind|
2381 feature}
2382 When this option is set, as the cursor in the current
2383 window moves other cursorbound windows (windows that also have
2384 this option set) move their cursors to the corresponding line and
2385 column. This option is useful for viewing the
2386 differences between two versions of a file (see 'diff'); in diff mode,
2387 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002388 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002389
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002390
2391 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2392'cursorcolumn' 'cuc' boolean (default off)
2393 local to window
2394 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002395 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002396 feature}
2397 Highlight the screen column of the cursor with CursorColumn
2398 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2399 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002400 If you only want the highlighting in the current window you can use
2401 these autocommands: >
2402 au WinLeave * set nocursorline nocursorcolumn
2403 au WinEnter * set cursorline cursorcolumn
2404<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002405
2406 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2407'cursorline' 'cul' boolean (default off)
2408 local to window
2409 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002410 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002411 feature}
2412 Highlight the screen line of the cursor with CursorLine
2413 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2414 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002415 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002416 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002417
2418
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 *'debug'*
2420'debug' string (default "")
2421 global
2422 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002423 These values can be used:
2424 msg Error messages that would otherwise be omitted will be given
2425 anyway.
2426 throw Error messages that would otherwise be omitted will be given
2427 anyway and also throw an exception and set |v:errmsg|.
2428 beep A message will be given when otherwise only a beep would be
2429 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002430 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002431 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2432 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433
2434 *'define'* *'def'*
2435'define' 'def' string (default "^\s*#\s*define")
2436 global or local to buffer |global-local|
2437 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002438 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 pattern, just like for the "/" command. This option is used for the
2440 commands like "[i" and "[d" |include-search|. The 'isident' option is
2441 used to recognize the defined name after the match:
2442 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2443 See |option-backslash| about inserting backslashes to include a space
2444 or backslash.
2445 The default value is for C programs. For C++ this value would be
2446 useful, to include const type declarations: >
2447 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2448< When using the ":set" command, you need to double the backslashes!
2449
2450 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2451'delcombine' 'deco' boolean (default off)
2452 global
2453 {not in Vi}
2454 {only available when compiled with the |+multi_byte|
2455 feature}
2456 If editing Unicode and this option is set, backspace and Normal mode
2457 "x" delete each combining character on its own. When it is off (the
2458 default) the character along with its combining characters are
2459 deleted.
2460 Note: When 'delcombine' is set "xx" may work different from "2x"!
2461
2462 This is useful for Arabic, Hebrew and many other languages where one
2463 may have combining characters overtop of base characters, and want
2464 to remove only the combining ones.
2465
2466 *'dictionary'* *'dict'*
2467'dictionary' 'dict' string (default "")
2468 global or local to buffer |global-local|
2469 {not in Vi}
2470 List of file names, separated by commas, that are used to lookup words
2471 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2472 contain a list of words. This can be one word per line, or several
2473 words per line, separated by non-keyword characters (white space is
2474 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002475 When this option is empty, or an entry "spell" is present, spell
2476 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002477 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 after a comma are ignored, otherwise spaces are included in the file
2479 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002480 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 Where to find a list of words?
2482 - On FreeBSD, there is the file "/usr/share/dict/words".
2483 - In the Simtel archive, look in the "msdos/linguist" directory.
2484 - In "miscfiles" of the GNU collection.
2485 The use of |:set+=| and |:set-=| is preferred when adding or removing
2486 directories from the list. This avoids problems when a future version
2487 uses another default.
2488 Backticks cannot be used in this option for security reasons.
2489
2490 *'diff'* *'nodiff'*
2491'diff' boolean (default off)
2492 local to window
2493 {not in Vi}
2494 {not available when compiled without the |+diff|
2495 feature}
2496 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002497 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498
2499 *'dex'* *'diffexpr'*
2500'diffexpr' 'dex' string (default "")
2501 global
2502 {not in Vi}
2503 {not available when compiled without the |+diff|
2504 feature}
2505 Expression which is evaluated to obtain an ed-style diff file from two
2506 versions of a file. See |diff-diffexpr|.
2507 This option cannot be set from a |modeline| or in the |sandbox|, for
2508 security reasons.
2509
2510 *'dip'* *'diffopt'*
2511'diffopt' 'dip' string (default "filler")
2512 global
2513 {not in Vi}
2514 {not available when compiled without the |+diff|
2515 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002516 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 All are optional. Items must be separated by a comma.
2518
2519 filler Show filler lines, to keep the text
2520 synchronized with a window that has inserted
2521 lines at the same position. Mostly useful
2522 when windows are side-by-side and 'scrollbind'
2523 is set.
2524
2525 context:{n} Use a context of {n} lines between a change
2526 and a fold that contains unchanged lines.
2527 When omitted a context of six lines is used.
2528 See |fold-diff|.
2529
2530 icase Ignore changes in case of text. "a" and "A"
2531 are considered the same. Adds the "-i" flag
2532 to the "diff" command if 'diffexpr' is empty.
2533
2534 iwhite Ignore changes in amount of white space. Adds
2535 the "-b" flag to the "diff" command if
2536 'diffexpr' is empty. Check the documentation
2537 of the "diff" command for what this does
2538 exactly. It should ignore adding trailing
2539 white space, but not leading white space.
2540
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002541 horizontal Start diff mode with horizontal splits (unless
2542 explicitly specified otherwise).
2543
2544 vertical Start diff mode with vertical splits (unless
2545 explicitly specified otherwise).
2546
2547 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2548 starting diff mode. Without this 2 is used.
2549
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 Examples: >
2551
2552 :set diffopt=filler,context:4
2553 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002554 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555<
2556 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2557'digraph' 'dg' boolean (default off)
2558 global
2559 {not in Vi}
2560 {not available when compiled without the |+digraphs|
2561 feature}
2562 Enable the entering of digraphs in Insert mode with {char1} <BS>
2563 {char2}. See |digraphs|.
2564 NOTE: This option is reset when 'compatible' is set.
2565
2566 *'directory'* *'dir'*
2567'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002568 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 for Unix: ".,~/tmp,/var/tmp,/tmp")
2570 global
2571 List of directory names for the swap file, separated with commas.
2572 - The swap file will be created in the first directory where this is
2573 possible.
2574 - Empty means that no swap file will be used (recovery is
2575 impossible!).
2576 - A directory "." means to put the swap file in the same directory as
2577 the edited file. On Unix, a dot is prepended to the file name, so
2578 it doesn't show in a directory listing. On MS-Windows the "hidden"
2579 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002580 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 put the swap file relative to where the edited file is. The leading
2582 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002583 - For Unix and Win32, if a directory ends in two path separators "//"
2584 or "\\", the swap file name will be built from the complete path to
2585 the file with all path separators substituted to percent '%' signs.
2586 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002587 On Win32, when a separating comma is following, you must use "//",
2588 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 - Spaces after the comma are ignored, other spaces are considered part
2590 of the directory name. To have a space at the start of a directory
2591 name, precede it with a backslash.
2592 - To include a comma in a directory name precede it with a backslash.
2593 - A directory name may end in an ':' or '/'.
2594 - Environment variables are expanded |:set_env|.
2595 - Careful with '\' characters, type one before a space, type two to
2596 get one in the option (see |option-backslash|), for example: >
2597 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2598< - For backwards compatibility with Vim version 3.0 a '>' at the start
2599 of the option is removed.
2600 Using "." first in the list is recommended. This means that editing
2601 the same file twice will result in a warning. Using "/tmp" on Unix is
2602 discouraged: When the system crashes you lose the swap file.
2603 "/var/tmp" is often not cleared when rebooting, thus is a better
2604 choice than "/tmp". But it can contain a lot of files, your swap
2605 files get lost in the crowd. That is why a "tmp" directory in your
2606 home directory is tried first.
2607 The use of |:set+=| and |:set-=| is preferred when adding or removing
2608 directories from the list. This avoids problems when a future version
2609 uses another default.
2610 This option cannot be set from a |modeline| or in the |sandbox|, for
2611 security reasons.
2612 {Vi: directory to put temp file in, defaults to "/tmp"}
2613
2614 *'display'* *'dy'*
2615'display' 'dy' string (default "")
2616 global
2617 {not in Vi}
2618 Change the way text is displayed. This is comma separated list of
2619 flags:
2620 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 last line that doesn't fit is replaced with "@" lines.
2623 uhex Show unprintable characters hexadecimal as <xx>
2624 instead of using ^C and ~C.
2625
2626 *'eadirection'* *'ead'*
2627'eadirection' 'ead' string (default "both")
2628 global
2629 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002630 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 feature}
2632 Tells when the 'equalalways' option applies:
2633 ver vertically, width of windows is not affected
2634 hor horizontally, height of windows is not affected
2635 both width and height of windows is affected
2636
2637 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2638'edcompatible' 'ed' boolean (default off)
2639 global
2640 Makes the 'g' and 'c' flags of the ":substitute" command to be
2641 toggled each time the flag is given. See |complex-change|. See
2642 also 'gdefault' option.
2643 Switching this option on is discouraged!
2644
2645 *'encoding'* *'enc'* *E543*
2646'encoding' 'enc' string (default: "latin1" or value from $LANG)
2647 global
2648 {only available when compiled with the |+multi_byte|
2649 feature}
2650 {not in Vi}
2651 Sets the character encoding used inside Vim. It applies to text in
2652 the buffers, registers, Strings in expressions, text stored in the
2653 viminfo file, etc. It sets the kind of characters which Vim can work
2654 with. See |encoding-names| for the possible values.
2655
2656 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002657 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002659 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660
Bram Moolenaar865242e2010-07-14 21:12:05 +02002661 This option cannot be set from a |modeline|. It would most likely
2662 corrupt the text.
2663
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2665 "utf-8". Although care has been taken to allow different values of
2666 'encoding', "utf-8" is the natural choice for the environment and
2667 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002668 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 versions, and to avoid changing the encoding of newly created files
2670 without your knowledge (in case 'fileencodings' is empty).
2671
2672 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002673 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 iconv() or as specified with 'charconvert'.
2675
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002676 If you need to know whether 'encoding' is a multi-byte encoding, you
2677 can use: >
2678 if has("multi_byte_encoding")
2679<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 Normally 'encoding' will be equal to your current locale. This will
2681 be the default if Vim recognizes your environment settings. If
2682 'encoding' is not set to the current locale, 'termencoding' must be
2683 set to convert typed and displayed text. See |encoding-table|.
2684
2685 When you set this option, it fires the |EncodingChanged| autocommand
2686 event so that you can set up fonts if necessary.
2687
2688 When the option is set, the value is converted to lowercase. Thus
2689 you can set it with uppercase values too. Underscores are translated
2690 to '-' signs.
2691 When the encoding is recognized, it is changed to the standard name.
2692 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2693 "iso-8859-2" and "utf8" becomes "utf-8".
2694
2695 Note: "latin1" is also used when the encoding could not be detected.
2696 This only works when editing files in the same encoding! When the
2697 actual character set is not latin1, make sure 'fileencoding' and
2698 'fileencodings' are empty. When conversion is needed, switch to using
2699 utf-8.
2700
2701 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2702 You don't notice this while editing, but it does matter for the
2703 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2704 setting 'encoding' to one of these values instead of utf-8 only has
2705 effect for encoding used for files when 'fileencoding' is empty.
2706
Bram Moolenaar661b1822005-07-28 22:36:45 +00002707 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2708 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709
2710 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2711'endofline' 'eol' boolean (default on)
2712 local to buffer
2713 {not in Vi}
2714 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002715 is on, or 'fixeol' option is off, no <EOL> will be written for the
2716 last line in the file. This option is automatically set or reset when
2717 starting to edit a new file, depending on whether file has an <EOL>
2718 for the last line in the file. Normally you don't have to set or
2719 reset this option.
2720 When 'binary' is off and 'fixeol' is on the value is not used when
2721 writing the file. When 'binary' is on or 'fixeol' is off it is used
2722 to remember the presence of a <EOL> for the last line in the file, so
2723 that when you write the file the situation from the original file can
2724 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725
2726 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2727'equalalways' 'ea' boolean (default on)
2728 global
2729 {not in Vi}
2730 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002731 splitting or closing a window. This also happens the moment the
2732 option is switched on. When off, splitting a window will reduce the
2733 size of the current window and leave the other windows the same. When
2734 closing a window the extra lines are given to the window next to it
2735 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 When mixing vertically and horizontally split windows, a minimal size
2737 is computed and some windows may be larger if there is room. The
2738 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002739 Changing the height and width of a window can be avoided by setting
2740 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002741 If a window size is specified when creating a new window sizes are
2742 currently not equalized (it's complicated, but may be implemented in
2743 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744
2745 *'equalprg'* *'ep'*
2746'equalprg' 'ep' string (default "")
2747 global or local to buffer |global-local|
2748 {not in Vi}
2749 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002750 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002751 or 'indentexpr'. When Vim was compiled without internal formatting,
2752 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002753 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 about including spaces and backslashes.
2755 This option cannot be set from a |modeline| or in the |sandbox|, for
2756 security reasons.
2757
2758 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2759'errorbells' 'eb' boolean (default off)
2760 global
2761 Ring the bell (beep or screen flash) for error messages. This only
2762 makes a difference for error messages, the bell will be used always
2763 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002764 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002765 screen flash or do nothing. See 'belloff' to finetune when to ring the
2766 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767
2768 *'errorfile'* *'ef'*
2769'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2770 others: "errors.err")
2771 global
2772 {not in Vi}
2773 {not available when compiled without the |+quickfix|
2774 feature}
2775 Name of the errorfile for the QuickFix mode (see |:cf|).
2776 When the "-q" command-line argument is used, 'errorfile' is set to the
2777 following argument. See |-q|.
2778 NOT used for the ":make" command. See 'makeef' for that.
2779 Environment variables are expanded |:set_env|.
2780 See |option-backslash| about including spaces and backslashes.
2781 This option cannot be set from a |modeline| or in the |sandbox|, for
2782 security reasons.
2783
2784 *'errorformat'* *'efm'*
2785'errorformat' 'efm' string (default is very long)
2786 global or local to buffer |global-local|
2787 {not in Vi}
2788 {not available when compiled without the |+quickfix|
2789 feature}
2790 Scanf-like description of the format for the lines in the error file
2791 (see |errorformat|).
2792
2793 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2794'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2795 global
2796 {not in Vi}
2797 Function keys that start with an <Esc> are recognized in Insert
2798 mode. When this option is off, the cursor and function keys cannot be
2799 used in Insert mode if they start with an <Esc>. The advantage of
2800 this is that the single <Esc> is recognized immediately, instead of
2801 after one second. Instead of resetting this option, you might want to
2802 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2803 when 'esckeys' is off, you can still map anything, but the cursor keys
2804 won't work by default.
2805 NOTE: This option is set to the Vi default value when 'compatible' is
2806 set and to the Vim default value when 'compatible' is reset.
2807
2808 *'eventignore'* *'ei'*
2809'eventignore' 'ei' string (default "")
2810 global
2811 {not in Vi}
2812 {not available when compiled without the |+autocmd|
2813 feature}
2814 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002815 When set to "all" or when "all" is one of the items, all autocommand
2816 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 Otherwise this is a comma separated list of event names. Example: >
2818 :set ei=WinEnter,WinLeave
2819<
2820 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2821'expandtab' 'et' boolean (default off)
2822 local to buffer
2823 {not in Vi}
2824 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002825 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2827 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2828 NOTE: This option is reset when 'compatible' is set.
2829
2830 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2831'exrc' 'ex' boolean (default off)
2832 global
2833 {not in Vi}
2834 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2835 directory. If you switch this option on you should also consider
2836 setting the 'secure' option (see |initialization|). Using a local
2837 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2838 also see |.vimrc| and |gui-init|.
2839 This option cannot be set from a |modeline| or in the |sandbox|, for
2840 security reasons.
2841
2842 *'fileencoding'* *'fenc'* *E213*
2843'fileencoding' 'fenc' string (default: "")
2844 local to buffer
2845 {only available when compiled with the |+multi_byte|
2846 feature}
2847 {not in Vi}
2848 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002849
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002851 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852 When 'fileencoding' is empty, the same value as 'encoding' will be
2853 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002854 Conversion will also be done when 'encoding' and 'fileencoding' are
2855 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2856 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002858 'encoding' is "utf-8" or another Unicode encoding, conversion
2859 is most likely done in a way that the reverse conversion
2860 results in the same text. When 'encoding' is not "utf-8" some
2861 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002862
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 See 'encoding' for the possible values. Additionally, values may be
2864 specified that can be handled by the converter, see
2865 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002866
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 When reading a file 'fileencoding' will be set from 'fileencodings'.
2868 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002869 'fileencoding', use the |++enc| argument. One exception: when
2870 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002871 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002872
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2874 When the option is set, the value is converted to lowercase. Thus
2875 you can set it with uppercase values too. '_' characters are
2876 replaced with '-'. If a name is recognized from the list for
2877 'encoding', it is replaced by the standard name. For example
2878 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002879
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 When this option is set, after starting to edit a file, the 'modified'
2881 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002882
2883 Keep in mind that changing 'fenc' from a modeline happens
2884 AFTER the text has been read, thus it applies to when the file will be
2885 written. If you do set 'fenc' in a modeline, you might want to set
2886 'nomodified' to avoid not being able to ":q".
2887
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 This option can not be changed when 'modifiable' is off.
2889
2890 *'fe'*
2891 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 old short name was 'fe', which is no longer used.
2894
2895 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002896'fileencodings' 'fencs' string (default: "ucs-bom",
2897 "ucs-bom,utf-8,default,latin1" when
2898 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899 global
2900 {only available when compiled with the |+multi_byte|
2901 feature}
2902 {not in Vi}
2903 This is a list of character encodings considered when starting to edit
2904 an existing file. When a file is read, Vim tries to use the first
2905 mentioned character encoding. If an error is detected, the next one
2906 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 an empty string, which means the value of 'encoding' is used.
2909 WARNING: Conversion can cause loss of information! When
2910 'encoding' is "utf-8" (or one of the other Unicode variants)
2911 conversion is most likely done in a way that the reverse
2912 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002913 "utf-8" some non-ASCII characters may be lost! You can use
2914 the |++bad| argument to specify what is done with characters
2915 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 For an empty file or a file with only ASCII characters most encodings
2917 will work and the first entry of 'fileencodings' will be used (except
2918 "ucs-bom", which requires the BOM to be present). If you prefer
2919 another encoding use an BufReadPost autocommand event to test if your
2920 preferred encoding is to be used. Example: >
2921 au BufReadPost * if search('\S', 'w') == 0 |
2922 \ set fenc=iso-2022-jp | endif
2923< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2924 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002925 When the |++enc| argument is used then the value of 'fileencodings' is
2926 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002927 Note that 'fileencodings' is not used for a new file, the global value
2928 of 'fileencoding' is used instead. You can set it with: >
2929 :setglobal fenc=iso-8859-2
2930< This means that a non-existing file may get a different encoding than
2931 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 The special value "ucs-bom" can be used to check for a Unicode BOM
2933 (Byte Order Mark) at the start of the file. It must not be preceded
2934 by "utf-8" or another Unicode encoding for this to work properly.
2935 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2936 because Vim cannot detect an error, thus the encoding is always
2937 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002938 The special value "default" can be used for the encoding from the
2939 environment. This is the default value for 'encoding'. It is useful
2940 when 'encoding' is set to "utf-8" and your environment uses a
2941 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002942 When 'encoding' is "utf-8" and a file contains an illegal byte
2943 sequence it won't be recognized as UTF-8. You can use the |8g8|
2944 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 WRONG VALUES: WHAT'S WRONG:
2946 latin1,utf-8 "latin1" will always be used
2947 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2948 file
2949 cp1250,latin1 "cp1250" will always be used
2950 If 'fileencodings' is empty, 'fileencoding' is not modified.
2951 See 'fileencoding' for the possible values.
2952 Setting this option does not have an effect until the next time a file
2953 is read.
2954
2955 *'fileformat'* *'ff'*
2956'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2957 Unix default: "unix",
2958 Macintosh default: "mac")
2959 local to buffer
2960 {not in Vi}
2961 This gives the <EOL> of the current buffer, which is used for
2962 reading/writing the buffer from/to a file:
2963 dos <CR> <NL>
2964 unix <NL>
2965 mac <CR>
2966 When "dos" is used, CTRL-Z at the end of a file is ignored.
2967 See |file-formats| and |file-read|.
2968 For the character encoding of the file see 'fileencoding'.
2969 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002970 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 This option is set automatically when starting to edit a file and
2972 'fileformats' is not empty and 'binary' is off.
2973 When this option is set, after starting to edit a file, the 'modified'
2974 option is set, because the file would be different when written.
2975 This option can not be changed when 'modifiable' is off.
2976 For backwards compatibility: When this option is set to "dos",
2977 'textmode' is set, otherwise 'textmode' is reset.
2978
2979 *'fileformats'* *'ffs'*
2980'fileformats' 'ffs' string (default:
2981 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2982 Vim Unix: "unix,dos",
2983 Vim Mac: "mac,unix,dos",
2984 Vi Cygwin: "unix,dos",
2985 Vi others: "")
2986 global
2987 {not in Vi}
2988 This gives the end-of-line (<EOL>) formats that will be tried when
2989 starting to edit a new buffer and when reading a file into an existing
2990 buffer:
2991 - When empty, the format defined with 'fileformat' will be used
2992 always. It is not set automatically.
2993 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002994 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 'fileformats' name will be used when a file is read into an existing
2996 buffer, no matter what 'fileformat' for that buffer is set to.
2997 - When more than one name is present, separated by commas, automatic
2998 <EOL> detection will be done when reading a file. When starting to
2999 edit a file, a check is done for the <EOL>:
3000 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3001 'fileformat' is set to "dos".
3002 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003005 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3006 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003007 This means that "mac" is only chosen when:
3008 "unix" is not present or no <NL> is found in the file, and
3009 "dos" is not present or no <CR><NL> is found in the file.
3010 Except: if "unix" was chosen, but there is a <CR> before
3011 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003012 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 4. If 'fileformat' is still not set, the first name from
3014 'fileformats' is used.
3015 When reading a file into an existing buffer, the same is done, but
3016 this happens like 'fileformat' has been set appropriately for that
3017 file only, the option is not changed.
3018 When 'binary' is set, the value of 'fileformats' is not used.
3019
Bram Moolenaar81af9252010-12-10 20:35:50 +01003020 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01003021 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003022
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3024 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3025 done:
3026 - When 'fileformats' is empty, there is no automatic detection. Dos
3027 format will be used.
3028 - When 'fileformats' is set to one or more names, automatic detection
3029 is done. This is based on the first <NL> in the file: If there is a
3030 <CR> in front of it, Dos format is used, otherwise Unix format is
3031 used.
3032 Also see |file-formats|.
3033 For backwards compatibility: When this option is set to an empty
3034 string or one format (no comma is included), 'textauto' is reset,
3035 otherwise 'textauto' is set.
3036 NOTE: This option is set to the Vi default value when 'compatible' is
3037 set and to the Vim default value when 'compatible' is reset.
3038
Bram Moolenaarbf884932013-04-05 22:26:15 +02003039 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3040'fileignorecase' 'fic' boolean (default on for systems where case in file
3041 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003042 global
3043 {not in Vi}
3044 When set case is ignored when using file names and directories.
3045 See 'wildignorecase' for only ignoring case when doing completion.
3046
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 *'filetype'* *'ft'*
3048'filetype' 'ft' string (default: "")
3049 local to buffer
3050 {not in Vi}
3051 {not available when compiled without the |+autocmd|
3052 feature}
3053 When this option is set, the FileType autocommand event is triggered.
3054 All autocommands that match with the value of this option will be
3055 executed. Thus the value of 'filetype' is used in place of the file
3056 name.
3057 Otherwise this option does not always reflect the current file type.
3058 This option is normally set when the file type is detected. To enable
3059 this use the ":filetype on" command. |:filetype|
3060 Setting this option to a different value is most useful in a modeline,
3061 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003062 Example, for in an IDL file:
3063 /* vim: set filetype=idl : */ ~
3064 |FileType| |filetypes|
3065 When a dot appears in the value then this separates two filetype
3066 names. Example:
3067 /* vim: set filetype=c.doxygen : */ ~
3068 This will use the "c" filetype first, then the "doxygen" filetype.
3069 This works both for filetype plugins and for syntax files. More than
3070 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 This option is not copied to another buffer, independent of the 's' or
3072 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003073 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074
3075 *'fillchars'* *'fcs'*
3076'fillchars' 'fcs' string (default "vert:|,fold:-")
3077 global
3078 {not in Vi}
3079 {not available when compiled without the |+windows|
3080 and |+folding| features}
3081 Characters to fill the statuslines and vertical separators.
3082 It is a comma separated list of items:
3083
3084 item default Used for ~
3085 stl:c ' ' or '^' statusline of the current window
3086 stlnc:c ' ' or '-' statusline of the non-current windows
3087 vert:c '|' vertical separators |:vsplit|
3088 fold:c '-' filling 'foldtext'
3089 diff:c '-' deleted lines of the 'diff' option
3090
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003091 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 "stlnc" the space will be used when there is highlighting, '^' or '-'
3093 otherwise.
3094
3095 Example: >
3096 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3097< This is similar to the default, except that these characters will also
3098 be used when there is highlighting.
3099
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003100 for "stl" and "stlnc" only single-byte values are supported.
3101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 The highlighting used for these items:
3103 item highlight group ~
3104 stl:c StatusLine |hl-StatusLine|
3105 stlnc:c StatusLineNC |hl-StatusLineNC|
3106 vert:c VertSplit |hl-VertSplit|
3107 fold:c Folded |hl-Folded|
3108 diff:c DiffDelete |hl-DiffDelete|
3109
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003110 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3111'fixendofline' 'fixeol' boolean (default on)
3112 local to buffer
3113 {not in Vi}
3114 When writing a file and this option is on, <EOL> at the end of file
3115 will be restored if missing. Turn this option off if you want to
3116 preserve the situation from the original file.
3117 When the 'binary' option is set the value of this option doesn't
3118 matter.
3119 See the 'endofline' option.
3120
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3122'fkmap' 'fk' boolean (default off) *E198*
3123 global
3124 {not in Vi}
3125 {only available when compiled with the |+rightleft|
3126 feature}
3127 When on, the keyboard is mapped for the Farsi character set.
3128 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003129 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130
3131 *'foldclose'* *'fcl'*
3132'foldclose' 'fcl' string (default "")
3133 global
3134 {not in Vi}
3135 {not available when compiled without the |+folding|
3136 feature}
3137 When set to "all", a fold is closed when the cursor isn't in it and
3138 its level is higher than 'foldlevel'. Useful if you want folds to
3139 automatically close when moving out of them.
3140
3141 *'foldcolumn'* *'fdc'*
3142'foldcolumn' 'fdc' number (default 0)
3143 local to window
3144 {not in Vi}
3145 {not available when compiled without the |+folding|
3146 feature}
3147 When non-zero, a column with the specified width is shown at the side
3148 of the window which indicates open and closed folds. The maximum
3149 value is 12.
3150 See |folding|.
3151
3152 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3153'foldenable' 'fen' boolean (default on)
3154 local to window
3155 {not in Vi}
3156 {not available when compiled without the |+folding|
3157 feature}
3158 When off, all folds are open. This option can be used to quickly
3159 switch between showing all text unfolded and viewing the text with
3160 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 'foldenable' is off.
3163 This option is set by commands that create a new fold or close a fold.
3164 See |folding|.
3165
3166 *'foldexpr'* *'fde'*
3167'foldexpr' 'fde' string (default: "0")
3168 local to window
3169 {not in Vi}
3170 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003171 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003173 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003174
Bram Moolenaar30b65812012-07-12 22:01:11 +02003175 The expression will be evaluated in the |sandbox| if set from a
3176 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003177 This option can't be set from a |modeline| when the 'diff' option is
3178 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003179
3180 It is not allowed to change text or jump to another window while
3181 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
3183 *'foldignore'* *'fdi'*
3184'foldignore' 'fdi' string (default: "#")
3185 local to window
3186 {not in Vi}
3187 {not available when compiled without the |+folding|
3188 feature}
3189 Used only when 'foldmethod' is "indent". Lines starting with
3190 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003191 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 The default "#" works well for C programs. See |fold-indent|.
3193
3194 *'foldlevel'* *'fdl'*
3195'foldlevel' 'fdl' number (default: 0)
3196 local to window
3197 {not in Vi}
3198 {not available when compiled without the |+folding|
3199 feature}
3200 Sets the fold level: Folds with a higher level will be closed.
3201 Setting this option to zero will close all folds. Higher numbers will
3202 close fewer folds.
3203 This option is set by commands like |zm|, |zM| and |zR|.
3204 See |fold-foldlevel|.
3205
3206 *'foldlevelstart'* *'fdls'*
3207'foldlevelstart' 'fdls' number (default: -1)
3208 global
3209 {not in Vi}
3210 {not available when compiled without the |+folding|
3211 feature}
3212 Sets 'foldlevel' when starting to edit another buffer in a window.
3213 Useful to always start editing with all folds closed (value zero),
3214 some folds closed (one) or no folds closed (99).
3215 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 ignores this option and closes all folds.
3218 It is also done before BufReadPre autocommands, to allow an autocmd to
3219 overrule the 'foldlevel' value for specific files.
3220 When the value is negative, it is not used.
3221
3222 *'foldmarker'* *'fmr'* *E536*
3223'foldmarker' 'fmr' string (default: "{{{,}}}")
3224 local to window
3225 {not in Vi}
3226 {not available when compiled without the |+folding|
3227 feature}
3228 The start and end marker used when 'foldmethod' is "marker". There
3229 must be one comma, which separates the start and end marker. The
3230 marker is a literal string (a regular expression would be too slow).
3231 See |fold-marker|.
3232
3233 *'foldmethod'* *'fdm'*
3234'foldmethod' 'fdm' string (default: "manual")
3235 local to window
3236 {not in Vi}
3237 {not available when compiled without the |+folding|
3238 feature}
3239 The kind of folding used for the current window. Possible values:
3240 |fold-manual| manual Folds are created manually.
3241 |fold-indent| indent Lines with equal indent form a fold.
3242 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3243 |fold-marker| marker Markers are used to specify folds.
3244 |fold-syntax| syntax Syntax highlighting items specify folds.
3245 |fold-diff| diff Fold text that is not changed.
3246
3247 *'foldminlines'* *'fml'*
3248'foldminlines' 'fml' number (default: 1)
3249 local to window
3250 {not in Vi}
3251 {not available when compiled without the |+folding|
3252 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003253 Sets the number of screen lines above which a fold can be displayed
3254 closed. Also for manually closed folds. With the default value of
3255 one a fold can only be closed if it takes up two or more screen lines.
3256 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003257 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 "zc" to close a fold, which is displayed open because it's smaller
3259 than 'foldminlines', a following "zc" may close a containing fold.
3260
3261 *'foldnestmax'* *'fdn'*
3262'foldnestmax' 'fdn' number (default: 20)
3263 local to window
3264 {not in Vi}
3265 {not available when compiled without the |+folding|
3266 feature}
3267 Sets the maximum nesting of folds for the "indent" and "syntax"
3268 methods. This avoids that too many folds will be created. Using more
3269 than 20 doesn't work, because the internal limit is 20.
3270
3271 *'foldopen'* *'fdo'*
3272'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3273 search,tag,undo")
3274 global
3275 {not in Vi}
3276 {not available when compiled without the |+folding|
3277 feature}
3278 Specifies for which type of commands folds will be opened, if the
3279 command moves the cursor into a closed fold. It is a comma separated
3280 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003281 NOTE: When the command is part of a mapping this option is not used.
3282 Add the |zv| command to the mapping to get the same effect.
3283 (rationale: the mapping may want to control opening folds itself)
3284
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 item commands ~
3286 all any
3287 block "(", "{", "[[", "[{", etc.
3288 hor horizontal movements: "l", "w", "fx", etc.
3289 insert any command in Insert mode
3290 jump far jumps: "G", "gg", etc.
3291 mark jumping to a mark: "'m", CTRL-O, etc.
3292 percent "%"
3293 quickfix ":cn", ":crew", ":make", etc.
3294 search search for a pattern: "/", "n", "*", "gd", etc.
3295 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003296 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 tag jumping to a tag: ":ta", CTRL-T, etc.
3298 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 When a movement command is used for an operator (e.g., "dl" or "y%")
3300 this option is not used. This means the operator will include the
3301 whole closed fold.
3302 Note that vertical movements are not here, because it would make it
3303 very difficult to move onto a closed fold.
3304 In insert mode the folds containing the cursor will always be open
3305 when text is inserted.
3306 To close folds you can re-apply 'foldlevel' with the |zx| command or
3307 set the 'foldclose' option to "all".
3308
3309 *'foldtext'* *'fdt'*
3310'foldtext' 'fdt' string (default: "foldtext()")
3311 local to window
3312 {not in Vi}
3313 {not available when compiled without the |+folding|
3314 feature}
3315 An expression which is used to specify the text displayed for a closed
3316 fold. See |fold-foldtext|.
3317
Bram Moolenaar30b65812012-07-12 22:01:11 +02003318 The expression will be evaluated in the |sandbox| if set from a
3319 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003320
3321 It is not allowed to change text or jump to another window while
3322 evaluating 'foldtext' |textlock|.
3323
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 *'formatoptions'* *'fo'*
3325'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3326 local to buffer
3327 {not in Vi}
3328 This is a sequence of letters which describes how automatic
3329 formatting is to be done. See |fo-table|. When the 'paste' option is
3330 on, no formatting is done (like 'formatoptions' is empty). Commas can
3331 be inserted for readability.
3332 To avoid problems with flags that are added in the future, use the
3333 "+=" and "-=" feature of ":set" |add-option-flags|.
3334 NOTE: This option is set to the Vi default value when 'compatible' is
3335 set and to the Vim default value when 'compatible' is reset.
3336
Bram Moolenaar86b68352004-12-27 21:59:20 +00003337 *'formatlistpat'* *'flp'*
3338'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3339 local to buffer
3340 {not in Vi}
3341 A pattern that is used to recognize a list header. This is used for
3342 the "n" flag in 'formatoptions'.
3343 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003344 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003345 while still checking more characters. There must be a character
3346 following the pattern, when it matches the whole line it is handled
3347 like there is no match.
3348 The default recognizes a number, followed by an optional punctuation
3349 character and white space.
3350
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 *'formatprg'* *'fp'*
3352'formatprg' 'fp' string (default "")
3353 global
3354 {not in Vi}
3355 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003356 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003358 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003359 If the 'formatexpr' option is not empty it will be used instead.
3360 Otherwise, if 'formatprg' option is an empty string, the internal
3361 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003362 Environment variables are expanded |:set_env|. See |option-backslash|
3363 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003364 This option cannot be set from a |modeline| or in the |sandbox|, for
3365 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003367 *'formatexpr'* *'fex'*
3368'formatexpr' 'fex' string (default "")
3369 local to buffer
3370 {not in Vi}
3371 {not available when compiled without the |+eval|
3372 feature}
3373 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003374 operator or automatic formatting (see 'formatoptions'). When this
3375 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003376
3377 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003378 The |v:count| variable holds the number of lines to be formatted.
3379 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003380 inserted if the expression is being evaluated due to
3381 automatic formatting. This can be empty. Don't insert
3382 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003383
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003384 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003385 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003386< This will invoke the mylang#Format() function in the
3387 autoload/mylang.vim file in 'runtimepath'. |autoload|
3388
3389 The expression is also evaluated when 'textwidth' is set and adding
3390 text beyond that limit. This happens under the same conditions as
3391 when internal formatting is used. Make sure the cursor is kept in the
3392 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003393 return "i" or "R" in this situation.
3394
3395 When the expression evaluates to non-zero Vim will fall back to using
3396 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003397
Bram Moolenaar30b65812012-07-12 22:01:11 +02003398 The expression will be evaluated in the |sandbox| when set from a
3399 modeline, see |sandbox-option|. That stops the option from working,
3400 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003401
3402 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003403'fsync' 'fs' boolean (default on)
3404 global
3405 {not in Vi}
3406 When on, the library function fsync() will be called after writing a
3407 file. This will flush a file to disk, ensuring that it is safely
3408 written even on filesystems which do metadata-only journaling. This
3409 will force the harddrive to spin up on Linux systems running in laptop
3410 mode, so it may be undesirable in some situations. Be warned that
3411 turning this off increases the chances of data loss after a crash. On
3412 systems without an fsync() implementation, this variable is always
3413 off.
3414 Also see 'swapsync' for controlling fsync() on swap files.
3415
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3417'gdefault' 'gd' boolean (default off)
3418 global
3419 {not in Vi}
3420 When on, the ":substitute" flag 'g' is default on. This means that
3421 all matches in a line are substituted instead of one. When a 'g' flag
3422 is given to a ":substitute" command, this will toggle the substitution
3423 of all or one match. See |complex-change|.
3424
3425 command 'gdefault' on 'gdefault' off ~
3426 :s/// subst. all subst. one
3427 :s///g subst. one subst. all
3428 :s///gg subst. all subst. one
3429
3430 NOTE: This option is reset when 'compatible' is set.
3431
3432 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003433'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 global
3435 {not in Vi}
3436 Format to recognize for the ":grep" command output.
3437 This is a scanf-like string that uses the same format as the
3438 'errorformat' option: see |errorformat|.
3439
3440 *'grepprg'* *'gp'*
3441'grepprg' 'gp' string (default "grep -n ",
3442 Unix: "grep -n $* /dev/null",
3443 Win32: "findstr /n" or "grep -n",
3444 VMS: "SEARCH/NUMBERS ")
3445 global or local to buffer |global-local|
3446 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003447 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 and '#' characters, which are expanded like when used in a command-
3449 line. The placeholder "$*" is allowed to specify where the arguments
3450 will be included. Environment variables are expanded |:set_env|. See
3451 |option-backslash| about including spaces and backslashes.
3452 When your "grep" accepts the "-H" argument, use this to make ":grep"
3453 also work well with a single file: >
3454 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003455< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003456 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3457 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003458 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 apply equally to 'grepprg'.
3460 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3461 otherwise it's "grep -n".
3462 This option cannot be set from a |modeline| or in the |sandbox|, for
3463 security reasons.
3464
3465 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3466'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3467 ve:ver35-Cursor,
3468 o:hor50-Cursor,
3469 i-ci:ver25-Cursor/lCursor,
3470 r-cr:hor20-Cursor/lCursor,
3471 sm:block-Cursor
3472 -blinkwait175-blinkoff150-blinkon175",
3473 for MS-DOS and Win32 console:
3474 "n-v-c:block,o:hor50,i-ci:hor15,
3475 r-cr:hor30,sm:block")
3476 global
3477 {not in Vi}
3478 {only available when compiled with GUI enabled, and
3479 for MS-DOS and Win32 console}
3480 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003481 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 the height of the cursor can be changed. This can be done by
3483 specifying a block cursor, or a percentage for a vertical or
3484 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003485 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3486 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003488 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 mode-list and an argument-list:
3490 mode-list:argument-list,mode-list:argument-list,..
3491 The mode-list is a dash separated list of these modes:
3492 n Normal mode
3493 v Visual mode
3494 ve Visual mode with 'selection' "exclusive" (same as 'v',
3495 if not specified)
3496 o Operator-pending mode
3497 i Insert mode
3498 r Replace mode
3499 c Command-line Normal (append) mode
3500 ci Command-line Insert mode
3501 cr Command-line Replace mode
3502 sm showmatch in Insert mode
3503 a all modes
3504 The argument-list is a dash separated list of these arguments:
3505 hor{N} horizontal bar, {N} percent of the character height
3506 ver{N} vertical bar, {N} percent of the character width
3507 block block cursor, fills the whole character
3508 [only one of the above three should be present]
3509 blinkwait{N} *cursor-blinking*
3510 blinkon{N}
3511 blinkoff{N}
3512 blink times for cursor: blinkwait is the delay before
3513 the cursor starts blinking, blinkon is the time that
3514 the cursor is shown and blinkoff is the time that the
3515 cursor is not shown. The times are in msec. When one
3516 of the numbers is zero, there is no blinking. The
3517 default is: "blinkwait700-blinkon400-blinkoff250".
3518 These numbers are used for a missing entry. This
3519 means that blinking is enabled by default. To switch
3520 blinking off you can use "blinkon0". The cursor only
3521 blinks when Vim is waiting for input, not while
3522 executing a command.
3523 To make the cursor blink in an xterm, see
3524 |xterm-blink|.
3525 {group-name}
3526 a highlight group name, that sets the color and font
3527 for the cursor
3528 {group-name}/{group-name}
3529 Two highlight group names, the first is used when
3530 no language mappings are used, the other when they
3531 are. |language-mapping|
3532
3533 Examples of parts:
3534 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3535 block cursor with colors from the "nCursor"
3536 highlight group
3537 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3538 In Insert and Command-line Insert mode, use a
3539 30% vertical bar cursor with colors from the
3540 "iCursor" highlight group. Blink a bit
3541 faster.
3542
3543 The 'a' mode is different. It will set the given argument-list for
3544 all modes. It does not reset anything to defaults. This can be used
3545 to do a common setting for all modes. For example, to switch off
3546 blinking: "a:blinkon0"
3547
3548 Examples of cursor highlighting: >
3549 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3550 :highlight Cursor gui=NONE guifg=bg guibg=fg
3551<
3552 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003553 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554'guifont' 'gfn' string (default "")
3555 global
3556 {not in Vi}
3557 {only available when compiled with GUI enabled}
3558 This is a list of fonts which will be used for the GUI version of Vim.
3559 In its simplest form the value is just one font name. When
3560 the font cannot be found you will get an error message. To try other
3561 font names a list can be specified, font names separated with commas.
3562 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003563
Bram Moolenaar05159a02005-02-26 23:04:13 +00003564 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3565 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003566
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 Spaces after a comma are ignored. To include a comma in a font name
3568 precede it with a backslash. Setting an option requires an extra
3569 backslash before a space and a backslash. See also
3570 |option-backslash|. For example: >
3571 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003572< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003574
3575 If none of the fonts can be loaded, Vim will keep the current setting.
3576 If an empty font list is given, Vim will try using other resource
3577 settings (for X, it will use the Vim.font resource), and finally it
3578 will try some builtin default which should always be there ("7x13" in
3579 the case of X). The font names given should be "normal" fonts. Vim
3580 will try to find the related bold and italic fonts.
3581
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003582 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003583 :set guifont=*
3584< will bring up a font requester, where you can pick the font you want.
3585
3586 The font name depends on the GUI used. See |setting-guifont| for a
3587 way to set 'guifont' for various systems.
3588
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 For the GTK+ 2 GUI the font name looks like this: >
3590 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003591< That's all. XLFDs are not used. For Chinese this is reported to work
3592 well: >
3593 if has("gui_gtk2")
3594 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3595 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3596 endif
3597<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003598 For Mac OSX you can use something like this: >
3599 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003600< Also see 'macatsui', it can help fix display problems.
3601 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003603 width). An exception is GTK 2: all fonts are accepted, but
3604 mono-spaced fonts look best.
3605
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 To preview a font on X11, you might be able to use the "xfontsel"
3607 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003608
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 For the Win32 GUI *E244* *E245*
3610 - takes these options in the font name:
3611 hXX - height is XX (points, can be floating-point)
3612 wXX - width is XX (points, can be floating-point)
3613 b - bold
3614 i - italic
3615 u - underline
3616 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003617 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3619 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3620 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003621 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622
3623 Use a ':' to separate the options.
3624 - A '_' can be used in the place of a space, so you don't need to use
3625 backslashes to escape the spaces.
3626 - Examples: >
3627 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3628 :set guifont=Andale_Mono:h7.5:w4.5
3629< See also |font-sizes|.
3630
3631 *'guifontset'* *'gfs'*
3632 *E250* *E252* *E234* *E597* *E598*
3633'guifontset' 'gfs' string (default "")
3634 global
3635 {not in Vi}
3636 {only available when compiled with GUI enabled and
3637 with the |+xfontset| feature}
3638 {not available in the GTK+ 2 GUI}
3639 When not empty, specifies two (or more) fonts to be used. The first
3640 one for normal English, the second one for your special language. See
3641 |xfontset|.
3642 Setting this option also means that all font names will be handled as
3643 a fontset name. Also the ones used for the "font" argument of the
3644 |:highlight| command.
3645 The fonts must match with the current locale. If fonts for the
3646 character sets that the current locale uses are not included, setting
3647 'guifontset' will fail.
3648 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3649 the comma-separated names are alternative names, one of which will be
3650 used. In 'guifontset' the whole string is one fontset name,
3651 including the commas. It is not possible to specify alternative
3652 fontset names.
3653 This example works on many X11 systems: >
3654 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3655<
3656 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3657'guifontwide' 'gfw' string (default "")
3658 global
3659 {not in Vi}
3660 {only available when compiled with GUI enabled}
3661 When not empty, specifies a comma-separated list of fonts to be used
3662 for double-width characters. The first font that can be loaded is
3663 used.
3664 Note: The size of these fonts must be exactly twice as wide as the one
3665 specified with 'guifont' and the same height.
3666
3667 All GUI versions but GTK+ 2:
3668
3669 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3670 'guifontset' is empty or invalid.
3671 When 'guifont' is set and a valid font is found in it and
3672 'guifontwide' is empty Vim will attempt to find a matching
3673 double-width font and set 'guifontwide' to it.
3674
3675 GTK+ 2 GUI only: *guifontwide_gtk2*
3676
3677 If set and valid, 'guifontwide' is always used for double width
3678 characters, even if 'encoding' is not set to "utf-8".
3679 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003680 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 font for characters not available in 'guifont'. Thus you do not need
3682 to set 'guifontwide' at all unless you want to override the choice
3683 made by Pango/Xft.
3684
Bram Moolenaar0f272122013-01-23 18:37:40 +01003685 Windows +multibyte only: *guifontwide_win_mbyte*
3686
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003687 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003688
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 *'guiheadroom'* *'ghr'*
3690'guiheadroom' 'ghr' number (default 50)
3691 global
3692 {not in Vi} {only for GTK and X11 GUI}
3693 The number of pixels subtracted from the screen height when fitting
3694 the GUI window on the screen. Set this before the GUI is started,
3695 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 lines will be left for window decorations and other items on the
3698 screen. Set it to a negative value to allow windows taller than the
3699 screen.
3700
3701 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003702'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3703 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 global
3705 {not in Vi}
3706 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003707 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 sequence of letters which describes what components and options of the
3709 GUI should be used.
3710 To avoid problems with flags that are added in the future, use the
3711 "+=" and "-=" feature of ":set" |add-option-flags|.
3712
3713 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003714 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 'a' Autoselect: If present, then whenever VISUAL mode is started,
3716 or the Visual area extended, Vim tries to become the owner of
3717 the windowing system's global selection. This means that the
3718 Visually highlighted text is available for pasting into other
3719 applications as well as into Vim itself. When the Visual mode
3720 ends, possibly due to an operation on the text, or when an
3721 application wants to paste the selection, the highlighted text
3722 is automatically yanked into the "* selection register.
3723 Thus the selection is still available for pasting into other
3724 applications after the VISUAL mode has ended.
3725 If not present, then Vim won't become the owner of the
3726 windowing system's global selection unless explicitly told to
3727 by a yank or delete operation for the "* register.
3728 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003729 *'go-P'*
3730 'P' Like autoselect but using the "+ register instead of the "*
3731 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003732 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 applies to the modeless selection.
3735
3736 'guioptions' autoselect Visual autoselect modeless ~
3737 "" - -
3738 "a" yes yes
3739 "A" - yes
3740 "aA" yes yes
3741
Bram Moolenaar02467872007-05-06 13:22:01 +00003742 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 'c' Use console dialogs instead of popup dialogs for simple
3744 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003745 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003746 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003747 'guitablabel' can be used to change the text in the labels.
3748 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003749 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003750 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003751 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 'f' Foreground: Don't use fork() to detach the GUI from the shell
3753 where it was started. Use this for programs that wait for the
3754 editor to finish (e.g., an e-mail program). Alternatively you
3755 can use "gvim -f" or ":gui -f" to start the GUI in the
3756 foreground. |gui-fork|
3757 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003758 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003759 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3761 corner of the window. It's black&white on non-GTK, because of
3762 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003763 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003765 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003766 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003768 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 file is sourced the system menu has already been loaded; the
3770 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003771 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'g' Grey menu items: Make menu items that are not active grey. If
3773 'g' is not included inactive menu items are not shown at all.
3774 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003775 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 't' Include tearoff menu items. Currently only works for Win32,
3777 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003779 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003780 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003783 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 'R' Right-hand scrollbar is present when there is a vertically
3785 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003786 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003788 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 'L' Left-hand scrollbar is present when there is a vertically
3790 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003791 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3793 the longest visible line, or on the cursor line if the 'h'
3794 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003795 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 'h' Limit horizontal scrollbar size to the length of the cursor
3797 line. Reduces computations. |gui-horiz-scroll|
3798
3799 And yes, you may even have scrollbars on the left AND the right if
3800 you really want to :-). See |gui-scrollbars| for more information.
3801
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003802 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'v' Use a vertical button layout for dialogs. When not included,
3804 a horizontal layout is preferred, but when it doesn't fit a
3805 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003806 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003807 'p' Use Pointer callbacks for X11 GUI. This is required for some
3808 window managers. If the cursor is not blinking or hollow at
3809 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003810 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003812 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003813 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814
Bram Moolenaar02467872007-05-06 13:22:01 +00003815
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 *'guipty'* *'noguipty'*
3817'guipty' boolean (default on)
3818 global
3819 {not in Vi}
3820 {only available when compiled with GUI enabled}
3821 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3822 I/O to/from shell commands. See |gui-pty|.
3823
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003824 *'guitablabel'* *'gtl'*
3825'guitablabel' 'gtl' string (default empty)
3826 global
3827 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003828 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003829 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003830 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003831 pages line. When empty and when the result is empty Vim will use a
3832 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003833
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003834 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003835 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003836
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003837 Only used when the GUI tab pages line is displayed. 'e' must be
3838 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3839 used.
3840
Bram Moolenaar57657d82006-04-21 22:12:41 +00003841 *'guitabtooltip'* *'gtt'*
3842'guitabtooltip' 'gtt' string (default empty)
3843 global
3844 {not in Vi}
3845 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003846 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003847 When nonempty describes the text to use in a tooltip for the GUI tab
3848 pages line. When empty Vim will use a default tooltip.
3849 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003850 You can include a line break. Simplest method is to use |:let|: >
3851 :let &guitabtooltip = "line one\nline two"
3852<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003853
Bram Moolenaar071d4272004-06-13 20:20:40 +00003854 *'helpfile'* *'hf'*
3855'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3856 (others) "$VIMRUNTIME/doc/help.txt")
3857 global
3858 {not in Vi}
3859 Name of the main help file. All distributed help files should be
3860 placed together in one directory. Additionally, all "doc" directories
3861 in 'runtimepath' will be used.
3862 Environment variables are expanded |:set_env|. For example:
3863 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003864 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 spaces and backslashes.
3866 This option cannot be set from a |modeline| or in the |sandbox|, for
3867 security reasons.
3868
3869 *'helpheight'* *'hh'*
3870'helpheight' 'hh' number (default 20)
3871 global
3872 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003873 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 feature}
3875 Minimal initial height of the help window when it is opened with the
3876 ":help" command. The initial height of the help window is half of the
3877 current window, or (when the 'ea' option is on) the same as other
3878 windows. When the height is less than 'helpheight', the height is
3879 set to 'helpheight'. Set to zero to disable.
3880
3881 *'helplang'* *'hlg'*
3882'helplang' 'hlg' string (default: messages language or empty)
3883 global
3884 {only available when compiled with the |+multi_lang|
3885 feature}
3886 {not in Vi}
3887 Comma separated list of languages. Vim will use the first language
3888 for which the desired help can be found. The English help will always
3889 be used as a last resort. You can add "en" to prefer English over
3890 another language, but that will only find tags that exist in that
3891 language and not in the English help.
3892 Example: >
3893 :set helplang=de,it
3894< This will first search German, then Italian and finally English help
3895 files.
3896 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3897 try to find the tag in the current language before using this option.
3898 See |help-translated|.
3899
3900 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3901'hidden' 'hid' boolean (default off)
3902 global
3903 {not in Vi}
3904 When off a buffer is unloaded when it is |abandon|ed. When on a
3905 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3906 displayed in another window, it does not become hidden, of course.
3907 The commands that move through the buffer list sometimes make a buffer
3908 hidden although the 'hidden' option is off: When the buffer is
3909 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003911 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 This option is set for one command with ":hide {command}" |:hide|.
3913 WARNING: It's easy to forget that you have changes in hidden buffers.
3914 Think twice when using ":q!" or ":qa!".
3915
3916 *'highlight'* *'hl'*
3917'highlight' 'hl' string (default (as a single string):
3918 "8:SpecialKey,@:NonText,d:Directory,
3919 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003920 M:ModeMsg,n:LineNr,N:CursorLineNr,
3921 r:Question,s:StatusLine,S:StatusLineNC,
3922 c:VertSplit, t:Title,v:Visual,
3923 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 f:Folded,F:FoldColumn,A:DiffAdd,
3925 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003926 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003927 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003928 +:Pmenu,=:PmenuSel,
3929 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 global
3931 {not in Vi}
3932 This option can be used to set highlighting mode for various
3933 occasions. It is a comma separated list of character pairs. The
3934 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3937 |hl-NonText| @ '~' and '@' at the end of the window and
3938 characters from 'showbreak'
3939 |hl-Directory| d directories in CTRL-D listing and other special
3940 things in listings
3941 |hl-ErrorMsg| e error messages
3942 h (obsolete, ignored)
3943 |hl-IncSearch| i 'incsearch' highlighting
3944 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3945 |hl-MoreMsg| m |more-prompt|
3946 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003947 |hl-LineNr| n line number for ":number" and ":#" commands, and
3948 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003949 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3950 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 |hl-Question| r |hit-enter| prompt and yes/no questions
3952 |hl-StatusLine| s status line of current window |status-line|
3953 |hl-StatusLineNC| S status lines of not-current windows
3954 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3955 |hl-VertSplit| c column used to separate vertically split windows
3956 |hl-Visual| v Visual mode
3957 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3958 Selection" Only X11 Gui's |gui-x11| and
3959 |xterm-clipboard|.
3960 |hl-WarningMsg| w warning messages
3961 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3962 |hl-Folded| f line used for closed folds
3963 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003964 |hl-DiffAdd| A added line in diff mode
3965 |hl-DiffChange| C changed line in diff mode
3966 |hl-DiffDelete| D deleted line in diff mode
3967 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003969 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003970 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003971 |hl-SpellRare| R rare word |spell|
3972 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003973 |hl-Conceal| - the placeholders used for concealed characters
3974 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003975 |hl-Pmenu| + popup menu normal line
3976 |hl-PmenuSel| = popup menu normal line
3977 |hl-PmenuSbar| x popup menu scrollbar
3978 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979
3980 The display modes are:
3981 r reverse (termcap entry "mr" and "me")
3982 i italic (termcap entry "ZH" and "ZR")
3983 b bold (termcap entry "md" and "me")
3984 s standout (termcap entry "so" and "se")
3985 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003986 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 n no highlighting
3988 - no highlighting
3989 : use a highlight group
3990 The default is used for occasions that are not included.
3991 If you want to change what the display modes do, see |dos-colors|
3992 for an example.
3993 When using the ':' display mode, this must be followed by the name of
3994 a highlight group. A highlight group can be used to define any type
3995 of highlighting, including using color. See |:highlight| on how to
3996 define one. The default uses a different group for each occasion.
3997 See |highlight-default| for the default highlight groups.
3998
3999 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4000'hlsearch' 'hls' boolean (default off)
4001 global
4002 {not in Vi}
4003 {not available when compiled without the
4004 |+extra_search| feature}
4005 When there is a previous search pattern, highlight all its matches.
4006 The type of highlighting used can be set with the 'l' occasion in the
4007 'highlight' option. This uses the "Search" highlight group by
4008 default. Note that only the matching text is highlighted, any offsets
4009 are not applied.
4010 See also: 'incsearch' and |:match|.
4011 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004012 off with |:nohlsearch|. This does not change the option value, as
4013 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004014 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 When the search pattern can match an end-of-line, Vim will try to
4016 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004017 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004019 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004020 You can specify whether the highlight status is restored on startup
4021 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 NOTE: This option is reset when 'compatible' is set.
4023
4024 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004025'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 global
4027 {not in Vi}
4028 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004029 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004031 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 NOTE: This option is set to the Vi default value when 'compatible' is
4033 set and to the Vim default value when 'compatible' is reset.
4034
4035 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4036'hkmap' 'hk' boolean (default off)
4037 global
4038 {not in Vi}
4039 {only available when compiled with the |+rightleft|
4040 feature}
4041 When on, the keyboard is mapped for the Hebrew character set.
4042 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4043 toggle this option. See |rileft.txt|.
4044 NOTE: This option is reset when 'compatible' is set.
4045
4046 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4047'hkmapp' 'hkp' boolean (default off)
4048 global
4049 {not in Vi}
4050 {only available when compiled with the |+rightleft|
4051 feature}
4052 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4053 This is useful if you have a non-Hebrew keyboard.
4054 See |rileft.txt|.
4055 NOTE: This option is reset when 'compatible' is set.
4056
4057 *'icon'* *'noicon'*
4058'icon' boolean (default off, on when title can be restored)
4059 global
4060 {not in Vi}
4061 {not available when compiled without the |+title|
4062 feature}
4063 When on, the icon text of the window will be set to the value of
4064 'iconstring' (if it is not empty), or to the name of the file
4065 currently being edited. Only the last part of the name is used.
4066 Overridden by the 'iconstring' option.
4067 Only works if the terminal supports setting window icons (currently
4068 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4069 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4070 builtin termcap).
4071 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004072 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004074 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075
4076 *'iconstring'*
4077'iconstring' string (default "")
4078 global
4079 {not in Vi}
4080 {not available when compiled without the |+title|
4081 feature}
4082 When this option is not empty, it will be used for the icon text of
4083 the window. This happens only when the 'icon' option is on.
4084 Only works if the terminal supports setting window icon text
4085 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4086 Does not work for MS Windows.
4087 When Vim was compiled with HAVE_X11 defined, the original icon will be
4088 restored if possible |X11|.
4089 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004090 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 'titlestring' for example settings.
4092 {not available when compiled without the |+statusline| feature}
4093
4094 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4095'ignorecase' 'ic' boolean (default off)
4096 global
4097 Ignore case in search patterns. Also used when searching in the tags
4098 file.
4099 Also see 'smartcase'.
4100 Can be overruled by using "\c" or "\C" in the pattern, see
4101 |/ignorecase|.
4102
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004103 *'imactivatefunc'* *'imaf'*
4104'imactivatefunc' 'imaf' string (default "")
4105 global
4106 {not in Vi}
4107 {only available when compiled with |+xim| and
4108 |+GUI_GTK|}
4109 This option specifies a function that will be called to
4110 activate/inactivate Input Method.
4111
4112 Example: >
4113 function ImActivateFunc(active)
4114 if a:active
4115 ... do something
4116 else
4117 ... do something
4118 endif
4119 " return value is not used
4120 endfunction
4121 set imactivatefunc=ImActivateFunc
4122<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 *'imactivatekey'* *'imak'*
4124'imactivatekey' 'imak' string (default "")
4125 global
4126 {not in Vi}
4127 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004128 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 Specifies the key that your Input Method in X-Windows uses for
4130 activation. When this is specified correctly, vim can fully control
4131 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4132 You can't use this option to change the activation key, the option
4133 tells Vim what the key is.
4134 Format:
4135 [MODIFIER_FLAG-]KEY_STRING
4136
4137 These characters can be used for MODIFIER_FLAG (case is ignored):
4138 S Shift key
4139 L Lock key
4140 C Control key
4141 1 Mod1 key
4142 2 Mod2 key
4143 3 Mod3 key
4144 4 Mod4 key
4145 5 Mod5 key
4146 Combinations are allowed, for example "S-C-space" or "SC-space" are
4147 both shift+ctrl+space.
4148 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4149
4150 Example: >
4151 :set imactivatekey=S-space
4152< "S-space" means shift+space. This is the activation key for kinput2 +
4153 canna (Japanese), and ami (Korean).
4154
4155 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4156'imcmdline' 'imc' boolean (default off)
4157 global
4158 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004159 {only available when compiled with the |+xim|,
4160 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 When set the Input Method is always on when starting to edit a command
4162 line, unless entering a search pattern (see 'imsearch' for that).
4163 Setting this option is useful when your input method allows entering
4164 English characters directly, e.g., when it's used to type accented
4165 characters with dead keys.
4166
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004167 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4169 global
4170 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004171 {only available when compiled with the |+xim|,
4172 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 When set the Input Method is never used. This is useful to disable
4174 the IM when it doesn't work properly.
4175 Currently this option is on by default for SGI/IRIX machines. This
4176 may change in later releases.
4177
4178 *'iminsert'* *'imi'*
4179'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4180 local to buffer
4181 {not in Vi}
4182 Specifies whether :lmap or an Input Method (IM) is to be used in
4183 Insert mode. Valid values:
4184 0 :lmap is off and IM is off
4185 1 :lmap is ON and IM is off
4186 2 :lmap is off and IM is ON
4187 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4188 or |global-ime|.
4189 To always reset the option to zero when leaving Insert mode with <Esc>
4190 this can be used: >
4191 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4192< This makes :lmap and IM turn off automatically when leaving Insert
4193 mode.
4194 Note that this option changes when using CTRL-^ in Insert mode
4195 |i_CTRL-^|.
4196 The value is set to 1 when setting 'keymap' to a valid keymap name.
4197 It is also used for the argument of commands like "r" and "f".
4198 The value 0 may not work correctly with Athena and Motif with some XIM
4199 methods. Use 'imdisable' to disable XIM then.
4200
4201 *'imsearch'* *'ims'*
4202'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4203 local to buffer
4204 {not in Vi}
4205 Specifies whether :lmap or an Input Method (IM) is to be used when
4206 entering a search pattern. Valid values:
4207 -1 the value of 'iminsert' is used, makes it look like
4208 'iminsert' is also used when typing a search pattern
4209 0 :lmap is off and IM is off
4210 1 :lmap is ON and IM is off
4211 2 :lmap is off and IM is ON
4212 Note that this option changes when using CTRL-^ in Command-line mode
4213 |c_CTRL-^|.
4214 The value is set to 1 when it is not -1 and setting the 'keymap'
4215 option to a valid keymap name.
4216 The value 0 may not work correctly with Athena and Motif with some XIM
4217 methods. Use 'imdisable' to disable XIM then.
4218
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004219 *'imstatusfunc'* *'imsf'*
4220'imstatusfunc' 'imsf' string (default "")
4221 global
4222 {not in Vi}
4223 {only available when compiled with |+xim| and
4224 |+GUI_GTK|}
4225 This option specifies a function that is called to obtain the status
4226 of Input Method. It must return a positive number when IME is active.
4227
4228 Example: >
4229 function ImStatusFunc()
4230 let is_active = ...do something
4231 return is_active ? 1 : 0
4232 endfunction
4233 set imstatusfunc=ImStatusFunc
4234<
4235 NOTE: This function is invoked very often. Keep it fast.
4236
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 *'include'* *'inc'*
4238'include' 'inc' string (default "^\s*#\s*include")
4239 global or local to buffer |global-local|
4240 {not in Vi}
4241 {not available when compiled without the
4242 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 pattern, just like for the "/" command (See |pattern|). The default
4245 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004246 "]I", "[d", etc.
4247 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004248 comes after the matched pattern. But if "\zs" appears in the pattern
4249 then the text matched from "\zs" to the end, or until "\ze" if it
4250 appears, is used as the file name. Use this to include characters
4251 that are not in 'isfname', such as a space. You can then use
4252 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004253 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254
4255 *'includeexpr'* *'inex'*
4256'includeexpr' 'inex' string (default "")
4257 local to buffer
4258 {not in Vi}
4259 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004260 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004262 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 :set includeexpr=substitute(v:fname,'\\.','/','g')
4264< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004265
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004267 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 Also used for |<cfile>|.
4269
Bram Moolenaar30b65812012-07-12 22:01:11 +02004270 The expression will be evaluated in the |sandbox| when set from a
4271 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004272
4273 It is not allowed to change text or jump to another window while
4274 evaluating 'includeexpr' |textlock|.
4275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4277'incsearch' 'is' boolean (default off)
4278 global
4279 {not in Vi}
4280 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004281 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004282 While typing a search command, show where the pattern, as it was typed
4283 so far, matches. The matched string is highlighted. If the pattern
4284 is invalid or not found, nothing is shown. The screen will be updated
4285 often, this is only useful on fast terminals.
4286 Note that the match will be shown, but the cursor will return to its
4287 original position when no match is found and when pressing <Esc>. You
4288 still need to finish the search command with <Enter> to move the
4289 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004290 When compiled with the |+reltime| feature Vim only searches for about
4291 half a second. With a complicated pattern and/or a lot of text the
4292 match may not be found. This is to avoid that Vim hangs while you
4293 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004294 The highlighting can be set with the 'i' flag in 'highlight'.
4295 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004296 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004297 to the command line. If 'ignorecase' and 'smartcase' are set and the
4298 command line has no uppercase characters, the added character is
4299 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004300 CTRL-R CTRL-W can be used to add the word at the end of the current
4301 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 NOTE: This option is reset when 'compatible' is set.
4303
4304 *'indentexpr'* *'inde'*
4305'indentexpr' 'inde' string (default "")
4306 local to buffer
4307 {not in Vi}
4308 {not available when compiled without the |+cindent|
4309 or |+eval| features}
4310 Expression which is evaluated to obtain the proper indent for a line.
4311 It is used when a new line is created, for the |=| operator and
4312 in Insert mode as specified with the 'indentkeys' option.
4313 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004314 'smartindent' indenting. When 'lisp' is set, this option is
4315 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004316 When 'paste' is set this option is not used for indenting.
4317 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004318 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 when the expression is evaluated (but it may be moved around).
4320 The expression must return the number of spaces worth of indent. It
4321 can return "-1" to keep the current indent (this means 'autoindent' is
4322 used for the indent).
4323 Functions useful for computing the indent are |indent()|, |cindent()|
4324 and |lispindent()|.
4325 The evaluation of the expression must not have side effects! It must
4326 not change the text, jump to another window, etc. Afterwards the
4327 cursor position is always restored, thus the cursor may be moved.
4328 Normally this option would be set to call a function: >
4329 :set indentexpr=GetMyIndent()
4330< Error messages will be suppressed, unless the 'debug' option contains
4331 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004332 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 NOTE: This option is made empty when 'compatible' is set.
4334
Bram Moolenaar30b65812012-07-12 22:01:11 +02004335 The expression will be evaluated in the |sandbox| when set from a
4336 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004337
4338 It is not allowed to change text or jump to another window while
4339 evaluating 'indentexpr' |textlock|.
4340
4341
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 *'indentkeys'* *'indk'*
4343'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4344 local to buffer
4345 {not in Vi}
4346 {not available when compiled without the |+cindent|
4347 feature}
4348 A list of keys that, when typed in Insert mode, cause reindenting of
4349 the current line. Only happens if 'indentexpr' isn't empty.
4350 The format is identical to 'cinkeys', see |indentkeys-format|.
4351 See |C-indenting| and |indent-expression|.
4352
4353 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4354'infercase' 'inf' boolean (default off)
4355 local to buffer
4356 {not in Vi}
4357 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004358 'ignorecase' is also on, the case of the match is adjusted depending
4359 on the typed text. If the typed text contains a lowercase letter
4360 where the match has an upper case letter, the completed part is made
4361 lowercase. If the typed text has no lowercase letters and the match
4362 has a lowercase letter where the typed text has an uppercase letter,
4363 and there is a letter before it, the completed part is made uppercase.
4364 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365
4366 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4367'insertmode' 'im' boolean (default off)
4368 global
4369 {not in Vi}
4370 Makes Vim work in a way that Insert mode is the default mode. Useful
4371 if you want to use Vim as a modeless editor. Used for |evim|.
4372 These Insert mode commands will be useful:
4373 - Use the cursor keys to move around.
4374 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4375 this is a mapping, it is executed as if 'insertmode' was off.
4376 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004378 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4379 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380
4381 These items change when 'insertmode' is set:
4382 - when starting to edit of a file, Vim goes to Insert mode.
4383 - <Esc> in Insert mode is a no-op and beeps.
4384 - <Esc> in Normal mode makes Vim go to Insert mode.
4385 - CTRL-L in Insert mode is a command, it is not inserted.
4386 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4387 However, when <Esc> is used inside a mapping, it behaves like
4388 'insertmode' was not set. This was done to be able to use the same
4389 mappings with 'insertmode' set or not set.
4390 When executing commands with |:normal| 'insertmode' is not used.
4391
4392 NOTE: This option is reset when 'compatible' is set.
4393
4394 *'isfname'* *'isf'*
4395'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4396 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4397 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4398 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4399 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4400 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4401 global
4402 {not in Vi}
4403 The characters specified by this option are included in file names and
4404 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004405 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 Multi-byte characters 256 and above are always included, only the
4407 characters up to 255 are specified with this option.
4408 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004409 Think twice before adding white space to this option. Although a
4410 space may appear inside a file name, the effect will be that Vim
4411 doesn't know where a file name starts or ends when doing completion.
4412 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413
4414 Note that on systems using a backslash as path separator, Vim tries to
4415 do its best to make it work as you would expect. That is a bit
4416 tricky, since Vi originally used the backslash to escape special
4417 characters. Vim will not remove a backslash in front of a normal file
4418 name character on these systems, but it will on Unix and alikes. The
4419 '&' and '^' are not included by default, because these are special for
4420 cmd.exe.
4421
4422 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004423 Each part can be a single character number or a range. A range is two
4424 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 decimal number between 0 and 255 or the ASCII character itself (does
4426 not work for digits). Example:
4427 "_,-,128-140,#-43" (include '_' and '-' and the range
4428 128 to 140 and '#' to 43)
4429 If a part starts with '^', the following character number or range
4430 will be excluded from the option. The option is interpreted from left
4431 to right. Put the excluded character after the range where it is
4432 included. To include '^' itself use it as the last character of the
4433 option or the end of a range. Example:
4434 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4435 If the character is '@', all characters where isalpha() returns TRUE
4436 are included. Normally these are the characters a to z and A to Z,
4437 plus accented characters. To include '@' itself use "@-@". Examples:
4438 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004439 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 "a-z,A-Z,@-@" All letters plus the '@' character.
4441 A comma can be included by using it where a character number is
4442 expected. Example:
4443 "48-57,,,_" Digits, comma and underscore.
4444 A comma can be excluded by prepending a '^'. Example:
4445 " -~,^,,9" All characters from space to '~', excluding
4446 comma, plus <Tab>.
4447 See |option-backslash| about including spaces and backslashes.
4448
4449 *'isident'* *'isi'*
4450'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4451 "@,48-57,_,128-167,224-235"
4452 otherwise: "@,48-57,_,192-255")
4453 global
4454 {not in Vi}
4455 The characters given by this option are included in identifiers.
4456 Identifiers are used in recognizing environment variables and after a
4457 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004458 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 option.
4460 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004461 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4463
4464 *'iskeyword'* *'isk'*
4465'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4466 "@,48-57,_,128-167,224-235"
4467 otherwise: "@,48-57,_,192-255"
4468 Vi default: "@,48-57,_")
4469 local to buffer
4470 {not in Vi}
4471 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004472 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 'isfname' for a description of the format of this option. For C
4474 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4475 For a help file it is set to all non-blank printable characters except
4476 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4477 command).
4478 When the 'lisp' option is on the '-' character is always included.
4479 NOTE: This option is set to the Vi default value when 'compatible' is
4480 set and to the Vim default value when 'compatible' is reset.
4481
4482 *'isprint'* *'isp'*
4483'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4484 "@,~-255"; otherwise: "@,161-255")
4485 global
4486 {not in Vi}
4487 The characters given by this option are displayed directly on the
4488 screen. It is also used for "\p" in a |pattern|. The characters from
4489 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4490 even when they are not included in 'isprint' or excluded. See
4491 'isfname' for a description of the format of this option.
4492
4493 Non-printable characters are displayed with two characters:
4494 0 - 31 "^@" - "^_"
4495 32 - 126 always single characters
4496 127 "^?"
4497 128 - 159 "~@" - "~_"
4498 160 - 254 "| " - "|~"
4499 255 "~?"
4500 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4501 displayed as <xx>, with the hexadecimal value of the byte.
4502 When 'display' contains "uhex" all unprintable characters are
4503 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004504 The SpecialKey highlighting will be used for unprintable characters.
4505 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506
4507 Multi-byte characters 256 and above are always included, only the
4508 characters up to 255 are specified with this option. When a character
4509 is printable but it is not available in the current font, a
4510 replacement character will be shown.
4511 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4512 There is no option to specify these characters.
4513
4514 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4515'joinspaces' 'js' boolean (default on)
4516 global
4517 {not in Vi}
4518 Insert two spaces after a '.', '?' and '!' with a join command.
4519 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4520 Otherwise only one space is inserted.
4521 NOTE: This option is set when 'compatible' is set.
4522
4523 *'key'*
4524'key' string (default "")
4525 local to buffer
4526 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004527 {only available when compiled with the |+cryptv|
4528 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004530 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 Careful: Do not set the key value by hand, someone might see the typed
4532 key. Use the |:X| command. But you can make 'key' empty: >
4533 :set key=
4534< It is not possible to get the value of this option with ":set key" or
4535 "echo &key". This is to avoid showing it to someone who shouldn't
4536 know. It also means you cannot see it yourself once you have set it,
4537 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004538 You can use "&key" in an expression to detect whether encryption is
4539 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
4541 *'keymap'* *'kmp'* *E544*
4542'keymap' 'kmp' string (default "")
4543 local to buffer
4544 {not in Vi}
4545 {only available when compiled with the |+keymap|
4546 feature}
4547 Name of a keyboard mapping. See |mbyte-keymap|.
4548 Setting this option to a valid keymap name has the side effect of
4549 setting 'iminsert' to one, so that the keymap becomes effective.
4550 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004551 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004552
4553 *'keymodel'* *'km'*
4554'keymodel' 'km' string (default "")
4555 global
4556 {not in Vi}
4557 List of comma separated words, which enable special things that keys
4558 can do. These values can be used:
4559 startsel Using a shifted special key starts selection (either
4560 Select mode or Visual mode, depending on "key" being
4561 present in 'selectmode').
4562 stopsel Using a not-shifted special key stops selection.
4563 Special keys in this context are the cursor keys, <End>, <Home>,
4564 <PageUp> and <PageDown>.
4565 The 'keymodel' option is set by the |:behave| command.
4566
4567 *'keywordprg'* *'kp'*
4568'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4569 OS/2: "view /", VMS: "help")
4570 global or local to buffer |global-local|
4571 {not in Vi}
4572 Program to use for the |K| command. Environment variables are
4573 expanded |:set_env|. ":help" may be used to access the Vim internal
4574 help. (Note that previously setting the global option to the empty
4575 value did this, which is now deprecated.)
4576 When "man" is used, Vim will automatically translate a count for the
4577 "K" command to a section number. Also for "man -s", in which case the
4578 "-s" is removed when there is no count.
4579 See |option-backslash| about including spaces and backslashes.
4580 Example: >
4581 :set keywordprg=man\ -s
4582< This option cannot be set from a |modeline| or in the |sandbox|, for
4583 security reasons.
4584
4585 *'langmap'* *'lmap'* *E357* *E358*
4586'langmap' 'lmap' string (default "")
4587 global
4588 {not in Vi}
4589 {only available when compiled with the |+langmap|
4590 feature}
4591 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004592 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 inserted directly. When in command mode the 'langmap' option takes
4594 care of translating these special characters to the original meaning
4595 of the key. This means you don't have to change the keyboard mode to
4596 be able to execute Normal mode commands.
4597 This is the opposite of the 'keymap' option, where characters are
4598 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004599 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4600 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004601 This option cannot be set from a |modeline| or in the |sandbox|, for
4602 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004604 Example (for Greek, in UTF-8): *greek* >
4605 :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 +00004606< Example (exchanges meaning of z and y for commands): >
4607 :set langmap=zy,yz,ZY,YZ
4608<
4609 The 'langmap' option is a list of parts, separated with commas. Each
4610 part can be in one of two forms:
4611 1. A list of pairs. Each pair is a "from" character immediately
4612 followed by the "to" character. Examples: "aA", "aAbBcC".
4613 2. A list of "from" characters, a semi-colon and a list of "to"
4614 characters. Example: "abc;ABC"
4615 Example: "aA,fgh;FGH,cCdDeE"
4616 Special characters need to be preceded with a backslash. These are
4617 ";", ',' and backslash itself.
4618
4619 This will allow you to activate vim actions without having to switch
4620 back and forth between the languages. Your language characters will
4621 be understood as normal vim English characters (according to the
4622 langmap mappings) in the following cases:
4623 o Normal/Visual mode (commands, buffer/register names, user mappings)
4624 o Insert/Replace Mode: Register names after CTRL-R
4625 o Insert/Replace Mode: Mappings
4626 Characters entered in Command-line mode will NOT be affected by
4627 this option. Note that this option can be changed at any time
4628 allowing to switch between mappings for different languages/encodings.
4629 Use a mapping to avoid having to type it each time!
4630
4631 *'langmenu'* *'lm'*
4632'langmenu' 'lm' string (default "")
4633 global
4634 {not in Vi}
4635 {only available when compiled with the |+menu| and
4636 |+multi_lang| features}
4637 Language to use for menu translation. Tells which file is loaded
4638 from the "lang" directory in 'runtimepath': >
4639 "lang/menu_" . &langmenu . ".vim"
4640< (without the spaces). For example, to always use the Dutch menus, no
4641 matter what $LANG is set to: >
4642 :set langmenu=nl_NL.ISO_8859-1
4643< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004644 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 If your $LANG is set to a non-English language but you do want to use
4646 the English menus: >
4647 :set langmenu=none
4648< This option must be set before loading menus, switching on filetype
4649 detection or syntax highlighting. Once the menus are defined setting
4650 this option has no effect. But you could do this: >
4651 :source $VIMRUNTIME/delmenu.vim
4652 :set langmenu=de_DE.ISO_8859-1
4653 :source $VIMRUNTIME/menu.vim
4654< Warning: This deletes all menus that you defined yourself!
4655
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004656 *'langnoremap'* *'lnr'*
4657'langnoremap' 'lnr' boolean (default off)
4658 global
4659 {not in Vi}
4660 {only available when compiled with the |+langmap|
4661 feature}
4662 When on, setting 'langmap' does not apply to characters resulting from
4663 a mapping. This basically means, if you noticed that setting
4664 'langmap' disables some of your mappings, try setting this option.
4665 This option defaults to off for backwards compatibility. Set it on if
4666 that works for you to avoid mappings to break.
4667
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 *'laststatus'* *'ls'*
4669'laststatus' 'ls' number (default 1)
4670 global
4671 {not in Vi}
4672 The value of this option influences when the last window will have a
4673 status line:
4674 0: never
4675 1: only if there are at least two windows
4676 2: always
4677 The screen looks nicer with a status line if you have several
4678 windows, but it takes another screen line. |status-line|
4679
4680 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4681'lazyredraw' 'lz' boolean (default off)
4682 global
4683 {not in Vi}
4684 When this option is set, the screen will not be redrawn while
4685 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004686 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 update use |:redraw|.
4688
4689 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4690'linebreak' 'lbr' boolean (default off)
4691 local to window
4692 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004693 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004695 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 than at the last character that fits on the screen. Unlike
4697 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004698 it only affects the way the file is displayed, not its contents.
4699 If 'breakindent' is set, line is visually indented. Then, the value
4700 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004701 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702 Note that <Tab> characters after an <EOL> are mostly not displayed
4703 with the right amount of white space.
4704
4705 *'lines'* *E593*
4706'lines' number (default 24 or terminal height)
4707 global
4708 Number of lines of the Vim window.
4709 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004710 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 When Vim is running in the GUI or in a resizable window, setting this
4712 option will cause the window size to be changed. When you only want
4713 to use the size for the GUI, put the command in your |gvimrc| file.
4714 Vim limits the number of lines to what fits on the screen. You can
4715 use this command to get the tallest window possible: >
4716 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004717< Minimum value is 2, maximum value is 1000.
4718 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 When you set this option and Vim is unable to change the physical
4720 number of lines of the display, the display may be messed up.
4721
4722 *'linespace'* *'lsp'*
4723'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4724 global
4725 {not in Vi}
4726 {only in the GUI}
4727 Number of pixel lines inserted between characters. Useful if the font
4728 uses the full character cell height, making lines touch each other.
4729 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004730 With some fonts there can be too much room between lines (to have
4731 space for ascents and descents). Then it makes sense to set
4732 'linespace' to a negative value. This may cause display problems
4733 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734
4735 *'lisp'* *'nolisp'*
4736'lisp' boolean (default off)
4737 local to buffer
4738 {not available when compiled without the |+lispindent|
4739 feature}
4740 Lisp mode: When <Enter> is typed in insert mode set the indent for
4741 the next line to Lisp standards (well, sort of). Also happens with
4742 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4743 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4744 better. Also see 'lispwords'.
4745 The '-' character is included in keyword characters. Redefines the
4746 "=" operator to use this same indentation algorithm rather than
4747 calling an external program if 'equalprg' is empty.
4748 This option is not used when 'paste' is set.
4749 {Vi: Does it a little bit differently}
4750
4751 *'lispwords'* *'lw'*
4752'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004753 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 {not in Vi}
4755 {not available when compiled without the |+lispindent|
4756 feature}
4757 Comma separated list of words that influence the Lisp indenting.
4758 |'lisp'|
4759
4760 *'list'* *'nolist'*
4761'list' boolean (default off)
4762 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004763 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4764 line. Useful to see the difference between tabs and spaces and for
4765 trailing blanks. Further changed by the 'listchars' option.
4766
4767 The cursor is displayed at the start of the space a Tab character
4768 occupies, not at the end as usual in Normal mode. To get this cursor
4769 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004770 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004771<
4772 Note that list mode will also affect formatting (set with 'textwidth'
4773 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 changing the way tabs are displayed.
4775
4776 *'listchars'* *'lcs'*
4777'listchars' 'lcs' string (default "eol:$")
4778 global
4779 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004780 Strings to use in 'list' mode and for the |:list| command. It is a
4781 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004782 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 eol:c Character to show at the end of each line. When
4784 omitted, there is no extra character at the end of the
4785 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004786 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004787 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004789 fill the space that the tab normally occupies.
4790 "tab:>-" will show a tab that takes four spaces as
4791 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004792 *lcs-space*
4793 space:c Character to show for a space. When omitted, spaces
4794 are left blank.
4795 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004796 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004797 trailing spaces are blank. Overrides the "space"
4798 setting for trailing spaces.
4799 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 extends:c Character to show in the last column, when 'wrap' is
4801 off and the line continues beyond the right of the
4802 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004803 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 precedes:c Character to show in the first column, when 'wrap'
4805 is off and there is text preceding the character
4806 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004807 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004808 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004809 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004810 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004811 nbsp:c Character to show for a non-breakable space character
4812 (0xA0 (160 decimal) and U+202F). Left blank when
4813 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004815 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004817 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818
4819 Examples: >
4820 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004821 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 :set lcs=extends:>,precedes:<
4823< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004824 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004825 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826
4827 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4828'loadplugins' 'lpl' boolean (default on)
4829 global
4830 {not in Vi}
4831 When on the plugin scripts are loaded when starting up |load-plugins|.
4832 This option can be reset in your |vimrc| file to disable the loading
4833 of plugins.
4834 Note that using the "-u NONE" and "--noplugin" command line arguments
4835 reset this option. |-u| |--noplugin|
4836
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004837 *'macatsui'* *'nomacatsui'*
4838'macatsui' boolean (default on)
4839 global
4840 {only available in Mac GUI version}
4841 This is a workaround for when drawing doesn't work properly. When set
4842 and compiled with multi-byte support ATSUI text drawing is used. When
4843 not set ATSUI text drawing is not used. Switch this option off when
4844 you experience drawing problems. In a future version the problems may
4845 be solved and this option becomes obsolete. Therefore use this method
4846 to unset it: >
4847 if exists('&macatsui')
4848 set nomacatsui
4849 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004850< Another option to check if you have drawing problems is
4851 'termencoding'.
4852
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 *'magic'* *'nomagic'*
4854'magic' boolean (default on)
4855 global
4856 Changes the special characters that can be used in search patterns.
4857 See |pattern|.
4858 NOTE: To avoid portability problems with using patterns, always keep
4859 this option at the default "on". Only switch it off when working with
4860 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004861 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004862
4863 *'makeef'* *'mef'*
4864'makeef' 'mef' string (default: "")
4865 global
4866 {not in Vi}
4867 {not available when compiled without the |+quickfix|
4868 feature}
4869 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4870 and the |:grep| command.
4871 When it is empty, an internally generated temp file will be used.
4872 When "##" is included, it is replaced by a number to make the name
4873 unique. This makes sure that the ":make" command doesn't overwrite an
4874 existing file.
4875 NOT used for the ":cf" command. See 'errorfile' for that.
4876 Environment variables are expanded |:set_env|.
4877 See |option-backslash| about including spaces and backslashes.
4878 This option cannot be set from a |modeline| or in the |sandbox|, for
4879 security reasons.
4880
4881 *'makeprg'* *'mp'*
4882'makeprg' 'mp' string (default "make", VMS: "MMS")
4883 global or local to buffer |global-local|
4884 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004885 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004886 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4887 which are expanded to the current and alternate file name. Use |::S|
4888 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004889 Environment variables are expanded |:set_env|. See |option-backslash|
4890 about including spaces and backslashes.
4891 Note that a '|' must be escaped twice: once for ":set" and once for
4892 the interpretation of a command. When you use a filter called
4893 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 :set makeprg=gmake\ \\\|\ myfilter
4895< The placeholder "$*" can be given (even multiple times) to specify
4896 where the arguments will be included, for example: >
4897 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4898< This option cannot be set from a |modeline| or in the |sandbox|, for
4899 security reasons.
4900
4901 *'matchpairs'* *'mps'*
4902'matchpairs' 'mps' string (default "(:),{:},[:]")
4903 local to buffer
4904 {not in Vi}
4905 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004906 other.
4907 Only character pairs are allowed that are different, thus you cannot
4908 jump between two double quotes.
4909 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004910 The pairs must be separated by a comma. Example for including '<' and
4911 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 :set mps+=<:>
4913
4914< A more exotic example, to jump between the '=' and ';' in an
4915 assignment, useful for languages like C and Java: >
4916 :au FileType c,cpp,java set mps+==:;
4917
4918< For a more advanced way of using "%", see the matchit.vim plugin in
4919 the $VIMRUNTIME/macros directory. |add-local-help|
4920
4921 *'matchtime'* *'mat'*
4922'matchtime' 'mat' number (default 5)
4923 global
4924 {not in Vi}{in Nvi}
4925 Tenths of a second to show the matching paren, when 'showmatch' is
4926 set. Note that this is not in milliseconds, like other options that
4927 set a time. This is to be compatible with Nvi.
4928
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004929 *'maxcombine'* *'mco'*
4930'maxcombine' 'mco' number (default 2)
4931 global
4932 {not in Vi}
4933 {only available when compiled with the |+multi_byte|
4934 feature}
4935 The maximum number of combining characters supported for displaying.
4936 Only used when 'encoding' is "utf-8".
4937 The default is OK for most languages. Hebrew may require 4.
4938 Maximum value is 6.
4939 Even when this option is set to 2 you can still edit text with more
4940 combining characters, you just can't see them. Use |g8| or |ga|.
4941 See |mbyte-combining|.
4942
Bram Moolenaar071d4272004-06-13 20:20:40 +00004943 *'maxfuncdepth'* *'mfd'*
4944'maxfuncdepth' 'mfd' number (default 100)
4945 global
4946 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004947 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004948 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 Maximum depth of function calls for user functions. This normally
4950 catches endless recursion. When using a recursive function with
4951 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4952 more memory, there is the danger of failing when memory is exhausted.
4953 See also |:function|.
4954
4955 *'maxmapdepth'* *'mmd'* *E223*
4956'maxmapdepth' 'mmd' number (default 1000)
4957 global
4958 {not in Vi}
4959 Maximum number of times a mapping is done without resulting in a
4960 character to be used. This normally catches endless mappings, like
4961 ":map x y" with ":map y x". It still does not catch ":map g wg",
4962 because the 'w' is used before the next mapping is done. See also
4963 |key-mapping|.
4964
4965 *'maxmem'* *'mm'*
4966'maxmem' 'mm' number (default between 256 to 5120 (system
4967 dependent) or half the amount of memory
4968 available)
4969 global
4970 {not in Vi}
4971 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4972 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004973 other memory to be freed. The maximum usable value is about 2000000.
4974 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004976 *'maxmempattern'* *'mmp'*
4977'maxmempattern' 'mmp' number (default 1000)
4978 global
4979 {not in Vi}
4980 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004981 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004982 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004983 When Vim runs into the limit it gives an error message and mostly
4984 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004985 Running into the limit often means that the pattern is very
4986 inefficient or too complex. This may already happen with the pattern
4987 "\(.\)*" on a very long line. ".*" works much better.
4988 Vim may run out of memory before hitting the 'maxmempattern' limit.
4989
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 *'maxmemtot'* *'mmt'*
4991'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4992 dependent) or half the amount of memory
4993 available)
4994 global
4995 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004996 Maximum amount of memory in Kbyte to use for all buffers together.
4997 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4998 without a limit. On 64 bit machines higher values might work. But
4999 hey, do you really need more than 2 Gbyte for text editing?
5000 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001
5002 *'menuitems'* *'mis'*
5003'menuitems' 'mis' number (default 25)
5004 global
5005 {not in Vi}
5006 {not available when compiled without the |+menu|
5007 feature}
5008 Maximum number of items to use in a menu. Used for menus that are
5009 generated from a list of items, e.g., the Buffers menu. Changing this
5010 option has no direct effect, the menu must be refreshed first.
5011
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005012 *'mkspellmem'* *'msm'*
5013'mkspellmem' 'msm' string (default "460000,2000,500")
5014 global
5015 {not in Vi}
5016 {not available when compiled without the |+syntax|
5017 feature}
5018 Parameters for |:mkspell|. This tunes when to start compressing the
5019 word tree. Compression can be slow when there are many words, but
5020 it's needed to avoid running out of memory. The amount of memory used
5021 per word depends very much on how similar the words are, that's why
5022 this tuning is complicated.
5023
5024 There are three numbers, separated by commas:
5025 {start},{inc},{added}
5026
5027 For most languages the uncompressed word tree fits in memory. {start}
5028 gives the amount of memory in Kbyte that can be used before any
5029 compression is done. It should be a bit smaller than the amount of
5030 memory that is available to Vim.
5031
5032 When going over the {start} limit the {inc} number specifies the
5033 amount of memory in Kbyte that can be allocated before another
5034 compression is done. A low number means compression is done after
5035 less words are added, which is slow. A high number means more memory
5036 will be allocated.
5037
5038 After doing compression, {added} times 1024 words can be added before
5039 the {inc} limit is ignored and compression is done when any extra
5040 amount of memory is needed. A low number means there is a smaller
5041 chance of hitting the {inc} limit, less memory is used but it's
5042 slower.
5043
5044 The languages for which these numbers are important are Italian and
5045 Hungarian. The default works for when you have about 512 Mbyte. If
5046 you have 1 Gbyte you could use: >
5047 :set mkspellmem=900000,3000,800
5048< If you have less than 512 Mbyte |:mkspell| may fail for some
5049 languages, no matter what you set 'mkspellmem' to.
5050
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005052'modeline' 'ml' boolean (Vim default: on (off for root),
5053 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 local to buffer
5055 *'modelines'* *'mls'*
5056'modelines' 'mls' number (default 5)
5057 global
5058 {not in Vi}
5059 If 'modeline' is on 'modelines' gives the number of lines that is
5060 checked for set commands. If 'modeline' is off or 'modelines' is zero
5061 no lines are checked. See |modeline|.
5062 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5063 set and to the Vim default value when 'compatible' is reset.
5064
5065 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5066'modifiable' 'ma' boolean (default on)
5067 local to buffer
5068 {not in Vi} *E21*
5069 When off the buffer contents cannot be changed. The 'fileformat' and
5070 'fileencoding' options also can't be changed.
5071 Can be reset with the |-M| command line argument.
5072
5073 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5074'modified' 'mod' boolean (default off)
5075 local to buffer
5076 {not in Vi}
5077 When on, the buffer is considered to be modified. This option is set
5078 when:
5079 1. A change was made to the text since it was last written. Using the
5080 |undo| command to go back to the original text will reset the
5081 option. But undoing changes that were made before writing the
5082 buffer will set the option again, since the text is different from
5083 when it was written.
5084 2. 'fileformat' or 'fileencoding' is different from its original
5085 value. The original value is set when the buffer is read or
5086 written. A ":set nomodified" command also resets the original
5087 values to the current values and the 'modified' option will be
5088 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005089 This option is not set when a change is made to the buffer as the
5090 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5091 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5092 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5094 will be ignored.
5095
5096 *'more'* *'nomore'*
5097'more' boolean (Vim default: on, Vi default: off)
5098 global
5099 {not in Vi}
5100 When on, listings pause when the whole screen is filled. You will get
5101 the |more-prompt|. When this option is off there are no pauses, the
5102 listing continues until finished.
5103 NOTE: This option is set to the Vi default value when 'compatible' is
5104 set and to the Vim default value when 'compatible' is reset.
5105
5106 *'mouse'* *E538*
5107'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5108 global
5109 {not in Vi}
5110 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005111 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5112 sysmouse and Linux console with gpm). For using the mouse in the
5113 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 The mouse can be enabled for different modes:
5115 n Normal mode
5116 v Visual mode
5117 i Insert mode
5118 c Command-line mode
5119 h all previous modes when editing a help file
5120 a all previous modes
5121 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 Normally you would enable the mouse in all four modes with: >
5123 :set mouse=a
5124< When the mouse is not enabled, the GUI will still use the mouse for
5125 modeless selection. This doesn't move the text cursor.
5126
5127 See |mouse-using|. Also see |'clipboard'|.
5128
5129 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005130 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131 the mouse buttons can still be used by keeping the shift key pressed.
5132 Also see the 'clipboard' option.
5133
5134 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5135'mousefocus' 'mousef' boolean (default off)
5136 global
5137 {not in Vi}
5138 {only works in the GUI}
5139 The window that the mouse pointer is on is automatically activated.
5140 When changing the window layout or window focus in another way, the
5141 mouse pointer is moved to the window with keyboard focus. Off is the
5142 default because it makes using the pull down menus a little goofy, as
5143 a pointer transit may activate a window unintentionally.
5144
5145 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5146'mousehide' 'mh' boolean (default on)
5147 global
5148 {not in Vi}
5149 {only works in the GUI}
5150 When on, the mouse pointer is hidden when characters are typed.
5151 The mouse pointer is restored when the mouse is moved.
5152
5153 *'mousemodel'* *'mousem'*
5154'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5155 global
5156 {not in Vi}
5157 Sets the model to use for the mouse. The name mostly specifies what
5158 the right mouse button is used for:
5159 extend Right mouse button extends a selection. This works
5160 like in an xterm.
5161 popup Right mouse button pops up a menu. The shifted left
5162 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005163 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 popup_setpos Like "popup", but the cursor will be moved to the
5165 position where the mouse was clicked, and thus the
5166 selected operation will act upon the clicked object.
5167 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005168 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 course, that right clicking outside a selection will
5170 end Visual mode.
5171 Overview of what button does what for each model:
5172 mouse extend popup(_setpos) ~
5173 left click place cursor place cursor
5174 left drag start selection start selection
5175 shift-left search word extend selection
5176 right click extend selection popup menu (place cursor)
5177 right drag extend selection -
5178 middle click paste paste
5179
5180 In the "popup" model the right mouse button produces a pop-up menu.
5181 You need to define this first, see |popup-menu|.
5182
5183 Note that you can further refine the meaning of buttons with mappings.
5184 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5185 selection (because that's handled in the GUI code directly).
5186
5187 The 'mousemodel' option is set by the |:behave| command.
5188
5189 *'mouseshape'* *'mouses'* *E547*
5190'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005191 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 global
5193 {not in Vi}
5194 {only available when compiled with the |+mouseshape|
5195 feature}
5196 This option tells Vim what the mouse pointer should look like in
5197 different modes. The option is a comma separated list of parts, much
5198 like used for 'guicursor'. Each part consist of a mode/location-list
5199 and an argument-list:
5200 mode-list:shape,mode-list:shape,..
5201 The mode-list is a dash separated list of these modes/locations:
5202 In a normal window: ~
5203 n Normal mode
5204 v Visual mode
5205 ve Visual mode with 'selection' "exclusive" (same as 'v',
5206 if not specified)
5207 o Operator-pending mode
5208 i Insert mode
5209 r Replace mode
5210
5211 Others: ~
5212 c appending to the command-line
5213 ci inserting in the command-line
5214 cr replacing in the command-line
5215 m at the 'Hit ENTER' or 'More' prompts
5216 ml idem, but cursor in the last line
5217 e any mode, pointer below last window
5218 s any mode, pointer on a status line
5219 sd any mode, while dragging a status line
5220 vs any mode, pointer on a vertical separator line
5221 vd any mode, while dragging a vertical separator line
5222 a everywhere
5223
5224 The shape is one of the following:
5225 avail name looks like ~
5226 w x arrow Normal mouse pointer
5227 w x blank no pointer at all (use with care!)
5228 w x beam I-beam
5229 w x updown up-down sizing arrows
5230 w x leftright left-right sizing arrows
5231 w x busy The system's usual busy pointer
5232 w x no The system's usual 'no input' pointer
5233 x udsizing indicates up-down resizing
5234 x lrsizing indicates left-right resizing
5235 x crosshair like a big thin +
5236 x hand1 black hand
5237 x hand2 white hand
5238 x pencil what you write with
5239 x question big ?
5240 x rightup-arrow arrow pointing right-up
5241 w x up-arrow arrow pointing up
5242 x <number> any X11 pointer number (see X11/cursorfont.h)
5243
5244 The "avail" column contains a 'w' if the shape is available for Win32,
5245 x for X11.
5246 Any modes not specified or shapes not available use the normal mouse
5247 pointer.
5248
5249 Example: >
5250 :set mouseshape=s:udsizing,m:no
5251< will make the mouse turn to a sizing arrow over the status lines and
5252 indicate no input when the hit-enter prompt is displayed (since
5253 clicking the mouse has no effect in this state.)
5254
5255 *'mousetime'* *'mouset'*
5256'mousetime' 'mouset' number (default 500)
5257 global
5258 {not in Vi}
5259 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5260 time in msec between two mouse clicks for the second click to be
5261 recognized as a multi click.
5262
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005263 *'mzquantum'* *'mzq'*
5264'mzquantum' 'mzq' number (default 100)
5265 global
5266 {not in Vi}
5267 {not available when compiled without the |+mzscheme|
5268 feature}
5269 The number of milliseconds between polls for MzScheme threads.
5270 Negative or zero value means no thread scheduling.
5271
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 *'nrformats'* *'nf'*
5273'nrformats' 'nf' string (default "octal,hex")
5274 local to buffer
5275 {not in Vi}
5276 This defines what bases Vim will consider for numbers when using the
5277 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5278 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005279 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005281 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005282 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005284 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 considered to be hexadecimal. Example: Using CTRL-X on
5286 "0x100" results in "0x0ff".
5287 Numbers which simply begin with a digit in the range 1-9 are always
5288 considered decimal. This also happens for numbers that are not
5289 recognized as octal or hex.
5290
5291 *'number'* *'nu'* *'nonumber'* *'nonu'*
5292'number' 'nu' boolean (default off)
5293 local to window
5294 Print the line number in front of each line. When the 'n' option is
5295 excluded from 'cpoptions' a wrapped line will not use the column of
5296 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005297 The 'numberwidth' option can be used to set the room used for the line
5298 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 When a long, wrapped line doesn't start with the first character, '-'
5300 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005301 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5302 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005303 *number_relativenumber*
5304 The 'relativenumber' option changes the displayed number to be
5305 relative to the cursor. Together with 'number' there are these
5306 four combinations (cursor in line 3):
5307
5308 'nonu' 'nu' 'nonu' 'nu'
5309 'nornu' 'nornu' 'rnu' 'rnu'
5310
5311 |apple | 1 apple | 2 apple | 2 apple
5312 |pear | 2 pear | 1 pear | 1 pear
5313 |nobody | 3 nobody | 0 nobody |3 nobody
5314 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005315
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005316 *'numberwidth'* *'nuw'*
5317'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5318 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005319 {not in Vi}
5320 {only available when compiled with the |+linebreak|
5321 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005322 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005323 when the 'number' or 'relativenumber' option is set or printing lines
5324 with a line number. Since one space is always between the number and
5325 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005326 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005327 fit the highest line number in the buffer respectively the number of
5328 rows in the window, depending on whether 'number' or 'relativenumber'
5329 is set. Thus with the Vim default of 4 there is room for a line number
5330 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005331 The minimum value is 1, the maximum value is 10.
5332 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5333
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005334 *'omnifunc'* *'ofu'*
5335'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005336 local to buffer
5337 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005338 {not available when compiled without the |+eval|
5339 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005340 This option specifies a function to be used for Insert mode omni
5341 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005342 See |complete-functions| for an explanation of how the function is
5343 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005344 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005345 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005346 This option cannot be set from a |modeline| or in the |sandbox|, for
5347 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005348
5349
Bram Moolenaar02467872007-05-06 13:22:01 +00005350 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005351'opendevice' 'odev' boolean (default off)
5352 global
5353 {not in Vi}
5354 {only for MS-DOS, MS-Windows and OS/2}
5355 Enable reading and writing from devices. This may get Vim stuck on a
5356 device that can be opened but doesn't actually do the I/O. Therefore
5357 it is off by default.
5358 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5359 result in editing a device.
5360
5361
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005362 *'operatorfunc'* *'opfunc'*
5363'operatorfunc' 'opfunc' string (default: empty)
5364 global
5365 {not in Vi}
5366 This option specifies a function to be called by the |g@| operator.
5367 See |:map-operator| for more info and an example.
5368
5369 This option cannot be set from a |modeline| or in the |sandbox|, for
5370 security reasons.
5371
5372
Bram Moolenaar251e1912011-06-19 05:09:16 +02005373 *'osfiletype'* *'oft'*
5374'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 local to buffer
5376 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005377 This option was supported on RISC OS, which has been removed.
5378
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005381'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 global
5383 Specifies the nroff macros that separate paragraphs. These are pairs
5384 of two letters (see |object-motions|).
5385
5386 *'paste'* *'nopaste'*
5387'paste' boolean (default off)
5388 global
5389 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005390 Put Vim in Paste mode. This is useful if you want to cut or copy
5391 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 unexpected effects.
5393 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005394 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 knows about pasting and will mostly do the right thing without 'paste'
5396 being set. The same is true for a terminal where Vim handles the
5397 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005398 This option is reset when starting the GUI. Thus if you set it in
5399 your .vimrc it will work in a terminal, but not in the GUI. Setting
5400 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5401 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 When the 'paste' option is switched on (also when it was already on):
5403 - mapping in Insert mode and Command-line mode is disabled
5404 - abbreviations are disabled
5405 - 'textwidth' is set to 0
5406 - 'wrapmargin' is set to 0
5407 - 'autoindent' is reset
5408 - 'smartindent' is reset
5409 - 'softtabstop' is set to 0
5410 - 'revins' is reset
5411 - 'ruler' is reset
5412 - 'showmatch' is reset
5413 - 'formatoptions' is used like it is empty
5414 These options keep their value, but their effect is disabled:
5415 - 'lisp'
5416 - 'indentexpr'
5417 - 'cindent'
5418 NOTE: When you start editing another file while the 'paste' option is
5419 on, settings from the modelines or autocommands may change the
5420 settings again, causing trouble when pasting text. You might want to
5421 set the 'paste' option again.
5422 When the 'paste' option is reset the mentioned options are restored to
5423 the value before the moment 'paste' was switched from off to on.
5424 Resetting 'paste' before ever setting it does not have any effect.
5425 Since mapping doesn't work while 'paste' is active, you need to use
5426 the 'pastetoggle' option to toggle the 'paste' option with some key.
5427
5428 *'pastetoggle'* *'pt'*
5429'pastetoggle' 'pt' string (default "")
5430 global
5431 {not in Vi}
5432 When non-empty, specifies the key sequence that toggles the 'paste'
5433 option. This is like specifying a mapping: >
5434 :map {keys} :set invpaste<CR>
5435< Where {keys} is the value of 'pastetoggle'.
5436 The difference is that it will work even when 'paste' is set.
5437 'pastetoggle' works in Insert mode and Normal mode, but not in
5438 Command-line mode.
5439 Mappings are checked first, thus overrule 'pastetoggle'. However,
5440 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5441 this: >
5442 :map <F10> :set paste<CR>
5443 :map <F11> :set nopaste<CR>
5444 :imap <F10> <C-O>:set paste<CR>
5445 :imap <F11> <nop>
5446 :set pastetoggle=<F11>
5447< This will make <F10> start paste mode and <F11> stop paste mode.
5448 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5449 mode everything is inserted literally, except the 'pastetoggle' key
5450 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005451 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
5453 *'pex'* *'patchexpr'*
5454'patchexpr' 'pex' string (default "")
5455 global
5456 {not in Vi}
5457 {not available when compiled without the |+diff|
5458 feature}
5459 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005460 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461
Bram Moolenaardbc28022014-07-26 13:40:44 +02005462 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005463'patchmode' 'pm' string (default "")
5464 global
5465 {not in Vi}
5466 When non-empty the oldest version of a file is kept. This can be used
5467 to keep the original version of a file if you are changing files in a
5468 source distribution. Only the first time that a file is written a
5469 copy of the original file will be kept. The name of the copy is the
5470 name of the original file with the string in the 'patchmode' option
5471 appended. This option should start with a dot. Use a string like
5472 ".org". 'backupdir' must not be empty for this to work (Detail: The
5473 backup file is renamed to the patchmode file after the new file has
5474 been successfully written, that's why it must be possible to write a
5475 backup file). If there was no file to be backed up, an empty file is
5476 created.
5477 When the 'backupskip' pattern matches, a patchmode file is not made.
5478 Using 'patchmode' for compressed files appends the extension at the
5479 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5480 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005481 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005483 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005484'path' 'pa' string (default on Unix: ".,/usr/include,,"
5485 on OS/2: ".,/emx/include,,"
5486 other systems: ".,,")
5487 global or local to buffer |global-local|
5488 {not in Vi}
5489 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005490 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5491 provided that the file being searched for has a relative path (not
5492 starting with "/", "./" or "../"). The directories in the 'path'
5493 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 - Use commas to separate directory names: >
5495 :set path=.,/usr/local/include,/usr/include
5496< - Spaces can also be used to separate directory names (for backwards
5497 compatibility with version 3.0). To have a space in a directory
5498 name, precede it with an extra backslash, and escape the space: >
5499 :set path=.,/dir/with\\\ space
5500< - To include a comma in a directory name precede it with an extra
5501 backslash: >
5502 :set path=.,/dir/with\\,comma
5503< - To search relative to the directory of the current file, use: >
5504 :set path=.
5505< - To search in the current directory use an empty string between two
5506 commas: >
5507 :set path=,,
5508< - A directory name may end in a ':' or '/'.
5509 - Environment variables are expanded |:set_env|.
5510 - When using |netrw.vim| URLs can be used. For example, adding
5511 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005512 - Search upwards and downwards in a directory tree using "*", "**" and
5513 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 {not available when compiled without the |+path_extra| feature}
5515 - Careful with '\' characters, type two to get one in the option: >
5516 :set path=.,c:\\include
5517< Or just use '/' instead: >
5518 :set path=.,c:/include
5519< Don't forget "." or files won't even be found in the same directory as
5520 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005521 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 it is something like 256 or 1024 characters.
5523 You can check if all the include files are found, using the value of
5524 'path', see |:checkpath|.
5525 The use of |:set+=| and |:set-=| is preferred when adding or removing
5526 directories from the list. This avoids problems when a future version
5527 uses another default. To remove the current directory use: >
5528 :set path-=
5529< To add the current directory use: >
5530 :set path+=
5531< To use an environment variable, you probably need to replace the
5532 separator. Here is an example to append $INCL, in which directory
5533 names are separated with a semi-colon: >
5534 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5535< Replace the ';' with a ':' or whatever separator is used. Note that
5536 this doesn't work when $INCL contains a comma or white space.
5537
5538 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5539'preserveindent' 'pi' boolean (default off)
5540 local to buffer
5541 {not in Vi}
5542 When changing the indent of the current line, preserve as much of the
5543 indent structure as possible. Normally the indent is replaced by a
5544 series of tabs followed by spaces as required (unless |'expandtab'| is
5545 enabled, in which case only spaces are used). Enabling this option
5546 means the indent will preserve as many existing characters as possible
5547 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005548 'expandtab' does not apply to the preserved white space, a Tab remains
5549 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 NOTE: When using ">>" multiple times the resulting indent is a mix of
5551 tabs and spaces. You might not like this.
5552 NOTE: 'preserveindent' is reset when 'compatible' is set.
5553 Also see 'copyindent'.
5554 Use |:retab| to clean up white space.
5555
5556 *'previewheight'* *'pvh'*
5557'previewheight' 'pvh' number (default 12)
5558 global
5559 {not in Vi}
5560 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005561 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 Default height for a preview window. Used for |:ptag| and associated
5563 commands. Used for |CTRL-W_}| when no count is given.
5564
5565 *'previewwindow'* *'nopreviewwindow'*
5566 *'pvw'* *'nopvw'* *E590*
5567'previewwindow' 'pvw' boolean (default off)
5568 local to window
5569 {not in Vi}
5570 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005571 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005572 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 set. It's normally not set directly, but by using one of the commands
5574 |:ptag|, |:pedit|, etc.
5575
5576 *'printdevice'* *'pdev'*
5577'printdevice' 'pdev' string (default empty)
5578 global
5579 {not in Vi}
5580 {only available when compiled with the |+printer|
5581 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005582 The name of the printer to be used for |:hardcopy|.
5583 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005584 This option cannot be set from a |modeline| or in the |sandbox|, for
5585 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586
Bram Moolenaar8299df92004-07-10 09:47:34 +00005587 *'printencoding'* *'penc'*
5588'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 global
5590 {not in Vi}
5591 {only available when compiled with the |+printer|
5592 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005593 Sets the character encoding used when printing.
5594 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595
5596 *'printexpr'* *'pexpr'*
5597'printexpr' 'pexpr' String (default: see below)
5598 global
5599 {not in Vi}
5600 {only available when compiled with the |+printer|
5601 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005602 Expression used to print the PostScript produced with |:hardcopy|.
5603 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604
Bram Moolenaar8299df92004-07-10 09:47:34 +00005605 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606'printfont' 'pfn' string (default "courier")
5607 global
5608 {not in Vi}
5609 {only available when compiled with the |+printer|
5610 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005611 The name of the font that will be used for |:hardcopy|.
5612 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
5614 *'printheader'* *'pheader'*
5615'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5616 global
5617 {not in Vi}
5618 {only available when compiled with the |+printer|
5619 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005620 The format of the header produced in |:hardcopy| output.
5621 See |pheader-option|.
5622
5623 *'printmbcharset'* *'pmbcs'*
5624'printmbcharset' 'pmbcs' string (default "")
5625 global
5626 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005627 {only available when compiled with the |+printer|,
5628 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005629 The CJK character set to be used for CJK output from |:hardcopy|.
5630 See |pmbcs-option|.
5631
5632 *'printmbfont'* *'pmbfn'*
5633'printmbfont' 'pmbfn' string (default "")
5634 global
5635 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005636 {only available when compiled with the |+printer|,
5637 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005638 List of font names to be used for CJK output from |:hardcopy|.
5639 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005640
5641 *'printoptions'* *'popt'*
5642'printoptions' 'popt' string (default "")
5643 global
5644 {not in Vi}
5645 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005646 List of items that control the format of the output of |:hardcopy|.
5647 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005649 *'prompt'* *'noprompt'*
5650'prompt' boolean (default on)
5651 global
5652 When on a ":" prompt is used in Ex mode.
5653
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005654 *'pumheight'* *'ph'*
5655'pumheight' 'ph' number (default 0)
5656 global
5657 {not available when compiled without the
5658 |+insert_expand| feature}
5659 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005660 Determines the maximum number of items to show in the popup menu for
5661 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005662 |ins-completion-menu|.
5663
5664
Bram Moolenaar677ee682005-01-27 14:41:15 +00005665 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005666'quoteescape' 'qe' string (default "\")
5667 local to buffer
5668 {not in Vi}
5669 The characters that are used to escape quotes in a string. Used for
5670 objects like a', a" and a` |a'|.
5671 When one of the characters in this option is found inside a string,
5672 the following character will be skipped. The default value makes the
5673 text "foo\"bar\\" considered to be one string.
5674
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5676'readonly' 'ro' boolean (default off)
5677 local to buffer
5678 If on, writes fail unless you use a '!'. Protects you from
5679 accidentally overwriting a file. Default on when Vim is started
5680 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005681 When using ":w!" the 'readonly' option is reset for the current
5682 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005684 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005686 *'redrawtime'* *'rdt'*
5687'redrawtime' 'rdt' number (default 2000)
5688 global
5689 {not in Vi}
5690 {only available when compiled with the |+reltime|
5691 feature}
5692 The time in milliseconds for redrawing the display. This applies to
5693 searching for patterns for 'hlsearch' and |:match| highlighting.
5694 When redrawing takes more than this many milliseconds no further
5695 matches will be highlighted. This is used to avoid that Vim hangs
5696 when using a very complicated pattern.
5697
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005698 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005699'regexpengine' 're' number (default 0)
5700 global
5701 {not in Vi}
5702 This selects the default regexp engine. |two-engines|
5703 The possible values are:
5704 0 automatic selection
5705 1 old engine
5706 2 NFA engine
5707 Note that when using the NFA engine and the pattern contains something
5708 that is not supported the pattern will not match. This is only useful
5709 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005710 Using automatic selection enables Vim to switch the engine, if the
5711 default engine becomes too costly. E.g., when the NFA engine uses too
5712 many states. This should prevent Vim from hanging on a combination of
5713 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005714
Bram Moolenaar64486672010-05-16 15:46:46 +02005715 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5716'relativenumber' 'rnu' boolean (default off)
5717 local to window
5718 {not in Vi}
5719 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005720 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005721 precede some vertical motion commands (e.g. j k + -) with, without
5722 having to calculate it yourself. Especially useful in combination with
5723 other commands (e.g. y d c < > gq gw =).
5724 When the 'n' option is excluded from 'cpoptions' a wrapped
5725 line will not use the column of line numbers (this is the default when
5726 'compatible' isn't set).
5727 The 'numberwidth' option can be used to set the room used for the line
5728 number.
5729 When a long, wrapped line doesn't start with the first character, '-'
5730 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005731 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5732 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005733
5734 The number in front of the cursor line also depends on the value of
5735 'number', see |number_relativenumber| for all combinations of the two
5736 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005737
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 *'remap'* *'noremap'*
5739'remap' boolean (default on)
5740 global
5741 Allows for mappings to work recursively. If you do not want this for
5742 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005743 NOTE: To avoid portability problems with Vim scripts, always keep
5744 this option at the default "on". Only switch it off when working with
5745 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005747 *'renderoptions'* *'rop'*
5748'renderoptions' 'rop' string (default: empty)
5749 global
5750 {not in Vi}
5751 {only available when compiled with GUI and DIRECTX on
5752 MS-Windows}
5753 Select a text renderer and set its options. The options depend on the
5754 renderer.
5755
5756 Syntax: >
5757 set rop=type:{renderer}(,{name}:{value})*
5758<
5759 Currently, only one optional renderer is available.
5760
5761 render behavior ~
5762 directx Vim will draw text using DirectX (DirectWrite). It makes
5763 drawn glyphs more beautiful than default GDI.
5764 It requires 'encoding' is "utf-8", and only works on
5765 MS-Windows Vista or newer version.
5766
5767 Options:
5768 name meaning type value ~
5769 gamma gamma float 1.0 - 2.2 (maybe)
5770 contrast enhancedContrast float (unknown)
5771 level clearTypeLevel float (unknown)
5772 geom pixelGeometry int 0 - 2 (see below)
5773 renmode renderingMode int 0 - 6 (see below)
5774 taamode textAntialiasMode int 0 - 3 (see below)
5775
5776 See this URL for detail:
5777 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5778
5779 For geom: structure of a device pixel.
5780 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5781 1 - DWRITE_PIXEL_GEOMETRY_RGB
5782 2 - DWRITE_PIXEL_GEOMETRY_BGR
5783
5784 See this URL for detail:
5785 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5786
5787 For renmode: method of rendering glyphs.
5788 0 - DWRITE_RENDERING_MODE_DEFAULT
5789 1 - DWRITE_RENDERING_MODE_ALIASED
5790 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5791 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5792 4 - DWRITE_RENDERING_MODE_NATURAL
5793 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5794 6 - DWRITE_RENDERING_MODE_OUTLINE
5795
5796 See this URL for detail:
5797 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5798
5799 For taamode: antialiasing mode used for drawing text.
5800 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5801 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5802 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5803 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5804
5805 See this URL for detail:
5806 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5807
5808 Example: >
5809 set encoding=utf-8
5810 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5811 set rop=type:directx
5812<
5813 If select a raster font (Courier, Terminal or FixedSys) to
5814 'guifont', it fallbacks to be drawn by GDI automatically.
5815
5816 Other render types are currently not supported.
5817
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 *'report'*
5819'report' number (default 2)
5820 global
5821 Threshold for reporting number of lines changed. When the number of
5822 changed lines is more than 'report' a message will be given for most
5823 ":" commands. If you want it always, set 'report' to 0.
5824 For the ":substitute" command the number of substitutions is used
5825 instead of the number of lines.
5826
5827 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5828'restorescreen' 'rs' boolean (default on)
5829 global
5830 {not in Vi} {only in Windows 95/NT console version}
5831 When set, the screen contents is restored when exiting Vim. This also
5832 happens when executing external commands.
5833
5834 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5835 options in your .vimrc. To disable restoring:
5836 set t_ti= t_te=
5837 To enable restoring (for an xterm):
5838 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5839 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5840
5841 *'revins'* *'ri'* *'norevins'* *'nori'*
5842'revins' 'ri' boolean (default off)
5843 global
5844 {not in Vi}
5845 {only available when compiled with the |+rightleft|
5846 feature}
5847 Inserting characters in Insert mode will work backwards. See "typing
5848 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5849 command in Insert mode, when 'allowrevins' is set.
5850 NOTE: This option is reset when 'compatible' or 'paste' is set.
5851
5852 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5853'rightleft' 'rl' boolean (default off)
5854 local to window
5855 {not in Vi}
5856 {only available when compiled with the |+rightleft|
5857 feature}
5858 When on, display orientation becomes right-to-left, i.e., characters
5859 that are stored in the file appear from the right to the left.
5860 Using this option, it is possible to edit files for languages that
5861 are written from the right to the left such as Hebrew and Arabic.
5862 This option is per window, so it is possible to edit mixed files
5863 simultaneously, or to view the same file in both ways (this is
5864 useful whenever you have a mixed text file with both right-to-left
5865 and left-to-right strings so that both sets are displayed properly
5866 in different windows). Also see |rileft.txt|.
5867
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005868 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869'rightleftcmd' 'rlc' string (default "search")
5870 local to window
5871 {not in Vi}
5872 {only available when compiled with the |+rightleft|
5873 feature}
5874 Each word in this option enables the command line editing to work in
5875 right-to-left mode for a group of commands:
5876
5877 search "/" and "?" commands
5878
5879 This is useful for languages such as Hebrew, Arabic and Farsi.
5880 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5881
5882 *'ruler'* *'ru'* *'noruler'* *'noru'*
5883'ruler' 'ru' boolean (default off)
5884 global
5885 {not in Vi}
5886 {not available when compiled without the
5887 |+cmdline_info| feature}
5888 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005889 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005890 text in the file is shown on the far right:
5891 Top first line is visible
5892 Bot last line is visible
5893 All first and last line are visible
5894 45% relative position in the file
5895 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005896 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005898 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 this option takes precedence over 'ruler' and 'rulerformat'
5900 If the number of characters displayed is different from the number of
5901 bytes in the text (e.g., for a TAB or a multi-byte character), both
5902 the text column (byte number) and the screen column are shown,
5903 separated with a dash.
5904 For an empty line "0-1" is shown.
5905 For an empty buffer the line number will also be zero: "0,0-1".
5906 This option is reset when the 'paste' option is set.
5907 If you don't want to see the ruler all the time but want to know where
5908 you are, use "g CTRL-G" |g_CTRL-G|.
5909 NOTE: This option is reset when 'compatible' is set.
5910
5911 *'rulerformat'* *'ruf'*
5912'rulerformat' 'ruf' string (default empty)
5913 global
5914 {not in Vi}
5915 {not available when compiled without the |+statusline|
5916 feature}
5917 When this option is not empty, it determines the content of the ruler
5918 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005919 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 The default ruler width is 17 characters. To make the ruler 15
5921 characters wide, put "%15(" at the start and "%)" at the end.
5922 Example: >
5923 :set rulerformat=%15(%c%V\ %p%%%)
5924<
5925 *'runtimepath'* *'rtp'* *vimfiles*
5926'runtimepath' 'rtp' string (default:
5927 Unix: "$HOME/.vim,
5928 $VIM/vimfiles,
5929 $VIMRUNTIME,
5930 $VIM/vimfiles/after,
5931 $HOME/.vim/after"
5932 Amiga: "home:vimfiles,
5933 $VIM/vimfiles,
5934 $VIMRUNTIME,
5935 $VIM/vimfiles/after,
5936 home:vimfiles/after"
5937 PC, OS/2: "$HOME/vimfiles,
5938 $VIM/vimfiles,
5939 $VIMRUNTIME,
5940 $VIM/vimfiles/after,
5941 $HOME/vimfiles/after"
5942 Macintosh: "$VIM:vimfiles,
5943 $VIMRUNTIME,
5944 $VIM:vimfiles:after"
5945 RISC-OS: "Choices:vimfiles,
5946 $VIMRUNTIME,
5947 Choices:vimfiles/after"
5948 VMS: "sys$login:vimfiles,
5949 $VIM/vimfiles,
5950 $VIMRUNTIME,
5951 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005952 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 global
5954 {not in Vi}
5955 This is a list of directories which will be searched for runtime
5956 files:
5957 filetype.vim filetypes by file name |new-filetype|
5958 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005959 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005960 colors/ color scheme files |:colorscheme|
5961 compiler/ compiler files |:compiler|
5962 doc/ documentation |write-local-help|
5963 ftplugin/ filetype plugins |write-filetype-plugin|
5964 indent/ indent scripts |indent-expression|
5965 keymap/ key mapping files |mbyte-keymap|
5966 lang/ menu translations |:menutrans|
5967 menu.vim GUI menus |menu.vim|
5968 plugin/ plugin scripts |write-plugin|
5969 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005970 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 syntax/ syntax files |mysyntaxfile|
5972 tutor/ files for vimtutor |tutor|
5973
5974 And any other file searched for with the |:runtime| command.
5975
5976 The defaults for most systems are setup to search five locations:
5977 1. In your home directory, for your personal preferences.
5978 2. In a system-wide Vim directory, for preferences from the system
5979 administrator.
5980 3. In $VIMRUNTIME, for files distributed with Vim.
5981 *after-directory*
5982 4. In the "after" directory in the system-wide Vim directory. This is
5983 for the system administrator to overrule or add to the distributed
5984 defaults (rarely needed)
5985 5. In the "after" directory in your home directory. This is for
5986 personal preferences to overrule or add to the distributed defaults
5987 or system-wide settings (rarely needed).
5988
5989 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5990 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005991 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 wildcards.
5993 See |:runtime|.
5994 Example: >
5995 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5996< This will use the directory "~/vimruntime" first (containing your
5997 personal Vim runtime files), then "/mygroup/vim" (shared between a
5998 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5999 files).
6000 You probably should always include $VIMRUNTIME somewhere, to use the
6001 distributed runtime files. You can put a directory before $VIMRUNTIME
6002 to find files which replace a distributed runtime files. You can put
6003 a directory after $VIMRUNTIME to find files which add to distributed
6004 runtime files.
6005 This option cannot be set from a |modeline| or in the |sandbox|, for
6006 security reasons.
6007
6008 *'scroll'* *'scr'*
6009'scroll' 'scr' number (default: half the window height)
6010 local to window
6011 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6012 set to half the number of lines in the window when the window size
6013 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006014 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6016 the number of screen lines instead of file lines, makes a difference
6017 when lines wrap}
6018
6019 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6020'scrollbind' 'scb' boolean (default off)
6021 local to window
6022 {not in Vi}
6023 {not available when compiled without the |+scrollbind|
6024 feature}
6025 See also |scroll-binding|. When this option is set, the current
6026 window scrolls as other scrollbind windows (windows that also have
6027 this option set) scroll. This option is useful for viewing the
6028 differences between two versions of a file, see 'diff'.
6029 See |'scrollopt'| for options that determine how this option should be
6030 interpreted.
6031 This option is mostly reset when splitting a window to edit another
6032 file. This means that ":split | edit file" results in two windows
6033 with scroll-binding, but ":split file" does not.
6034
6035 *'scrolljump'* *'sj'*
6036'scrolljump' 'sj' number (default 1)
6037 global
6038 {not in Vi}
6039 Minimal number of lines to scroll when the cursor gets off the
6040 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6041 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006042 When set to a negative number from -1 to -100 this is used as the
6043 percentage of the window height. Thus -50 scrolls half the window
6044 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006045 NOTE: This option is set to 1 when 'compatible' is set.
6046
6047 *'scrolloff'* *'so'*
6048'scrolloff' 'so' number (default 0)
6049 global
6050 {not in Vi}
6051 Minimal number of screen lines to keep above and below the cursor.
6052 This will make some context visible around where you are working. If
6053 you set it to a very large value (999) the cursor line will always be
6054 in the middle of the window (except at the start or end of the file or
6055 when long lines wrap).
6056 For scrolling horizontally see 'sidescrolloff'.
6057 NOTE: This option is set to 0 when 'compatible' is set.
6058
6059 *'scrollopt'* *'sbo'*
6060'scrollopt' 'sbo' string (default "ver,jump")
6061 global
6062 {not available when compiled without the |+scrollbind|
6063 feature}
6064 {not in Vi}
6065 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006066 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6067 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 The following words are available:
6069 ver Bind vertical scrolling for 'scrollbind' windows
6070 hor Bind horizontal scrolling for 'scrollbind' windows
6071 jump Applies to the offset between two windows for vertical
6072 scrolling. This offset is the difference in the first
6073 displayed line of the bound windows. When moving
6074 around in a window, another 'scrollbind' window may
6075 reach a position before the start or after the end of
6076 the buffer. The offset is not changed though, when
6077 moving back the 'scrollbind' window will try to scroll
6078 to the desired position when possible.
6079 When now making that window the current one, two
6080 things can be done with the relative offset:
6081 1. When "jump" is not included, the relative offset is
6082 adjusted for the scroll position in the new current
6083 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006084 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 2. When "jump" is included, the other windows are
6086 scrolled to keep the same relative offset. When
6087 going back to the other window, it still uses the
6088 same relative offset.
6089 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006090 When 'diff' mode is active there always is vertical scroll binding,
6091 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092
6093 *'sections'* *'sect'*
6094'sections' 'sect' string (default "SHNHH HUnhsh")
6095 global
6096 Specifies the nroff macros that separate sections. These are pairs of
6097 two letters (See |object-motions|). The default makes a section start
6098 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6099
6100 *'secure'* *'nosecure'* *E523*
6101'secure' boolean (default off)
6102 global
6103 {not in Vi}
6104 When on, ":autocmd", shell and write commands are not allowed in
6105 ".vimrc" and ".exrc" in the current directory and map commands are
6106 displayed. Switch it off only if you know that you will not run into
6107 problems, or when the 'exrc' option is off. On Unix this option is
6108 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006109 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 'secure' at the end of your ~/.vimrc then.
6111 This option cannot be set from a |modeline| or in the |sandbox|, for
6112 security reasons.
6113
6114 *'selection'* *'sel'*
6115'selection' 'sel' string (default "inclusive")
6116 global
6117 {not in Vi}
6118 This option defines the behavior of the selection. It is only used
6119 in Visual and Select mode.
6120 Possible values:
6121 value past line inclusive ~
6122 old no yes
6123 inclusive yes yes
6124 exclusive yes no
6125 "past line" means that the cursor is allowed to be positioned one
6126 character past the line.
6127 "inclusive" means that the last character of the selection is included
6128 in an operation. For example, when "x" is used to delete the
6129 selection.
6130 Note that when "exclusive" is used and selecting from the end
6131 backwards, you cannot include the last character of a line, when
6132 starting in Normal mode and 'virtualedit' empty.
6133
6134 The 'selection' option is set by the |:behave| command.
6135
6136 *'selectmode'* *'slm'*
6137'selectmode' 'slm' string (default "")
6138 global
6139 {not in Vi}
6140 This is a comma separated list of words, which specifies when to start
6141 Select mode instead of Visual mode, when a selection is started.
6142 Possible values:
6143 mouse when using the mouse
6144 key when using shifted special keys
6145 cmd when using "v", "V" or CTRL-V
6146 See |Select-mode|.
6147 The 'selectmode' option is set by the |:behave| command.
6148
6149 *'sessionoptions'* *'ssop'*
6150'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006151 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 global
6153 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006154 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 feature}
6156 Changes the effect of the |:mksession| command. It is a comma
6157 separated list of words. Each word enables saving and restoring
6158 something:
6159 word save and restore ~
6160 blank empty windows
6161 buffers hidden and unloaded buffers, not just those in windows
6162 curdir the current directory
6163 folds manually created folds, opened/closed folds and local
6164 fold options
6165 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006166 and contain at least one lowercase letter. Only
6167 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 help the help window
6169 localoptions options and mappings local to a window or buffer (not
6170 global values for local options)
6171 options all options and mappings (also global values for local
6172 options)
6173 resize size of the Vim window: 'lines' and 'columns'
6174 sesdir the directory in which the session file is located
6175 will become the current directory (useful with
6176 projects accessed over a network from different
6177 systems)
6178 slash backslashes in file names replaced with forward
6179 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006180 tabpages all tab pages; without this only the current tab page
6181 is restored, so that you can make a session for each
6182 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 unix with Unix end-of-line format (single <NL>), even when
6184 on Windows or DOS
6185 winpos position of the whole Vim window
6186 winsize window sizes
6187
6188 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006189 When neither "curdir" nor "sesdir" is included, file names are stored
6190 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 "slash" and "unix" are useful on Windows when sharing session files
6192 with Unix. The Unix version of Vim cannot source dos format scripts,
6193 but the Windows version of Vim can source unix format scripts.
6194
6195 *'shell'* *'sh'* *E91*
6196'shell' 'sh' string (default $SHELL or "sh",
6197 MS-DOS and Win32: "command.com" or
6198 "cmd.exe", OS/2: "cmd")
6199 global
6200 Name of the shell to use for ! and :! commands. When changing the
6201 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6202 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006203 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 See |option-backslash| about including spaces and backslashes.
6205 Environment variables are expanded |:set_env|.
6206 If the name of the shell contains a space, you might need to enclose
6207 it in quotes. Example: >
6208 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6209< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006210 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 "-f" is not inside the quotes, because it is not part of the command
6212 name. And Vim automagically recognizes the backslashes that are path
6213 separators.
6214 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6215 variable to change the way external commands are executed. See the
6216 libc.inf file of DJGPP.
6217 Under MS-Windows, when the executable ends in ".com" it must be
6218 included. Thus setting the shell to "command.com" or "4dos.com"
6219 works, but "command" and "4dos" do not work for all commands (e.g.,
6220 filtering).
6221 For unknown reasons, when using "4dos.com" the current directory is
6222 changed to "C:\". To avoid this set 'shell' like this: >
6223 :set shell=command.com\ /c\ 4dos
6224< This option cannot be set from a |modeline| or in the |sandbox|, for
6225 security reasons.
6226
6227 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006228'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006229 MS-DOS and Win32, when 'shell' does not
6230 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006231 global
6232 {not in Vi}
6233 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6234 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6235 systems, the default is set according to the value of 'shell', to
6236 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006237 OS/2 (EMX figures this out itself).
6238 On Unix it can have more than one flag. Each white space separated
6239 part is passed as an argument to the shell command.
6240 See |option-backslash| about including spaces and backslashes.
6241 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 This option cannot be set from a |modeline| or in the |sandbox|, for
6243 security reasons.
6244
6245 *'shellpipe'* *'sp'*
6246'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6247 global
6248 {not in Vi}
6249 {not available when compiled without the |+quickfix|
6250 feature}
6251 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006252 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 including spaces and backslashes.
6254 The name of the temporary file can be represented by "%s" if necessary
6255 (the file name is appended automatically if no %s appears in the value
6256 of this option).
6257 For the Amiga and MS-DOS the default is ">". The output is directly
6258 saved in a file and not echoed to the screen.
6259 For Unix the default it "| tee". The stdout of the compiler is saved
6260 in a file and echoed to the screen. If the 'shell' option is "csh" or
6261 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006262 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6263 default becomes "2>&1| tee". This means that stderr is also included.
6264 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6265 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 The initialization of this option is done after reading the ".vimrc"
6267 and the other initializations, so that when the 'shell' option is set
6268 there, the 'shellpipe' option changes automatically, unless it was
6269 explicitly set before.
6270 When 'shellpipe' is set to an empty string, no redirection of the
6271 ":make" output will be done. This is useful if you use a 'makeprg'
6272 that writes to 'makeef' by itself. If you want no piping, but do
6273 want to include the 'makeef', set 'shellpipe' to a single space.
6274 Don't forget to precede the space with a backslash: ":set sp=\ ".
6275 In the future pipes may be used for filtering and this option will
6276 become obsolete (at least for Unix).
6277 This option cannot be set from a |modeline| or in the |sandbox|, for
6278 security reasons.
6279
6280 *'shellquote'* *'shq'*
6281'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6282 contains "sh" somewhere: "\"")
6283 global
6284 {not in Vi}
6285 Quoting character(s), put around the command passed to the shell, for
6286 the "!" and ":!" commands. The redirection is kept outside of the
6287 quoting. See 'shellxquote' to include the redirection. It's
6288 probably not useful to set both options.
6289 This is an empty string by default. Only known to be useful for
6290 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6291 or bash, where it should be "\"". The default is adjusted according
6292 the value of 'shell', to reduce the need to set this option by the
6293 user. See |dos-shell|.
6294 This option cannot be set from a |modeline| or in the |sandbox|, for
6295 security reasons.
6296
6297 *'shellredir'* *'srr'*
6298'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6299 global
6300 {not in Vi}
6301 String to be used to put the output of a filter command in a temporary
6302 file. See also |:!|. See |option-backslash| about including spaces
6303 and backslashes.
6304 The name of the temporary file can be represented by "%s" if necessary
6305 (the file name is appended automatically if no %s appears in the value
6306 of this option).
6307 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6308 or "zsh" during initializations, the default becomes ">&". If the
6309 'shell' option is "sh", "ksh" or "bash" the default becomes
6310 ">%s 2>&1". This means that stderr is also included.
6311 For Win32, the Unix checks are done and additionally "cmd" is checked
6312 for, which makes the default ">%s 2>&1". Also, the same names with
6313 ".exe" appended are checked for.
6314 The initialization of this option is done after reading the ".vimrc"
6315 and the other initializations, so that when the 'shell' option is set
6316 there, the 'shellredir' option changes automatically unless it was
6317 explicitly set before.
6318 In the future pipes may be used for filtering and this option will
6319 become obsolete (at least for Unix).
6320 This option cannot be set from a |modeline| or in the |sandbox|, for
6321 security reasons.
6322
6323 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6324'shellslash' 'ssl' boolean (default off)
6325 global
6326 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6327 When set, a forward slash is used when expanding file names. This is
6328 useful when a Unix-like shell is used instead of command.com or
6329 cmd.exe. Backward slashes can still be typed, but they are changed to
6330 forward slashes by Vim.
6331 Note that setting or resetting this option has no effect for some
6332 existing file names, thus this option needs to be set before opening
6333 any file for best results. This might change in the future.
6334 'shellslash' only works when a backslash can be used as a path
6335 separator. To test if this is so use: >
6336 if exists('+shellslash')
6337<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006338 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6339'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6340 global
6341 {not in Vi}
6342 When on, use temp files for shell commands. When off use a pipe.
6343 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006344 Currently a pipe is only supported on Unix and MS-Windows 2K and
6345 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006346 :if has("filterpipe")
6347< The advantage of using a pipe is that nobody can read the temp file
6348 and the 'shell' command does not need to support redirection.
6349 The advantage of using a temp file is that the file type and encoding
6350 can be detected.
6351 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6352 |FilterWritePost| autocommands event are not triggered when
6353 'shelltemp' is off.
6354
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 *'shelltype'* *'st'*
6356'shelltype' 'st' number (default 0)
6357 global
6358 {not in Vi} {only for the Amiga}
6359 On the Amiga this option influences the way how the commands work
6360 which use a shell.
6361 0 and 1: always use the shell
6362 2 and 3: use the shell only to filter lines
6363 4 and 5: use shell only for ':sh' command
6364 When not using the shell, the command is executed directly.
6365
6366 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6367 1 and 3: use "shell cmd" to start external commands
6368
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006369 *'shellxescape'* *'sxe'*
6370'shellxescape' 'sxe' string (default: "";
6371 for MS-DOS and MS-Windows: "\"&|<>()@^")
6372 global
6373 {not in Vi}
6374 When 'shellxquote' is set to "(" then the characters listed in this
6375 option will be escaped with a '^' character. This makes it possible
6376 to execute most external commands with cmd.exe.
6377
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 *'shellxquote'* *'sxq'*
6379'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006380 for Win32, when 'shell' is cmd.exe: "("
6381 for Win32, when 'shell' contains "sh"
6382 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 for Unix, when using system(): "\"")
6384 global
6385 {not in Vi}
6386 Quoting character(s), put around the command passed to the shell, for
6387 the "!" and ":!" commands. Includes the redirection. See
6388 'shellquote' to exclude the redirection. It's probably not useful
6389 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006390 When the value is '(' then ')' is appended. When the value is '"('
6391 then ')"' is appended.
6392 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006393 This is an empty string by default on most systems, but is known to be
6394 useful for on Win32 version, either for cmd.exe which automatically
6395 strips off the first and last quote on a command, or 3rd-party shells
6396 such as the MKS Korn Shell or bash, where it should be "\"". The
6397 default is adjusted according the value of 'shell', to reduce the need
6398 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 This option cannot be set from a |modeline| or in the |sandbox|, for
6400 security reasons.
6401
6402 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6403'shiftround' 'sr' boolean (default off)
6404 global
6405 {not in Vi}
6406 Round indent to multiple of 'shiftwidth'. Applies to > and <
6407 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6408 a multiple of 'shiftwidth' (this is Vi compatible).
6409 NOTE: This option is reset when 'compatible' is set.
6410
6411 *'shiftwidth'* *'sw'*
6412'shiftwidth' 'sw' number (default 8)
6413 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006414 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006416 When zero the 'ts' value will be used. Use the |shiftwidth()|
6417 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418
6419 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006420'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6421 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 global
6423 {not in Vi}
6424 This option helps to avoid all the |hit-enter| prompts caused by file
6425 messages, for example with CTRL-G, and to avoid some other messages.
6426 It is a list of flags:
6427 flag meaning when present ~
6428 f use "(3 of 5)" instead of "(file 3 of 5)"
6429 i use "[noeol]" instead of "[Incomplete last line]"
6430 l use "999L, 888C" instead of "999 lines, 888 characters"
6431 m use "[+]" instead of "[Modified]"
6432 n use "[New]" instead of "[New File]"
6433 r use "[RO]" instead of "[readonly]"
6434 w use "[w]" instead of "written" for file write message
6435 and "[a]" instead of "appended" for ':w >> file' command
6436 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6437 "[unix format]" and "[mac]" instead of "[mac format]".
6438 a all of the above abbreviations
6439
6440 o overwrite message for writing a file with subsequent message
6441 for reading a file (useful for ":wn" or when 'autowrite' on)
6442 O message for reading a file overwrites any previous message.
6443 Also for quickfix message (e.g., ":cn").
6444 s don't give "search hit BOTTOM, continuing at TOP" or "search
6445 hit TOP, continuing at BOTTOM" messages
6446 t truncate file message at the start if it is too long to fit
6447 on the command-line, "<" will appear in the left most column.
6448 Ignored in Ex mode.
6449 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006450 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 Ignored in Ex mode.
6452 W don't give "written" or "[w]" when writing a file
6453 A don't give the "ATTENTION" message when an existing swap file
6454 is found.
6455 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006456 c don't give |ins-completion-menu| messages. For example,
6457 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6458 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459
6460 This gives you the opportunity to avoid that a change between buffers
6461 requires you to hit <Enter>, but still gives as useful a message as
6462 possible for the space available. To get the whole message that you
6463 would have got with 'shm' empty, use ":file!"
6464 Useful values:
6465 shm= No abbreviation of message.
6466 shm=a Abbreviation, but no loss of information.
6467 shm=at Abbreviation, and truncate message when necessary.
6468
6469 NOTE: This option is set to the Vi default value when 'compatible' is
6470 set and to the Vim default value when 'compatible' is reset.
6471
6472 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6473'shortname' 'sn' boolean (default off)
6474 local to buffer
6475 {not in Vi, not in MS-DOS versions}
6476 Filenames are assumed to be 8 characters plus one extension of 3
6477 characters. Multiple dots in file names are not allowed. When this
6478 option is on, dots in file names are replaced with underscores when
6479 adding an extension (".~" or ".swp"). This option is not available
6480 for MS-DOS, because then it would always be on. This option is useful
6481 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6482 or crossdos. When running the Win32 GUI version under Win32s, this
6483 option is always on by default.
6484
6485 *'showbreak'* *'sbr'* *E595*
6486'showbreak' 'sbr' string (default "")
6487 global
6488 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006489 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 feature}
6491 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006492 values are "> " or "+++ ": >
6493 :set showbreak=>\
6494< Note the backslash to escape the trailing space. It's easier like
6495 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006496 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006497< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 comma (in a future version the comma might be used to separate the
6499 part that is shown at the end and at the start of a line).
6500 The characters are highlighted according to the '@' flag in
6501 'highlight'.
6502 Note that tabs after the showbreak will be displayed differently.
6503 If you want the 'showbreak' to appear in between line numbers, add the
6504 "n" flag to 'cpoptions'.
6505
6506 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6507'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6508 off)
6509 global
6510 {not in Vi}
6511 {not available when compiled without the
6512 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006513 Show (partial) command in the last line of the screen. Set this
6514 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006515 In Visual mode the size of the selected area is shown:
6516 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006517 If the number of bytes is different it is also displayed: "2-6"
6518 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006520 - When selecting a block, the size in screen characters:
6521 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 NOTE: This option is set to the Vi default value when 'compatible' is
6523 set and to the Vim default value when 'compatible' is reset.
6524
6525 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6526'showfulltag' 'sft' boolean (default off)
6527 global
6528 {not in Vi}
6529 When completing a word in insert mode (see |ins-completion|) from the
6530 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006531 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 matched a C function, you can see a template for what arguments are
6533 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006534 Note that this doesn't work well together with having "longest" in
6535 'completeopt', because the completion from the search pattern may not
6536 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537
6538 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6539'showmatch' 'sm' boolean (default off)
6540 global
6541 When a bracket is inserted, briefly jump to the matching one. The
6542 jump is only done if the match can be seen on the screen. The time to
6543 show the match can be set with 'matchtime'.
6544 A Beep is given if there is no match (no matter if the match can be
6545 seen or not). This option is reset when the 'paste' option is set.
6546 When the 'm' flag is not included in 'cpoptions', typing a character
6547 will immediately move the cursor back to where it belongs.
6548 See the "sm" field in 'guicursor' for setting the cursor shape and
6549 blinking when showing the match.
6550 The 'matchpairs' option can be used to specify the characters to show
6551 matches for. 'rightleft' and 'revins' are used to look for opposite
6552 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006553 Also see the matchparen plugin for highlighting the match when moving
6554 around |pi_paren.txt|.
6555 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556
6557 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6558'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6559 global
6560 If in Insert, Replace or Visual mode put a message on the last line.
6561 Use the 'M' flag in 'highlight' to set the type of highlighting for
6562 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006563 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 doesn't mean XIM is really active, especially when 'imactivatekey' is
6565 not set.
6566 NOTE: This option is set to the Vi default value when 'compatible' is
6567 set and to the Vim default value when 'compatible' is reset.
6568
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006569 *'showtabline'* *'stal'*
6570'showtabline' 'stal' number (default 1)
6571 global
6572 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006573 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006574 feature}
6575 The value of this option specifies when the line with tab page labels
6576 will be displayed:
6577 0: never
6578 1: only if there are at least two tab pages
6579 2: always
6580 This is both for the GUI and non-GUI implementation of the tab pages
6581 line.
6582 See |tab-page| for more information about tab pages.
6583
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 *'sidescroll'* *'ss'*
6585'sidescroll' 'ss' number (default 0)
6586 global
6587 {not in Vi}
6588 The minimal number of columns to scroll horizontally. Used only when
6589 the 'wrap' option is off and the cursor is moved off of the screen.
6590 When it is zero the cursor will be put in the middle of the screen.
6591 When using a slow terminal set it to a large number or 0. When using
6592 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6593 commands.
6594
6595 *'sidescrolloff'* *'siso'*
6596'sidescrolloff' 'siso' number (default 0)
6597 global
6598 {not in Vi}
6599 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006600 right of the cursor if 'nowrap' is set. Setting this option to a
6601 value greater than 0 while having |'sidescroll'| also at a non-zero
6602 value makes some context visible in the line you are scrolling in
6603 horizontally (except at beginning of the line). Setting this option
6604 to a large value (like 999) has the effect of keeping the cursor
6605 horizontally centered in the window, as long as one does not come too
6606 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 NOTE: This option is set to 0 when 'compatible' is set.
6608
6609 Example: Try this together with 'sidescroll' and 'listchars' as
6610 in the following example to never allow the cursor to move
6611 onto the "extends" character:
6612
6613 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6614 :set sidescrolloff=1
6615
6616
6617 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6618'smartcase' 'scs' boolean (default off)
6619 global
6620 {not in Vi}
6621 Override the 'ignorecase' option if the search pattern contains upper
6622 case characters. Only used when the search pattern is typed and
6623 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006624 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6626 recalling the search pattern from history and hitting <Enter>.
6627 NOTE: This option is reset when 'compatible' is set.
6628
6629 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6630'smartindent' 'si' boolean (default off)
6631 local to buffer
6632 {not in Vi}
6633 {not available when compiled without the
6634 |+smartindent| feature}
6635 Do smart autoindenting when starting a new line. Works for C-like
6636 programs, but can also be used for other languages. 'cindent' does
6637 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006638 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006639 setting 'si' has no effect. 'indentexpr' is a more advanced
6640 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 Normally 'autoindent' should also be on when using 'smartindent'.
6642 An indent is automatically inserted:
6643 - After a line ending in '{'.
6644 - After a line starting with a keyword from 'cinwords'.
6645 - Before a line starting with '}' (only with the "O" command).
6646 When typing '}' as the first character in a new line, that line is
6647 given the same indent as the matching '{'.
6648 When typing '#' as the first character in a new line, the indent for
6649 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006650 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6652 When using the ">>" command, lines starting with '#' are not shifted
6653 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006654 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 is set smart indenting is disabled.
6656
6657 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6658'smarttab' 'sta' boolean (default off)
6659 global
6660 {not in Vi}
6661 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006662 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6663 <BS> will delete a 'shiftwidth' worth of space at the start of the
6664 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006665 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006666 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6667 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006668 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006670 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 NOTE: This option is reset when 'compatible' is set.
6672
6673 *'softtabstop'* *'sts'*
6674'softtabstop' 'sts' number (default 0)
6675 local to buffer
6676 {not in Vi}
6677 Number of spaces that a <Tab> counts for while performing editing
6678 operations, like inserting a <Tab> or using <BS>. It "feels" like
6679 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6680 used. This is useful to keep the 'ts' setting at its standard value
6681 of 8, while being able to edit like it is set to 'sts'. However,
6682 commands like "x" still work on the actual characters.
6683 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006684 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 'softtabstop' is set to 0 when the 'paste' option is set.
6686 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6687 spaces is minimized by using <Tab>s.
6688 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6689 set.
6690 NOTE: This option is set to 0 when 'compatible' is set.
6691
Bram Moolenaar217ad922005-03-20 22:37:15 +00006692 *'spell'* *'nospell'*
6693'spell' boolean (default off)
6694 local to window
6695 {not in Vi}
6696 {not available when compiled without the |+syntax|
6697 feature}
6698 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006699 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006700
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006701 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006702'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006703 local to buffer
6704 {not in Vi}
6705 {not available when compiled without the |+syntax|
6706 feature}
6707 Pattern to locate the end of a sentence. The following word will be
6708 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006709 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006710 When this check is not wanted make this option empty.
6711 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006712 Be careful with special characters, see |option-backslash| about
6713 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006714 To set this option automatically depending on the language, see
6715 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006716
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006717 *'spellfile'* *'spf'*
6718'spellfile' 'spf' string (default empty)
6719 local to buffer
6720 {not in Vi}
6721 {not available when compiled without the |+syntax|
6722 feature}
6723 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006724 commands. It must end in ".{encoding}.add". You need to include the
6725 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006726 *E765*
6727 It may also be a comma separated list of names. A count before the
6728 |zg| and |zw| commands can be used to access each. This allows using
6729 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006730 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006731 you: Using the first directory in 'runtimepath' that is writable. If
6732 there is no "spell" directory yet it will be created. For the file
6733 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006734 ignoring the region.
6735 The resulting ".spl" file will be used for spell checking, it does not
6736 have to appear in 'spelllang'.
6737 Normally one file is used for all regions, but you can add the region
6738 name if you want to. However, it will then only be used when
6739 'spellfile' is set to it, for entries in 'spelllang' only files
6740 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006741 This option cannot be set from a |modeline| or in the |sandbox|, for
6742 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006743
Bram Moolenaar217ad922005-03-20 22:37:15 +00006744 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006745'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006746 local to buffer
6747 {not in Vi}
6748 {not available when compiled without the |+syntax|
6749 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006750 A comma separated list of word list names. When the 'spell' option is
6751 on spellchecking will be done for these languages. Example: >
6752 set spelllang=en_us,nl,medical
6753< This means US English, Dutch and medical words are recognized. Words
6754 that are not recognized will be highlighted.
6755 The word list name must not include a comma or dot. Using a dash is
6756 recommended to separate the two letter language name from a
6757 specification. Thus "en-rare" is used for rare English words.
6758 A region name must come last and have the form "_xx", where "xx" is
6759 the two-letter, lower case region name. You can use more than one
6760 region by listing them: "en_us,en_ca" supports both US and Canadian
6761 English, but not words specific for Australia, New Zealand or Great
6762 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006763 If the name "cjk" is included East Asian characters are excluded from
6764 spell checking. This is useful when editing text that also has Asian
6765 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006766 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006767 As a special case the name of a .spl file can be given as-is. The
6768 first "_xx" in the name is removed and used as the region name
6769 (_xx is an underscore, two letters and followed by a non-letter).
6770 This is mainly for testing purposes. You must make sure the correct
6771 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006772 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006773 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6774 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006775 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006776
Bram Moolenaar98692072006-02-04 00:57:42 +00006777 If the |spellfile.vim| plugin is active and you use a language name
6778 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6779 will ask you if you want to download the file.
6780
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006781 After this option has been set successfully, Vim will source the files
6782 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006783 up to the first comma, dot or underscore.
6784 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006785
6786
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006787 *'spellsuggest'* *'sps'*
6788'spellsuggest' 'sps' string (default "best")
6789 global
6790 {not in Vi}
6791 {not available when compiled without the |+syntax|
6792 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006793 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006794 the |spellsuggest()| function. This is a comma-separated list of
6795 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006796
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006797 best Internal method that works best for English. Finds
6798 changes like "fast" and uses a bit of sound-a-like
6799 scoring to improve the ordering.
6800
6801 double Internal method that uses two methods and mixes the
6802 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006803 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006804 word. That only works when the language specifies
6805 sound folding. Can be slow and doesn't always give
6806 better results.
6807
6808 fast Internal method that only checks for simple changes:
6809 character inserts/deletes/swaps. Works well for
6810 simple typing mistakes.
6811
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006812 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006813 Not used for |spellsuggest()|. The number of
6814 suggestions is never more than the value of 'lines'
6815 minus two.
6816
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006817 file:{filename} Read file {filename}, which must have two columns,
6818 separated by a slash. The first column contains the
6819 bad word, the second column the suggested good word.
6820 Example:
6821 theribal/terrible ~
6822 Use this for common mistakes that do not appear at the
6823 top of the suggestion list with the internal methods.
6824 Lines without a slash are ignored, use this for
6825 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006826 The word in the second column must be correct,
6827 otherwise it will not be used. Add the word to an
6828 ".add" file if it is currently flagged as a spelling
6829 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006830 The file is used for all languages.
6831
6832 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6833 trouble with spaces. |v:val| holds the badly spelled
6834 word. The expression must evaluate to a List of
6835 Lists, each with a suggestion and a score.
6836 Example:
6837 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006838 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006839 internal methods use. A lower score is better.
6840 This may invoke |spellsuggest()| if you temporarily
6841 set 'spellsuggest' to exclude the "expr:" part.
6842 Errors are silently ignored, unless you set the
6843 'verbose' option to a non-zero value.
6844
6845 Only one of "best", "double" or "fast" may be used. The others may
6846 appear several times in any order. Example: >
6847 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6848<
6849 This option cannot be set from a |modeline| or in the |sandbox|, for
6850 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006851
6852
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6854'splitbelow' 'sb' boolean (default off)
6855 global
6856 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006857 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 feature}
6859 When on, splitting a window will put the new window below the current
6860 one. |:split|
6861
6862 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6863'splitright' 'spr' boolean (default off)
6864 global
6865 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006866 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 feature}
6868 When on, splitting a window will put the new window right of the
6869 current one. |:vsplit|
6870
6871 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6872'startofline' 'sol' boolean (default on)
6873 global
6874 {not in Vi}
6875 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006876 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006877 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006878 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 with a linewise operator, with "%" with a count and to buffer changing
6880 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6881 only has a line number, e.g., ":25" or ":+".
6882 In case of buffer changing commands the cursor is placed at the column
6883 where it was the last time the buffer was edited.
6884 NOTE: This option is set when 'compatible' is set.
6885
Bram Moolenaar00654022011-02-25 14:42:19 +01006886 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006888 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 {not in Vi}
6890 {not available when compiled without the |+statusline|
6891 feature}
6892 When nonempty, this option determines the content of the status line.
6893 Also see |status-line|.
6894
6895 The option consists of printf style '%' items interspersed with
6896 normal text. Each status line item is of the form:
6897 %-0{minwid}.{maxwid}{item}
6898 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006899 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900
Bram Moolenaar238a5642006-02-21 22:12:05 +00006901 When the option starts with "%!" then it is used as an expression,
6902 evaluated and the result is used as the option value. Example: >
6903 :set statusline=%!MyStatusLine()
6904< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006905 Note that the "%!" expression is evaluated in the context of the
6906 current window and buffer, while %{} items are evaluated in the
6907 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006908
6909 When there is error while evaluating the option then it will be made
6910 empty to avoid further errors. Otherwise screen updating would loop.
6911
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 Note that the only effect of 'ruler' when this option is set (and
6913 'laststatus' is 2) is controlling the output of |CTRL-G|.
6914
6915 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006916 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006918 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 minwid Minimum width of the item, padding as set by '-' & '0'.
6920 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006921 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 on the left for text items. Numeric items will be
6923 shifted down to maxwid-2 digits followed by '>'number
6924 where number is the amount of missing digits, much like
6925 an exponential notation.
6926 item A one letter code as described below.
6927
6928 Following is a description of the possible statusline items. The
6929 second character in "item" is the type:
6930 N for number
6931 S for string
6932 F for flags as described below
6933 - not applicable
6934
6935 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006936 f S Path to the file in the buffer, as typed or relative to current
6937 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 F S Full path to the file in the buffer.
6939 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006940 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006942 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006944 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006946 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006948 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6950 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006951 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6953 being used: "<keymap>"
6954 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006955 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 B N As above, in hexadecimal.
6957 o N Byte number in file of byte under cursor, first byte is 1.
6958 Mnemonic: Offset from start of file (with one added)
6959 {not available when compiled without |+byte_offset| feature}
6960 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006961 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 l N Line number.
6963 L N Number of lines in buffer.
6964 c N Column number.
6965 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006966 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006967 p N Percentage through file in lines as in |CTRL-G|.
6968 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006969 percentage described for 'ruler'. Always 3 in length, unless
6970 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006971 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006973 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006974 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975 ( - Start of item group. Can be used for setting the width and
6976 alignment of a section. Must be followed by %) somewhere.
6977 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006978 T N For 'tabline': start of tab page N label. Use %T after the last
6979 label. This information is used for mouse clicks.
6980 X N For 'tabline': start of close tab N label. Use %X after the
6981 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6982 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 < - Where to truncate line if too long. Default is at the start.
6984 No width fields allowed.
6985 = - Separation point between left and right aligned items.
6986 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006987 # - Set highlight group. The name must follow and then a # again.
6988 Thus use %#HLname# for highlight group HLname. The same
6989 highlighting is used, also for the statusline of non-current
6990 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006992 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 The difference between User{N} and StatusLine will be applied
6994 to StatusLineNC for the statusline of non-current windows.
6995 The number N must be between 1 and 9. See |hl-User1..9|
6996
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006997 When displaying a flag, Vim removes the leading comma, if any, when
6998 that flag comes right after plaintext. This will make a nice display
6999 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000
Bram Moolenaar582fd852005-03-28 20:58:01 +00007001 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007002 not set) and a minwid is not set for the group, the whole group will
7003 become empty. This will make a group like the following disappear
7004 completely from the statusline when none of the flags are set. >
7005 :set statusline=...%(\ [%M%R%H]%)...
7006<
7007 Beware that an expression is evaluated each and every time the status
7008 line is displayed. The current buffer and current window will be set
7009 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007010 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007012 real current buffer.
7013
Bram Moolenaar30b65812012-07-12 22:01:11 +02007014 The 'statusline' option will be evaluated in the |sandbox| if set from
7015 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007016
7017 It is not allowed to change text or jump to another window while
7018 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019
7020 If the statusline is not updated when you want it (e.g., after setting
7021 a variable that's used in an expression), you can force an update by
7022 setting an option without changing its value. Example: >
7023 :let &ro = &ro
7024
7025< A result of all digits is regarded a number for display purposes.
7026 Otherwise the result is taken as flag text and applied to the rules
7027 described above.
7028
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007029 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7031 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7032
7033 Examples:
7034 Emulate standard status line with 'ruler' set >
7035 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7036< Similar, but add ASCII value of char under the cursor (like "ga") >
7037 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7038< Display byte count and byte value, modified flag in red. >
7039 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7040 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7041< Display a ,GZ flag if a compressed file is loaded >
7042 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7043< In the |:autocmd|'s: >
7044 :let b:gzflag = 1
7045< And: >
7046 :unlet b:gzflag
7047< And define this function: >
7048 :function VarExists(var, val)
7049 : if exists(a:var) | return a:val | else | return '' | endif
7050 :endfunction
7051<
7052 *'suffixes'* *'su'*
7053'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7054 global
7055 {not in Vi}
7056 Files with these suffixes get a lower priority when multiple files
7057 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007058 suffixes. Spaces after the comma are ignored. A dot is also seen as
7059 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 separator, precede it with a backslash (see |option-backslash| about
7061 including spaces and backslashes).
7062 See 'wildignore' for completely ignoring files.
7063 The use of |:set+=| and |:set-=| is preferred when adding or removing
7064 suffixes from the list. This avoids problems when a future version
7065 uses another default.
7066
7067 *'suffixesadd'* *'sua'*
7068'suffixesadd' 'sua' string (default "")
7069 local to buffer
7070 {not in Vi}
7071 {not available when compiled without the
7072 |+file_in_path| feature}
7073 Comma separated list of suffixes, which are used when searching for a
7074 file for the "gf", "[I", etc. commands. Example: >
7075 :set suffixesadd=.java
7076<
7077 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7078'swapfile' 'swf' boolean (default on)
7079 local to buffer
7080 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007081 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 swapfile is not wanted for a specific buffer. For example, with
7083 confidential information that even root must not be able to access.
7084 Careful: All text will be in memory:
7085 - Don't use this for big files.
7086 - Recovery will be impossible!
7087 A swapfile will only be present when |'updatecount'| is non-zero and
7088 'swapfile' is set.
7089 When 'swapfile' is reset, the swap file for the current buffer is
7090 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7091 non-zero, a swap file is immediately created.
7092 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007093 If you want to open a new buffer without creating a swap file for it,
7094 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095
7096 This option is used together with 'bufhidden' and 'buftype' to
7097 specify special kinds of buffers. See |special-buffers|.
7098
7099 *'swapsync'* *'sws'*
7100'swapsync' 'sws' string (default "fsync")
7101 global
7102 {not in Vi}
7103 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007104 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 When this option is empty parts of the swap file may be in memory and
7106 not written to disk. When the system crashes you may lose more work.
7107 On Unix the system does a sync now and then without Vim asking for it,
7108 so the disadvantage of setting this option off is small. On some
7109 systems the swap file will not be written at all. For a unix system
7110 setting it to "sync" will use the sync() call instead of the default
7111 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007112 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007113
7114 *'switchbuf'* *'swb'*
7115'switchbuf' 'swb' string (default "")
7116 global
7117 {not in Vi}
7118 This option controls the behavior when switching between buffers.
7119 Possible values (comma separated list):
7120 useopen If included, jump to the first open window that
7121 contains the specified buffer (if there is one).
7122 Otherwise: Do not examine other windows.
7123 This setting is checked with |quickfix| commands, when
7124 jumping to errors (":cc", ":cn", "cp", etc.). It is
7125 also used in all buffer related split commands, for
7126 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007127 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007128 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007130 a buffer for a |quickfix| command that display errors.
7131 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007132 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007133 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007134 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007136 *'synmaxcol'* *'smc'*
7137'synmaxcol' 'smc' number (default 3000)
7138 local to buffer
7139 {not in Vi}
7140 {not available when compiled without the |+syntax|
7141 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007142 Maximum column in which to search for syntax items. In long lines the
7143 text after this column is not highlighted and following lines may not
7144 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007145 This helps to avoid very slow redrawing for an XML file that is one
7146 long line.
7147 Set to zero to remove the limit.
7148
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 *'syntax'* *'syn'*
7150'syntax' 'syn' string (default empty)
7151 local to buffer
7152 {not in Vi}
7153 {not available when compiled without the |+syntax|
7154 feature}
7155 When this option is set, the syntax with this name is loaded, unless
7156 syntax highlighting has been switched off with ":syntax off".
7157 Otherwise this option does not always reflect the current syntax (the
7158 b:current_syntax variable does).
7159 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007160 not automatically recognized. Example, in an IDL file:
7161 /* vim: set syntax=idl : */ ~
7162 When a dot appears in the value then this separates two filetype
7163 names. Example:
7164 /* vim: set syntax=c.doxygen : */ ~
7165 This will use the "c" syntax first, then the "doxygen" syntax.
7166 Note that the second one must be prepared to be loaded as an addition,
7167 otherwise it will be skipped. More than one dot may appear.
7168 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 :set syntax=OFF
7170< To switch syntax highlighting on according to the current value of the
7171 'filetype' option: >
7172 :set syntax=ON
7173< What actually happens when setting the 'syntax' option is that the
7174 Syntax autocommand event is triggered with the value as argument.
7175 This option is not copied to another buffer, independent of the 's' or
7176 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007177 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007179 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007180'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007181 global
7182 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007183 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007184 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007185 When nonempty, this option determines the content of the tab pages
7186 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007187 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007188
7189 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007190 option and only when there is no GUI tab line. When 'e' is in
7191 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007192 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007193
7194 The value is evaluated like with 'statusline'. You can use
7195 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007196 the text to be displayed. Use "%1T" for the first label, "%2T" for
7197 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007198
7199 Keep in mind that only one of the tab pages is the current one, others
7200 are invisible and you can't jump to their windows.
7201
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007202
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007203 *'tabpagemax'* *'tpm'*
7204'tabpagemax' 'tpm' number (default 10)
7205 global
7206 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007207 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007208 feature}
7209 Maximum number of tab pages to be opened by the |-p| command line
7210 argument or the ":tab all" command. |tabpage|
7211
7212
7213 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214'tabstop' 'ts' number (default 8)
7215 local to buffer
7216 Number of spaces that a <Tab> in the file counts for. Also see
7217 |:retab| command, and 'softtabstop' option.
7218
7219 Note: Setting 'tabstop' to any other value than 8 can make your file
7220 appear wrong in many places (e.g., when printing it).
7221
7222 There are four main ways to use tabs in Vim:
7223 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7224 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007225 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 behave like a tab appears every 4 (or 3) characters.
7227 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7228 'expandtab'. This way you will always insert spaces. The
7229 formatting will never be messed up when 'tabstop' is changed.
7230 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007231 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 works when using Vim to edit the file.
7233 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7234 'noexpandtab'. This should then work (for initial indents only)
7235 for any tabstop setting that people use. It might be nice to have
7236 tabs after the first non-blank inserted as spaces if you do this
7237 though. Otherwise aligned comments will be wrong when 'tabstop' is
7238 changed.
7239
7240 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7241'tagbsearch' 'tbs' boolean (default on)
7242 global
7243 {not in Vi}
7244 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007245 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 searching makes searching for a tag a LOT faster, but a linear search
7247 will find more tags if the tags file wasn't properly sorted.
7248 Vim normally assumes that your tags files are sorted, or indicate that
7249 they are not sorted. Only when this is not the case does the
7250 'tagbsearch' option need to be switched off.
7251
7252 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 certain files, or retry all files with a linear search. When
7255 'tagbsearch' is off, only a linear search is done.
7256
7257 Linear searching is done anyway, for one file, when Vim finds a line
7258 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007259 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260< [The whitespace before and after the '0' must be a single <Tab>]
7261
7262 When a binary search was done and no match was found in any of the
7263 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7264 instead of a normal tag name, a retry is done with a linear search.
7265 Tags in unsorted tags files, and matches with different case will only
7266 be found in the retry.
7267
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007268 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 linear search can be avoided for the 'ignorecase' case. Use a value
7270 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7271 case-fold sorted with the -f switch to "sort" in most unices, as in
7272 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007273 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7274 for this as well. Note that case must be folded to uppercase for this
7275 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276
7277 When 'tagbsearch' is off, tags searching is slower when a full match
7278 exists, but faster when no full match exists. Tags in unsorted tags
7279 files may only be found with 'tagbsearch' off.
7280 When the tags file is not sorted, or sorted in a wrong way (not on
7281 ASCII byte value), 'tagbsearch' should be off, or the line given above
7282 must be included in the tags file.
7283 This option doesn't affect commands that find all matching tags (e.g.,
7284 command-line completion and ":help").
7285 {Vi: always uses binary search in some versions}
7286
7287 *'taglength'* *'tl'*
7288'taglength' 'tl' number (default 0)
7289 global
7290 If non-zero, tags are significant up to this number of characters.
7291
7292 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7293'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7294 global
7295 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007296 If on and using a tags file in another directory, file names in that
7297 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007298 NOTE: This option is set to the Vi default value when 'compatible' is
7299 set and to the Vim default value when 'compatible' is reset.
7300
7301 *'tags'* *'tag'* *E433*
7302'tags' 'tag' string (default "./tags,tags", when compiled with
7303 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7304 global or local to buffer |global-local|
7305 Filenames for the tag command, separated by spaces or commas. To
7306 include a space or comma in a file name, precede it with a backslash
7307 (see |option-backslash| about including spaces and backslashes).
7308 When a file name starts with "./", the '.' is replaced with the path
7309 of the current file. But only when the 'd' flag is not included in
7310 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7311 |tags-option|.
7312 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007313 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7314 find all files named "tags" below "/lib". The filename itself cannot
7315 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7316 files called "tags?". {not available when compiled without the
7317 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007318 The |tagfiles()| function can be used to get a list of the file names
7319 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7321 files are also supported. They are automatically recognized. The
7322 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7323 differences are ignored (MS-Windows). |emacs-tags|
7324 The use of |:set+=| and |:set-=| is preferred when adding or removing
7325 file names from the list. This avoids problems when a future version
7326 uses another default.
7327 {Vi: default is "tags /usr/lib/tags"}
7328
7329 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7330'tagstack' 'tgst' boolean (default on)
7331 global
7332 {not in all versions of Vi}
7333 When on, the |tagstack| is used normally. When off, a ":tag" or
7334 ":tselect" command with an argument will not push the tag onto the
7335 tagstack. A following ":tag" without an argument, a ":pop" command or
7336 any other command that uses the tagstack will use the unmodified
7337 tagstack, but does change the pointer to the active entry.
7338 Resetting this option is useful when using a ":tag" command in a
7339 mapping which should not change the tagstack.
7340
7341 *'term'* *E529* *E530* *E531*
7342'term' string (default is $TERM, if that fails:
7343 in the GUI: "builtin_gui"
7344 on Amiga: "amiga"
7345 on BeOS: "beos-ansi"
7346 on Mac: "mac-ansi"
7347 on MiNT: "vt52"
7348 on MS-DOS: "pcterm"
7349 on OS/2: "os2ansi"
7350 on Unix: "ansi"
7351 on VMS: "ansi"
7352 on Win 32: "win32")
7353 global
7354 Name of the terminal. Used for choosing the terminal control
7355 characters. Environment variables are expanded |:set_env|.
7356 For example: >
7357 :set term=$TERM
7358< See |termcap|.
7359
7360 *'termbidi'* *'tbidi'*
7361 *'notermbidi'* *'notbidi'*
7362'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7363 global
7364 {not in Vi}
7365 {only available when compiled with the |+arabic|
7366 feature}
7367 The terminal is in charge of Bi-directionality of text (as specified
7368 by Unicode). The terminal is also expected to do the required shaping
7369 that some languages (such as Arabic) require.
7370 Setting this option implies that 'rightleft' will not be set when
7371 'arabic' is set and the value of 'arabicshape' will be ignored.
7372 Note that setting 'termbidi' has the immediate effect that
7373 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7374 This option is reset when the GUI is started.
7375 For further details see |arabic.txt|.
7376
7377 *'termencoding'* *'tenc'*
7378'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7379 Macintosh GUI: "macroman")
7380 global
7381 {only available when compiled with the |+multi_byte|
7382 feature}
7383 {not in Vi}
7384 Encoding used for the terminal. This specifies what character
7385 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007386 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007387 display). Except for the Mac when 'macatsui' is off, then
7388 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 In the Win32 console version the default value is the console codepage
7390 when it differs from the ANSI codepage.
7391 *E617*
7392 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7393 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7394 Any attempts to set a different value will be rejected, and an error
7395 message is shown.
7396 For the Win32 GUI 'termencoding' is not used for typed characters,
7397 because the Win32 system always passes Unicode characters.
7398 When empty, the same encoding is used as for the 'encoding' option.
7399 This is the normal value.
7400 Not all combinations for 'termencoding' and 'encoding' are valid. See
7401 |encoding-table|.
7402 The value for this option must be supported by internal conversions or
7403 iconv(). When this is not possible no conversion will be done and you
7404 will probably experience problems with non-ASCII characters.
7405 Example: You are working with the locale set to euc-jp (Japanese) and
7406 want to edit a UTF-8 file: >
7407 :let &termencoding = &encoding
7408 :set encoding=utf-8
7409< You need to do this when your system has no locale support for UTF-8.
7410
7411 *'terse'* *'noterse'*
7412'terse' boolean (default off)
7413 global
7414 When set: Add 's' flag to 'shortmess' option (this makes the message
7415 for a search that hits the start or end of the file not being
7416 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7417 shortens a lot of messages}
7418
7419 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7420'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7421 global
7422 {not in Vi}
7423 This option is obsolete. Use 'fileformats'.
7424 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7425 set to the default value for the current system. When 'textauto' is
7426 reset, 'fileformats' is made empty.
7427 NOTE: This option is set to the Vi default value when 'compatible' is
7428 set and to the Vim default value when 'compatible' is reset.
7429
7430 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7431'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7432 others: default off)
7433 local to buffer
7434 {not in Vi}
7435 This option is obsolete. Use 'fileformat'.
7436 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7437 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7438 "unix".
7439
7440 *'textwidth'* *'tw'*
7441'textwidth' 'tw' number (default 0)
7442 local to buffer
7443 {not in Vi}
7444 Maximum width of text that is being inserted. A longer line will be
7445 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007446 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7447 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007448 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007449 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 NOTE: This option is set to 0 when 'compatible' is set.
7451
7452 *'thesaurus'* *'tsr'*
7453'thesaurus' 'tsr' string (default "")
7454 global or local to buffer |global-local|
7455 {not in Vi}
7456 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007457 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 the file should contain words with similar meaning, separated by
7459 non-keyword characters (white space is preferred). Maximum line
7460 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007461 To obtain a file to be used here, check out this ftp site:
7462 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007463 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007464 after a comma are ignored, otherwise spaces are included in the file
7465 name. See |option-backslash| about using backslashes.
7466 The use of |:set+=| and |:set-=| is preferred when adding or removing
7467 directories from the list. This avoids problems when a future version
7468 uses another default.
7469 Backticks cannot be used in this option for security reasons.
7470
7471 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7472'tildeop' 'top' boolean (default off)
7473 global
7474 {not in Vi}
7475 When on: The tilde command "~" behaves like an operator.
7476 NOTE: This option is reset when 'compatible' is set.
7477
7478 *'timeout'* *'to'* *'notimeout'* *'noto'*
7479'timeout' 'to' boolean (default on)
7480 global
7481 *'ttimeout'* *'nottimeout'*
7482'ttimeout' boolean (default off)
7483 global
7484 {not in Vi}
7485 These two options together determine the behavior when part of a
7486 mapped key sequence or keyboard code has been received:
7487
7488 'timeout' 'ttimeout' action ~
7489 off off do not time out
7490 on on or off time out on :mappings and key codes
7491 off on time out on key codes
7492
7493 If both options are off, Vim will wait until either the complete
7494 mapping or key sequence has been received, or it is clear that there
7495 is no mapping or key sequence for the received characters. For
7496 example: if you have mapped "vl" and Vim has received 'v', the next
7497 character is needed to see if the 'v' is followed by an 'l'.
7498 When one of the options is on, Vim will wait for about 1 second for
7499 the next character to arrive. After that the already received
7500 characters are interpreted as single characters. The waiting time can
7501 be changed with the 'timeoutlen' option.
7502 On slow terminals or very busy systems timing out may cause
7503 malfunctioning cursor keys. If both options are off, Vim waits
7504 forever after an entered <Esc> if there are key codes that start
7505 with <Esc>. You will have to type <Esc> twice. If you do not have
7506 problems with key codes, but would like to have :mapped key
7507 sequences not timing out in 1 second, set the 'ttimeout' option and
7508 reset the 'timeout' option.
7509
7510 NOTE: 'ttimeout' is reset when 'compatible' is set.
7511
7512 *'timeoutlen'* *'tm'*
7513'timeoutlen' 'tm' number (default 1000)
7514 global
7515 {not in all versions of Vi}
7516 *'ttimeoutlen'* *'ttm'*
7517'ttimeoutlen' 'ttm' number (default -1)
7518 global
7519 {not in Vi}
7520 The time in milliseconds that is waited for a key code or mapped key
7521 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7522 when part of a command has been typed.
7523 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7524 different timeout value for key codes is desired set 'ttimeoutlen' to
7525 a non-negative number.
7526
7527 ttimeoutlen mapping delay key code delay ~
7528 < 0 'timeoutlen' 'timeoutlen'
7529 >= 0 'timeoutlen' 'ttimeoutlen'
7530
7531 The timeout only happens when the 'timeout' and 'ttimeout' options
7532 tell so. A useful setting would be >
7533 :set timeout timeoutlen=3000 ttimeoutlen=100
7534< (time out on mapping after three seconds, time out on key codes after
7535 a tenth of a second).
7536
7537 *'title'* *'notitle'*
7538'title' boolean (default off, on when title can be restored)
7539 global
7540 {not in Vi}
7541 {not available when compiled without the |+title|
7542 feature}
7543 When on, the title of the window will be set to the value of
7544 'titlestring' (if it is not empty), or to:
7545 filename [+=-] (path) - VIM
7546 Where:
7547 filename the name of the file being edited
7548 - indicates the file cannot be modified, 'ma' off
7549 + indicates the file was modified
7550 = indicates the file is read-only
7551 =+ indicates the file is read-only and modified
7552 (path) is the path of the file being edited
7553 - VIM the server name |v:servername| or "VIM"
7554 Only works if the terminal supports setting window titles
7555 (currently Amiga console, Win32 console, all GUI versions and
7556 terminals with a non- empty 't_ts' option - these are Unix xterm and
7557 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7558 *X11*
7559 When Vim was compiled with HAVE_X11 defined, the original title will
7560 be restored if possible. The output of ":version" will include "+X11"
7561 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7562 works for the icon name |'icon'|.
7563 But: When Vim was started with the |-X| argument, restoring the title
7564 will not work (except in the GUI).
7565 If the title cannot be restored, it is set to the value of 'titleold'.
7566 You might want to restore the title outside of Vim then.
7567 When using an xterm from a remote machine you can use this command:
7568 rsh machine_name xterm -display $DISPLAY &
7569 then the WINDOWID environment variable should be inherited and the
7570 title of the window should change back to what it should be after
7571 exiting Vim.
7572
7573 *'titlelen'*
7574'titlelen' number (default 85)
7575 global
7576 {not in Vi}
7577 {not available when compiled without the |+title|
7578 feature}
7579 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007580 title. When the title is longer, only the end of the path name is
7581 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 Using a percentage makes this adapt to the width of the window. But
7583 it won't work perfectly, because the actual number of characters
7584 available also depends on the font used and other things in the title
7585 bar. When 'titlelen' is zero the full path is used. Otherwise,
7586 values from 1 to 30000 percent can be used.
7587 'titlelen' is also used for the 'titlestring' option.
7588
7589 *'titleold'*
7590'titleold' string (default "Thanks for flying Vim")
7591 global
7592 {not in Vi}
7593 {only available when compiled with the |+title|
7594 feature}
7595 This option will be used for the window title when exiting Vim if the
7596 original title cannot be restored. Only happens if 'title' is on or
7597 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007598 This option cannot be set from a |modeline| or in the |sandbox|, for
7599 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 *'titlestring'*
7601'titlestring' string (default "")
7602 global
7603 {not in Vi}
7604 {not available when compiled without the |+title|
7605 feature}
7606 When this option is not empty, it will be used for the title of the
7607 window. This happens only when the 'title' option is on.
7608 Only works if the terminal supports setting window titles (currently
7609 Amiga console, Win32 console, all GUI versions and terminals with a
7610 non-empty 't_ts' option).
7611 When Vim was compiled with HAVE_X11 defined, the original title will
7612 be restored if possible |X11|.
7613 When this option contains printf-style '%' items, they will be
7614 expanded according to the rules used for 'statusline'.
7615 Example: >
7616 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7617 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7618< The value of 'titlelen' is used to align items in the middle or right
7619 of the available space.
7620 Some people prefer to have the file name first: >
7621 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7622< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007623 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 separating space only when needed.
7625 NOTE: Use of special characters in 'titlestring' may cause the display
7626 to be garbled (e.g., when it contains a CR or NL character).
7627 {not available when compiled without the |+statusline| feature}
7628
7629 *'toolbar'* *'tb'*
7630'toolbar' 'tb' string (default "icons,tooltips")
7631 global
7632 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7633 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007634 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007635 possible values are:
7636 icons Toolbar buttons are shown with icons.
7637 text Toolbar buttons shown with text.
7638 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007639 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 tooltips Tooltips are active for toolbar buttons.
7641 Tooltips refer to the popup help text which appears after the mouse
7642 cursor is placed over a toolbar button for a brief moment.
7643
7644 If you want the toolbar to be shown with icons as well as text, do the
7645 following: >
7646 :set tb=icons,text
7647< Motif and Athena cannot display icons and text at the same time. They
7648 will show icons if both are requested.
7649
7650 If none of the strings specified in 'toolbar' are valid or if
7651 'toolbar' is empty, this option is ignored. If you want to disable
7652 the toolbar, you need to set the 'guioptions' option. For example: >
7653 :set guioptions-=T
7654< Also see |gui-toolbar|.
7655
7656 *'toolbariconsize'* *'tbis'*
7657'toolbariconsize' 'tbis' string (default "small")
7658 global
7659 {not in Vi}
7660 {only in the GTK+ 2 GUI}
7661 Controls the size of toolbar icons. The possible values are:
7662 tiny Use tiny toolbar icons.
7663 small Use small toolbar icons (default).
7664 medium Use medium-sized toolbar icons.
7665 large Use large toolbar icons.
7666 The exact dimensions in pixels of the various icon sizes depend on
7667 the current theme. Common dimensions are large=32x32, medium=24x24,
7668 small=20x20 and tiny=16x16.
7669
7670 If 'toolbariconsize' is empty, the global default size as determined
7671 by user preferences or the current theme is used.
7672
7673 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7674'ttybuiltin' 'tbi' boolean (default on)
7675 global
7676 {not in Vi}
7677 When on, the builtin termcaps are searched before the external ones.
7678 When off the builtin termcaps are searched after the external ones.
7679 When this option is changed, you should set the 'term' option next for
7680 the change to take effect, for example: >
7681 :set notbi term=$TERM
7682< See also |termcap|.
7683 Rationale: The default for this option is "on", because the builtin
7684 termcap entries are generally better (many systems contain faulty
7685 xterm entries...).
7686
7687 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7688'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7689 sun-cmd, screen, rxvt, dtterm or
7690 iris-ansi; also on when running Vim in
7691 a DOS console)
7692 global
7693 {not in Vi}
7694 Indicates a fast terminal connection. More characters will be sent to
7695 the screen for redrawing, instead of using insert/delete line
7696 commands. Improves smoothness of redrawing when there are multiple
7697 windows and the terminal does not support a scrolling region.
7698 Also enables the extra writing of characters at the end of each screen
7699 line for lines that wrap. This helps when using copy/paste with the
7700 mouse in an xterm and other terminals.
7701
7702 *'ttymouse'* *'ttym'*
7703'ttymouse' 'ttym' string (default depends on 'term')
7704 global
7705 {not in Vi}
7706 {only in Unix and VMS, doesn't work in the GUI; not
7707 available when compiled without |+mouse|}
7708 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007709 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 *xterm-mouse*
7711 xterm xterm-like mouse handling. The mouse generates
7712 "<Esc>[Mscr", where "scr" is three bytes:
7713 "s" = button state
7714 "c" = column plus 33
7715 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007716 This only works up to 223 columns! See "dec",
7717 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 xterm2 Works like "xterm", but with the xterm reporting the
7719 mouse position while the mouse is dragged. This works
7720 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007721 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 work. See below for how Vim detects this
7723 automatically.
7724 *netterm-mouse*
7725 netterm NetTerm mouse handling. The mouse generates
7726 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7727 for the row and column.
7728 *dec-mouse*
7729 dec DEC terminal mouse handling. The mouse generates a
7730 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007731 This is also available for an Xterm, if it was
7732 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 *jsbterm-mouse*
7734 jsbterm JSB term mouse handling.
7735 *pterm-mouse*
7736 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007737 *urxvt-mouse*
7738 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007739 The mouse works only if the terminal supports this
7740 encoding style, but it does not have 223 columns limit
7741 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007742 *sgr-mouse*
7743 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007744 mouse reporting. The mouse works even in columns
7745 beyond 223. This option is backward compatible with
7746 "xterm2" because it can also decode "xterm2" style
7747 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748
7749 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007750 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7751 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007752 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7753 recognized, if enabled at compile time. DEC terminal mouse codes
7754 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007755 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7756 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007758 set to a name that starts with "xterm", "mlterm", or "screen", and
7759 'ttymouse' is not set already.
7760 Additionally, if vim is compiled with the |+termresponse| feature and
7761 |t_RV| is set to the escape sequence to request the xterm version
7762 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007764 from 95 to 276. The "sgr" value will be set if the xterm version is
7765 277 or highter.
7766 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7767 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 :set t_RV=
7769<
7770 *'ttyscroll'* *'tsl'*
7771'ttyscroll' 'tsl' number (default 999)
7772 global
7773 Maximum number of lines to scroll the screen. If there are more lines
7774 to scroll the window is redrawn. For terminals where scrolling is
7775 very slow and redrawing is not slow this can be set to a small number,
7776 e.g., 3, to speed up displaying.
7777
7778 *'ttytype'* *'tty'*
7779'ttytype' 'tty' string (default from $TERM)
7780 global
7781 Alias for 'term', see above.
7782
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007783 *'undodir'* *'udir'*
7784'undodir' 'udir' string (default ".")
7785 global
7786 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007787 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007788 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007789 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007790 "." means using the directory of the file. The undo file name for
7791 "file.txt" is ".file.txt.un~".
7792 For other directories the file name is the full path of the edited
7793 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007794 When writing: The first directory that exists is used. "." always
7795 works, no directories after "." will be used for writing.
7796 When reading all entries are tried to find an undo file. The first
7797 undo file that exists is used. When it cannot be read an error is
7798 given, no further entry is used.
7799 See |undo-persistence|.
7800
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007801 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007802'undofile' 'udf' boolean (default off)
7803 local to buffer
7804 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007805 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007806 When on, Vim automatically saves undo history to an undo file when
7807 writing a buffer to a file, and restores undo history from the same
7808 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007809 The directory where the undo file is stored is specified by 'undodir'.
7810 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007811 The undo file is not read when 'undoreload' causes the buffer from
7812 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007813 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007814
Bram Moolenaar071d4272004-06-13 20:20:40 +00007815 *'undolevels'* *'ul'*
7816'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7817 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007818 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 {not in Vi}
7820 Maximum number of changes that can be undone. Since undo information
7821 is kept in memory, higher numbers will cause more memory to be used
7822 (nevertheless, a single change can use an unlimited amount of memory).
7823 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7824 itself: >
7825 set ul=0
7826< But you can also get Vi compatibility by including the 'u' flag in
7827 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007828 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007829 Set to -1 for no undo at all. You might want to do this only for the
7830 current buffer: >
7831 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007833
7834 The local value is set to -123456 when the global value is to be used.
7835
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007836 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007838 *'undoreload'* *'ur'*
7839'undoreload' 'ur' number (default 10000)
7840 global
7841 {not in Vi}
7842 Save the whole buffer for undo when reloading it. This applies to the
7843 ":e!" command and reloading for when the buffer changed outside of
7844 Vim. |FileChangedShell|
7845 The save only happens when this options is negative or when the number
7846 of lines is smaller than the value of this option.
7847 Set this option to zero to disable undo for a reload.
7848
7849 When saving undo for a reload, any undo file is not read.
7850
7851 Note that this causes the whole buffer to be stored in memory. Set
7852 this option to a lower value if you run out of memory.
7853
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 *'updatecount'* *'uc'*
7855'updatecount' 'uc' number (default: 200)
7856 global
7857 {not in Vi}
7858 After typing this many characters the swap file will be written to
7859 disk. When zero, no swap file will be created at all (see chapter on
7860 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7861 Vim with the "-n" option, see |startup|. When editing in readonly
7862 mode this option will be initialized to 10000.
7863 The swapfile can be disabled per buffer with |'swapfile'|.
7864 When 'updatecount' is set from zero to non-zero, swap files are
7865 created for all buffers that have 'swapfile' set. When 'updatecount'
7866 is set to zero, existing swap files are not deleted.
7867 Also see |'swapsync'|.
7868 This option has no meaning in buffers where |'buftype'| is "nofile"
7869 or "nowrite".
7870
7871 *'updatetime'* *'ut'*
7872'updatetime' 'ut' number (default 4000)
7873 global
7874 {not in Vi}
7875 If this many milliseconds nothing is typed the swap file will be
7876 written to disk (see |crash-recovery|). Also used for the
7877 |CursorHold| autocommand event.
7878
7879 *'verbose'* *'vbs'*
7880'verbose' 'vbs' number (default 0)
7881 global
7882 {not in Vi, although some versions have a boolean
7883 verbose option}
7884 When bigger than zero, Vim will give messages about what it is doing.
7885 Currently, these messages are given:
7886 >= 1 When the viminfo file is read or written.
7887 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007888 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 >= 8 Files for which a group of autocommands is executed.
7890 >= 9 Every executed autocommand.
7891 >= 12 Every executed function.
7892 >= 13 When an exception is thrown, caught, finished, or discarded.
7893 >= 14 Anything pending in a ":finally" clause.
7894 >= 15 Every executed Ex command (truncated at 200 characters).
7895
7896 This option can also be set with the "-V" argument. See |-V|.
7897 This option is also set by the |:verbose| command.
7898
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007899 When the 'verbosefile' option is set then the verbose messages are not
7900 displayed.
7901
7902 *'verbosefile'* *'vfile'*
7903'verbosefile' 'vfile' string (default empty)
7904 global
7905 {not in Vi}
7906 When not empty all messages are written in a file with this name.
7907 When the file exists messages are appended.
7908 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007909 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007910 Setting 'verbosefile' to a new value is like making it empty first.
7911 The difference with |:redir| is that verbose messages are not
7912 displayed when 'verbosefile' is set.
7913
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 *'viewdir'* *'vdir'*
7915'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7916 "$VIM/vimfiles/view",
7917 for Unix: "~/.vim/view",
7918 for Macintosh: "$VIM:vimfiles:view"
7919 for VMS: "sys$login:vimfiles/view"
7920 for RiscOS: "Choices:vimfiles/view")
7921 global
7922 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007923 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 feature}
7925 Name of the directory where to store files for |:mkview|.
7926 This option cannot be set from a |modeline| or in the |sandbox|, for
7927 security reasons.
7928
7929 *'viewoptions'* *'vop'*
7930'viewoptions' 'vop' string (default: "folds,options,cursor")
7931 global
7932 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007933 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 feature}
7935 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007936 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 word save and restore ~
7938 cursor cursor position in file and in window
7939 folds manually created folds, opened/closed folds and local
7940 fold options
7941 options options and mappings local to a window or buffer (not
7942 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007943 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 slash backslashes in file names replaced with forward
7945 slashes
7946 unix with Unix end-of-line format (single <NL>), even when
7947 on Windows or DOS
7948
7949 "slash" and "unix" are useful on Windows when sharing view files
7950 with Unix. The Unix version of Vim cannot source dos format scripts,
7951 but the Windows version of Vim can source unix format scripts.
7952
7953 *'viminfo'* *'vi'* *E526* *E527* *E528*
7954'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007955 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7956 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7957 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 global
7959 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007960 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 feature}
7962 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007963 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 separated list of parameters, each consisting of a single character
7965 identifying the particular parameter, followed by a number or string
7966 which specifies the value of that parameter. If a particular
7967 character is left out, then the default value is used for that
7968 parameter. The following is a list of the identifying characters and
7969 the effect of their value.
7970 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007971 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 ! When included, save and restore global variables that start
7973 with an uppercase letter, and don't contain a lowercase
7974 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007975 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007976 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007977 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007978 " Maximum number of lines saved for each register. Old name of
7979 the '<' item, with the disadvantage that you need to put a
7980 backslash before the ", otherwise it will be recognized as the
7981 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007982 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 % When included, save and restore the buffer list. If Vim is
7984 started with a file name argument, the buffer list is not
7985 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007986 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 without a file name and buffers for help files are not written
7988 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007989 When followed by a number, the number specifies the maximum
7990 number of buffers that are stored. Without a number all
7991 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007992 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 ' Maximum number of previously edited files for which the marks
7994 are remembered. This parameter must always be included when
7995 'viminfo' is non-empty.
7996 Including this item also means that the |jumplist| and the
7997 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007998 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007999 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008000 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 patterns are also saved. When not included, the value of
8002 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008003 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008004 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008005 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008006 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 < Maximum number of lines saved for each register. If zero then
8008 registers are not saved. When not included, all lines are
8009 saved. '"' is the old name for this item.
8010 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008011 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008013 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008014 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 c When included, convert the text in the viminfo file from the
8016 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008017 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008018 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008019 f Whether file marks need to be stored. If zero, file marks ('0
8020 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008021 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008023 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 h Disable the effect of 'hlsearch' when loading the viminfo
8025 file. When not included, it depends on whether ":nohlsearch"
8026 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008027 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 n Name of the viminfo file. The name must immediately follow
8029 the 'n'. Must be the last one! If the "-i" argument was
8030 given when starting Vim, that file name overrides the one
8031 given here with 'viminfo'. Environment variables are expanded
8032 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008033 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 r Removable media. The argument is a string (up to the next
8035 ','). This parameter can be given several times. Each
8036 specifies the start of a path for which no marks will be
8037 stored. This is to avoid removable media. For MS-DOS you
8038 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8039 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8040 ignored. Maximum length of each 'r' argument is 50
8041 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008042 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043 s Maximum size of an item in Kbyte. If zero then registers are
8044 not saved. Currently only applies to registers. The default
8045 "s10" will exclude registers with more than 10 Kbyte of text.
8046 Also see the '<' item above: line count limit.
8047
8048 Example: >
8049 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8050<
8051 '50 Marks will be remembered for the last 50 files you
8052 edited.
8053 <1000 Contents of registers (up to 1000 lines each) will be
8054 remembered.
8055 s100 Registers with more than 100 Kbyte text are skipped.
8056 :0 Command-line history will not be saved.
8057 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8058 no / Since '/' is not specified, the default will be used,
8059 that is, save all of the search history, and also the
8060 previous search and substitute patterns.
8061 no % The buffer list will not be saved nor read back.
8062 no h 'hlsearch' highlighting will be restored.
8063
8064 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8065 load the contents of the file, this is not done automatically.
8066
8067 This option cannot be set from a |modeline| or in the |sandbox|, for
8068 security reasons.
8069
8070 *'virtualedit'* *'ve'*
8071'virtualedit' 've' string (default "")
8072 global
8073 {not in Vi}
8074 {not available when compiled without the
8075 |+virtualedit| feature}
8076 A comma separated list of these words:
8077 block Allow virtual editing in Visual block mode.
8078 insert Allow virtual editing in Insert mode.
8079 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008080 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008081
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008083 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008084 of the line. Useful for selecting a rectangle in Visual mode and
8085 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008086 "onemore" is not the same, it will only allow moving the cursor just
8087 after the last character of the line. This makes some commands more
8088 consistent. Previously the cursor was always past the end of the line
8089 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008090 break some plugins or Vim scripts. For example because |l| can move
8091 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008092 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008093 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008094 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008095 It doesn't make sense to combine "all" with "onemore", but you will
8096 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097
8098 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8099'visualbell' 'vb' boolean (default off)
8100 global
8101 {not in Vi}
8102 Use visual bell instead of beeping. The terminal code to display the
8103 visual bell is given with 't_vb'. When no beep or flash is wanted,
8104 use ":set vb t_vb=".
8105 Note: When the GUI starts, 't_vb' is reset to its default value. You
8106 might want to set it again in your |gvimrc|.
8107 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8108 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8109 where 40 is the time in msec.
8110 Does not work on the Amiga, you always get a screen flash.
8111 Also see 'errorbells'.
8112
8113 *'warn'* *'nowarn'*
8114'warn' boolean (default on)
8115 global
8116 Give a warning message when a shell command is used while the buffer
8117 has been changed.
8118
8119 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8120'weirdinvert' 'wiv' boolean (default off)
8121 global
8122 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008123 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 It is provided for backwards compatibility with version 4.x.
8125 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8126 vice versa. Has no effect when the GUI is running.
8127
8128 *'whichwrap'* *'ww'*
8129'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8130 global
8131 {not in Vi}
8132 Allow specified keys that move the cursor left/right to move to the
8133 previous/next line when the cursor is on the first/last character in
8134 the line. Concatenate characters to allow this for these keys:
8135 char key mode ~
8136 b <BS> Normal and Visual
8137 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008138 h "h" Normal and Visual (not recommended)
8139 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008140 < <Left> Normal and Visual
8141 > <Right> Normal and Visual
8142 ~ "~" Normal
8143 [ <Left> Insert and Replace
8144 ] <Right> Insert and Replace
8145 For example: >
8146 :set ww=<,>,[,]
8147< allows wrap only when cursor keys are used.
8148 When the movement keys are used in combination with a delete or change
8149 operator, the <EOL> also counts for a character. This makes "3h"
8150 different from "3dh" when the cursor crosses the end of a line. This
8151 is also true for "x" and "X", because they do the same as "dl" and
8152 "dh". If you use this, you may also want to use the mapping
8153 ":map <BS> X" to make backspace delete the character in front of the
8154 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008155 When 'l' is included and it is used after an operator at the end of a
8156 line then it will not move to the next line. This makes "dl", "cl",
8157 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008158 NOTE: This option is set to the Vi default value when 'compatible' is
8159 set and to the Vim default value when 'compatible' is reset.
8160
8161 *'wildchar'* *'wc'*
8162'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8163 global
8164 {not in Vi}
8165 Character you have to type to start wildcard expansion in the
8166 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008167 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 The character is not recognized when used inside a macro. See
8169 'wildcharm' for that.
8170 Although 'wc' is a number option, you can set it to a special key: >
8171 :set wc=<Esc>
8172< NOTE: This option is set to the Vi default value when 'compatible' is
8173 set and to the Vim default value when 'compatible' is reset.
8174
8175 *'wildcharm'* *'wcm'*
8176'wildcharm' 'wcm' number (default: none (0))
8177 global
8178 {not in Vi}
8179 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008180 recognized when used inside a macro. You can find "spare" command-line
8181 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008182 you'll never actually type 'wildcharm', just use it in mappings that
8183 automatically invoke completion mode, e.g.: >
8184 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008185 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186< Then after typing :ss you can use CTRL-P & CTRL-N.
8187
8188 *'wildignore'* *'wig'*
8189'wildignore' 'wig' string (default "")
8190 global
8191 {not in Vi}
8192 {not available when compiled without the |+wildignore|
8193 feature}
8194 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008195 patterns is ignored when expanding |wildcards|, completing file or
8196 directory names, and influences the result of |expand()|, |glob()| and
8197 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008198 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8199 Also see 'suffixes'.
8200 Example: >
8201 :set wildignore=*.o,*.obj
8202< The use of |:set+=| and |:set-=| is preferred when adding or removing
8203 a pattern from the list. This avoids problems when a future version
8204 uses another default.
8205
Bram Moolenaar94950a92010-12-02 16:01:29 +01008206
Bram Moolenaar81af9252010-12-10 20:35:50 +01008207 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008208'wildignorecase' 'wic' boolean (default off)
8209 global
8210 {not in Vi}
8211 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008212 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008213 Does not apply when the shell is used to expand wildcards, which
8214 happens when there are special characters.
8215
8216
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8218'wildmenu' 'wmnu' boolean (default off)
8219 global
8220 {not in Vi}
8221 {not available if compiled without the |+wildmenu|
8222 feature}
8223 When 'wildmenu' is on, command-line completion operates in an enhanced
8224 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8225 the possible matches are shown just above the command line, with the
8226 first match highlighted (overwriting the status line, if there is
8227 one). Keys that show the previous/next match, such as <Tab> or
8228 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8229 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8230 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008231 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 If there are more matches than can fit in the line, a ">" is shown on
8233 the right and/or a "<" is shown on the left. The status line scrolls
8234 as needed.
8235 The "wildmenu" mode is abandoned when a key is hit that is not used
8236 for selecting a completion.
8237 While the "wildmenu" is active the following keys have special
8238 meanings:
8239
8240 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8241 <Down> - in filename/menu name completion: move into a
8242 subdirectory or submenu.
8243 <CR> - in menu completion, when the cursor is just after a
8244 dot: move into a submenu.
8245 <Up> - in filename/menu name completion: move up into
8246 parent directory or parent menu.
8247
8248 This makes the menus accessible from the console |console-menus|.
8249
8250 If you prefer the <Left> and <Right> keys to move the cursor instead
8251 of selecting a different match, use this: >
8252 :cnoremap <Left> <Space><BS><Left>
8253 :cnoremap <Right> <Space><BS><Right>
8254<
8255 The "WildMenu" highlighting is used for displaying the current match
8256 |hl-WildMenu|.
8257
8258 *'wildmode'* *'wim'*
8259'wildmode' 'wim' string (Vim default: "full")
8260 global
8261 {not in Vi}
8262 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008263 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008264 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008265 first part specifies the behavior for the first use of 'wildchar',
8266 The second part for the second use, etc.
8267 These are the possible values for each part:
8268 "" Complete only the first match.
8269 "full" Complete the next full match. After the last match,
8270 the original string is used and then the first match
8271 again.
8272 "longest" Complete till longest common string. If this doesn't
8273 result in a longer string, use the next part.
8274 "longest:full" Like "longest", but also start 'wildmenu' if it is
8275 enabled.
8276 "list" When more than one match, list all matches.
8277 "list:full" When more than one match, list all matches and
8278 complete first match.
8279 "list:longest" When more than one match, list all matches and
8280 complete till longest common string.
8281 When there is only a single match, it is fully completed in all cases.
8282
8283 Examples: >
8284 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008285< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008286 :set wildmode=longest,full
8287< Complete longest common string, then each full match >
8288 :set wildmode=list:full
8289< List all matches and complete each full match >
8290 :set wildmode=list,full
8291< List all matches without completing, then each full match >
8292 :set wildmode=longest,list
8293< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008294 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008295
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008296 *'wildoptions'* *'wop'*
8297'wildoptions' 'wop' string (default "")
8298 global
8299 {not in Vi}
8300 {not available when compiled without the |+wildignore|
8301 feature}
8302 A list of words that change how command line completion is done.
8303 Currently only one word is allowed:
8304 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008305 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008306 is displayed per line. Often used tag kinds are:
8307 d #define
8308 f function
8309 Also see |cmdline-completion|.
8310
Bram Moolenaar071d4272004-06-13 20:20:40 +00008311 *'winaltkeys'* *'wak'*
8312'winaltkeys' 'wak' string (default "menu")
8313 global
8314 {not in Vi}
8315 {only used in Win32, Motif, GTK and Photon GUI}
8316 Some GUI versions allow the access to menu entries by using the ALT
8317 key in combination with a character that appears underlined in the
8318 menu. This conflicts with the use of the ALT key for mappings and
8319 entering special characters. This option tells what to do:
8320 no Don't use ALT keys for menus. ALT key combinations can be
8321 mapped, but there is no automatic handling. This can then be
8322 done with the |:simalt| command.
8323 yes ALT key handling is done by the windowing system. ALT key
8324 combinations cannot be mapped.
8325 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008326 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 keys can be mapped.
8328 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8329 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008330 This option is not used for <F10>; on Win32 and with GTK <F10> will
8331 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008332
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008333 *'window'* *'wi'*
8334'window' 'wi' number (default screen height - 1)
8335 global
8336 Window height. Do not confuse this with the height of the Vim window,
8337 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008338 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8339 value is smaller than 'lines' minus one. The screen will scroll
8340 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008341 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8342 in a much smarter way, taking care of wrapping lines.
8343 When resizing the Vim window, the value is smaller than 1 or more than
8344 or equal to 'lines' it will be set to 'lines' minus 1.
8345 {Vi also uses the option to specify the number of displayed lines}
8346
Bram Moolenaar071d4272004-06-13 20:20:40 +00008347 *'winheight'* *'wh'* *E591*
8348'winheight' 'wh' number (default 1)
8349 global
8350 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008351 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 feature}
8353 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008354 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008355 focus goes to a window that is smaller, its size is increased, at the
8356 cost of the height of other windows.
8357 Set 'winheight' to a small number for normal editing.
8358 Set it to 999 to make the current window fill most of the screen.
8359 Other windows will be only 'winminheight' high. This has the drawback
8360 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8361 to create only two windows, set the option after startup is done,
8362 using the |VimEnter| event: >
8363 au VimEnter * set winheight=999
8364< Minimum value is 1.
8365 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 height of the current window.
8367 'winheight' applies to the current window. Use 'winminheight' to set
8368 the minimal height for other windows.
8369
8370 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8371'winfixheight' 'wfh' boolean (default off)
8372 local to window
8373 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008374 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 feature}
8376 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008377 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8378 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008379 The height may be changed anyway when running out of room.
8380
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008381 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8382'winfixwidth' 'wfw' boolean (default off)
8383 local to window
8384 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008385 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008386 feature}
8387 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008388 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008389 The width may be changed anyway when running out of room.
8390
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 *'winminheight'* *'wmh'*
8392'winminheight' 'wmh' number (default 1)
8393 global
8394 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008395 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 feature}
8397 The minimal height of a window, when it's not the current window.
8398 This is a hard minimum, windows will never become smaller.
8399 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8400 status bar) if necessary. They will return to at least one line when
8401 they become active (since the cursor has to have somewhere to go.)
8402 Use 'winheight' to set the minimal height of the current window.
8403 This option is only checked when making a window smaller. Don't use a
8404 large number, it will cause errors when opening more than a few
8405 windows. A value of 0 to 3 is reasonable.
8406
8407 *'winminwidth'* *'wmw'*
8408'winminwidth' 'wmw' number (default 1)
8409 global
8410 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008411 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412 feature}
8413 The minimal width of a window, when it's not the current window.
8414 This is a hard minimum, windows will never become smaller.
8415 When set to zero, windows may be "squashed" to zero columns (i.e. just
8416 a vertical separator) if necessary. They will return to at least one
8417 line when they become active (since the cursor has to have somewhere
8418 to go.)
8419 Use 'winwidth' to set the minimal width of the current window.
8420 This option is only checked when making a window smaller. Don't use a
8421 large number, it will cause errors when opening more than a few
8422 windows. A value of 0 to 12 is reasonable.
8423
8424 *'winwidth'* *'wiw'* *E592*
8425'winwidth' 'wiw' number (default 20)
8426 global
8427 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008428 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 feature}
8430 Minimal number of columns for the current window. This is not a hard
8431 minimum, Vim will use fewer columns if there is not enough room. If
8432 the current window is smaller, its size is increased, at the cost of
8433 the width of other windows. Set it to 999 to make the current window
8434 always fill the screen. Set it to a small number for normal editing.
8435 The width is not adjusted after one of the commands to change the
8436 width of the current window.
8437 'winwidth' applies to the current window. Use 'winminwidth' to set
8438 the minimal width for other windows.
8439
8440 *'wrap'* *'nowrap'*
8441'wrap' boolean (default on)
8442 local to window
8443 {not in Vi}
8444 This option changes how text is displayed. It doesn't change the text
8445 in the buffer, see 'textwidth' for that.
8446 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008447 displaying continues on the next line. When off lines will not wrap
8448 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 moved to a part that is not shown, the screen will scroll
8450 horizontally.
8451 The line will be broken in the middle of a word if necessary. See
8452 'linebreak' to get the break at a word boundary.
8453 To make scrolling horizontally a bit more useful, try this: >
8454 :set sidescroll=5
8455 :set listchars+=precedes:<,extends:>
8456< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008457 This option can't be set from a |modeline| when the 'diff' option is
8458 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459
8460 *'wrapmargin'* *'wm'*
8461'wrapmargin' 'wm' number (default 0)
8462 local to buffer
8463 Number of characters from the right window border where wrapping
8464 starts. When typing text beyond this limit, an <EOL> will be inserted
8465 and inserting continues on the next line.
8466 Options that add a margin, such as 'number' and 'foldcolumn', cause
8467 the text width to be further reduced. This is Vi compatible.
8468 When 'textwidth' is non-zero, this option is not used.
8469 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8470 and less usefully}
8471
8472 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8473'wrapscan' 'ws' boolean (default on) *E384* *E385*
8474 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008475 Searches wrap around the end of the file. Also applies to |]s| and
8476 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008477
8478 *'write'* *'nowrite'*
8479'write' boolean (default on)
8480 global
8481 {not in Vi}
8482 Allows writing files. When not set, writing a file is not allowed.
8483 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008484 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 argument. Filtering text is still possible, even though this requires
8486 writing a temporary file.
8487
8488 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8489'writeany' 'wa' boolean (default off)
8490 global
8491 Allows writing to any file with no need for "!" override.
8492
8493 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8494'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8495 otherwise)
8496 global
8497 {not in Vi}
8498 Make a backup before overwriting a file. The backup is removed after
8499 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008500 also on.
8501 WARNING: Switching this option off means that when Vim fails to write
8502 your buffer correctly and then, for whatever reason, Vim exits, you
8503 lose both the original file and what you were writing. Only reset
8504 this option if your file system is almost full and it makes the write
8505 fail (and make sure not to exit Vim until the write was successful).
8506 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008507 When the 'backupskip' pattern matches, a backup is not made anyway.
8508 NOTE: This option is set to the default value when 'compatible' is
8509 set.
8510
8511 *'writedelay'* *'wd'*
8512'writedelay' 'wd' number (default 0)
8513 global
8514 {not in Vi}
8515 The number of microseconds to wait for each character sent to the
8516 screen. When non-zero, characters are sent to the terminal one by
8517 one. For MS-DOS pcterm this does not work. For debugging purposes.
8518
8519 vim:tw=78:ts=8:ft=help:norl: