blob: 918e1b7e4d0cb5d23ece236da78cbfd4b623bb51 [file] [log] [blame]
Bram Moolenaar8feef4f2015-01-07 16:57:10 +01001*options.txt* For Vim version 7.4. Last change: 2014 Dec 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}
539{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000540For example, to use a modeline only for Vim 6.0 and later:
541 /* vim600: set foldmethod=marker: */ ~
542To use a modeline for Vim before version 5.7:
543 /* vim<570: set sw=4: */ ~
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 Moolenaar071d4272004-06-13 20:20:40 +00001127 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1128'binary' 'bin' boolean (default off)
1129 local to buffer
1130 {not in Vi}
1131 This option should be set before editing a binary file. You can also
1132 use the |-b| Vim argument. When this option is switched on a few
1133 options will be changed (also when it already was on):
1134 'textwidth' will be set to 0
1135 'wrapmargin' will be set to 0
1136 'modeline' will be off
1137 'expandtab' will be off
1138 Also, 'fileformat' and 'fileformats' options will not be used, the
1139 file is read and written like 'fileformat' was "unix" (a single <NL>
1140 separates lines).
1141 The 'fileencoding' and 'fileencodings' options will not be used, the
1142 file is read without conversion.
1143 NOTE: When you start editing a(nother) file while the 'bin' option is
1144 on, settings from autocommands may change the settings again (e.g.,
1145 'textwidth'), causing trouble when editing. You might want to set
1146 'bin' again when the file has been loaded.
1147 The previous values of these options are remembered and restored when
1148 'bin' is switched from on to off. Each buffer has its own set of
1149 saved option values.
1150 To edit a file with 'binary' set you can use the |++bin| argument.
1151 This avoids you have to do ":set bin", which would have effect for all
1152 files you edit.
1153 When writing a file the <EOL> for the last line is only written if
1154 there was one in the original file (normally Vim appends an <EOL> to
1155 the last line if there is none; this would make the file longer). See
1156 the 'endofline' option.
1157
1158 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1159'bioskey' 'biosk' boolean (default on)
1160 global
1161 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001162 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 better to detect CTRL-C, but only works for the console. When using a
1164 terminal over a serial port reset this option.
1165 Also see |'conskey'|.
1166
1167 *'bomb'* *'nobomb'*
1168'bomb' boolean (default off)
1169 local to buffer
1170 {not in Vi}
1171 {only available when compiled with the |+multi_byte|
1172 feature}
1173 When writing a file and the following conditions are met, a BOM (Byte
1174 Order Mark) is prepended to the file:
1175 - this option is on
1176 - the 'binary' option is off
1177 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1178 endian variants.
1179 Some applications use the BOM to recognize the encoding of the file.
1180 Often used for UCS-2 files on MS-Windows. For other applications it
1181 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001182 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001183 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1184 check for the presence of the BOM is done and 'bomb' set accordingly.
1185 Unless 'binary' is set, it is removed from the first line, so that you
1186 don't see it when editing. When you don't change the options, the BOM
1187 will be restored when writing the file.
1188
1189 *'breakat'* *'brk'*
1190'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1191 global
1192 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001193 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 feature}
1195 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001196 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1197 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001198
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001199 *'breakindent'* *'bri'*
1200'breakindent' 'bri' boolean (default off)
1201 local to window
1202 {not in Vi}
1203 {not available when compiled without the |+linebreak|
1204 feature}
1205 Every wrapped line will continue visually indented (same amount of
1206 space as the beginning of that line), thus preserving horizontal blocks
1207 of text.
1208
1209 *'breakindentopt'* *'briopt'*
1210'breakindentopt' 'briopt' string (default empty)
1211 local to window
1212 {not in Vi}
1213 {not available when compiled without the |+linebreak|
1214 feature}
1215 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001216 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001217 min:{n} Minimum text width that will be kept after
1218 applying 'breakindent', even if the resulting
1219 text should normally be narrower. This prevents
1220 text indented almost to the right window border
1221 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001222 shift:{n} After applying 'breakindent', the wrapped line's
1223 beginning will be shifted by the given number of
1224 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001225 indentation (negative) or emphasizing the line
1226 continuation (positive).
1227 sbr Display the 'showbreak' value before applying the
1228 additional indent.
1229 The default value for min is 20 and shift is 0.
1230
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001232'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001234 {not in Vi} {only for Motif, Athena, GTK, Mac and
1235 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001236 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001237 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001238 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239 buffer Use the directory of the related buffer.
1240 current Use the current directory.
1241 {path} Use the specified directory
1242
1243 *'bufhidden'* *'bh'*
1244'bufhidden' 'bh' string (default: "")
1245 local to buffer
1246 {not in Vi}
1247 {not available when compiled without the |+quickfix|
1248 feature}
1249 This option specifies what happens when a buffer is no longer
1250 displayed in a window:
1251 <empty> follow the global 'hidden' option
1252 hide hide the buffer (don't unload it), also when 'hidden'
1253 is not set
1254 unload unload the buffer, also when 'hidden' is set or using
1255 |:hide|
1256 delete delete the buffer from the buffer list, also when
1257 'hidden' is set or using |:hide|, like using
1258 |:bdelete|
1259 wipe wipe out the buffer from the buffer list, also when
1260 'hidden' is set or using |:hide|, like using
1261 |:bwipeout|
1262
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001263 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001264 are lost without a warning. Also, these values may break autocommands
1265 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 This option is used together with 'buftype' and 'swapfile' to specify
1267 special kinds of buffers. See |special-buffers|.
1268
1269 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1270'buflisted' 'bl' boolean (default: on)
1271 local to buffer
1272 {not in Vi}
1273 When this option is set, the buffer shows up in the buffer list. If
1274 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1275 This option is reset by Vim for buffers that are only used to remember
1276 a file name or marks. Vim sets it when starting to edit a buffer.
1277 But not when moving to a buffer with ":buffer".
1278
1279 *'buftype'* *'bt'* *E382*
1280'buftype' 'bt' string (default: "")
1281 local to buffer
1282 {not in Vi}
1283 {not available when compiled without the |+quickfix|
1284 feature}
1285 The value of this option specifies the type of a buffer:
1286 <empty> normal buffer
1287 nofile buffer which is not related to a file and will not be
1288 written
1289 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001290 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001291 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001292 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001294 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 help help buffer (you are not supposed to set this
1296 manually)
1297
1298 This option is used together with 'bufhidden' and 'swapfile' to
1299 specify special kinds of buffers. See |special-buffers|.
1300
1301 Be careful with changing this option, it can have many side effects!
1302
Bram Moolenaar280f1262006-01-30 00:14:18 +00001303 A "quickfix" buffer is only used for the error list and the location
1304 list. This value is set by the |:cwindow| and |:lwindow| commands and
1305 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306
1307 "nofile" and "nowrite" buffers are similar:
1308 both: The buffer is not to be written to disk, ":w" doesn't
1309 work (":w filename" does work though).
1310 both: The buffer is never considered to be |'modified'|.
1311 There is no warning when the changes will be lost, for
1312 example when you quit Vim.
1313 both: A swap file is only created when using too much memory
1314 (when 'swapfile' has been reset there is never a swap
1315 file).
1316 nofile only: The buffer name is fixed, it is not handled like a
1317 file name. It is not modified in response to a |:cd|
1318 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001319 *E676*
1320 "acwrite" implies that the buffer name is not related to a file, like
1321 "nofile", but it will be written. Thus, in contrast to "nofile" and
1322 "nowrite", ":w" does work and a modified buffer can't be abandoned
1323 without saving. For writing there must be matching |BufWriteCmd|,
1324 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325
1326 *'casemap'* *'cmp'*
1327'casemap' 'cmp' string (default: "internal,keepascii")
1328 global
1329 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001330 {only available when compiled with the |+multi_byte|
1331 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001332 Specifies details about changing the case of letters. It may contain
1333 these words, separated by a comma:
1334 internal Use internal case mapping functions, the current
1335 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001336 matters when 'encoding' is a Unicode encoding,
1337 "latin1" or "iso-8859-15". When "internal" is
1338 omitted, the towupper() and towlower() system library
1339 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001340 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1341 case mapping, the current locale is not effective.
1342 This probably only matters for Turkish.
1343
1344 *'cdpath'* *'cd'* *E344* *E346*
1345'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1346 global
1347 {not in Vi}
1348 {not available when compiled without the
1349 |+file_in_path| feature}
1350 This is a list of directories which will be searched when using the
1351 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001352 for has a relative path, not an absolute part starting with "/", "./"
1353 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 The 'cdpath' option's value has the same form and semantics as
1355 |'path'|. Also see |file-searching|.
1356 The default value is taken from $CDPATH, with a "," prepended to look
1357 in the current directory first.
1358 If the default value taken from $CDPATH is not what you want, include
1359 a modified version of the following command in your vimrc file to
1360 override it: >
1361 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1362< This option cannot be set from a |modeline| or in the |sandbox|, for
1363 security reasons.
1364 (parts of 'cdpath' can be passed to the shell to expand file names).
1365
1366 *'cedit'*
1367'cedit' string (Vi default: "", Vim default: CTRL-F)
1368 global
1369 {not in Vi}
1370 {not available when compiled without the |+vertsplit|
1371 feature}
1372 The key used in Command-line Mode to open the command-line window.
1373 The default is CTRL-F when 'compatible' is off.
1374 Only non-printable keys are allowed.
1375 The key can be specified as a single character, but it is difficult to
1376 type. The preferred way is to use the <> notation. Examples: >
1377 :set cedit=<C-Y>
1378 :set cedit=<Esc>
1379< |Nvi| also has this option, but it only uses the first character.
1380 See |cmdwin|.
1381
1382 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1383'charconvert' 'ccv' string (default "")
1384 global
1385 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001386 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 {not in Vi}
1388 An expression that is used for character encoding conversion. It is
1389 evaluated when a file that is to be read or has been written has a
1390 different encoding from what is desired.
1391 'charconvert' is not used when the internal iconv() function is
1392 supported and is able to do the conversion. Using iconv() is
1393 preferred, because it is much faster.
1394 'charconvert' is not used when reading stdin |--|, because there is no
1395 file to convert from. You will have to save the text in a file first.
1396 The expression must return zero or an empty string for success,
1397 non-zero for failure.
1398 The possible encoding names encountered are in 'encoding'.
1399 Additionally, names given in 'fileencodings' and 'fileencoding' are
1400 used.
1401 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1402 is done internally by Vim, 'charconvert' is not used for this.
1403 'charconvert' is also used to convert the viminfo file, if the 'c'
1404 flag is present in 'viminfo'. Also used for Unicode conversion.
1405 Example: >
1406 set charconvert=CharConvert()
1407 fun CharConvert()
1408 system("recode "
1409 \ . v:charconvert_from . ".." . v:charconvert_to
1410 \ . " <" . v:fname_in . " >" v:fname_out)
1411 return v:shell_error
1412 endfun
1413< The related Vim variables are:
1414 v:charconvert_from name of the current encoding
1415 v:charconvert_to name of the desired encoding
1416 v:fname_in name of the input file
1417 v:fname_out name of the output file
1418 Note that v:fname_in and v:fname_out will never be the same.
1419 Note that v:charconvert_from and v:charconvert_to may be different
1420 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1421 Encryption is not done by Vim when using 'charconvert'. If you want
1422 to encrypt the file after conversion, 'charconvert' should take care
1423 of this.
1424 This option cannot be set from a |modeline| or in the |sandbox|, for
1425 security reasons.
1426
1427 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1428'cindent' 'cin' boolean (default off)
1429 local to buffer
1430 {not in Vi}
1431 {not available when compiled without the |+cindent|
1432 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001433 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 that trigger reindenting in insert mode and 'cinoptions' to set your
1435 preferred indent style.
1436 If 'indentexpr' is not empty, it overrules 'cindent'.
1437 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1438 the "=" operator indents using this algorithm rather than calling an
1439 external program.
1440 See |C-indenting|.
1441 When you don't like the way 'cindent' works, try the 'smartindent'
1442 option or 'indentexpr'.
1443 This option is not used when 'paste' is set.
1444 NOTE: This option is reset when 'compatible' is set.
1445
1446 *'cinkeys'* *'cink'*
1447'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1448 local to buffer
1449 {not in Vi}
1450 {not available when compiled without the |+cindent|
1451 feature}
1452 A list of keys that, when typed in Insert mode, cause reindenting of
1453 the current line. Only used if 'cindent' is on and 'indentexpr' is
1454 empty.
1455 For the format of this option see |cinkeys-format|.
1456 See |C-indenting|.
1457
1458 *'cinoptions'* *'cino'*
1459'cinoptions' 'cino' string (default "")
1460 local to buffer
1461 {not in Vi}
1462 {not available when compiled without the |+cindent|
1463 feature}
1464 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1465 program. See |cinoptions-values| for the values of this option, and
1466 |C-indenting| for info on C indenting in general.
1467
1468
1469 *'cinwords'* *'cinw'*
1470'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1471 local to buffer
1472 {not in Vi}
1473 {not available when compiled without both the
1474 |+cindent| and the |+smartindent| features}
1475 These keywords start an extra indent in the next line when
1476 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1477 an appropriate place (inside {}).
1478 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1479 matter, include the keyword both the uppercase and lowercase:
1480 "if,If,IF".
1481
1482 *'clipboard'* *'cb'*
1483'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1484 for X-windows, "" otherwise)
1485 global
1486 {not in Vi}
1487 {only in GUI versions or when the |+xterm_clipboard|
1488 feature is included}
1489 This option is a list of comma separated names.
1490 These names are recognized:
1491
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001492 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 unnamed When included, Vim will use the clipboard register '*'
1494 for all yank, delete, change and put operations which
1495 would normally go to the unnamed register. When a
1496 register is explicitly specified, it will always be
1497 used regardless of whether "unnamed" is in 'clipboard'
1498 or not. The clipboard register can always be
1499 explicitly accessed using the "* notation. Also see
1500 |gui-clipboard|.
1501
Bram Moolenaar30b65812012-07-12 22:01:11 +02001502 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001503 unnamedplus A variant of the "unnamed" flag which uses the
1504 clipboard register '+' (|quoteplus|) instead of
1505 register '*' for all yank, delete, change and put
1506 operations which would normally go to the unnamed
1507 register. When "unnamed" is also included to the
1508 option, yank operations (but not delete, change or
1509 put) will additionally copy the text into register
1510 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001511 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001512 Availability can be checked with: >
1513 if has('unnamedplus')
1514<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001515 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 autoselect Works like the 'a' flag in 'guioptions': If present,
1517 then whenever Visual mode is started, or the Visual
1518 area extended, Vim tries to become the owner of the
1519 windowing system's global selection or put the
1520 selected text on the clipboard used by the selection
1521 register "*. See |guioptions_a| and |quotestar| for
1522 details. When the GUI is active, the 'a' flag in
1523 'guioptions' is used, when the GUI is not active, this
1524 "autoselect" flag is used.
1525 Also applies to the modeless selection.
1526
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001527 *clipboard-autoselectplus*
1528 autoselectplus Like "autoselect" but using the + register instead of
1529 the * register. Compare to the 'P' flag in
1530 'guioptions'.
1531
1532 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 autoselectml Like "autoselect", but for the modeless selection
1534 only. Compare to the 'A' flag in 'guioptions'.
1535
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001536 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001537 html When the clipboard contains HTML, use this when
1538 pasting. When putting text on the clipboard, mark it
1539 as HTML. This works to copy rendered HTML from
1540 Firefox, paste it as raw HTML in Vim, select the HTML
1541 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001542 You probably want to add this only temporarily,
1543 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001544 Only supported for GTK version 2 and later.
1545 Only available with the |+multi_byte| feature.
1546
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001547 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001548 exclude:{pattern}
1549 Defines a pattern that is matched against the name of
1550 the terminal 'term'. If there is a match, no
1551 connection will be made to the X server. This is
1552 useful in this situation:
1553 - Running Vim in a console.
1554 - $DISPLAY is set to start applications on another
1555 display.
1556 - You do not want to connect to the X server in the
1557 console, but do want this in a terminal emulator.
1558 To never connect to the X server use: >
1559 exclude:.*
1560< This has the same effect as using the |-X| argument.
1561 Note that when there is no connection to the X server
1562 the window title won't be restored and the clipboard
1563 cannot be accessed.
1564 The value of 'magic' is ignored, {pattern} is
1565 interpreted as if 'magic' was on.
1566 The rest of the option value will be used for
1567 {pattern}, this must be the last entry.
1568
1569 *'cmdheight'* *'ch'*
1570'cmdheight' 'ch' number (default 1)
1571 global
1572 {not in Vi}
1573 Number of screen lines to use for the command-line. Helps avoiding
1574 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001575 The value of this option is stored with the tab page, so that each tab
1576 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577
1578 *'cmdwinheight'* *'cwh'*
1579'cmdwinheight' 'cwh' number (default 7)
1580 global
1581 {not in Vi}
1582 {not available when compiled without the |+vertsplit|
1583 feature}
1584 Number of screen lines to use for the command-line window. |cmdwin|
1585
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001586 *'colorcolumn'* *'cc'*
1587'colorcolumn' 'cc' string (default "")
1588 local to window
1589 {not in Vi}
1590 {not available when compiled without the |+syntax|
1591 feature}
1592 'colorcolumn' is a comma separated list of screen columns that are
1593 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1594 text. Will make screen redrawing slower.
1595 The screen column can be an absolute number, or a number preceded with
1596 '+' or '-', which is added to or subtracted from 'textwidth'. >
1597
1598 :set cc=+1 " highlight column after 'textwidth'
1599 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1600 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1601<
1602 When 'textwidth' is zero then the items with '-' and '+' are not used.
1603 A maximum of 256 columns are highlighted.
1604
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 *'columns'* *'co'* *E594*
1606'columns' 'co' number (default 80 or terminal width)
1607 global
1608 {not in Vi}
1609 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001610 initialization and does not have to be set by hand. Also see
1611 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 When Vim is running in the GUI or in a resizable window, setting this
1613 option will cause the window size to be changed. When you only want
1614 to use the size for the GUI, put the command in your |gvimrc| file.
1615 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001616 number of columns of the display, the display may be messed up. For
1617 the GUI it is always possible and Vim limits the number of columns to
1618 what fits on the screen. You can use this command to get the widest
1619 window possible: >
1620 :set columns=9999
1621< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622
1623 *'comments'* *'com'* *E524* *E525*
1624'comments' 'com' string (default
1625 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1626 local to buffer
1627 {not in Vi}
1628 {not available when compiled without the |+comments|
1629 feature}
1630 A comma separated list of strings that can start a comment line. See
1631 |format-comments|. See |option-backslash| about using backslashes to
1632 insert a space.
1633
1634 *'commentstring'* *'cms'* *E537*
1635'commentstring' 'cms' string (default "/*%s*/")
1636 local to buffer
1637 {not in Vi}
1638 {not available when compiled without the |+folding|
1639 feature}
1640 A template for a comment. The "%s" in the value is replaced with the
1641 comment text. Currently only used to add markers for folding, see
1642 |fold-marker|.
1643
1644 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001645'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1646 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 global
1648 {not in Vi}
1649 This option has the effect of making Vim either more Vi-compatible, or
1650 make Vim behave in a more useful way.
1651 This is a special kind of option, because when it's set or reset,
1652 other options are also changed as a side effect. CAREFUL: Setting or
1653 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001654 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 set this option in your vimrc file, you should probably put it at the
1656 very start.
1657 By default this option is on and the Vi defaults are used for the
1658 options. This default was chosen for those people who want to use Vim
1659 just like Vi, and don't even (want to) know about the 'compatible'
1660 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001661 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001662 this option is switched off, and all options that have not been
1663 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001664 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001665 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001666 happen for the system-wide vimrc or gvimrc file, nor for a file given
1667 with the |-u| argument). Also see |compatible-default| and
1668 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669 You can also set this option with the "-C" argument, and reset it with
1670 "-N". See |-C| and |-N|.
1671 Switching this option off makes the Vim defaults be used for options
1672 that have a different Vi and Vim default value. See the options
1673 marked with a '+' below. Other options are not modified.
1674 At the moment this option is set, several other options will be set
1675 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001676 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 editing.
1678 See also 'cpoptions'.
1679
1680 option + set value effect ~
1681
1682 'allowrevins' off no CTRL-_ command
1683 'backupcopy' Unix: "yes" backup file is a copy
1684 others: "auto" copy or rename backup file
1685 'backspace' "" normal backspace
1686 'backup' off no backup file
1687 'cindent' off no C code indentation
1688 'cedit' + "" no key to open the |cmdwin|
1689 'cpoptions' + (all flags) Vi-compatible flags
1690 'cscopetag' off don't use cscope for ":tag"
1691 'cscopetagorder' 0 see |cscopetagorder|
1692 'cscopeverbose' off see |cscopeverbose|
1693 'digraph' off no digraphs
1694 'esckeys' + off no <Esc>-keys in Insert mode
1695 'expandtab' off tabs not expanded to spaces
1696 'fileformats' + "" no automatic file format detection,
1697 "dos,unix" except for DOS, Windows and OS/2
1698 'formatoptions' + "vt" Vi compatible formatting
1699 'gdefault' off no default 'g' flag for ":s"
1700 'history' + 0 no commandline history
1701 'hkmap' off no Hebrew keyboard mapping
1702 'hkmapp' off no phonetic Hebrew keyboard mapping
1703 'hlsearch' off no highlighting of search matches
1704 'incsearch' off no incremental searching
1705 'indentexpr' "" no indenting by expression
1706 'insertmode' off do not start in Insert mode
1707 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1708 characters and '_'
1709 'joinspaces' on insert 2 spaces after period
1710 'modeline' + off no modelines
1711 'more' + off no pauses in listings
1712 'revins' off no reverse insert
1713 'ruler' off no ruler
1714 'scrolljump' 1 no jump scroll
1715 'scrolloff' 0 no scroll offset
1716 'shiftround' off indent not rounded to shiftwidth
1717 'shortmess' + "" no shortening of messages
1718 'showcmd' + off command characters not shown
1719 'showmode' + off current mode not shown
1720 'smartcase' off no automatic ignore case switch
1721 'smartindent' off no smart indentation
1722 'smarttab' off no smart tab size
1723 'softtabstop' 0 tabs are always 'tabstop' positions
1724 'startofline' on goto startofline with some commands
1725 'tagrelative' + off tag file names are not relative
1726 'textauto' + off no automatic textmode detection
1727 'textwidth' 0 no automatic line wrap
1728 'tildeop' off tilde is not an operator
1729 'ttimeout' off no terminal timeout
1730 'whichwrap' + "" left-right movements don't wrap
1731 'wildchar' + CTRL-E only when the current value is <Tab>
1732 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001733 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001734
1735 *'complete'* *'cpt'* *E535*
1736'complete' 'cpt' string (default: ".,w,b,u,t,i")
1737 local to buffer
1738 {not in Vi}
1739 This option specifies how keyword completion |ins-completion| works
1740 when CTRL-P or CTRL-N are used. It is also used for whole-line
1741 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1742 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001743 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 w scan buffers from other windows
1745 b scan other loaded buffers that are in the buffer list
1746 u scan the unloaded buffers that are in the buffer list
1747 U scan the buffers that are not in the buffer list
1748 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001749 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 k{dict} scan the file {dict}. Several "k" flags can be given,
1751 patterns are valid too. For example: >
1752 :set cpt=k/usr/dict/*,k~/spanish
1753< s scan the files given with the 'thesaurus' option
1754 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1755 are valid too.
1756 i scan current and included files
1757 d scan current and included files for defined name or macro
1758 |i_CTRL-X_CTRL-D|
1759 ] tag completion
1760 t same as "]"
1761
1762 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1763 not executed, this may lead to unexpected completions from some files
1764 (gzipped files for example). Unloaded buffers are not scanned for
1765 whole-line completion.
1766
1767 The default is ".,w,b,u,t,i", which means to scan:
1768 1. the current buffer
1769 2. buffers in other windows
1770 3. other loaded buffers
1771 4. unloaded buffers
1772 5. tags
1773 6. included files
1774
1775 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001776 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1777 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001779 *'completefunc'* *'cfu'*
1780'completefunc' 'cfu' string (default: empty)
1781 local to buffer
1782 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001783 {not available when compiled without the |+eval|
1784 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001785 This option specifies a function to be used for Insert mode completion
1786 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001787 See |complete-functions| for an explanation of how the function is
1788 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001789 This option cannot be set from a |modeline| or in the |sandbox|, for
1790 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001791
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001792 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001793'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001794 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001795 {not available when compiled without the
1796 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001797 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001798 A comma separated list of options for Insert mode completion
1799 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001800
1801 menu Use a popup menu to show the possible completions. The
1802 menu is only shown when there is more than one match and
1803 sufficient colors are available. |ins-completion-menu|
1804
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001805 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001806 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001807 match, e.g., what file it comes from.
1808
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001809 longest Only insert the longest common text of the matches. If
1810 the menu is displayed you can use CTRL-L to add more
1811 characters. Whether case is ignored depends on the kind
1812 of completion. For buffer text the 'ignorecase' option is
1813 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001814
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001815 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001816 completion in the preview window. Only works in
1817 combination with "menu" or "menuone".
1818
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001819
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001820 *'concealcursor'* *'cocu'*
1821'concealcursor' 'cocu' string (default: "")
1822 local to window
1823 {not in Vi}
1824 {not available when compiled without the |+conceal|
1825 feature}
1826 Sets the modes in which text in the cursor line can also be concealed.
1827 When the current mode is listed then concealing happens just like in
1828 other lines.
1829 n Normal mode
1830 v Visual mode
1831 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001832 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001833
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001834 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001835 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001836 are moving around text is concealed, but when starting to insert text
1837 or selecting a Visual area the concealed text is displayed, so that
1838 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001839 Keep in mind that the cursor position is not always where it's
1840 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001841
1842
1843'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001844 number (default 0)
1845 local to window
1846 {not in Vi}
1847 {not available when compiled without the |+conceal|
1848 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001849 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1850 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001851
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001852 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001853 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001854 1 Each block of concealed text is replaced with one
1855 character. If the syntax item does not have a custom
1856 replacement character defined (see |:syn-cchar|) the
1857 character defined in 'listchars' is used (default is a
1858 space).
1859 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001860 2 Concealed text is completely hidden unless it has a
1861 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001862 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001863 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001864
Bram Moolenaara7781e02010-07-19 20:13:22 +02001865 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001866 edit and copy the text. This can be changed with the 'concealcursor'
1867 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001868
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1870'confirm' 'cf' boolean (default off)
1871 global
1872 {not in Vi}
1873 When 'confirm' is on, certain operations that would normally
1874 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1875 instead raise a |dialog| asking if you wish to save the current
1876 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1877 If 'confirm' is off you can still activate confirmation for one
1878 command only (this is most useful in mappings) with the |:confirm|
1879 command.
1880 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1881
1882 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1883'conskey' 'consk' boolean (default off)
1884 global
1885 {not in Vi} {only for MS-DOS}
1886 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001887 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888 three methods of console input are available:
1889 'conskey' 'bioskey' action ~
1890 on on or off direct console input
1891 off on BIOS
1892 off off STDIN
1893
1894 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1895'copyindent' 'ci' boolean (default off)
1896 local to buffer
1897 {not in Vi}
1898 Copy the structure of the existing lines indent when autoindenting a
1899 new line. Normally the new indent is reconstructed by a series of
1900 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1901 in which case only spaces are used). Enabling this option makes the
1902 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001903 existing line. 'expandtab' has no effect on these characters, a Tab
1904 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 line, the remaining space is filled in the normal manner.
1906 NOTE: 'copyindent' is reset when 'compatible' is set.
1907 Also see 'preserveindent'.
1908
1909 *'cpoptions'* *'cpo'*
1910'cpoptions' 'cpo' string (Vim default: "aABceFs",
1911 Vi default: all flags)
1912 global
1913 {not in Vi}
1914 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001915 this indicates Vi-compatible behavior. This is used for things where
1916 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 'cpoptions' stands for "compatible-options".
1918 Commas can be added for readability.
1919 To avoid problems with flags that are added in the future, use the
1920 "+=" and "-=" feature of ":set" |add-option-flags|.
1921 NOTE: This option is set to the Vi default value when 'compatible' is
1922 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001923 NOTE: This option is set to the POSIX default value at startup when
1924 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001925 variable exists |posix|. This means Vim tries to behave like the
1926 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927
1928 contains behavior ~
1929 *cpo-a*
1930 a When included, a ":read" command with a file name
1931 argument will set the alternate file name for the
1932 current window.
1933 *cpo-A*
1934 A When included, a ":write" command with a file name
1935 argument will set the alternate file name for the
1936 current window.
1937 *cpo-b*
1938 b "\|" in a ":map" command is recognized as the end of
1939 the map command. The '\' is included in the mapping,
1940 the text after the '|' is interpreted as the next
1941 command. Use a CTRL-V instead of a backslash to
1942 include the '|' in the mapping. Applies to all
1943 mapping, abbreviation, menu and autocmd commands.
1944 See also |map_bar|.
1945 *cpo-B*
1946 B A backslash has no special meaning in mappings,
1947 abbreviations and the "to" part of the menu commands.
1948 Remove this flag to be able to use a backslash like a
1949 CTRL-V. For example, the command ":map X \<Esc>"
1950 results in X being mapped to:
1951 'B' included: "\^[" (^[ is a real <Esc>)
1952 'B' excluded: "<Esc>" (5 characters)
1953 ('<' excluded in both cases)
1954 *cpo-c*
1955 c Searching continues at the end of any match at the
1956 cursor position, but not further than the start of the
1957 next line. When not present searching continues
1958 one character from the cursor position. With 'c'
1959 "abababababab" only gets three matches when repeating
1960 "/abab", without 'c' there are five matches.
1961 *cpo-C*
1962 C Do not concatenate sourced lines that start with a
1963 backslash. See |line-continuation|.
1964 *cpo-d*
1965 d Using "./" in the 'tags' option doesn't mean to use
1966 the tags file relative to the current file, but the
1967 tags file in the current directory.
1968 *cpo-D*
1969 D Can't use CTRL-K to enter a digraph after Normal mode
1970 commands with a character argument, like |r|, |f| and
1971 |t|.
1972 *cpo-e*
1973 e When executing a register with ":@r", always add a
1974 <CR> to the last line, also when the register is not
1975 linewise. If this flag is not present, the register
1976 is not linewise and the last line does not end in a
1977 <CR>, then the last line is put on the command-line
1978 and can be edited before hitting <CR>.
1979 *cpo-E*
1980 E It is an error when using "y", "d", "c", "g~", "gu" or
1981 "gU" on an Empty region. The operators only work when
1982 at least one character is to be operate on. Example:
1983 This makes "y0" fail in the first column.
1984 *cpo-f*
1985 f When included, a ":read" command with a file name
1986 argument will set the file name for the current buffer,
1987 if the current buffer doesn't have a file name yet.
1988 *cpo-F*
1989 F When included, a ":write" command with a file name
1990 argument will set the file name for the current
1991 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001992 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 *cpo-g*
1994 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001995 *cpo-H*
1996 H When using "I" on a line with only blanks, insert
1997 before the last blank. Without this flag insert after
1998 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 *cpo-i*
2000 i When included, interrupting the reading of a file will
2001 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002002 *cpo-I*
2003 I When moving the cursor up or down just after inserting
2004 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 *cpo-j*
2006 j When joining lines, only add two spaces after a '.',
2007 not after '!' or '?'. Also see 'joinspaces'.
2008 *cpo-J*
2009 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002010 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 white space.
2012 *cpo-k*
2013 k Disable the recognition of raw key codes in
2014 mappings, abbreviations, and the "to" part of menu
2015 commands. For example, if <Key> sends ^[OA (where ^[
2016 is <Esc>), the command ":map X ^[OA" results in X
2017 being mapped to:
2018 'k' included: "^[OA" (3 characters)
2019 'k' excluded: "<Key>" (one key code)
2020 Also see the '<' flag below.
2021 *cpo-K*
2022 K Don't wait for a key code to complete when it is
2023 halfway a mapping. This breaks mapping <F1><F1> when
2024 only part of the second <F1> has been read. It
2025 enables cancelling the mapping by typing <F1><Esc>.
2026 *cpo-l*
2027 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002028 literally, only "\]", "\^", "\-" and "\\" are special.
2029 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2031 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002032 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 *cpo-L*
2034 L When the 'list' option is set, 'wrapmargin',
2035 'textwidth', 'softtabstop' and Virtual Replace mode
2036 (see |gR|) count a <Tab> as two characters, instead of
2037 the normal behavior of a <Tab>.
2038 *cpo-m*
2039 m When included, a showmatch will always wait half a
2040 second. When not included, a showmatch will wait half
2041 a second or until a character is typed. |'showmatch'|
2042 *cpo-M*
2043 M When excluded, "%" matching will take backslashes into
2044 account. Thus in "( \( )" and "\( ( \)" the outer
2045 parenthesis match. When included "%" ignores
2046 backslashes, which is Vi compatible.
2047 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002048 n When included, the column used for 'number' and
2049 'relativenumber' will also be used for text of wrapped
2050 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 *cpo-o*
2052 o Line offset to search command is not remembered for
2053 next search.
2054 *cpo-O*
2055 O Don't complain if a file is being overwritten, even
2056 when it didn't exist when editing it. This is a
2057 protection against a file unexpectedly created by
2058 someone else. Vi didn't complain about this.
2059 *cpo-p*
2060 p Vi compatible Lisp indenting. When not present, a
2061 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002062 *cpo-P*
2063 P When included, a ":write" command that appends to a
2064 file will set the file name for the current buffer, if
2065 the current buffer doesn't have a file name yet and
2066 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002067 *cpo-q*
2068 q When joining multiple lines leave the cursor at the
2069 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070 *cpo-r*
2071 r Redo ("." command) uses "/" to repeat a search
2072 command, instead of the actually used search string.
2073 *cpo-R*
2074 R Remove marks from filtered lines. Without this flag
2075 marks are kept like |:keepmarks| was used.
2076 *cpo-s*
2077 s Set buffer options when entering the buffer for the
2078 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002079 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 set when the buffer is created.
2081 *cpo-S*
2082 S Set buffer options always when entering a buffer
2083 (except 'readonly', 'fileformat', 'filetype' and
2084 'syntax'). This is the (most) Vi compatible setting.
2085 The options are set to the values in the current
2086 buffer. When you change an option and go to another
2087 buffer, the value is copied. Effectively makes the
2088 buffer options global to all buffers.
2089
2090 's' 'S' copy buffer options
2091 no no when buffer created
2092 yes no when buffer first entered (default)
2093 X yes each time when buffer entered (vi comp.)
2094 *cpo-t*
2095 t Search pattern for the tag command is remembered for
2096 "n" command. Otherwise Vim only puts the pattern in
2097 the history for search pattern, but doesn't change the
2098 last used search pattern.
2099 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002100 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 *cpo-v*
2102 v Backspaced characters remain visible on the screen in
2103 Insert mode. Without this flag the characters are
2104 erased from the screen right away. With this flag the
2105 screen newly typed text overwrites backspaced
2106 characters.
2107 *cpo-w*
2108 w When using "cw" on a blank character, only change one
2109 character and not all blanks until the start of the
2110 next word.
2111 *cpo-W*
2112 W Don't overwrite a readonly file. When omitted, ":w!"
2113 overwrites a readonly file, if possible.
2114 *cpo-x*
2115 x <Esc> on the command-line executes the command-line.
2116 The default in Vim is to abandon the command-line,
2117 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002118 *cpo-X*
2119 X When using a count with "R" the replaced text is
2120 deleted only once. Also when repeating "R" with "."
2121 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-y*
2123 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002124 *cpo-Z*
2125 Z When using "w!" while the 'readonly' option is set,
2126 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127 *cpo-!*
2128 ! When redoing a filter command, use the last used
2129 external command, whatever it was. Otherwise the last
2130 used -filter- command is used.
2131 *cpo-$*
2132 $ When making a change to one line, don't redisplay the
2133 line, but put a '$' at the end of the changed text.
2134 The changed text will be overwritten when you type the
2135 new text. The line is redisplayed if you type any
2136 command that moves the cursor from the insertion
2137 point.
2138 *cpo-%*
2139 % Vi-compatible matching is done for the "%" command.
2140 Does not recognize "#if", "#endif", etc.
2141 Does not recognize "/*" and "*/".
2142 Parens inside single and double quotes are also
2143 counted, causing a string that contains a paren to
2144 disturb the matching. For example, in a line like
2145 "if (strcmp("foo(", s))" the first paren does not
2146 match the last one. When this flag is not included,
2147 parens inside single and double quotes are treated
2148 specially. When matching a paren outside of quotes,
2149 everything inside quotes is ignored. When matching a
2150 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002151 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002152 This flag is also used for other features, such as
2153 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002154 *cpo--*
2155 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002156 it would go above the first line or below the last
2157 line. Without it the cursor moves to the first or
2158 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002159 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002160 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002161 *cpo-+*
2162 + When included, a ":write file" command will reset the
2163 'modified' flag of the buffer, even though the buffer
2164 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002165 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 * Use ":*" in the same way as ":@". When not included,
2167 ":*" is an alias for ":'<,'>", select the Visual area.
2168 *cpo-<*
2169 < Disable the recognition of special key codes in |<>|
2170 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002171 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 ":map X <Tab>" results in X being mapped to:
2173 '<' included: "<Tab>" (5 characters)
2174 '<' excluded: "^I" (^I is a real <Tab>)
2175 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002176 *cpo->*
2177 > When appending to a register, put a line break before
2178 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002179 *cpo-;*
2180 ; When using |,| or |;| to repeat the last |t| search
2181 and the cursor is right in front of the searched
2182 character, the cursor won't move. When not included,
2183 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002184 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002185
2186 POSIX flags. These are not included in the Vi default value, except
2187 when $VIM_POSIX was set on startup. |posix|
2188
2189 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002190 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002191 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002192 *cpo-&*
2193 & When ":preserve" was used keep the swap file when
2194 exiting normally while this buffer is still loaded.
2195 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002196 *cpo-\*
2197 \ Backslash in a [] range in a search pattern is taken
2198 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002199 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2200 '\' excluded: "/[ \-]" finds <Space> and '-'
2201 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002202 *cpo-/*
2203 / When "%" is used as the replacement string in a |:s|
2204 command, use the previous replacement string. |:s%|
2205 *cpo-{*
2206 { The |{| and |}| commands also stop at a "{" character
2207 at the start of a line.
2208 *cpo-.*
2209 . The ":chdir" and ":cd" commands fail if the current
2210 buffer is modified, unless ! is used. Vim doesn't
2211 need this, since it remembers the full path of an
2212 opened file.
2213 *cpo-bar*
2214 | The value of the $LINES and $COLUMNS environment
2215 variables overrule the terminal size values obtained
2216 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002217
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002219 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002220'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002221 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002222 {not in Vi}
2223 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002224 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002225 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002226 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002227 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002228 blowfish Blowfish method. Medium strong encryption but it has
2229 an implementation flaw. Requires Vim 7.3 or later,
2230 files can NOT be read by Vim 7.2 and older. This adds
2231 a "seed" to the file, every time you write the file
2232 the encrypted bytes will be different.
2233 *blowfish2*
2234 blowfish2 Blowfish method. Medium strong encryption. Requires
2235 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2236 and older. This adds a "seed" to the file, every time
2237 you write the file the encrypted bytes will be
2238 different. The whole undo file is encrypted, not just
2239 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002240
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002241 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002242 to the detected method of the file being read. Thus if you write it
2243 without changing 'cryptmethod' the same method will be used.
2244 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002245 explicitly write it, you don't get a warning unless there are other
2246 modifications. Also see |:X|.
2247
2248 When setting the global value to an empty string, it will end up with
2249 the value "zip". When setting the local value to an empty string the
2250 buffer will use the global value.
2251
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002252 When a new encryption method is added in a later version of Vim, and
2253 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002254 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002255
2256
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 *'cscopepathcomp'* *'cspc'*
2258'cscopepathcomp' 'cspc' number (default 0)
2259 global
2260 {not available when compiled without the |+cscope|
2261 feature}
2262 {not in Vi}
2263 Determines how many components of the path to show in a list of tags.
2264 See |cscopepathcomp|.
2265
2266 *'cscopeprg'* *'csprg'*
2267'cscopeprg' 'csprg' string (default "cscope")
2268 global
2269 {not available when compiled without the |+cscope|
2270 feature}
2271 {not in Vi}
2272 Specifies the command to execute cscope. See |cscopeprg|.
2273 This option cannot be set from a |modeline| or in the |sandbox|, for
2274 security reasons.
2275
2276 *'cscopequickfix'* *'csqf'*
2277'cscopequickfix' 'csqf' string (default "")
2278 global
2279 {not available when compiled without the |+cscope|
2280 or |+quickfix| features}
2281 {not in Vi}
2282 Specifies whether to use quickfix window to show cscope results.
2283 See |cscopequickfix|.
2284
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002285 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002286'cscoperelative' 'csre' boolean (default off)
2287 global
2288 {not available when compiled without the |+cscope|
2289 feature}
2290 {not in Vi}
2291 In the absence of a prefix (-P) for cscope. setting this option enables
2292 to use the basename of cscope.out path as the prefix.
2293 See |cscoperelative|.
2294
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2296'cscopetag' 'cst' boolean (default off)
2297 global
2298 {not available when compiled without the |+cscope|
2299 feature}
2300 {not in Vi}
2301 Use cscope for tag commands. See |cscope-options|.
2302 NOTE: This option is reset when 'compatible' is set.
2303
2304 *'cscopetagorder'* *'csto'*
2305'cscopetagorder' 'csto' number (default 0)
2306 global
2307 {not available when compiled without the |+cscope|
2308 feature}
2309 {not in Vi}
2310 Determines the order in which ":cstag" performs a search. See
2311 |cscopetagorder|.
2312 NOTE: This option is set to 0 when 'compatible' is set.
2313
2314 *'cscopeverbose'* *'csverb'*
2315 *'nocscopeverbose'* *'nocsverb'*
2316'cscopeverbose' 'csverb' boolean (default off)
2317 global
2318 {not available when compiled without the |+cscope|
2319 feature}
2320 {not in Vi}
2321 Give messages when adding a cscope database. See |cscopeverbose|.
2322 NOTE: This option is reset when 'compatible' is set.
2323
Bram Moolenaar860cae12010-06-05 23:22:07 +02002324 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2325'cursorbind' 'crb' boolean (default off)
2326 local to window
2327 {not in Vi}
2328 {not available when compiled without the |+cursorbind|
2329 feature}
2330 When this option is set, as the cursor in the current
2331 window moves other cursorbound windows (windows that also have
2332 this option set) move their cursors to the corresponding line and
2333 column. This option is useful for viewing the
2334 differences between two versions of a file (see 'diff'); in diff mode,
2335 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002336 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002337
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002338
2339 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2340'cursorcolumn' 'cuc' boolean (default off)
2341 local to window
2342 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002343 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002344 feature}
2345 Highlight the screen column of the cursor with CursorColumn
2346 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2347 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002348 If you only want the highlighting in the current window you can use
2349 these autocommands: >
2350 au WinLeave * set nocursorline nocursorcolumn
2351 au WinEnter * set cursorline cursorcolumn
2352<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002353
2354 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2355'cursorline' 'cul' boolean (default off)
2356 local to window
2357 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002358 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002359 feature}
2360 Highlight the screen line of the cursor with CursorLine
2361 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2362 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002363 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002364 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002365
2366
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 *'debug'*
2368'debug' string (default "")
2369 global
2370 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002371 These values can be used:
2372 msg Error messages that would otherwise be omitted will be given
2373 anyway.
2374 throw Error messages that would otherwise be omitted will be given
2375 anyway and also throw an exception and set |v:errmsg|.
2376 beep A message will be given when otherwise only a beep would be
2377 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002378 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002379 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2380 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381
2382 *'define'* *'def'*
2383'define' 'def' string (default "^\s*#\s*define")
2384 global or local to buffer |global-local|
2385 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002386 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 pattern, just like for the "/" command. This option is used for the
2388 commands like "[i" and "[d" |include-search|. The 'isident' option is
2389 used to recognize the defined name after the match:
2390 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2391 See |option-backslash| about inserting backslashes to include a space
2392 or backslash.
2393 The default value is for C programs. For C++ this value would be
2394 useful, to include const type declarations: >
2395 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2396< When using the ":set" command, you need to double the backslashes!
2397
2398 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2399'delcombine' 'deco' boolean (default off)
2400 global
2401 {not in Vi}
2402 {only available when compiled with the |+multi_byte|
2403 feature}
2404 If editing Unicode and this option is set, backspace and Normal mode
2405 "x" delete each combining character on its own. When it is off (the
2406 default) the character along with its combining characters are
2407 deleted.
2408 Note: When 'delcombine' is set "xx" may work different from "2x"!
2409
2410 This is useful for Arabic, Hebrew and many other languages where one
2411 may have combining characters overtop of base characters, and want
2412 to remove only the combining ones.
2413
2414 *'dictionary'* *'dict'*
2415'dictionary' 'dict' string (default "")
2416 global or local to buffer |global-local|
2417 {not in Vi}
2418 List of file names, separated by commas, that are used to lookup words
2419 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2420 contain a list of words. This can be one word per line, or several
2421 words per line, separated by non-keyword characters (white space is
2422 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002423 When this option is empty, or an entry "spell" is present, spell
2424 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002425 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 after a comma are ignored, otherwise spaces are included in the file
2427 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002428 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 Where to find a list of words?
2430 - On FreeBSD, there is the file "/usr/share/dict/words".
2431 - In the Simtel archive, look in the "msdos/linguist" directory.
2432 - In "miscfiles" of the GNU collection.
2433 The use of |:set+=| and |:set-=| is preferred when adding or removing
2434 directories from the list. This avoids problems when a future version
2435 uses another default.
2436 Backticks cannot be used in this option for security reasons.
2437
2438 *'diff'* *'nodiff'*
2439'diff' boolean (default off)
2440 local to window
2441 {not in Vi}
2442 {not available when compiled without the |+diff|
2443 feature}
2444 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002445 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002446
2447 *'dex'* *'diffexpr'*
2448'diffexpr' 'dex' string (default "")
2449 global
2450 {not in Vi}
2451 {not available when compiled without the |+diff|
2452 feature}
2453 Expression which is evaluated to obtain an ed-style diff file from two
2454 versions of a file. See |diff-diffexpr|.
2455 This option cannot be set from a |modeline| or in the |sandbox|, for
2456 security reasons.
2457
2458 *'dip'* *'diffopt'*
2459'diffopt' 'dip' string (default "filler")
2460 global
2461 {not in Vi}
2462 {not available when compiled without the |+diff|
2463 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002464 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 All are optional. Items must be separated by a comma.
2466
2467 filler Show filler lines, to keep the text
2468 synchronized with a window that has inserted
2469 lines at the same position. Mostly useful
2470 when windows are side-by-side and 'scrollbind'
2471 is set.
2472
2473 context:{n} Use a context of {n} lines between a change
2474 and a fold that contains unchanged lines.
2475 When omitted a context of six lines is used.
2476 See |fold-diff|.
2477
2478 icase Ignore changes in case of text. "a" and "A"
2479 are considered the same. Adds the "-i" flag
2480 to the "diff" command if 'diffexpr' is empty.
2481
2482 iwhite Ignore changes in amount of white space. Adds
2483 the "-b" flag to the "diff" command if
2484 'diffexpr' is empty. Check the documentation
2485 of the "diff" command for what this does
2486 exactly. It should ignore adding trailing
2487 white space, but not leading white space.
2488
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002489 horizontal Start diff mode with horizontal splits (unless
2490 explicitly specified otherwise).
2491
2492 vertical Start diff mode with vertical splits (unless
2493 explicitly specified otherwise).
2494
2495 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2496 starting diff mode. Without this 2 is used.
2497
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 Examples: >
2499
2500 :set diffopt=filler,context:4
2501 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002502 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002503<
2504 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2505'digraph' 'dg' boolean (default off)
2506 global
2507 {not in Vi}
2508 {not available when compiled without the |+digraphs|
2509 feature}
2510 Enable the entering of digraphs in Insert mode with {char1} <BS>
2511 {char2}. See |digraphs|.
2512 NOTE: This option is reset when 'compatible' is set.
2513
2514 *'directory'* *'dir'*
2515'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002516 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 for Unix: ".,~/tmp,/var/tmp,/tmp")
2518 global
2519 List of directory names for the swap file, separated with commas.
2520 - The swap file will be created in the first directory where this is
2521 possible.
2522 - Empty means that no swap file will be used (recovery is
2523 impossible!).
2524 - A directory "." means to put the swap file in the same directory as
2525 the edited file. On Unix, a dot is prepended to the file name, so
2526 it doesn't show in a directory listing. On MS-Windows the "hidden"
2527 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002528 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 put the swap file relative to where the edited file is. The leading
2530 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002531 - For Unix and Win32, if a directory ends in two path separators "//"
2532 or "\\", the swap file name will be built from the complete path to
2533 the file with all path separators substituted to percent '%' signs.
2534 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002535 On Win32, when a separating comma is following, you must use "//",
2536 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537 - Spaces after the comma are ignored, other spaces are considered part
2538 of the directory name. To have a space at the start of a directory
2539 name, precede it with a backslash.
2540 - To include a comma in a directory name precede it with a backslash.
2541 - A directory name may end in an ':' or '/'.
2542 - Environment variables are expanded |:set_env|.
2543 - Careful with '\' characters, type one before a space, type two to
2544 get one in the option (see |option-backslash|), for example: >
2545 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2546< - For backwards compatibility with Vim version 3.0 a '>' at the start
2547 of the option is removed.
2548 Using "." first in the list is recommended. This means that editing
2549 the same file twice will result in a warning. Using "/tmp" on Unix is
2550 discouraged: When the system crashes you lose the swap file.
2551 "/var/tmp" is often not cleared when rebooting, thus is a better
2552 choice than "/tmp". But it can contain a lot of files, your swap
2553 files get lost in the crowd. That is why a "tmp" directory in your
2554 home directory is tried first.
2555 The use of |:set+=| and |:set-=| is preferred when adding or removing
2556 directories from the list. This avoids problems when a future version
2557 uses another default.
2558 This option cannot be set from a |modeline| or in the |sandbox|, for
2559 security reasons.
2560 {Vi: directory to put temp file in, defaults to "/tmp"}
2561
2562 *'display'* *'dy'*
2563'display' 'dy' string (default "")
2564 global
2565 {not in Vi}
2566 Change the way text is displayed. This is comma separated list of
2567 flags:
2568 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002569 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 last line that doesn't fit is replaced with "@" lines.
2571 uhex Show unprintable characters hexadecimal as <xx>
2572 instead of using ^C and ~C.
2573
2574 *'eadirection'* *'ead'*
2575'eadirection' 'ead' string (default "both")
2576 global
2577 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002578 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 feature}
2580 Tells when the 'equalalways' option applies:
2581 ver vertically, width of windows is not affected
2582 hor horizontally, height of windows is not affected
2583 both width and height of windows is affected
2584
2585 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2586'edcompatible' 'ed' boolean (default off)
2587 global
2588 Makes the 'g' and 'c' flags of the ":substitute" command to be
2589 toggled each time the flag is given. See |complex-change|. See
2590 also 'gdefault' option.
2591 Switching this option on is discouraged!
2592
2593 *'encoding'* *'enc'* *E543*
2594'encoding' 'enc' string (default: "latin1" or value from $LANG)
2595 global
2596 {only available when compiled with the |+multi_byte|
2597 feature}
2598 {not in Vi}
2599 Sets the character encoding used inside Vim. It applies to text in
2600 the buffers, registers, Strings in expressions, text stored in the
2601 viminfo file, etc. It sets the kind of characters which Vim can work
2602 with. See |encoding-names| for the possible values.
2603
2604 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002605 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002607 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608
Bram Moolenaar865242e2010-07-14 21:12:05 +02002609 This option cannot be set from a |modeline|. It would most likely
2610 corrupt the text.
2611
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2613 "utf-8". Although care has been taken to allow different values of
2614 'encoding', "utf-8" is the natural choice for the environment and
2615 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002616 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 versions, and to avoid changing the encoding of newly created files
2618 without your knowledge (in case 'fileencodings' is empty).
2619
2620 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 iconv() or as specified with 'charconvert'.
2623
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002624 If you need to know whether 'encoding' is a multi-byte encoding, you
2625 can use: >
2626 if has("multi_byte_encoding")
2627<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 Normally 'encoding' will be equal to your current locale. This will
2629 be the default if Vim recognizes your environment settings. If
2630 'encoding' is not set to the current locale, 'termencoding' must be
2631 set to convert typed and displayed text. See |encoding-table|.
2632
2633 When you set this option, it fires the |EncodingChanged| autocommand
2634 event so that you can set up fonts if necessary.
2635
2636 When the option is set, the value is converted to lowercase. Thus
2637 you can set it with uppercase values too. Underscores are translated
2638 to '-' signs.
2639 When the encoding is recognized, it is changed to the standard name.
2640 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2641 "iso-8859-2" and "utf8" becomes "utf-8".
2642
2643 Note: "latin1" is also used when the encoding could not be detected.
2644 This only works when editing files in the same encoding! When the
2645 actual character set is not latin1, make sure 'fileencoding' and
2646 'fileencodings' are empty. When conversion is needed, switch to using
2647 utf-8.
2648
2649 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2650 You don't notice this while editing, but it does matter for the
2651 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2652 setting 'encoding' to one of these values instead of utf-8 only has
2653 effect for encoding used for files when 'fileencoding' is empty.
2654
Bram Moolenaar661b1822005-07-28 22:36:45 +00002655 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2656 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657
2658 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2659'endofline' 'eol' boolean (default on)
2660 local to buffer
2661 {not in Vi}
2662 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002663 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 option is automatically set when starting to edit a new file, unless
2665 the file does not have an <EOL> for the last line in the file, in
2666 which case it is reset. Normally you don't have to set or reset this
2667 option. When 'binary' is off the value is not used when writing the
2668 file. When 'binary' is on it is used to remember the presence of a
2669 <EOL> for the last line in the file, so that when you write the file
2670 the situation from the original file can be kept. But you can change
2671 it if you want to.
2672
2673 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2674'equalalways' 'ea' boolean (default on)
2675 global
2676 {not in Vi}
2677 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002678 splitting or closing a window. This also happens the moment the
2679 option is switched on. When off, splitting a window will reduce the
2680 size of the current window and leave the other windows the same. When
2681 closing a window the extra lines are given to the window next to it
2682 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 When mixing vertically and horizontally split windows, a minimal size
2684 is computed and some windows may be larger if there is room. The
2685 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002686 Changing the height and width of a window can be avoided by setting
2687 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002688 If a window size is specified when creating a new window sizes are
2689 currently not equalized (it's complicated, but may be implemented in
2690 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691
2692 *'equalprg'* *'ep'*
2693'equalprg' 'ep' string (default "")
2694 global or local to buffer |global-local|
2695 {not in Vi}
2696 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002697 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002698 or 'indentexpr'. When Vim was compiled without internal formatting,
2699 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002700 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 about including spaces and backslashes.
2702 This option cannot be set from a |modeline| or in the |sandbox|, for
2703 security reasons.
2704
2705 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2706'errorbells' 'eb' boolean (default off)
2707 global
2708 Ring the bell (beep or screen flash) for error messages. This only
2709 makes a difference for error messages, the bell will be used always
2710 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 screen flash or do nothing.
2713
2714 *'errorfile'* *'ef'*
2715'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2716 others: "errors.err")
2717 global
2718 {not in Vi}
2719 {not available when compiled without the |+quickfix|
2720 feature}
2721 Name of the errorfile for the QuickFix mode (see |:cf|).
2722 When the "-q" command-line argument is used, 'errorfile' is set to the
2723 following argument. See |-q|.
2724 NOT used for the ":make" command. See 'makeef' for that.
2725 Environment variables are expanded |:set_env|.
2726 See |option-backslash| about including spaces and backslashes.
2727 This option cannot be set from a |modeline| or in the |sandbox|, for
2728 security reasons.
2729
2730 *'errorformat'* *'efm'*
2731'errorformat' 'efm' string (default is very long)
2732 global or local to buffer |global-local|
2733 {not in Vi}
2734 {not available when compiled without the |+quickfix|
2735 feature}
2736 Scanf-like description of the format for the lines in the error file
2737 (see |errorformat|).
2738
2739 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2740'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2741 global
2742 {not in Vi}
2743 Function keys that start with an <Esc> are recognized in Insert
2744 mode. When this option is off, the cursor and function keys cannot be
2745 used in Insert mode if they start with an <Esc>. The advantage of
2746 this is that the single <Esc> is recognized immediately, instead of
2747 after one second. Instead of resetting this option, you might want to
2748 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2749 when 'esckeys' is off, you can still map anything, but the cursor keys
2750 won't work by default.
2751 NOTE: This option is set to the Vi default value when 'compatible' is
2752 set and to the Vim default value when 'compatible' is reset.
2753
2754 *'eventignore'* *'ei'*
2755'eventignore' 'ei' string (default "")
2756 global
2757 {not in Vi}
2758 {not available when compiled without the |+autocmd|
2759 feature}
2760 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002761 When set to "all" or when "all" is one of the items, all autocommand
2762 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 Otherwise this is a comma separated list of event names. Example: >
2764 :set ei=WinEnter,WinLeave
2765<
2766 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2767'expandtab' 'et' boolean (default off)
2768 local to buffer
2769 {not in Vi}
2770 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2773 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2774 NOTE: This option is reset when 'compatible' is set.
2775
2776 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2777'exrc' 'ex' boolean (default off)
2778 global
2779 {not in Vi}
2780 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2781 directory. If you switch this option on you should also consider
2782 setting the 'secure' option (see |initialization|). Using a local
2783 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2784 also see |.vimrc| and |gui-init|.
2785 This option cannot be set from a |modeline| or in the |sandbox|, for
2786 security reasons.
2787
2788 *'fileencoding'* *'fenc'* *E213*
2789'fileencoding' 'fenc' string (default: "")
2790 local to buffer
2791 {only available when compiled with the |+multi_byte|
2792 feature}
2793 {not in Vi}
2794 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002795
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002797 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 When 'fileencoding' is empty, the same value as 'encoding' will be
2799 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002800 Conversion will also be done when 'encoding' and 'fileencoding' are
2801 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2802 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002804 'encoding' is "utf-8" or another Unicode encoding, conversion
2805 is most likely done in a way that the reverse conversion
2806 results in the same text. When 'encoding' is not "utf-8" some
2807 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002808
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 See 'encoding' for the possible values. Additionally, values may be
2810 specified that can be handled by the converter, see
2811 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002812
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 When reading a file 'fileencoding' will be set from 'fileencodings'.
2814 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002815 'fileencoding', use the |++enc| argument. One exception: when
2816 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002817 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002818
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2820 When the option is set, the value is converted to lowercase. Thus
2821 you can set it with uppercase values too. '_' characters are
2822 replaced with '-'. If a name is recognized from the list for
2823 'encoding', it is replaced by the standard name. For example
2824 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002825
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 When this option is set, after starting to edit a file, the 'modified'
2827 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002828
2829 Keep in mind that changing 'fenc' from a modeline happens
2830 AFTER the text has been read, thus it applies to when the file will be
2831 written. If you do set 'fenc' in a modeline, you might want to set
2832 'nomodified' to avoid not being able to ":q".
2833
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834 This option can not be changed when 'modifiable' is off.
2835
2836 *'fe'*
2837 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 old short name was 'fe', which is no longer used.
2840
2841 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002842'fileencodings' 'fencs' string (default: "ucs-bom",
2843 "ucs-bom,utf-8,default,latin1" when
2844 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 global
2846 {only available when compiled with the |+multi_byte|
2847 feature}
2848 {not in Vi}
2849 This is a list of character encodings considered when starting to edit
2850 an existing file. When a file is read, Vim tries to use the first
2851 mentioned character encoding. If an error is detected, the next one
2852 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002853 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 an empty string, which means the value of 'encoding' is used.
2855 WARNING: Conversion can cause loss of information! When
2856 'encoding' is "utf-8" (or one of the other Unicode variants)
2857 conversion is most likely done in a way that the reverse
2858 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002859 "utf-8" some non-ASCII characters may be lost! You can use
2860 the |++bad| argument to specify what is done with characters
2861 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 For an empty file or a file with only ASCII characters most encodings
2863 will work and the first entry of 'fileencodings' will be used (except
2864 "ucs-bom", which requires the BOM to be present). If you prefer
2865 another encoding use an BufReadPost autocommand event to test if your
2866 preferred encoding is to be used. Example: >
2867 au BufReadPost * if search('\S', 'w') == 0 |
2868 \ set fenc=iso-2022-jp | endif
2869< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2870 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002871 When the |++enc| argument is used then the value of 'fileencodings' is
2872 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002873 Note that 'fileencodings' is not used for a new file, the global value
2874 of 'fileencoding' is used instead. You can set it with: >
2875 :setglobal fenc=iso-8859-2
2876< This means that a non-existing file may get a different encoding than
2877 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 The special value "ucs-bom" can be used to check for a Unicode BOM
2879 (Byte Order Mark) at the start of the file. It must not be preceded
2880 by "utf-8" or another Unicode encoding for this to work properly.
2881 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2882 because Vim cannot detect an error, thus the encoding is always
2883 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002884 The special value "default" can be used for the encoding from the
2885 environment. This is the default value for 'encoding'. It is useful
2886 when 'encoding' is set to "utf-8" and your environment uses a
2887 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002888 When 'encoding' is "utf-8" and a file contains an illegal byte
2889 sequence it won't be recognized as UTF-8. You can use the |8g8|
2890 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 WRONG VALUES: WHAT'S WRONG:
2892 latin1,utf-8 "latin1" will always be used
2893 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2894 file
2895 cp1250,latin1 "cp1250" will always be used
2896 If 'fileencodings' is empty, 'fileencoding' is not modified.
2897 See 'fileencoding' for the possible values.
2898 Setting this option does not have an effect until the next time a file
2899 is read.
2900
2901 *'fileformat'* *'ff'*
2902'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2903 Unix default: "unix",
2904 Macintosh default: "mac")
2905 local to buffer
2906 {not in Vi}
2907 This gives the <EOL> of the current buffer, which is used for
2908 reading/writing the buffer from/to a file:
2909 dos <CR> <NL>
2910 unix <NL>
2911 mac <CR>
2912 When "dos" is used, CTRL-Z at the end of a file is ignored.
2913 See |file-formats| and |file-read|.
2914 For the character encoding of the file see 'fileencoding'.
2915 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002916 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 This option is set automatically when starting to edit a file and
2918 'fileformats' is not empty and 'binary' is off.
2919 When this option is set, after starting to edit a file, the 'modified'
2920 option is set, because the file would be different when written.
2921 This option can not be changed when 'modifiable' is off.
2922 For backwards compatibility: When this option is set to "dos",
2923 'textmode' is set, otherwise 'textmode' is reset.
2924
2925 *'fileformats'* *'ffs'*
2926'fileformats' 'ffs' string (default:
2927 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2928 Vim Unix: "unix,dos",
2929 Vim Mac: "mac,unix,dos",
2930 Vi Cygwin: "unix,dos",
2931 Vi others: "")
2932 global
2933 {not in Vi}
2934 This gives the end-of-line (<EOL>) formats that will be tried when
2935 starting to edit a new buffer and when reading a file into an existing
2936 buffer:
2937 - When empty, the format defined with 'fileformat' will be used
2938 always. It is not set automatically.
2939 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002940 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 'fileformats' name will be used when a file is read into an existing
2942 buffer, no matter what 'fileformat' for that buffer is set to.
2943 - When more than one name is present, separated by commas, automatic
2944 <EOL> detection will be done when reading a file. When starting to
2945 edit a file, a check is done for the <EOL>:
2946 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2947 'fileformat' is set to "dos".
2948 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002951 3. If 'fileformat' has not yet been set, and if 'fileformats'
2952 includes "mac", 'fileformat' is set to "mac".
2953 This means that "mac" is only chosen when:
2954 "unix" is not present or no <NL> is found in the file, and
2955 "dos" is not present or no <CR><NL> is found in the file.
2956 Except: if "unix" was chosen, but there is a <CR> before
2957 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002958 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 4. If 'fileformat' is still not set, the first name from
2960 'fileformats' is used.
2961 When reading a file into an existing buffer, the same is done, but
2962 this happens like 'fileformat' has been set appropriately for that
2963 file only, the option is not changed.
2964 When 'binary' is set, the value of 'fileformats' is not used.
2965
Bram Moolenaar81af9252010-12-10 20:35:50 +01002966 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002967 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002968
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2970 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2971 done:
2972 - When 'fileformats' is empty, there is no automatic detection. Dos
2973 format will be used.
2974 - When 'fileformats' is set to one or more names, automatic detection
2975 is done. This is based on the first <NL> in the file: If there is a
2976 <CR> in front of it, Dos format is used, otherwise Unix format is
2977 used.
2978 Also see |file-formats|.
2979 For backwards compatibility: When this option is set to an empty
2980 string or one format (no comma is included), 'textauto' is reset,
2981 otherwise 'textauto' is set.
2982 NOTE: This option is set to the Vi default value when 'compatible' is
2983 set and to the Vim default value when 'compatible' is reset.
2984
Bram Moolenaarbf884932013-04-05 22:26:15 +02002985 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2986'fileignorecase' 'fic' boolean (default on for systems where case in file
2987 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002988 global
2989 {not in Vi}
2990 When set case is ignored when using file names and directories.
2991 See 'wildignorecase' for only ignoring case when doing completion.
2992
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 *'filetype'* *'ft'*
2994'filetype' 'ft' string (default: "")
2995 local to buffer
2996 {not in Vi}
2997 {not available when compiled without the |+autocmd|
2998 feature}
2999 When this option is set, the FileType autocommand event is triggered.
3000 All autocommands that match with the value of this option will be
3001 executed. Thus the value of 'filetype' is used in place of the file
3002 name.
3003 Otherwise this option does not always reflect the current file type.
3004 This option is normally set when the file type is detected. To enable
3005 this use the ":filetype on" command. |:filetype|
3006 Setting this option to a different value is most useful in a modeline,
3007 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003008 Example, for in an IDL file:
3009 /* vim: set filetype=idl : */ ~
3010 |FileType| |filetypes|
3011 When a dot appears in the value then this separates two filetype
3012 names. Example:
3013 /* vim: set filetype=c.doxygen : */ ~
3014 This will use the "c" filetype first, then the "doxygen" filetype.
3015 This works both for filetype plugins and for syntax files. More than
3016 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 This option is not copied to another buffer, independent of the 's' or
3018 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003019 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
3021 *'fillchars'* *'fcs'*
3022'fillchars' 'fcs' string (default "vert:|,fold:-")
3023 global
3024 {not in Vi}
3025 {not available when compiled without the |+windows|
3026 and |+folding| features}
3027 Characters to fill the statuslines and vertical separators.
3028 It is a comma separated list of items:
3029
3030 item default Used for ~
3031 stl:c ' ' or '^' statusline of the current window
3032 stlnc:c ' ' or '-' statusline of the non-current windows
3033 vert:c '|' vertical separators |:vsplit|
3034 fold:c '-' filling 'foldtext'
3035 diff:c '-' deleted lines of the 'diff' option
3036
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003037 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 "stlnc" the space will be used when there is highlighting, '^' or '-'
3039 otherwise.
3040
3041 Example: >
3042 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3043< This is similar to the default, except that these characters will also
3044 be used when there is highlighting.
3045
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003046 for "stl" and "stlnc" only single-byte values are supported.
3047
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 The highlighting used for these items:
3049 item highlight group ~
3050 stl:c StatusLine |hl-StatusLine|
3051 stlnc:c StatusLineNC |hl-StatusLineNC|
3052 vert:c VertSplit |hl-VertSplit|
3053 fold:c Folded |hl-Folded|
3054 diff:c DiffDelete |hl-DiffDelete|
3055
3056 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3057'fkmap' 'fk' boolean (default off) *E198*
3058 global
3059 {not in Vi}
3060 {only available when compiled with the |+rightleft|
3061 feature}
3062 When on, the keyboard is mapped for the Farsi character set.
3063 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003064 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065
3066 *'foldclose'* *'fcl'*
3067'foldclose' 'fcl' string (default "")
3068 global
3069 {not in Vi}
3070 {not available when compiled without the |+folding|
3071 feature}
3072 When set to "all", a fold is closed when the cursor isn't in it and
3073 its level is higher than 'foldlevel'. Useful if you want folds to
3074 automatically close when moving out of them.
3075
3076 *'foldcolumn'* *'fdc'*
3077'foldcolumn' 'fdc' number (default 0)
3078 local to window
3079 {not in Vi}
3080 {not available when compiled without the |+folding|
3081 feature}
3082 When non-zero, a column with the specified width is shown at the side
3083 of the window which indicates open and closed folds. The maximum
3084 value is 12.
3085 See |folding|.
3086
3087 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3088'foldenable' 'fen' boolean (default on)
3089 local to window
3090 {not in Vi}
3091 {not available when compiled without the |+folding|
3092 feature}
3093 When off, all folds are open. This option can be used to quickly
3094 switch between showing all text unfolded and viewing the text with
3095 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003096 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 'foldenable' is off.
3098 This option is set by commands that create a new fold or close a fold.
3099 See |folding|.
3100
3101 *'foldexpr'* *'fde'*
3102'foldexpr' 'fde' string (default: "0")
3103 local to window
3104 {not in Vi}
3105 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003106 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003108 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003109
Bram Moolenaar30b65812012-07-12 22:01:11 +02003110 The expression will be evaluated in the |sandbox| if set from a
3111 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003112 This option can't be set from a |modeline| when the 'diff' option is
3113 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003114
3115 It is not allowed to change text or jump to another window while
3116 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117
3118 *'foldignore'* *'fdi'*
3119'foldignore' 'fdi' string (default: "#")
3120 local to window
3121 {not in Vi}
3122 {not available when compiled without the |+folding|
3123 feature}
3124 Used only when 'foldmethod' is "indent". Lines starting with
3125 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003126 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003127 The default "#" works well for C programs. See |fold-indent|.
3128
3129 *'foldlevel'* *'fdl'*
3130'foldlevel' 'fdl' number (default: 0)
3131 local to window
3132 {not in Vi}
3133 {not available when compiled without the |+folding|
3134 feature}
3135 Sets the fold level: Folds with a higher level will be closed.
3136 Setting this option to zero will close all folds. Higher numbers will
3137 close fewer folds.
3138 This option is set by commands like |zm|, |zM| and |zR|.
3139 See |fold-foldlevel|.
3140
3141 *'foldlevelstart'* *'fdls'*
3142'foldlevelstart' 'fdls' number (default: -1)
3143 global
3144 {not in Vi}
3145 {not available when compiled without the |+folding|
3146 feature}
3147 Sets 'foldlevel' when starting to edit another buffer in a window.
3148 Useful to always start editing with all folds closed (value zero),
3149 some folds closed (one) or no folds closed (99).
3150 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003151 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 ignores this option and closes all folds.
3153 It is also done before BufReadPre autocommands, to allow an autocmd to
3154 overrule the 'foldlevel' value for specific files.
3155 When the value is negative, it is not used.
3156
3157 *'foldmarker'* *'fmr'* *E536*
3158'foldmarker' 'fmr' string (default: "{{{,}}}")
3159 local to window
3160 {not in Vi}
3161 {not available when compiled without the |+folding|
3162 feature}
3163 The start and end marker used when 'foldmethod' is "marker". There
3164 must be one comma, which separates the start and end marker. The
3165 marker is a literal string (a regular expression would be too slow).
3166 See |fold-marker|.
3167
3168 *'foldmethod'* *'fdm'*
3169'foldmethod' 'fdm' string (default: "manual")
3170 local to window
3171 {not in Vi}
3172 {not available when compiled without the |+folding|
3173 feature}
3174 The kind of folding used for the current window. Possible values:
3175 |fold-manual| manual Folds are created manually.
3176 |fold-indent| indent Lines with equal indent form a fold.
3177 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3178 |fold-marker| marker Markers are used to specify folds.
3179 |fold-syntax| syntax Syntax highlighting items specify folds.
3180 |fold-diff| diff Fold text that is not changed.
3181
3182 *'foldminlines'* *'fml'*
3183'foldminlines' 'fml' number (default: 1)
3184 local to window
3185 {not in Vi}
3186 {not available when compiled without the |+folding|
3187 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003188 Sets the number of screen lines above which a fold can be displayed
3189 closed. Also for manually closed folds. With the default value of
3190 one a fold can only be closed if it takes up two or more screen lines.
3191 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003192 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 "zc" to close a fold, which is displayed open because it's smaller
3194 than 'foldminlines', a following "zc" may close a containing fold.
3195
3196 *'foldnestmax'* *'fdn'*
3197'foldnestmax' 'fdn' number (default: 20)
3198 local to window
3199 {not in Vi}
3200 {not available when compiled without the |+folding|
3201 feature}
3202 Sets the maximum nesting of folds for the "indent" and "syntax"
3203 methods. This avoids that too many folds will be created. Using more
3204 than 20 doesn't work, because the internal limit is 20.
3205
3206 *'foldopen'* *'fdo'*
3207'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3208 search,tag,undo")
3209 global
3210 {not in Vi}
3211 {not available when compiled without the |+folding|
3212 feature}
3213 Specifies for which type of commands folds will be opened, if the
3214 command moves the cursor into a closed fold. It is a comma separated
3215 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003216 NOTE: When the command is part of a mapping this option is not used.
3217 Add the |zv| command to the mapping to get the same effect.
3218 (rationale: the mapping may want to control opening folds itself)
3219
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 item commands ~
3221 all any
3222 block "(", "{", "[[", "[{", etc.
3223 hor horizontal movements: "l", "w", "fx", etc.
3224 insert any command in Insert mode
3225 jump far jumps: "G", "gg", etc.
3226 mark jumping to a mark: "'m", CTRL-O, etc.
3227 percent "%"
3228 quickfix ":cn", ":crew", ":make", etc.
3229 search search for a pattern: "/", "n", "*", "gd", etc.
3230 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003231 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 tag jumping to a tag: ":ta", CTRL-T, etc.
3233 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 When a movement command is used for an operator (e.g., "dl" or "y%")
3235 this option is not used. This means the operator will include the
3236 whole closed fold.
3237 Note that vertical movements are not here, because it would make it
3238 very difficult to move onto a closed fold.
3239 In insert mode the folds containing the cursor will always be open
3240 when text is inserted.
3241 To close folds you can re-apply 'foldlevel' with the |zx| command or
3242 set the 'foldclose' option to "all".
3243
3244 *'foldtext'* *'fdt'*
3245'foldtext' 'fdt' string (default: "foldtext()")
3246 local to window
3247 {not in Vi}
3248 {not available when compiled without the |+folding|
3249 feature}
3250 An expression which is used to specify the text displayed for a closed
3251 fold. See |fold-foldtext|.
3252
Bram Moolenaar30b65812012-07-12 22:01:11 +02003253 The expression will be evaluated in the |sandbox| if set from a
3254 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003255
3256 It is not allowed to change text or jump to another window while
3257 evaluating 'foldtext' |textlock|.
3258
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 *'formatoptions'* *'fo'*
3260'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3261 local to buffer
3262 {not in Vi}
3263 This is a sequence of letters which describes how automatic
3264 formatting is to be done. See |fo-table|. When the 'paste' option is
3265 on, no formatting is done (like 'formatoptions' is empty). Commas can
3266 be inserted for readability.
3267 To avoid problems with flags that are added in the future, use the
3268 "+=" and "-=" feature of ":set" |add-option-flags|.
3269 NOTE: This option is set to the Vi default value when 'compatible' is
3270 set and to the Vim default value when 'compatible' is reset.
3271
Bram Moolenaar86b68352004-12-27 21:59:20 +00003272 *'formatlistpat'* *'flp'*
3273'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3274 local to buffer
3275 {not in Vi}
3276 A pattern that is used to recognize a list header. This is used for
3277 the "n" flag in 'formatoptions'.
3278 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003279 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003280 while still checking more characters. There must be a character
3281 following the pattern, when it matches the whole line it is handled
3282 like there is no match.
3283 The default recognizes a number, followed by an optional punctuation
3284 character and white space.
3285
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 *'formatprg'* *'fp'*
3287'formatprg' 'fp' string (default "")
3288 global
3289 {not in Vi}
3290 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003291 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003293 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003294 If the 'formatexpr' option is not empty it will be used instead.
3295 Otherwise, if 'formatprg' option is an empty string, the internal
3296 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003297 Environment variables are expanded |:set_env|. See |option-backslash|
3298 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003299 This option cannot be set from a |modeline| or in the |sandbox|, for
3300 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003302 *'formatexpr'* *'fex'*
3303'formatexpr' 'fex' string (default "")
3304 local to buffer
3305 {not in Vi}
3306 {not available when compiled without the |+eval|
3307 feature}
3308 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003309 operator or automatic formatting (see 'formatoptions'). When this
3310 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003311
3312 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003313 The |v:count| variable holds the number of lines to be formatted.
3314 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003315 inserted if the expression is being evaluated due to
3316 automatic formatting. This can be empty. Don't insert
3317 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003318
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003319 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003320 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003321< This will invoke the mylang#Format() function in the
3322 autoload/mylang.vim file in 'runtimepath'. |autoload|
3323
3324 The expression is also evaluated when 'textwidth' is set and adding
3325 text beyond that limit. This happens under the same conditions as
3326 when internal formatting is used. Make sure the cursor is kept in the
3327 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003328 return "i" or "R" in this situation.
3329
3330 When the expression evaluates to non-zero Vim will fall back to using
3331 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003332
Bram Moolenaar30b65812012-07-12 22:01:11 +02003333 The expression will be evaluated in the |sandbox| when set from a
3334 modeline, see |sandbox-option|. That stops the option from working,
3335 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003336
3337 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003338'fsync' 'fs' boolean (default on)
3339 global
3340 {not in Vi}
3341 When on, the library function fsync() will be called after writing a
3342 file. This will flush a file to disk, ensuring that it is safely
3343 written even on filesystems which do metadata-only journaling. This
3344 will force the harddrive to spin up on Linux systems running in laptop
3345 mode, so it may be undesirable in some situations. Be warned that
3346 turning this off increases the chances of data loss after a crash. On
3347 systems without an fsync() implementation, this variable is always
3348 off.
3349 Also see 'swapsync' for controlling fsync() on swap files.
3350
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3352'gdefault' 'gd' boolean (default off)
3353 global
3354 {not in Vi}
3355 When on, the ":substitute" flag 'g' is default on. This means that
3356 all matches in a line are substituted instead of one. When a 'g' flag
3357 is given to a ":substitute" command, this will toggle the substitution
3358 of all or one match. See |complex-change|.
3359
3360 command 'gdefault' on 'gdefault' off ~
3361 :s/// subst. all subst. one
3362 :s///g subst. one subst. all
3363 :s///gg subst. all subst. one
3364
3365 NOTE: This option is reset when 'compatible' is set.
3366
3367 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003368'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 global
3370 {not in Vi}
3371 Format to recognize for the ":grep" command output.
3372 This is a scanf-like string that uses the same format as the
3373 'errorformat' option: see |errorformat|.
3374
3375 *'grepprg'* *'gp'*
3376'grepprg' 'gp' string (default "grep -n ",
3377 Unix: "grep -n $* /dev/null",
3378 Win32: "findstr /n" or "grep -n",
3379 VMS: "SEARCH/NUMBERS ")
3380 global or local to buffer |global-local|
3381 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003382 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 and '#' characters, which are expanded like when used in a command-
3384 line. The placeholder "$*" is allowed to specify where the arguments
3385 will be included. Environment variables are expanded |:set_env|. See
3386 |option-backslash| about including spaces and backslashes.
3387 When your "grep" accepts the "-H" argument, use this to make ":grep"
3388 also work well with a single file: >
3389 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003390< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003391 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3392 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003393 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 apply equally to 'grepprg'.
3395 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3396 otherwise it's "grep -n".
3397 This option cannot be set from a |modeline| or in the |sandbox|, for
3398 security reasons.
3399
3400 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3401'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3402 ve:ver35-Cursor,
3403 o:hor50-Cursor,
3404 i-ci:ver25-Cursor/lCursor,
3405 r-cr:hor20-Cursor/lCursor,
3406 sm:block-Cursor
3407 -blinkwait175-blinkoff150-blinkon175",
3408 for MS-DOS and Win32 console:
3409 "n-v-c:block,o:hor50,i-ci:hor15,
3410 r-cr:hor30,sm:block")
3411 global
3412 {not in Vi}
3413 {only available when compiled with GUI enabled, and
3414 for MS-DOS and Win32 console}
3415 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003416 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 the height of the cursor can be changed. This can be done by
3418 specifying a block cursor, or a percentage for a vertical or
3419 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003420 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003422 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 mode-list and an argument-list:
3424 mode-list:argument-list,mode-list:argument-list,..
3425 The mode-list is a dash separated list of these modes:
3426 n Normal mode
3427 v Visual mode
3428 ve Visual mode with 'selection' "exclusive" (same as 'v',
3429 if not specified)
3430 o Operator-pending mode
3431 i Insert mode
3432 r Replace mode
3433 c Command-line Normal (append) mode
3434 ci Command-line Insert mode
3435 cr Command-line Replace mode
3436 sm showmatch in Insert mode
3437 a all modes
3438 The argument-list is a dash separated list of these arguments:
3439 hor{N} horizontal bar, {N} percent of the character height
3440 ver{N} vertical bar, {N} percent of the character width
3441 block block cursor, fills the whole character
3442 [only one of the above three should be present]
3443 blinkwait{N} *cursor-blinking*
3444 blinkon{N}
3445 blinkoff{N}
3446 blink times for cursor: blinkwait is the delay before
3447 the cursor starts blinking, blinkon is the time that
3448 the cursor is shown and blinkoff is the time that the
3449 cursor is not shown. The times are in msec. When one
3450 of the numbers is zero, there is no blinking. The
3451 default is: "blinkwait700-blinkon400-blinkoff250".
3452 These numbers are used for a missing entry. This
3453 means that blinking is enabled by default. To switch
3454 blinking off you can use "blinkon0". The cursor only
3455 blinks when Vim is waiting for input, not while
3456 executing a command.
3457 To make the cursor blink in an xterm, see
3458 |xterm-blink|.
3459 {group-name}
3460 a highlight group name, that sets the color and font
3461 for the cursor
3462 {group-name}/{group-name}
3463 Two highlight group names, the first is used when
3464 no language mappings are used, the other when they
3465 are. |language-mapping|
3466
3467 Examples of parts:
3468 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3469 block cursor with colors from the "nCursor"
3470 highlight group
3471 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3472 In Insert and Command-line Insert mode, use a
3473 30% vertical bar cursor with colors from the
3474 "iCursor" highlight group. Blink a bit
3475 faster.
3476
3477 The 'a' mode is different. It will set the given argument-list for
3478 all modes. It does not reset anything to defaults. This can be used
3479 to do a common setting for all modes. For example, to switch off
3480 blinking: "a:blinkon0"
3481
3482 Examples of cursor highlighting: >
3483 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3484 :highlight Cursor gui=NONE guifg=bg guibg=fg
3485<
3486 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003487 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488'guifont' 'gfn' string (default "")
3489 global
3490 {not in Vi}
3491 {only available when compiled with GUI enabled}
3492 This is a list of fonts which will be used for the GUI version of Vim.
3493 In its simplest form the value is just one font name. When
3494 the font cannot be found you will get an error message. To try other
3495 font names a list can be specified, font names separated with commas.
3496 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003497
Bram Moolenaar05159a02005-02-26 23:04:13 +00003498 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3499 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003500
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 Spaces after a comma are ignored. To include a comma in a font name
3502 precede it with a backslash. Setting an option requires an extra
3503 backslash before a space and a backslash. See also
3504 |option-backslash|. For example: >
3505 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003506< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003507 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003508
3509 If none of the fonts can be loaded, Vim will keep the current setting.
3510 If an empty font list is given, Vim will try using other resource
3511 settings (for X, it will use the Vim.font resource), and finally it
3512 will try some builtin default which should always be there ("7x13" in
3513 the case of X). The font names given should be "normal" fonts. Vim
3514 will try to find the related bold and italic fonts.
3515
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003516 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003517 :set guifont=*
3518< will bring up a font requester, where you can pick the font you want.
3519
3520 The font name depends on the GUI used. See |setting-guifont| for a
3521 way to set 'guifont' for various systems.
3522
Bram Moolenaar071d4272004-06-13 20:20:40 +00003523 For the GTK+ 2 GUI the font name looks like this: >
3524 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003525< That's all. XLFDs are not used. For Chinese this is reported to work
3526 well: >
3527 if has("gui_gtk2")
3528 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3529 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3530 endif
3531<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003532 For Mac OSX you can use something like this: >
3533 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003534< Also see 'macatsui', it can help fix display problems.
3535 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003537 width). An exception is GTK 2: all fonts are accepted, but
3538 mono-spaced fonts look best.
3539
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 To preview a font on X11, you might be able to use the "xfontsel"
3541 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003542
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 For the Win32 GUI *E244* *E245*
3544 - takes these options in the font name:
3545 hXX - height is XX (points, can be floating-point)
3546 wXX - width is XX (points, can be floating-point)
3547 b - bold
3548 i - italic
3549 u - underline
3550 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003551 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3553 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3554 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003555 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556
3557 Use a ':' to separate the options.
3558 - A '_' can be used in the place of a space, so you don't need to use
3559 backslashes to escape the spaces.
3560 - Examples: >
3561 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3562 :set guifont=Andale_Mono:h7.5:w4.5
3563< See also |font-sizes|.
3564
3565 *'guifontset'* *'gfs'*
3566 *E250* *E252* *E234* *E597* *E598*
3567'guifontset' 'gfs' string (default "")
3568 global
3569 {not in Vi}
3570 {only available when compiled with GUI enabled and
3571 with the |+xfontset| feature}
3572 {not available in the GTK+ 2 GUI}
3573 When not empty, specifies two (or more) fonts to be used. The first
3574 one for normal English, the second one for your special language. See
3575 |xfontset|.
3576 Setting this option also means that all font names will be handled as
3577 a fontset name. Also the ones used for the "font" argument of the
3578 |:highlight| command.
3579 The fonts must match with the current locale. If fonts for the
3580 character sets that the current locale uses are not included, setting
3581 'guifontset' will fail.
3582 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3583 the comma-separated names are alternative names, one of which will be
3584 used. In 'guifontset' the whole string is one fontset name,
3585 including the commas. It is not possible to specify alternative
3586 fontset names.
3587 This example works on many X11 systems: >
3588 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3589<
3590 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3591'guifontwide' 'gfw' string (default "")
3592 global
3593 {not in Vi}
3594 {only available when compiled with GUI enabled}
3595 When not empty, specifies a comma-separated list of fonts to be used
3596 for double-width characters. The first font that can be loaded is
3597 used.
3598 Note: The size of these fonts must be exactly twice as wide as the one
3599 specified with 'guifont' and the same height.
3600
3601 All GUI versions but GTK+ 2:
3602
3603 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3604 'guifontset' is empty or invalid.
3605 When 'guifont' is set and a valid font is found in it and
3606 'guifontwide' is empty Vim will attempt to find a matching
3607 double-width font and set 'guifontwide' to it.
3608
3609 GTK+ 2 GUI only: *guifontwide_gtk2*
3610
3611 If set and valid, 'guifontwide' is always used for double width
3612 characters, even if 'encoding' is not set to "utf-8".
3613 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003614 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 font for characters not available in 'guifont'. Thus you do not need
3616 to set 'guifontwide' at all unless you want to override the choice
3617 made by Pango/Xft.
3618
Bram Moolenaar0f272122013-01-23 18:37:40 +01003619 Windows +multibyte only: *guifontwide_win_mbyte*
3620
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003621 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003622
Bram Moolenaar071d4272004-06-13 20:20:40 +00003623 *'guiheadroom'* *'ghr'*
3624'guiheadroom' 'ghr' number (default 50)
3625 global
3626 {not in Vi} {only for GTK and X11 GUI}
3627 The number of pixels subtracted from the screen height when fitting
3628 the GUI window on the screen. Set this before the GUI is started,
3629 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 lines will be left for window decorations and other items on the
3632 screen. Set it to a negative value to allow windows taller than the
3633 screen.
3634
3635 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003636'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3637 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 global
3639 {not in Vi}
3640 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003641 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 sequence of letters which describes what components and options of the
3643 GUI should be used.
3644 To avoid problems with flags that are added in the future, use the
3645 "+=" and "-=" feature of ":set" |add-option-flags|.
3646
3647 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003648 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 'a' Autoselect: If present, then whenever VISUAL mode is started,
3650 or the Visual area extended, Vim tries to become the owner of
3651 the windowing system's global selection. This means that the
3652 Visually highlighted text is available for pasting into other
3653 applications as well as into Vim itself. When the Visual mode
3654 ends, possibly due to an operation on the text, or when an
3655 application wants to paste the selection, the highlighted text
3656 is automatically yanked into the "* selection register.
3657 Thus the selection is still available for pasting into other
3658 applications after the VISUAL mode has ended.
3659 If not present, then Vim won't become the owner of the
3660 windowing system's global selection unless explicitly told to
3661 by a yank or delete operation for the "* register.
3662 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003663 *'go-P'*
3664 'P' Like autoselect but using the "+ register instead of the "*
3665 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003666 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003667 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 applies to the modeless selection.
3669
3670 'guioptions' autoselect Visual autoselect modeless ~
3671 "" - -
3672 "a" yes yes
3673 "A" - yes
3674 "aA" yes yes
3675
Bram Moolenaar02467872007-05-06 13:22:01 +00003676 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 'c' Use console dialogs instead of popup dialogs for simple
3678 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003679 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003680 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003681 'guitablabel' can be used to change the text in the labels.
3682 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003683 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003684 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003685 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 'f' Foreground: Don't use fork() to detach the GUI from the shell
3687 where it was started. Use this for programs that wait for the
3688 editor to finish (e.g., an e-mail program). Alternatively you
3689 can use "gvim -f" or ":gui -f" to start the GUI in the
3690 foreground. |gui-fork|
3691 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003692 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003693 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3695 corner of the window. It's black&white on non-GTK, because of
3696 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003697 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003699 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003700 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003702 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 file is sourced the system menu has already been loaded; the
3704 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003705 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 'g' Grey menu items: Make menu items that are not active grey. If
3707 'g' is not included inactive menu items are not shown at all.
3708 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003709 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 't' Include tearoff menu items. Currently only works for Win32,
3711 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003712 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003713 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003714 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003715 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003717 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 'R' Right-hand scrollbar is present when there is a vertically
3719 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003720 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003722 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003723 'L' Left-hand scrollbar is present when there is a vertically
3724 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003725 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3727 the longest visible line, or on the cursor line if the 'h'
3728 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003729 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'h' Limit horizontal scrollbar size to the length of the cursor
3731 line. Reduces computations. |gui-horiz-scroll|
3732
3733 And yes, you may even have scrollbars on the left AND the right if
3734 you really want to :-). See |gui-scrollbars| for more information.
3735
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003736 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 'v' Use a vertical button layout for dialogs. When not included,
3738 a horizontal layout is preferred, but when it doesn't fit a
3739 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003740 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003741 'p' Use Pointer callbacks for X11 GUI. This is required for some
3742 window managers. If the cursor is not blinking or hollow at
3743 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003744 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003746 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003747 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748
Bram Moolenaar02467872007-05-06 13:22:01 +00003749
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 *'guipty'* *'noguipty'*
3751'guipty' boolean (default on)
3752 global
3753 {not in Vi}
3754 {only available when compiled with GUI enabled}
3755 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3756 I/O to/from shell commands. See |gui-pty|.
3757
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003758 *'guitablabel'* *'gtl'*
3759'guitablabel' 'gtl' string (default empty)
3760 global
3761 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003762 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003763 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003764 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003765 pages line. When empty and when the result is empty Vim will use a
3766 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003768 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003769 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003770
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003771 Only used when the GUI tab pages line is displayed. 'e' must be
3772 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3773 used.
3774
Bram Moolenaar57657d82006-04-21 22:12:41 +00003775 *'guitabtooltip'* *'gtt'*
3776'guitabtooltip' 'gtt' string (default empty)
3777 global
3778 {not in Vi}
3779 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003780 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003781 When nonempty describes the text to use in a tooltip for the GUI tab
3782 pages line. When empty Vim will use a default tooltip.
3783 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003784 You can include a line break. Simplest method is to use |:let|: >
3785 :let &guitabtooltip = "line one\nline two"
3786<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003787
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 *'helpfile'* *'hf'*
3789'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3790 (others) "$VIMRUNTIME/doc/help.txt")
3791 global
3792 {not in Vi}
3793 Name of the main help file. All distributed help files should be
3794 placed together in one directory. Additionally, all "doc" directories
3795 in 'runtimepath' will be used.
3796 Environment variables are expanded |:set_env|. For example:
3797 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003798 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 spaces and backslashes.
3800 This option cannot be set from a |modeline| or in the |sandbox|, for
3801 security reasons.
3802
3803 *'helpheight'* *'hh'*
3804'helpheight' 'hh' number (default 20)
3805 global
3806 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003807 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 feature}
3809 Minimal initial height of the help window when it is opened with the
3810 ":help" command. The initial height of the help window is half of the
3811 current window, or (when the 'ea' option is on) the same as other
3812 windows. When the height is less than 'helpheight', the height is
3813 set to 'helpheight'. Set to zero to disable.
3814
3815 *'helplang'* *'hlg'*
3816'helplang' 'hlg' string (default: messages language or empty)
3817 global
3818 {only available when compiled with the |+multi_lang|
3819 feature}
3820 {not in Vi}
3821 Comma separated list of languages. Vim will use the first language
3822 for which the desired help can be found. The English help will always
3823 be used as a last resort. You can add "en" to prefer English over
3824 another language, but that will only find tags that exist in that
3825 language and not in the English help.
3826 Example: >
3827 :set helplang=de,it
3828< This will first search German, then Italian and finally English help
3829 files.
3830 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3831 try to find the tag in the current language before using this option.
3832 See |help-translated|.
3833
3834 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3835'hidden' 'hid' boolean (default off)
3836 global
3837 {not in Vi}
3838 When off a buffer is unloaded when it is |abandon|ed. When on a
3839 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3840 displayed in another window, it does not become hidden, of course.
3841 The commands that move through the buffer list sometimes make a buffer
3842 hidden although the 'hidden' option is off: When the buffer is
3843 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003844 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003845 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 This option is set for one command with ":hide {command}" |:hide|.
3847 WARNING: It's easy to forget that you have changes in hidden buffers.
3848 Think twice when using ":q!" or ":qa!".
3849
3850 *'highlight'* *'hl'*
3851'highlight' 'hl' string (default (as a single string):
3852 "8:SpecialKey,@:NonText,d:Directory,
3853 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003854 M:ModeMsg,n:LineNr,N:CursorLineNr,
3855 r:Question,s:StatusLine,S:StatusLineNC,
3856 c:VertSplit, t:Title,v:Visual,
3857 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 f:Folded,F:FoldColumn,A:DiffAdd,
3859 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003860 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003861 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003862 +:Pmenu,=:PmenuSel,
3863 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 global
3865 {not in Vi}
3866 This option can be used to set highlighting mode for various
3867 occasions. It is a comma separated list of character pairs. The
3868 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003869 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3871 |hl-NonText| @ '~' and '@' at the end of the window and
3872 characters from 'showbreak'
3873 |hl-Directory| d directories in CTRL-D listing and other special
3874 things in listings
3875 |hl-ErrorMsg| e error messages
3876 h (obsolete, ignored)
3877 |hl-IncSearch| i 'incsearch' highlighting
3878 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3879 |hl-MoreMsg| m |more-prompt|
3880 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003881 |hl-LineNr| n line number for ":number" and ":#" commands, and
3882 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003883 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3884 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 |hl-Question| r |hit-enter| prompt and yes/no questions
3886 |hl-StatusLine| s status line of current window |status-line|
3887 |hl-StatusLineNC| S status lines of not-current windows
3888 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3889 |hl-VertSplit| c column used to separate vertically split windows
3890 |hl-Visual| v Visual mode
3891 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3892 Selection" Only X11 Gui's |gui-x11| and
3893 |xterm-clipboard|.
3894 |hl-WarningMsg| w warning messages
3895 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3896 |hl-Folded| f line used for closed folds
3897 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003898 |hl-DiffAdd| A added line in diff mode
3899 |hl-DiffChange| C changed line in diff mode
3900 |hl-DiffDelete| D deleted line in diff mode
3901 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003903 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003904 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003905 |hl-SpellRare| R rare word |spell|
3906 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003907 |hl-Conceal| - the placeholders used for concealed characters
3908 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003909 |hl-Pmenu| + popup menu normal line
3910 |hl-PmenuSel| = popup menu normal line
3911 |hl-PmenuSbar| x popup menu scrollbar
3912 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913
3914 The display modes are:
3915 r reverse (termcap entry "mr" and "me")
3916 i italic (termcap entry "ZH" and "ZR")
3917 b bold (termcap entry "md" and "me")
3918 s standout (termcap entry "so" and "se")
3919 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003920 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 n no highlighting
3922 - no highlighting
3923 : use a highlight group
3924 The default is used for occasions that are not included.
3925 If you want to change what the display modes do, see |dos-colors|
3926 for an example.
3927 When using the ':' display mode, this must be followed by the name of
3928 a highlight group. A highlight group can be used to define any type
3929 of highlighting, including using color. See |:highlight| on how to
3930 define one. The default uses a different group for each occasion.
3931 See |highlight-default| for the default highlight groups.
3932
3933 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3934'hlsearch' 'hls' boolean (default off)
3935 global
3936 {not in Vi}
3937 {not available when compiled without the
3938 |+extra_search| feature}
3939 When there is a previous search pattern, highlight all its matches.
3940 The type of highlighting used can be set with the 'l' occasion in the
3941 'highlight' option. This uses the "Search" highlight group by
3942 default. Note that only the matching text is highlighted, any offsets
3943 are not applied.
3944 See also: 'incsearch' and |:match|.
3945 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003946 off with |:nohlsearch|. This does not change the option value, as
3947 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003948 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 When the search pattern can match an end-of-line, Vim will try to
3950 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003951 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003953 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003954 You can specify whether the highlight status is restored on startup
3955 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 NOTE: This option is reset when 'compatible' is set.
3957
3958 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003959'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 global
3961 {not in Vi}
3962 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003963 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003965 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 NOTE: This option is set to the Vi default value when 'compatible' is
3967 set and to the Vim default value when 'compatible' is reset.
3968
3969 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3970'hkmap' 'hk' boolean (default off)
3971 global
3972 {not in Vi}
3973 {only available when compiled with the |+rightleft|
3974 feature}
3975 When on, the keyboard is mapped for the Hebrew character set.
3976 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3977 toggle this option. See |rileft.txt|.
3978 NOTE: This option is reset when 'compatible' is set.
3979
3980 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3981'hkmapp' 'hkp' boolean (default off)
3982 global
3983 {not in Vi}
3984 {only available when compiled with the |+rightleft|
3985 feature}
3986 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3987 This is useful if you have a non-Hebrew keyboard.
3988 See |rileft.txt|.
3989 NOTE: This option is reset when 'compatible' is set.
3990
3991 *'icon'* *'noicon'*
3992'icon' boolean (default off, on when title can be restored)
3993 global
3994 {not in Vi}
3995 {not available when compiled without the |+title|
3996 feature}
3997 When on, the icon text of the window will be set to the value of
3998 'iconstring' (if it is not empty), or to the name of the file
3999 currently being edited. Only the last part of the name is used.
4000 Overridden by the 'iconstring' option.
4001 Only works if the terminal supports setting window icons (currently
4002 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4003 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4004 builtin termcap).
4005 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004006 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004008 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009
4010 *'iconstring'*
4011'iconstring' string (default "")
4012 global
4013 {not in Vi}
4014 {not available when compiled without the |+title|
4015 feature}
4016 When this option is not empty, it will be used for the icon text of
4017 the window. This happens only when the 'icon' option is on.
4018 Only works if the terminal supports setting window icon text
4019 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4020 Does not work for MS Windows.
4021 When Vim was compiled with HAVE_X11 defined, the original icon will be
4022 restored if possible |X11|.
4023 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004024 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'titlestring' for example settings.
4026 {not available when compiled without the |+statusline| feature}
4027
4028 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4029'ignorecase' 'ic' boolean (default off)
4030 global
4031 Ignore case in search patterns. Also used when searching in the tags
4032 file.
4033 Also see 'smartcase'.
4034 Can be overruled by using "\c" or "\C" in the pattern, see
4035 |/ignorecase|.
4036
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004037 *'imactivatefunc'* *'imaf'*
4038'imactivatefunc' 'imaf' string (default "")
4039 global
4040 {not in Vi}
4041 {only available when compiled with |+xim| and
4042 |+GUI_GTK|}
4043 This option specifies a function that will be called to
4044 activate/inactivate Input Method.
4045
4046 Example: >
4047 function ImActivateFunc(active)
4048 if a:active
4049 ... do something
4050 else
4051 ... do something
4052 endif
4053 " return value is not used
4054 endfunction
4055 set imactivatefunc=ImActivateFunc
4056<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057 *'imactivatekey'* *'imak'*
4058'imactivatekey' 'imak' string (default "")
4059 global
4060 {not in Vi}
4061 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004062 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 Specifies the key that your Input Method in X-Windows uses for
4064 activation. When this is specified correctly, vim can fully control
4065 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4066 You can't use this option to change the activation key, the option
4067 tells Vim what the key is.
4068 Format:
4069 [MODIFIER_FLAG-]KEY_STRING
4070
4071 These characters can be used for MODIFIER_FLAG (case is ignored):
4072 S Shift key
4073 L Lock key
4074 C Control key
4075 1 Mod1 key
4076 2 Mod2 key
4077 3 Mod3 key
4078 4 Mod4 key
4079 5 Mod5 key
4080 Combinations are allowed, for example "S-C-space" or "SC-space" are
4081 both shift+ctrl+space.
4082 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4083
4084 Example: >
4085 :set imactivatekey=S-space
4086< "S-space" means shift+space. This is the activation key for kinput2 +
4087 canna (Japanese), and ami (Korean).
4088
4089 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4090'imcmdline' 'imc' boolean (default off)
4091 global
4092 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004093 {only available when compiled with the |+xim|,
4094 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 When set the Input Method is always on when starting to edit a command
4096 line, unless entering a search pattern (see 'imsearch' for that).
4097 Setting this option is useful when your input method allows entering
4098 English characters directly, e.g., when it's used to type accented
4099 characters with dead keys.
4100
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004101 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4103 global
4104 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004105 {only available when compiled with the |+xim|,
4106 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 When set the Input Method is never used. This is useful to disable
4108 the IM when it doesn't work properly.
4109 Currently this option is on by default for SGI/IRIX machines. This
4110 may change in later releases.
4111
4112 *'iminsert'* *'imi'*
4113'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4114 local to buffer
4115 {not in Vi}
4116 Specifies whether :lmap or an Input Method (IM) is to be used in
4117 Insert mode. Valid values:
4118 0 :lmap is off and IM is off
4119 1 :lmap is ON and IM is off
4120 2 :lmap is off and IM is ON
4121 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4122 or |global-ime|.
4123 To always reset the option to zero when leaving Insert mode with <Esc>
4124 this can be used: >
4125 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4126< This makes :lmap and IM turn off automatically when leaving Insert
4127 mode.
4128 Note that this option changes when using CTRL-^ in Insert mode
4129 |i_CTRL-^|.
4130 The value is set to 1 when setting 'keymap' to a valid keymap name.
4131 It is also used for the argument of commands like "r" and "f".
4132 The value 0 may not work correctly with Athena and Motif with some XIM
4133 methods. Use 'imdisable' to disable XIM then.
4134
4135 *'imsearch'* *'ims'*
4136'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4137 local to buffer
4138 {not in Vi}
4139 Specifies whether :lmap or an Input Method (IM) is to be used when
4140 entering a search pattern. Valid values:
4141 -1 the value of 'iminsert' is used, makes it look like
4142 'iminsert' is also used when typing a search pattern
4143 0 :lmap is off and IM is off
4144 1 :lmap is ON and IM is off
4145 2 :lmap is off and IM is ON
4146 Note that this option changes when using CTRL-^ in Command-line mode
4147 |c_CTRL-^|.
4148 The value is set to 1 when it is not -1 and setting the 'keymap'
4149 option to a valid keymap name.
4150 The value 0 may not work correctly with Athena and Motif with some XIM
4151 methods. Use 'imdisable' to disable XIM then.
4152
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004153 *'imstatusfunc'* *'imsf'*
4154'imstatusfunc' 'imsf' string (default "")
4155 global
4156 {not in Vi}
4157 {only available when compiled with |+xim| and
4158 |+GUI_GTK|}
4159 This option specifies a function that is called to obtain the status
4160 of Input Method. It must return a positive number when IME is active.
4161
4162 Example: >
4163 function ImStatusFunc()
4164 let is_active = ...do something
4165 return is_active ? 1 : 0
4166 endfunction
4167 set imstatusfunc=ImStatusFunc
4168<
4169 NOTE: This function is invoked very often. Keep it fast.
4170
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 *'include'* *'inc'*
4172'include' 'inc' string (default "^\s*#\s*include")
4173 global or local to buffer |global-local|
4174 {not in Vi}
4175 {not available when compiled without the
4176 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 pattern, just like for the "/" command (See |pattern|). The default
4179 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004180 "]I", "[d", etc.
4181 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004182 comes after the matched pattern. But if "\zs" appears in the pattern
4183 then the text matched from "\zs" to the end, or until "\ze" if it
4184 appears, is used as the file name. Use this to include characters
4185 that are not in 'isfname', such as a space. You can then use
4186 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004187 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188
4189 *'includeexpr'* *'inex'*
4190'includeexpr' 'inex' string (default "")
4191 local to buffer
4192 {not in Vi}
4193 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004194 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004196 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 :set includeexpr=substitute(v:fname,'\\.','/','g')
4198< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004199
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004201 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 Also used for |<cfile>|.
4203
Bram Moolenaar30b65812012-07-12 22:01:11 +02004204 The expression will be evaluated in the |sandbox| when set from a
4205 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004206
4207 It is not allowed to change text or jump to another window while
4208 evaluating 'includeexpr' |textlock|.
4209
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4211'incsearch' 'is' boolean (default off)
4212 global
4213 {not in Vi}
4214 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004215 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004216 While typing a search command, show where the pattern, as it was typed
4217 so far, matches. The matched string is highlighted. If the pattern
4218 is invalid or not found, nothing is shown. The screen will be updated
4219 often, this is only useful on fast terminals.
4220 Note that the match will be shown, but the cursor will return to its
4221 original position when no match is found and when pressing <Esc>. You
4222 still need to finish the search command with <Enter> to move the
4223 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004224 When compiled with the |+reltime| feature Vim only searches for about
4225 half a second. With a complicated pattern and/or a lot of text the
4226 match may not be found. This is to avoid that Vim hangs while you
4227 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004228 The highlighting can be set with the 'i' flag in 'highlight'.
4229 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004230 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004231 to the command line. If 'ignorecase' and 'smartcase' are set and the
4232 command line has no uppercase characters, the added character is
4233 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004234 CTRL-R CTRL-W can be used to add the word at the end of the current
4235 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 NOTE: This option is reset when 'compatible' is set.
4237
4238 *'indentexpr'* *'inde'*
4239'indentexpr' 'inde' string (default "")
4240 local to buffer
4241 {not in Vi}
4242 {not available when compiled without the |+cindent|
4243 or |+eval| features}
4244 Expression which is evaluated to obtain the proper indent for a line.
4245 It is used when a new line is created, for the |=| operator and
4246 in Insert mode as specified with the 'indentkeys' option.
4247 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004248 'smartindent' indenting. When 'lisp' is set, this option is
4249 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 When 'paste' is set this option is not used for indenting.
4251 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004252 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 when the expression is evaluated (but it may be moved around).
4254 The expression must return the number of spaces worth of indent. It
4255 can return "-1" to keep the current indent (this means 'autoindent' is
4256 used for the indent).
4257 Functions useful for computing the indent are |indent()|, |cindent()|
4258 and |lispindent()|.
4259 The evaluation of the expression must not have side effects! It must
4260 not change the text, jump to another window, etc. Afterwards the
4261 cursor position is always restored, thus the cursor may be moved.
4262 Normally this option would be set to call a function: >
4263 :set indentexpr=GetMyIndent()
4264< Error messages will be suppressed, unless the 'debug' option contains
4265 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004266 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 NOTE: This option is made empty when 'compatible' is set.
4268
Bram Moolenaar30b65812012-07-12 22:01:11 +02004269 The expression will be evaluated in the |sandbox| when set from a
4270 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004271
4272 It is not allowed to change text or jump to another window while
4273 evaluating 'indentexpr' |textlock|.
4274
4275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 *'indentkeys'* *'indk'*
4277'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4278 local to buffer
4279 {not in Vi}
4280 {not available when compiled without the |+cindent|
4281 feature}
4282 A list of keys that, when typed in Insert mode, cause reindenting of
4283 the current line. Only happens if 'indentexpr' isn't empty.
4284 The format is identical to 'cinkeys', see |indentkeys-format|.
4285 See |C-indenting| and |indent-expression|.
4286
4287 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4288'infercase' 'inf' boolean (default off)
4289 local to buffer
4290 {not in Vi}
4291 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004292 'ignorecase' is also on, the case of the match is adjusted depending
4293 on the typed text. If the typed text contains a lowercase letter
4294 where the match has an upper case letter, the completed part is made
4295 lowercase. If the typed text has no lowercase letters and the match
4296 has a lowercase letter where the typed text has an uppercase letter,
4297 and there is a letter before it, the completed part is made uppercase.
4298 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299
4300 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4301'insertmode' 'im' boolean (default off)
4302 global
4303 {not in Vi}
4304 Makes Vim work in a way that Insert mode is the default mode. Useful
4305 if you want to use Vim as a modeless editor. Used for |evim|.
4306 These Insert mode commands will be useful:
4307 - Use the cursor keys to move around.
4308 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4309 this is a mapping, it is executed as if 'insertmode' was off.
4310 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004312 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4313 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314
4315 These items change when 'insertmode' is set:
4316 - when starting to edit of a file, Vim goes to Insert mode.
4317 - <Esc> in Insert mode is a no-op and beeps.
4318 - <Esc> in Normal mode makes Vim go to Insert mode.
4319 - CTRL-L in Insert mode is a command, it is not inserted.
4320 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4321 However, when <Esc> is used inside a mapping, it behaves like
4322 'insertmode' was not set. This was done to be able to use the same
4323 mappings with 'insertmode' set or not set.
4324 When executing commands with |:normal| 'insertmode' is not used.
4325
4326 NOTE: This option is reset when 'compatible' is set.
4327
4328 *'isfname'* *'isf'*
4329'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4330 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4331 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4332 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4333 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4334 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4335 global
4336 {not in Vi}
4337 The characters specified by this option are included in file names and
4338 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004339 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 Multi-byte characters 256 and above are always included, only the
4341 characters up to 255 are specified with this option.
4342 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004343 Think twice before adding white space to this option. Although a
4344 space may appear inside a file name, the effect will be that Vim
4345 doesn't know where a file name starts or ends when doing completion.
4346 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347
4348 Note that on systems using a backslash as path separator, Vim tries to
4349 do its best to make it work as you would expect. That is a bit
4350 tricky, since Vi originally used the backslash to escape special
4351 characters. Vim will not remove a backslash in front of a normal file
4352 name character on these systems, but it will on Unix and alikes. The
4353 '&' and '^' are not included by default, because these are special for
4354 cmd.exe.
4355
4356 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004357 Each part can be a single character number or a range. A range is two
4358 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 decimal number between 0 and 255 or the ASCII character itself (does
4360 not work for digits). Example:
4361 "_,-,128-140,#-43" (include '_' and '-' and the range
4362 128 to 140 and '#' to 43)
4363 If a part starts with '^', the following character number or range
4364 will be excluded from the option. The option is interpreted from left
4365 to right. Put the excluded character after the range where it is
4366 included. To include '^' itself use it as the last character of the
4367 option or the end of a range. Example:
4368 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4369 If the character is '@', all characters where isalpha() returns TRUE
4370 are included. Normally these are the characters a to z and A to Z,
4371 plus accented characters. To include '@' itself use "@-@". Examples:
4372 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004373 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 "a-z,A-Z,@-@" All letters plus the '@' character.
4375 A comma can be included by using it where a character number is
4376 expected. Example:
4377 "48-57,,,_" Digits, comma and underscore.
4378 A comma can be excluded by prepending a '^'. Example:
4379 " -~,^,,9" All characters from space to '~', excluding
4380 comma, plus <Tab>.
4381 See |option-backslash| about including spaces and backslashes.
4382
4383 *'isident'* *'isi'*
4384'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4385 "@,48-57,_,128-167,224-235"
4386 otherwise: "@,48-57,_,192-255")
4387 global
4388 {not in Vi}
4389 The characters given by this option are included in identifiers.
4390 Identifiers are used in recognizing environment variables and after a
4391 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004392 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 option.
4394 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004395 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4397
4398 *'iskeyword'* *'isk'*
4399'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4400 "@,48-57,_,128-167,224-235"
4401 otherwise: "@,48-57,_,192-255"
4402 Vi default: "@,48-57,_")
4403 local to buffer
4404 {not in Vi}
4405 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004406 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 'isfname' for a description of the format of this option. For C
4408 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4409 For a help file it is set to all non-blank printable characters except
4410 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4411 command).
4412 When the 'lisp' option is on the '-' character is always included.
4413 NOTE: This option is set to the Vi default value when 'compatible' is
4414 set and to the Vim default value when 'compatible' is reset.
4415
4416 *'isprint'* *'isp'*
4417'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4418 "@,~-255"; otherwise: "@,161-255")
4419 global
4420 {not in Vi}
4421 The characters given by this option are displayed directly on the
4422 screen. It is also used for "\p" in a |pattern|. The characters from
4423 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4424 even when they are not included in 'isprint' or excluded. See
4425 'isfname' for a description of the format of this option.
4426
4427 Non-printable characters are displayed with two characters:
4428 0 - 31 "^@" - "^_"
4429 32 - 126 always single characters
4430 127 "^?"
4431 128 - 159 "~@" - "~_"
4432 160 - 254 "| " - "|~"
4433 255 "~?"
4434 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4435 displayed as <xx>, with the hexadecimal value of the byte.
4436 When 'display' contains "uhex" all unprintable characters are
4437 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004438 The SpecialKey highlighting will be used for unprintable characters.
4439 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
4441 Multi-byte characters 256 and above are always included, only the
4442 characters up to 255 are specified with this option. When a character
4443 is printable but it is not available in the current font, a
4444 replacement character will be shown.
4445 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4446 There is no option to specify these characters.
4447
4448 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4449'joinspaces' 'js' boolean (default on)
4450 global
4451 {not in Vi}
4452 Insert two spaces after a '.', '?' and '!' with a join command.
4453 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4454 Otherwise only one space is inserted.
4455 NOTE: This option is set when 'compatible' is set.
4456
4457 *'key'*
4458'key' string (default "")
4459 local to buffer
4460 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004461 {only available when compiled with the |+cryptv|
4462 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004464 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 Careful: Do not set the key value by hand, someone might see the typed
4466 key. Use the |:X| command. But you can make 'key' empty: >
4467 :set key=
4468< It is not possible to get the value of this option with ":set key" or
4469 "echo &key". This is to avoid showing it to someone who shouldn't
4470 know. It also means you cannot see it yourself once you have set it,
4471 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004472 You can use "&key" in an expression to detect whether encryption is
4473 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474
4475 *'keymap'* *'kmp'* *E544*
4476'keymap' 'kmp' string (default "")
4477 local to buffer
4478 {not in Vi}
4479 {only available when compiled with the |+keymap|
4480 feature}
4481 Name of a keyboard mapping. See |mbyte-keymap|.
4482 Setting this option to a valid keymap name has the side effect of
4483 setting 'iminsert' to one, so that the keymap becomes effective.
4484 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004485 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
4487 *'keymodel'* *'km'*
4488'keymodel' 'km' string (default "")
4489 global
4490 {not in Vi}
4491 List of comma separated words, which enable special things that keys
4492 can do. These values can be used:
4493 startsel Using a shifted special key starts selection (either
4494 Select mode or Visual mode, depending on "key" being
4495 present in 'selectmode').
4496 stopsel Using a not-shifted special key stops selection.
4497 Special keys in this context are the cursor keys, <End>, <Home>,
4498 <PageUp> and <PageDown>.
4499 The 'keymodel' option is set by the |:behave| command.
4500
4501 *'keywordprg'* *'kp'*
4502'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4503 OS/2: "view /", VMS: "help")
4504 global or local to buffer |global-local|
4505 {not in Vi}
4506 Program to use for the |K| command. Environment variables are
4507 expanded |:set_env|. ":help" may be used to access the Vim internal
4508 help. (Note that previously setting the global option to the empty
4509 value did this, which is now deprecated.)
4510 When "man" is used, Vim will automatically translate a count for the
4511 "K" command to a section number. Also for "man -s", in which case the
4512 "-s" is removed when there is no count.
4513 See |option-backslash| about including spaces and backslashes.
4514 Example: >
4515 :set keywordprg=man\ -s
4516< This option cannot be set from a |modeline| or in the |sandbox|, for
4517 security reasons.
4518
4519 *'langmap'* *'lmap'* *E357* *E358*
4520'langmap' 'lmap' string (default "")
4521 global
4522 {not in Vi}
4523 {only available when compiled with the |+langmap|
4524 feature}
4525 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004526 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 inserted directly. When in command mode the 'langmap' option takes
4528 care of translating these special characters to the original meaning
4529 of the key. This means you don't have to change the keyboard mode to
4530 be able to execute Normal mode commands.
4531 This is the opposite of the 'keymap' option, where characters are
4532 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004533 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4534 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004535 This option cannot be set from a |modeline| or in the |sandbox|, for
4536 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004538 Example (for Greek, in UTF-8): *greek* >
4539 :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 +00004540< Example (exchanges meaning of z and y for commands): >
4541 :set langmap=zy,yz,ZY,YZ
4542<
4543 The 'langmap' option is a list of parts, separated with commas. Each
4544 part can be in one of two forms:
4545 1. A list of pairs. Each pair is a "from" character immediately
4546 followed by the "to" character. Examples: "aA", "aAbBcC".
4547 2. A list of "from" characters, a semi-colon and a list of "to"
4548 characters. Example: "abc;ABC"
4549 Example: "aA,fgh;FGH,cCdDeE"
4550 Special characters need to be preceded with a backslash. These are
4551 ";", ',' and backslash itself.
4552
4553 This will allow you to activate vim actions without having to switch
4554 back and forth between the languages. Your language characters will
4555 be understood as normal vim English characters (according to the
4556 langmap mappings) in the following cases:
4557 o Normal/Visual mode (commands, buffer/register names, user mappings)
4558 o Insert/Replace Mode: Register names after CTRL-R
4559 o Insert/Replace Mode: Mappings
4560 Characters entered in Command-line mode will NOT be affected by
4561 this option. Note that this option can be changed at any time
4562 allowing to switch between mappings for different languages/encodings.
4563 Use a mapping to avoid having to type it each time!
4564
4565 *'langmenu'* *'lm'*
4566'langmenu' 'lm' string (default "")
4567 global
4568 {not in Vi}
4569 {only available when compiled with the |+menu| and
4570 |+multi_lang| features}
4571 Language to use for menu translation. Tells which file is loaded
4572 from the "lang" directory in 'runtimepath': >
4573 "lang/menu_" . &langmenu . ".vim"
4574< (without the spaces). For example, to always use the Dutch menus, no
4575 matter what $LANG is set to: >
4576 :set langmenu=nl_NL.ISO_8859-1
4577< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004578 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 If your $LANG is set to a non-English language but you do want to use
4580 the English menus: >
4581 :set langmenu=none
4582< This option must be set before loading menus, switching on filetype
4583 detection or syntax highlighting. Once the menus are defined setting
4584 this option has no effect. But you could do this: >
4585 :source $VIMRUNTIME/delmenu.vim
4586 :set langmenu=de_DE.ISO_8859-1
4587 :source $VIMRUNTIME/menu.vim
4588< Warning: This deletes all menus that you defined yourself!
4589
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004590 *'langnoremap'* *'lnr'*
4591'langnoremap' 'lnr' boolean (default off)
4592 global
4593 {not in Vi}
4594 {only available when compiled with the |+langmap|
4595 feature}
4596 When on, setting 'langmap' does not apply to characters resulting from
4597 a mapping. This basically means, if you noticed that setting
4598 'langmap' disables some of your mappings, try setting this option.
4599 This option defaults to off for backwards compatibility. Set it on if
4600 that works for you to avoid mappings to break.
4601
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 *'laststatus'* *'ls'*
4603'laststatus' 'ls' number (default 1)
4604 global
4605 {not in Vi}
4606 The value of this option influences when the last window will have a
4607 status line:
4608 0: never
4609 1: only if there are at least two windows
4610 2: always
4611 The screen looks nicer with a status line if you have several
4612 windows, but it takes another screen line. |status-line|
4613
4614 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4615'lazyredraw' 'lz' boolean (default off)
4616 global
4617 {not in Vi}
4618 When this option is set, the screen will not be redrawn while
4619 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004620 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 update use |:redraw|.
4622
4623 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4624'linebreak' 'lbr' boolean (default off)
4625 local to window
4626 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004627 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004629 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 than at the last character that fits on the screen. Unlike
4631 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004632 it only affects the way the file is displayed, not its contents.
4633 If 'breakindent' is set, line is visually indented. Then, the value
4634 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004635 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 Note that <Tab> characters after an <EOL> are mostly not displayed
4637 with the right amount of white space.
4638
4639 *'lines'* *E593*
4640'lines' number (default 24 or terminal height)
4641 global
4642 Number of lines of the Vim window.
4643 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004644 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645 When Vim is running in the GUI or in a resizable window, setting this
4646 option will cause the window size to be changed. When you only want
4647 to use the size for the GUI, put the command in your |gvimrc| file.
4648 Vim limits the number of lines to what fits on the screen. You can
4649 use this command to get the tallest window possible: >
4650 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004651< Minimum value is 2, maximum value is 1000.
4652 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 When you set this option and Vim is unable to change the physical
4654 number of lines of the display, the display may be messed up.
4655
4656 *'linespace'* *'lsp'*
4657'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4658 global
4659 {not in Vi}
4660 {only in the GUI}
4661 Number of pixel lines inserted between characters. Useful if the font
4662 uses the full character cell height, making lines touch each other.
4663 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004664 With some fonts there can be too much room between lines (to have
4665 space for ascents and descents). Then it makes sense to set
4666 'linespace' to a negative value. This may cause display problems
4667 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668
4669 *'lisp'* *'nolisp'*
4670'lisp' boolean (default off)
4671 local to buffer
4672 {not available when compiled without the |+lispindent|
4673 feature}
4674 Lisp mode: When <Enter> is typed in insert mode set the indent for
4675 the next line to Lisp standards (well, sort of). Also happens with
4676 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4677 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4678 better. Also see 'lispwords'.
4679 The '-' character is included in keyword characters. Redefines the
4680 "=" operator to use this same indentation algorithm rather than
4681 calling an external program if 'equalprg' is empty.
4682 This option is not used when 'paste' is set.
4683 {Vi: Does it a little bit differently}
4684
4685 *'lispwords'* *'lw'*
4686'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004687 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 {not in Vi}
4689 {not available when compiled without the |+lispindent|
4690 feature}
4691 Comma separated list of words that influence the Lisp indenting.
4692 |'lisp'|
4693
4694 *'list'* *'nolist'*
4695'list' boolean (default off)
4696 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004697 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4698 line. Useful to see the difference between tabs and spaces and for
4699 trailing blanks. Further changed by the 'listchars' option.
4700
4701 The cursor is displayed at the start of the space a Tab character
4702 occupies, not at the end as usual in Normal mode. To get this cursor
4703 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004704 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004705<
4706 Note that list mode will also affect formatting (set with 'textwidth'
4707 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 changing the way tabs are displayed.
4709
4710 *'listchars'* *'lcs'*
4711'listchars' 'lcs' string (default "eol:$")
4712 global
4713 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004714 Strings to use in 'list' mode and for the |:list| command. It is a
4715 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004716 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717 eol:c Character to show at the end of each line. When
4718 omitted, there is no extra character at the end of the
4719 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004720 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004721 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004723 fill the space that the tab normally occupies.
4724 "tab:>-" will show a tab that takes four spaces as
4725 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004726 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004727 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004729 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 extends:c Character to show in the last column, when 'wrap' is
4731 off and the line continues beyond the right of the
4732 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004733 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 precedes:c Character to show in the first column, when 'wrap'
4735 is off and there is text preceding the character
4736 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004737 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004738 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004739 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004740 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004741 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004742 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004744 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004746 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
4748 Examples: >
4749 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004750 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 :set lcs=extends:>,precedes:<
4752< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004753 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004754 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
4756 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4757'loadplugins' 'lpl' boolean (default on)
4758 global
4759 {not in Vi}
4760 When on the plugin scripts are loaded when starting up |load-plugins|.
4761 This option can be reset in your |vimrc| file to disable the loading
4762 of plugins.
4763 Note that using the "-u NONE" and "--noplugin" command line arguments
4764 reset this option. |-u| |--noplugin|
4765
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004766 *'macatsui'* *'nomacatsui'*
4767'macatsui' boolean (default on)
4768 global
4769 {only available in Mac GUI version}
4770 This is a workaround for when drawing doesn't work properly. When set
4771 and compiled with multi-byte support ATSUI text drawing is used. When
4772 not set ATSUI text drawing is not used. Switch this option off when
4773 you experience drawing problems. In a future version the problems may
4774 be solved and this option becomes obsolete. Therefore use this method
4775 to unset it: >
4776 if exists('&macatsui')
4777 set nomacatsui
4778 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004779< Another option to check if you have drawing problems is
4780 'termencoding'.
4781
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 *'magic'* *'nomagic'*
4783'magic' boolean (default on)
4784 global
4785 Changes the special characters that can be used in search patterns.
4786 See |pattern|.
4787 NOTE: To avoid portability problems with using patterns, always keep
4788 this option at the default "on". Only switch it off when working with
4789 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004790 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791
4792 *'makeef'* *'mef'*
4793'makeef' 'mef' string (default: "")
4794 global
4795 {not in Vi}
4796 {not available when compiled without the |+quickfix|
4797 feature}
4798 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4799 and the |:grep| command.
4800 When it is empty, an internally generated temp file will be used.
4801 When "##" is included, it is replaced by a number to make the name
4802 unique. This makes sure that the ":make" command doesn't overwrite an
4803 existing file.
4804 NOT used for the ":cf" command. See 'errorfile' for that.
4805 Environment variables are expanded |:set_env|.
4806 See |option-backslash| about including spaces and backslashes.
4807 This option cannot be set from a |modeline| or in the |sandbox|, for
4808 security reasons.
4809
4810 *'makeprg'* *'mp'*
4811'makeprg' 'mp' string (default "make", VMS: "MMS")
4812 global or local to buffer |global-local|
4813 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004814 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004815 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4816 which are expanded to the current and alternate file name. Use |::S|
4817 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004818 Environment variables are expanded |:set_env|. See |option-backslash|
4819 about including spaces and backslashes.
4820 Note that a '|' must be escaped twice: once for ":set" and once for
4821 the interpretation of a command. When you use a filter called
4822 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 :set makeprg=gmake\ \\\|\ myfilter
4824< The placeholder "$*" can be given (even multiple times) to specify
4825 where the arguments will be included, for example: >
4826 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4827< This option cannot be set from a |modeline| or in the |sandbox|, for
4828 security reasons.
4829
4830 *'matchpairs'* *'mps'*
4831'matchpairs' 'mps' string (default "(:),{:},[:]")
4832 local to buffer
4833 {not in Vi}
4834 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004835 other.
4836 Only character pairs are allowed that are different, thus you cannot
4837 jump between two double quotes.
4838 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004839 The pairs must be separated by a comma. Example for including '<' and
4840 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 :set mps+=<:>
4842
4843< A more exotic example, to jump between the '=' and ';' in an
4844 assignment, useful for languages like C and Java: >
4845 :au FileType c,cpp,java set mps+==:;
4846
4847< For a more advanced way of using "%", see the matchit.vim plugin in
4848 the $VIMRUNTIME/macros directory. |add-local-help|
4849
4850 *'matchtime'* *'mat'*
4851'matchtime' 'mat' number (default 5)
4852 global
4853 {not in Vi}{in Nvi}
4854 Tenths of a second to show the matching paren, when 'showmatch' is
4855 set. Note that this is not in milliseconds, like other options that
4856 set a time. This is to be compatible with Nvi.
4857
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004858 *'maxcombine'* *'mco'*
4859'maxcombine' 'mco' number (default 2)
4860 global
4861 {not in Vi}
4862 {only available when compiled with the |+multi_byte|
4863 feature}
4864 The maximum number of combining characters supported for displaying.
4865 Only used when 'encoding' is "utf-8".
4866 The default is OK for most languages. Hebrew may require 4.
4867 Maximum value is 6.
4868 Even when this option is set to 2 you can still edit text with more
4869 combining characters, you just can't see them. Use |g8| or |ga|.
4870 See |mbyte-combining|.
4871
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 *'maxfuncdepth'* *'mfd'*
4873'maxfuncdepth' 'mfd' number (default 100)
4874 global
4875 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004876 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004877 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 Maximum depth of function calls for user functions. This normally
4879 catches endless recursion. When using a recursive function with
4880 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4881 more memory, there is the danger of failing when memory is exhausted.
4882 See also |:function|.
4883
4884 *'maxmapdepth'* *'mmd'* *E223*
4885'maxmapdepth' 'mmd' number (default 1000)
4886 global
4887 {not in Vi}
4888 Maximum number of times a mapping is done without resulting in a
4889 character to be used. This normally catches endless mappings, like
4890 ":map x y" with ":map y x". It still does not catch ":map g wg",
4891 because the 'w' is used before the next mapping is done. See also
4892 |key-mapping|.
4893
4894 *'maxmem'* *'mm'*
4895'maxmem' 'mm' number (default between 256 to 5120 (system
4896 dependent) or half the amount of memory
4897 available)
4898 global
4899 {not in Vi}
4900 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4901 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004902 other memory to be freed. The maximum usable value is about 2000000.
4903 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004905 *'maxmempattern'* *'mmp'*
4906'maxmempattern' 'mmp' number (default 1000)
4907 global
4908 {not in Vi}
4909 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004910 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004911 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004912 When Vim runs into the limit it gives an error message and mostly
4913 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004914 Running into the limit often means that the pattern is very
4915 inefficient or too complex. This may already happen with the pattern
4916 "\(.\)*" on a very long line. ".*" works much better.
4917 Vim may run out of memory before hitting the 'maxmempattern' limit.
4918
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 *'maxmemtot'* *'mmt'*
4920'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4921 dependent) or half the amount of memory
4922 available)
4923 global
4924 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004925 Maximum amount of memory in Kbyte to use for all buffers together.
4926 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4927 without a limit. On 64 bit machines higher values might work. But
4928 hey, do you really need more than 2 Gbyte for text editing?
4929 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
4931 *'menuitems'* *'mis'*
4932'menuitems' 'mis' number (default 25)
4933 global
4934 {not in Vi}
4935 {not available when compiled without the |+menu|
4936 feature}
4937 Maximum number of items to use in a menu. Used for menus that are
4938 generated from a list of items, e.g., the Buffers menu. Changing this
4939 option has no direct effect, the menu must be refreshed first.
4940
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004941 *'mkspellmem'* *'msm'*
4942'mkspellmem' 'msm' string (default "460000,2000,500")
4943 global
4944 {not in Vi}
4945 {not available when compiled without the |+syntax|
4946 feature}
4947 Parameters for |:mkspell|. This tunes when to start compressing the
4948 word tree. Compression can be slow when there are many words, but
4949 it's needed to avoid running out of memory. The amount of memory used
4950 per word depends very much on how similar the words are, that's why
4951 this tuning is complicated.
4952
4953 There are three numbers, separated by commas:
4954 {start},{inc},{added}
4955
4956 For most languages the uncompressed word tree fits in memory. {start}
4957 gives the amount of memory in Kbyte that can be used before any
4958 compression is done. It should be a bit smaller than the amount of
4959 memory that is available to Vim.
4960
4961 When going over the {start} limit the {inc} number specifies the
4962 amount of memory in Kbyte that can be allocated before another
4963 compression is done. A low number means compression is done after
4964 less words are added, which is slow. A high number means more memory
4965 will be allocated.
4966
4967 After doing compression, {added} times 1024 words can be added before
4968 the {inc} limit is ignored and compression is done when any extra
4969 amount of memory is needed. A low number means there is a smaller
4970 chance of hitting the {inc} limit, less memory is used but it's
4971 slower.
4972
4973 The languages for which these numbers are important are Italian and
4974 Hungarian. The default works for when you have about 512 Mbyte. If
4975 you have 1 Gbyte you could use: >
4976 :set mkspellmem=900000,3000,800
4977< If you have less than 512 Mbyte |:mkspell| may fail for some
4978 languages, no matter what you set 'mkspellmem' to.
4979
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004981'modeline' 'ml' boolean (Vim default: on (off for root),
4982 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 local to buffer
4984 *'modelines'* *'mls'*
4985'modelines' 'mls' number (default 5)
4986 global
4987 {not in Vi}
4988 If 'modeline' is on 'modelines' gives the number of lines that is
4989 checked for set commands. If 'modeline' is off or 'modelines' is zero
4990 no lines are checked. See |modeline|.
4991 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4992 set and to the Vim default value when 'compatible' is reset.
4993
4994 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4995'modifiable' 'ma' boolean (default on)
4996 local to buffer
4997 {not in Vi} *E21*
4998 When off the buffer contents cannot be changed. The 'fileformat' and
4999 'fileencoding' options also can't be changed.
5000 Can be reset with the |-M| command line argument.
5001
5002 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5003'modified' 'mod' boolean (default off)
5004 local to buffer
5005 {not in Vi}
5006 When on, the buffer is considered to be modified. This option is set
5007 when:
5008 1. A change was made to the text since it was last written. Using the
5009 |undo| command to go back to the original text will reset the
5010 option. But undoing changes that were made before writing the
5011 buffer will set the option again, since the text is different from
5012 when it was written.
5013 2. 'fileformat' or 'fileencoding' is different from its original
5014 value. The original value is set when the buffer is read or
5015 written. A ":set nomodified" command also resets the original
5016 values to the current values and the 'modified' option will be
5017 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005018 This option is not set when a change is made to the buffer as the
5019 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5020 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5021 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5023 will be ignored.
5024
5025 *'more'* *'nomore'*
5026'more' boolean (Vim default: on, Vi default: off)
5027 global
5028 {not in Vi}
5029 When on, listings pause when the whole screen is filled. You will get
5030 the |more-prompt|. When this option is off there are no pauses, the
5031 listing continues until finished.
5032 NOTE: This option is set to the Vi default value when 'compatible' is
5033 set and to the Vim default value when 'compatible' is reset.
5034
5035 *'mouse'* *E538*
5036'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5037 global
5038 {not in Vi}
5039 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005040 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5041 sysmouse and Linux console with gpm). For using the mouse in the
5042 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 The mouse can be enabled for different modes:
5044 n Normal mode
5045 v Visual mode
5046 i Insert mode
5047 c Command-line mode
5048 h all previous modes when editing a help file
5049 a all previous modes
5050 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005051 Normally you would enable the mouse in all four modes with: >
5052 :set mouse=a
5053< When the mouse is not enabled, the GUI will still use the mouse for
5054 modeless selection. This doesn't move the text cursor.
5055
5056 See |mouse-using|. Also see |'clipboard'|.
5057
5058 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005059 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 the mouse buttons can still be used by keeping the shift key pressed.
5061 Also see the 'clipboard' option.
5062
5063 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5064'mousefocus' 'mousef' boolean (default off)
5065 global
5066 {not in Vi}
5067 {only works in the GUI}
5068 The window that the mouse pointer is on is automatically activated.
5069 When changing the window layout or window focus in another way, the
5070 mouse pointer is moved to the window with keyboard focus. Off is the
5071 default because it makes using the pull down menus a little goofy, as
5072 a pointer transit may activate a window unintentionally.
5073
5074 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5075'mousehide' 'mh' boolean (default on)
5076 global
5077 {not in Vi}
5078 {only works in the GUI}
5079 When on, the mouse pointer is hidden when characters are typed.
5080 The mouse pointer is restored when the mouse is moved.
5081
5082 *'mousemodel'* *'mousem'*
5083'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5084 global
5085 {not in Vi}
5086 Sets the model to use for the mouse. The name mostly specifies what
5087 the right mouse button is used for:
5088 extend Right mouse button extends a selection. This works
5089 like in an xterm.
5090 popup Right mouse button pops up a menu. The shifted left
5091 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005092 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 popup_setpos Like "popup", but the cursor will be moved to the
5094 position where the mouse was clicked, and thus the
5095 selected operation will act upon the clicked object.
5096 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005097 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 course, that right clicking outside a selection will
5099 end Visual mode.
5100 Overview of what button does what for each model:
5101 mouse extend popup(_setpos) ~
5102 left click place cursor place cursor
5103 left drag start selection start selection
5104 shift-left search word extend selection
5105 right click extend selection popup menu (place cursor)
5106 right drag extend selection -
5107 middle click paste paste
5108
5109 In the "popup" model the right mouse button produces a pop-up menu.
5110 You need to define this first, see |popup-menu|.
5111
5112 Note that you can further refine the meaning of buttons with mappings.
5113 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5114 selection (because that's handled in the GUI code directly).
5115
5116 The 'mousemodel' option is set by the |:behave| command.
5117
5118 *'mouseshape'* *'mouses'* *E547*
5119'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005120 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 global
5122 {not in Vi}
5123 {only available when compiled with the |+mouseshape|
5124 feature}
5125 This option tells Vim what the mouse pointer should look like in
5126 different modes. The option is a comma separated list of parts, much
5127 like used for 'guicursor'. Each part consist of a mode/location-list
5128 and an argument-list:
5129 mode-list:shape,mode-list:shape,..
5130 The mode-list is a dash separated list of these modes/locations:
5131 In a normal window: ~
5132 n Normal mode
5133 v Visual mode
5134 ve Visual mode with 'selection' "exclusive" (same as 'v',
5135 if not specified)
5136 o Operator-pending mode
5137 i Insert mode
5138 r Replace mode
5139
5140 Others: ~
5141 c appending to the command-line
5142 ci inserting in the command-line
5143 cr replacing in the command-line
5144 m at the 'Hit ENTER' or 'More' prompts
5145 ml idem, but cursor in the last line
5146 e any mode, pointer below last window
5147 s any mode, pointer on a status line
5148 sd any mode, while dragging a status line
5149 vs any mode, pointer on a vertical separator line
5150 vd any mode, while dragging a vertical separator line
5151 a everywhere
5152
5153 The shape is one of the following:
5154 avail name looks like ~
5155 w x arrow Normal mouse pointer
5156 w x blank no pointer at all (use with care!)
5157 w x beam I-beam
5158 w x updown up-down sizing arrows
5159 w x leftright left-right sizing arrows
5160 w x busy The system's usual busy pointer
5161 w x no The system's usual 'no input' pointer
5162 x udsizing indicates up-down resizing
5163 x lrsizing indicates left-right resizing
5164 x crosshair like a big thin +
5165 x hand1 black hand
5166 x hand2 white hand
5167 x pencil what you write with
5168 x question big ?
5169 x rightup-arrow arrow pointing right-up
5170 w x up-arrow arrow pointing up
5171 x <number> any X11 pointer number (see X11/cursorfont.h)
5172
5173 The "avail" column contains a 'w' if the shape is available for Win32,
5174 x for X11.
5175 Any modes not specified or shapes not available use the normal mouse
5176 pointer.
5177
5178 Example: >
5179 :set mouseshape=s:udsizing,m:no
5180< will make the mouse turn to a sizing arrow over the status lines and
5181 indicate no input when the hit-enter prompt is displayed (since
5182 clicking the mouse has no effect in this state.)
5183
5184 *'mousetime'* *'mouset'*
5185'mousetime' 'mouset' number (default 500)
5186 global
5187 {not in Vi}
5188 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5189 time in msec between two mouse clicks for the second click to be
5190 recognized as a multi click.
5191
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005192 *'mzquantum'* *'mzq'*
5193'mzquantum' 'mzq' number (default 100)
5194 global
5195 {not in Vi}
5196 {not available when compiled without the |+mzscheme|
5197 feature}
5198 The number of milliseconds between polls for MzScheme threads.
5199 Negative or zero value means no thread scheduling.
5200
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 *'nrformats'* *'nf'*
5202'nrformats' 'nf' string (default "octal,hex")
5203 local to buffer
5204 {not in Vi}
5205 This defines what bases Vim will consider for numbers when using the
5206 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5207 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005208 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005210 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005211 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005213 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 considered to be hexadecimal. Example: Using CTRL-X on
5215 "0x100" results in "0x0ff".
5216 Numbers which simply begin with a digit in the range 1-9 are always
5217 considered decimal. This also happens for numbers that are not
5218 recognized as octal or hex.
5219
5220 *'number'* *'nu'* *'nonumber'* *'nonu'*
5221'number' 'nu' boolean (default off)
5222 local to window
5223 Print the line number in front of each line. When the 'n' option is
5224 excluded from 'cpoptions' a wrapped line will not use the column of
5225 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005226 The 'numberwidth' option can be used to set the room used for the line
5227 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 When a long, wrapped line doesn't start with the first character, '-'
5229 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005230 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5231 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005232 *number_relativenumber*
5233 The 'relativenumber' option changes the displayed number to be
5234 relative to the cursor. Together with 'number' there are these
5235 four combinations (cursor in line 3):
5236
5237 'nonu' 'nu' 'nonu' 'nu'
5238 'nornu' 'nornu' 'rnu' 'rnu'
5239
5240 |apple | 1 apple | 2 apple | 2 apple
5241 |pear | 2 pear | 1 pear | 1 pear
5242 |nobody | 3 nobody | 0 nobody |3 nobody
5243 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005245 *'numberwidth'* *'nuw'*
5246'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5247 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005248 {not in Vi}
5249 {only available when compiled with the |+linebreak|
5250 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005251 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005252 when the 'number' or 'relativenumber' option is set or printing lines
5253 with a line number. Since one space is always between the number and
5254 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005255 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005256 fit the highest line number in the buffer respectively the number of
5257 rows in the window, depending on whether 'number' or 'relativenumber'
5258 is set. Thus with the Vim default of 4 there is room for a line number
5259 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005260 The minimum value is 1, the maximum value is 10.
5261 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5262
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005263 *'omnifunc'* *'ofu'*
5264'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005265 local to buffer
5266 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005267 {not available when compiled without the |+eval|
5268 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005269 This option specifies a function to be used for Insert mode omni
5270 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005271 See |complete-functions| for an explanation of how the function is
5272 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005273 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005274 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005275 This option cannot be set from a |modeline| or in the |sandbox|, for
5276 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005277
5278
Bram Moolenaar02467872007-05-06 13:22:01 +00005279 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005280'opendevice' 'odev' boolean (default off)
5281 global
5282 {not in Vi}
5283 {only for MS-DOS, MS-Windows and OS/2}
5284 Enable reading and writing from devices. This may get Vim stuck on a
5285 device that can be opened but doesn't actually do the I/O. Therefore
5286 it is off by default.
5287 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5288 result in editing a device.
5289
5290
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005291 *'operatorfunc'* *'opfunc'*
5292'operatorfunc' 'opfunc' string (default: empty)
5293 global
5294 {not in Vi}
5295 This option specifies a function to be called by the |g@| operator.
5296 See |:map-operator| for more info and an example.
5297
5298 This option cannot be set from a |modeline| or in the |sandbox|, for
5299 security reasons.
5300
5301
Bram Moolenaar251e1912011-06-19 05:09:16 +02005302 *'osfiletype'* *'oft'*
5303'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304 local to buffer
5305 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005306 This option was supported on RISC OS, which has been removed.
5307
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308
5309 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005310'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 global
5312 Specifies the nroff macros that separate paragraphs. These are pairs
5313 of two letters (see |object-motions|).
5314
5315 *'paste'* *'nopaste'*
5316'paste' boolean (default off)
5317 global
5318 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005319 Put Vim in Paste mode. This is useful if you want to cut or copy
5320 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 unexpected effects.
5322 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005323 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 knows about pasting and will mostly do the right thing without 'paste'
5325 being set. The same is true for a terminal where Vim handles the
5326 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005327 This option is reset when starting the GUI. Thus if you set it in
5328 your .vimrc it will work in a terminal, but not in the GUI. Setting
5329 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5330 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 When the 'paste' option is switched on (also when it was already on):
5332 - mapping in Insert mode and Command-line mode is disabled
5333 - abbreviations are disabled
5334 - 'textwidth' is set to 0
5335 - 'wrapmargin' is set to 0
5336 - 'autoindent' is reset
5337 - 'smartindent' is reset
5338 - 'softtabstop' is set to 0
5339 - 'revins' is reset
5340 - 'ruler' is reset
5341 - 'showmatch' is reset
5342 - 'formatoptions' is used like it is empty
5343 These options keep their value, but their effect is disabled:
5344 - 'lisp'
5345 - 'indentexpr'
5346 - 'cindent'
5347 NOTE: When you start editing another file while the 'paste' option is
5348 on, settings from the modelines or autocommands may change the
5349 settings again, causing trouble when pasting text. You might want to
5350 set the 'paste' option again.
5351 When the 'paste' option is reset the mentioned options are restored to
5352 the value before the moment 'paste' was switched from off to on.
5353 Resetting 'paste' before ever setting it does not have any effect.
5354 Since mapping doesn't work while 'paste' is active, you need to use
5355 the 'pastetoggle' option to toggle the 'paste' option with some key.
5356
5357 *'pastetoggle'* *'pt'*
5358'pastetoggle' 'pt' string (default "")
5359 global
5360 {not in Vi}
5361 When non-empty, specifies the key sequence that toggles the 'paste'
5362 option. This is like specifying a mapping: >
5363 :map {keys} :set invpaste<CR>
5364< Where {keys} is the value of 'pastetoggle'.
5365 The difference is that it will work even when 'paste' is set.
5366 'pastetoggle' works in Insert mode and Normal mode, but not in
5367 Command-line mode.
5368 Mappings are checked first, thus overrule 'pastetoggle'. However,
5369 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5370 this: >
5371 :map <F10> :set paste<CR>
5372 :map <F11> :set nopaste<CR>
5373 :imap <F10> <C-O>:set paste<CR>
5374 :imap <F11> <nop>
5375 :set pastetoggle=<F11>
5376< This will make <F10> start paste mode and <F11> stop paste mode.
5377 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5378 mode everything is inserted literally, except the 'pastetoggle' key
5379 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005380 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381
5382 *'pex'* *'patchexpr'*
5383'patchexpr' 'pex' string (default "")
5384 global
5385 {not in Vi}
5386 {not available when compiled without the |+diff|
5387 feature}
5388 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005389 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
Bram Moolenaardbc28022014-07-26 13:40:44 +02005391 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392'patchmode' 'pm' string (default "")
5393 global
5394 {not in Vi}
5395 When non-empty the oldest version of a file is kept. This can be used
5396 to keep the original version of a file if you are changing files in a
5397 source distribution. Only the first time that a file is written a
5398 copy of the original file will be kept. The name of the copy is the
5399 name of the original file with the string in the 'patchmode' option
5400 appended. This option should start with a dot. Use a string like
5401 ".org". 'backupdir' must not be empty for this to work (Detail: The
5402 backup file is renamed to the patchmode file after the new file has
5403 been successfully written, that's why it must be possible to write a
5404 backup file). If there was no file to be backed up, an empty file is
5405 created.
5406 When the 'backupskip' pattern matches, a patchmode file is not made.
5407 Using 'patchmode' for compressed files appends the extension at the
5408 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5409 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005410 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005412 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413'path' 'pa' string (default on Unix: ".,/usr/include,,"
5414 on OS/2: ".,/emx/include,,"
5415 other systems: ".,,")
5416 global or local to buffer |global-local|
5417 {not in Vi}
5418 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005419 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5420 provided that the file being searched for has a relative path (not
5421 starting with "/", "./" or "../"). The directories in the 'path'
5422 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 - Use commas to separate directory names: >
5424 :set path=.,/usr/local/include,/usr/include
5425< - Spaces can also be used to separate directory names (for backwards
5426 compatibility with version 3.0). To have a space in a directory
5427 name, precede it with an extra backslash, and escape the space: >
5428 :set path=.,/dir/with\\\ space
5429< - To include a comma in a directory name precede it with an extra
5430 backslash: >
5431 :set path=.,/dir/with\\,comma
5432< - To search relative to the directory of the current file, use: >
5433 :set path=.
5434< - To search in the current directory use an empty string between two
5435 commas: >
5436 :set path=,,
5437< - A directory name may end in a ':' or '/'.
5438 - Environment variables are expanded |:set_env|.
5439 - When using |netrw.vim| URLs can be used. For example, adding
5440 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005441 - Search upwards and downwards in a directory tree using "*", "**" and
5442 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 {not available when compiled without the |+path_extra| feature}
5444 - Careful with '\' characters, type two to get one in the option: >
5445 :set path=.,c:\\include
5446< Or just use '/' instead: >
5447 :set path=.,c:/include
5448< Don't forget "." or files won't even be found in the same directory as
5449 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005450 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451 it is something like 256 or 1024 characters.
5452 You can check if all the include files are found, using the value of
5453 'path', see |:checkpath|.
5454 The use of |:set+=| and |:set-=| is preferred when adding or removing
5455 directories from the list. This avoids problems when a future version
5456 uses another default. To remove the current directory use: >
5457 :set path-=
5458< To add the current directory use: >
5459 :set path+=
5460< To use an environment variable, you probably need to replace the
5461 separator. Here is an example to append $INCL, in which directory
5462 names are separated with a semi-colon: >
5463 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5464< Replace the ';' with a ':' or whatever separator is used. Note that
5465 this doesn't work when $INCL contains a comma or white space.
5466
5467 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5468'preserveindent' 'pi' boolean (default off)
5469 local to buffer
5470 {not in Vi}
5471 When changing the indent of the current line, preserve as much of the
5472 indent structure as possible. Normally the indent is replaced by a
5473 series of tabs followed by spaces as required (unless |'expandtab'| is
5474 enabled, in which case only spaces are used). Enabling this option
5475 means the indent will preserve as many existing characters as possible
5476 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005477 'expandtab' does not apply to the preserved white space, a Tab remains
5478 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 NOTE: When using ">>" multiple times the resulting indent is a mix of
5480 tabs and spaces. You might not like this.
5481 NOTE: 'preserveindent' is reset when 'compatible' is set.
5482 Also see 'copyindent'.
5483 Use |:retab| to clean up white space.
5484
5485 *'previewheight'* *'pvh'*
5486'previewheight' 'pvh' number (default 12)
5487 global
5488 {not in Vi}
5489 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005490 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 Default height for a preview window. Used for |:ptag| and associated
5492 commands. Used for |CTRL-W_}| when no count is given.
5493
5494 *'previewwindow'* *'nopreviewwindow'*
5495 *'pvw'* *'nopvw'* *E590*
5496'previewwindow' 'pvw' boolean (default off)
5497 local to window
5498 {not in Vi}
5499 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005500 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005501 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 set. It's normally not set directly, but by using one of the commands
5503 |:ptag|, |:pedit|, etc.
5504
5505 *'printdevice'* *'pdev'*
5506'printdevice' 'pdev' string (default empty)
5507 global
5508 {not in Vi}
5509 {only available when compiled with the |+printer|
5510 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005511 The name of the printer to be used for |:hardcopy|.
5512 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005513 This option cannot be set from a |modeline| or in the |sandbox|, for
5514 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
Bram Moolenaar8299df92004-07-10 09:47:34 +00005516 *'printencoding'* *'penc'*
5517'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 global
5519 {not in Vi}
5520 {only available when compiled with the |+printer|
5521 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005522 Sets the character encoding used when printing.
5523 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524
5525 *'printexpr'* *'pexpr'*
5526'printexpr' 'pexpr' String (default: see below)
5527 global
5528 {not in Vi}
5529 {only available when compiled with the |+printer|
5530 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005531 Expression used to print the PostScript produced with |:hardcopy|.
5532 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
Bram Moolenaar8299df92004-07-10 09:47:34 +00005534 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535'printfont' 'pfn' string (default "courier")
5536 global
5537 {not in Vi}
5538 {only available when compiled with the |+printer|
5539 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005540 The name of the font that will be used for |:hardcopy|.
5541 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542
5543 *'printheader'* *'pheader'*
5544'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5545 global
5546 {not in Vi}
5547 {only available when compiled with the |+printer|
5548 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005549 The format of the header produced in |:hardcopy| output.
5550 See |pheader-option|.
5551
5552 *'printmbcharset'* *'pmbcs'*
5553'printmbcharset' 'pmbcs' string (default "")
5554 global
5555 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005556 {only available when compiled with the |+printer|,
5557 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005558 The CJK character set to be used for CJK output from |:hardcopy|.
5559 See |pmbcs-option|.
5560
5561 *'printmbfont'* *'pmbfn'*
5562'printmbfont' 'pmbfn' string (default "")
5563 global
5564 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005565 {only available when compiled with the |+printer|,
5566 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005567 List of font names to be used for CJK output from |:hardcopy|.
5568 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005569
5570 *'printoptions'* *'popt'*
5571'printoptions' 'popt' string (default "")
5572 global
5573 {not in Vi}
5574 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005575 List of items that control the format of the output of |:hardcopy|.
5576 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005578 *'prompt'* *'noprompt'*
5579'prompt' boolean (default on)
5580 global
5581 When on a ":" prompt is used in Ex mode.
5582
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005583 *'pumheight'* *'ph'*
5584'pumheight' 'ph' number (default 0)
5585 global
5586 {not available when compiled without the
5587 |+insert_expand| feature}
5588 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005589 Determines the maximum number of items to show in the popup menu for
5590 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005591 |ins-completion-menu|.
5592
5593
Bram Moolenaar677ee682005-01-27 14:41:15 +00005594 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005595'quoteescape' 'qe' string (default "\")
5596 local to buffer
5597 {not in Vi}
5598 The characters that are used to escape quotes in a string. Used for
5599 objects like a', a" and a` |a'|.
5600 When one of the characters in this option is found inside a string,
5601 the following character will be skipped. The default value makes the
5602 text "foo\"bar\\" considered to be one string.
5603
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5605'readonly' 'ro' boolean (default off)
5606 local to buffer
5607 If on, writes fail unless you use a '!'. Protects you from
5608 accidentally overwriting a file. Default on when Vim is started
5609 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005610 When using ":w!" the 'readonly' option is reset for the current
5611 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005613 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005615 *'redrawtime'* *'rdt'*
5616'redrawtime' 'rdt' number (default 2000)
5617 global
5618 {not in Vi}
5619 {only available when compiled with the |+reltime|
5620 feature}
5621 The time in milliseconds for redrawing the display. This applies to
5622 searching for patterns for 'hlsearch' and |:match| highlighting.
5623 When redrawing takes more than this many milliseconds no further
5624 matches will be highlighted. This is used to avoid that Vim hangs
5625 when using a very complicated pattern.
5626
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005627 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005628'regexpengine' 're' number (default 0)
5629 global
5630 {not in Vi}
5631 This selects the default regexp engine. |two-engines|
5632 The possible values are:
5633 0 automatic selection
5634 1 old engine
5635 2 NFA engine
5636 Note that when using the NFA engine and the pattern contains something
5637 that is not supported the pattern will not match. This is only useful
5638 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005639 Using automatic selection enables Vim to switch the engine, if the
5640 default engine becomes too costly. E.g., when the NFA engine uses too
5641 many states. This should prevent Vim from hanging on a combination of
5642 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005643
Bram Moolenaar64486672010-05-16 15:46:46 +02005644 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5645'relativenumber' 'rnu' boolean (default off)
5646 local to window
5647 {not in Vi}
5648 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005649 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005650 precede some vertical motion commands (e.g. j k + -) with, without
5651 having to calculate it yourself. Especially useful in combination with
5652 other commands (e.g. y d c < > gq gw =).
5653 When the 'n' option is excluded from 'cpoptions' a wrapped
5654 line will not use the column of line numbers (this is the default when
5655 'compatible' isn't set).
5656 The 'numberwidth' option can be used to set the room used for the line
5657 number.
5658 When a long, wrapped line doesn't start with the first character, '-'
5659 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005660 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5661 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005662
5663 The number in front of the cursor line also depends on the value of
5664 'number', see |number_relativenumber| for all combinations of the two
5665 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005666
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 *'remap'* *'noremap'*
5668'remap' boolean (default on)
5669 global
5670 Allows for mappings to work recursively. If you do not want this for
5671 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005672 NOTE: To avoid portability problems with Vim scripts, always keep
5673 this option at the default "on". Only switch it off when working with
5674 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005676 *'renderoptions'* *'rop'*
5677'renderoptions' 'rop' string (default: empty)
5678 global
5679 {not in Vi}
5680 {only available when compiled with GUI and DIRECTX on
5681 MS-Windows}
5682 Select a text renderer and set its options. The options depend on the
5683 renderer.
5684
5685 Syntax: >
5686 set rop=type:{renderer}(,{name}:{value})*
5687<
5688 Currently, only one optional renderer is available.
5689
5690 render behavior ~
5691 directx Vim will draw text using DirectX (DirectWrite). It makes
5692 drawn glyphs more beautiful than default GDI.
5693 It requires 'encoding' is "utf-8", and only works on
5694 MS-Windows Vista or newer version.
5695
5696 Options:
5697 name meaning type value ~
5698 gamma gamma float 1.0 - 2.2 (maybe)
5699 contrast enhancedContrast float (unknown)
5700 level clearTypeLevel float (unknown)
5701 geom pixelGeometry int 0 - 2 (see below)
5702 renmode renderingMode int 0 - 6 (see below)
5703 taamode textAntialiasMode int 0 - 3 (see below)
5704
5705 See this URL for detail:
5706 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5707
5708 For geom: structure of a device pixel.
5709 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5710 1 - DWRITE_PIXEL_GEOMETRY_RGB
5711 2 - DWRITE_PIXEL_GEOMETRY_BGR
5712
5713 See this URL for detail:
5714 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5715
5716 For renmode: method of rendering glyphs.
5717 0 - DWRITE_RENDERING_MODE_DEFAULT
5718 1 - DWRITE_RENDERING_MODE_ALIASED
5719 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5720 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5721 4 - DWRITE_RENDERING_MODE_NATURAL
5722 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5723 6 - DWRITE_RENDERING_MODE_OUTLINE
5724
5725 See this URL for detail:
5726 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5727
5728 For taamode: antialiasing mode used for drawing text.
5729 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5730 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5731 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5732 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5733
5734 See this URL for detail:
5735 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5736
5737 Example: >
5738 set encoding=utf-8
5739 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5740 set rop=type:directx
5741<
5742 If select a raster font (Courier, Terminal or FixedSys) to
5743 'guifont', it fallbacks to be drawn by GDI automatically.
5744
5745 Other render types are currently not supported.
5746
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 *'report'*
5748'report' number (default 2)
5749 global
5750 Threshold for reporting number of lines changed. When the number of
5751 changed lines is more than 'report' a message will be given for most
5752 ":" commands. If you want it always, set 'report' to 0.
5753 For the ":substitute" command the number of substitutions is used
5754 instead of the number of lines.
5755
5756 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5757'restorescreen' 'rs' boolean (default on)
5758 global
5759 {not in Vi} {only in Windows 95/NT console version}
5760 When set, the screen contents is restored when exiting Vim. This also
5761 happens when executing external commands.
5762
5763 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5764 options in your .vimrc. To disable restoring:
5765 set t_ti= t_te=
5766 To enable restoring (for an xterm):
5767 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5768 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5769
5770 *'revins'* *'ri'* *'norevins'* *'nori'*
5771'revins' 'ri' boolean (default off)
5772 global
5773 {not in Vi}
5774 {only available when compiled with the |+rightleft|
5775 feature}
5776 Inserting characters in Insert mode will work backwards. See "typing
5777 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5778 command in Insert mode, when 'allowrevins' is set.
5779 NOTE: This option is reset when 'compatible' or 'paste' is set.
5780
5781 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5782'rightleft' 'rl' boolean (default off)
5783 local to window
5784 {not in Vi}
5785 {only available when compiled with the |+rightleft|
5786 feature}
5787 When on, display orientation becomes right-to-left, i.e., characters
5788 that are stored in the file appear from the right to the left.
5789 Using this option, it is possible to edit files for languages that
5790 are written from the right to the left such as Hebrew and Arabic.
5791 This option is per window, so it is possible to edit mixed files
5792 simultaneously, or to view the same file in both ways (this is
5793 useful whenever you have a mixed text file with both right-to-left
5794 and left-to-right strings so that both sets are displayed properly
5795 in different windows). Also see |rileft.txt|.
5796
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005797 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798'rightleftcmd' 'rlc' string (default "search")
5799 local to window
5800 {not in Vi}
5801 {only available when compiled with the |+rightleft|
5802 feature}
5803 Each word in this option enables the command line editing to work in
5804 right-to-left mode for a group of commands:
5805
5806 search "/" and "?" commands
5807
5808 This is useful for languages such as Hebrew, Arabic and Farsi.
5809 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5810
5811 *'ruler'* *'ru'* *'noruler'* *'noru'*
5812'ruler' 'ru' boolean (default off)
5813 global
5814 {not in Vi}
5815 {not available when compiled without the
5816 |+cmdline_info| feature}
5817 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005818 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 text in the file is shown on the far right:
5820 Top first line is visible
5821 Bot last line is visible
5822 All first and last line are visible
5823 45% relative position in the file
5824 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005827 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 this option takes precedence over 'ruler' and 'rulerformat'
5829 If the number of characters displayed is different from the number of
5830 bytes in the text (e.g., for a TAB or a multi-byte character), both
5831 the text column (byte number) and the screen column are shown,
5832 separated with a dash.
5833 For an empty line "0-1" is shown.
5834 For an empty buffer the line number will also be zero: "0,0-1".
5835 This option is reset when the 'paste' option is set.
5836 If you don't want to see the ruler all the time but want to know where
5837 you are, use "g CTRL-G" |g_CTRL-G|.
5838 NOTE: This option is reset when 'compatible' is set.
5839
5840 *'rulerformat'* *'ruf'*
5841'rulerformat' 'ruf' string (default empty)
5842 global
5843 {not in Vi}
5844 {not available when compiled without the |+statusline|
5845 feature}
5846 When this option is not empty, it determines the content of the ruler
5847 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005848 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 The default ruler width is 17 characters. To make the ruler 15
5850 characters wide, put "%15(" at the start and "%)" at the end.
5851 Example: >
5852 :set rulerformat=%15(%c%V\ %p%%%)
5853<
5854 *'runtimepath'* *'rtp'* *vimfiles*
5855'runtimepath' 'rtp' string (default:
5856 Unix: "$HOME/.vim,
5857 $VIM/vimfiles,
5858 $VIMRUNTIME,
5859 $VIM/vimfiles/after,
5860 $HOME/.vim/after"
5861 Amiga: "home:vimfiles,
5862 $VIM/vimfiles,
5863 $VIMRUNTIME,
5864 $VIM/vimfiles/after,
5865 home:vimfiles/after"
5866 PC, OS/2: "$HOME/vimfiles,
5867 $VIM/vimfiles,
5868 $VIMRUNTIME,
5869 $VIM/vimfiles/after,
5870 $HOME/vimfiles/after"
5871 Macintosh: "$VIM:vimfiles,
5872 $VIMRUNTIME,
5873 $VIM:vimfiles:after"
5874 RISC-OS: "Choices:vimfiles,
5875 $VIMRUNTIME,
5876 Choices:vimfiles/after"
5877 VMS: "sys$login:vimfiles,
5878 $VIM/vimfiles,
5879 $VIMRUNTIME,
5880 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005881 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 global
5883 {not in Vi}
5884 This is a list of directories which will be searched for runtime
5885 files:
5886 filetype.vim filetypes by file name |new-filetype|
5887 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005888 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 colors/ color scheme files |:colorscheme|
5890 compiler/ compiler files |:compiler|
5891 doc/ documentation |write-local-help|
5892 ftplugin/ filetype plugins |write-filetype-plugin|
5893 indent/ indent scripts |indent-expression|
5894 keymap/ key mapping files |mbyte-keymap|
5895 lang/ menu translations |:menutrans|
5896 menu.vim GUI menus |menu.vim|
5897 plugin/ plugin scripts |write-plugin|
5898 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005899 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 syntax/ syntax files |mysyntaxfile|
5901 tutor/ files for vimtutor |tutor|
5902
5903 And any other file searched for with the |:runtime| command.
5904
5905 The defaults for most systems are setup to search five locations:
5906 1. In your home directory, for your personal preferences.
5907 2. In a system-wide Vim directory, for preferences from the system
5908 administrator.
5909 3. In $VIMRUNTIME, for files distributed with Vim.
5910 *after-directory*
5911 4. In the "after" directory in the system-wide Vim directory. This is
5912 for the system administrator to overrule or add to the distributed
5913 defaults (rarely needed)
5914 5. In the "after" directory in your home directory. This is for
5915 personal preferences to overrule or add to the distributed defaults
5916 or system-wide settings (rarely needed).
5917
5918 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5919 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005920 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005921 wildcards.
5922 See |:runtime|.
5923 Example: >
5924 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5925< This will use the directory "~/vimruntime" first (containing your
5926 personal Vim runtime files), then "/mygroup/vim" (shared between a
5927 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5928 files).
5929 You probably should always include $VIMRUNTIME somewhere, to use the
5930 distributed runtime files. You can put a directory before $VIMRUNTIME
5931 to find files which replace a distributed runtime files. You can put
5932 a directory after $VIMRUNTIME to find files which add to distributed
5933 runtime files.
5934 This option cannot be set from a |modeline| or in the |sandbox|, for
5935 security reasons.
5936
5937 *'scroll'* *'scr'*
5938'scroll' 'scr' number (default: half the window height)
5939 local to window
5940 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5941 set to half the number of lines in the window when the window size
5942 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005943 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5945 the number of screen lines instead of file lines, makes a difference
5946 when lines wrap}
5947
5948 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5949'scrollbind' 'scb' boolean (default off)
5950 local to window
5951 {not in Vi}
5952 {not available when compiled without the |+scrollbind|
5953 feature}
5954 See also |scroll-binding|. When this option is set, the current
5955 window scrolls as other scrollbind windows (windows that also have
5956 this option set) scroll. This option is useful for viewing the
5957 differences between two versions of a file, see 'diff'.
5958 See |'scrollopt'| for options that determine how this option should be
5959 interpreted.
5960 This option is mostly reset when splitting a window to edit another
5961 file. This means that ":split | edit file" results in two windows
5962 with scroll-binding, but ":split file" does not.
5963
5964 *'scrolljump'* *'sj'*
5965'scrolljump' 'sj' number (default 1)
5966 global
5967 {not in Vi}
5968 Minimal number of lines to scroll when the cursor gets off the
5969 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5970 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005971 When set to a negative number from -1 to -100 this is used as the
5972 percentage of the window height. Thus -50 scrolls half the window
5973 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 NOTE: This option is set to 1 when 'compatible' is set.
5975
5976 *'scrolloff'* *'so'*
5977'scrolloff' 'so' number (default 0)
5978 global
5979 {not in Vi}
5980 Minimal number of screen lines to keep above and below the cursor.
5981 This will make some context visible around where you are working. If
5982 you set it to a very large value (999) the cursor line will always be
5983 in the middle of the window (except at the start or end of the file or
5984 when long lines wrap).
5985 For scrolling horizontally see 'sidescrolloff'.
5986 NOTE: This option is set to 0 when 'compatible' is set.
5987
5988 *'scrollopt'* *'sbo'*
5989'scrollopt' 'sbo' string (default "ver,jump")
5990 global
5991 {not available when compiled without the |+scrollbind|
5992 feature}
5993 {not in Vi}
5994 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005995 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5996 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 The following words are available:
5998 ver Bind vertical scrolling for 'scrollbind' windows
5999 hor Bind horizontal scrolling for 'scrollbind' windows
6000 jump Applies to the offset between two windows for vertical
6001 scrolling. This offset is the difference in the first
6002 displayed line of the bound windows. When moving
6003 around in a window, another 'scrollbind' window may
6004 reach a position before the start or after the end of
6005 the buffer. The offset is not changed though, when
6006 moving back the 'scrollbind' window will try to scroll
6007 to the desired position when possible.
6008 When now making that window the current one, two
6009 things can be done with the relative offset:
6010 1. When "jump" is not included, the relative offset is
6011 adjusted for the scroll position in the new current
6012 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006013 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 2. When "jump" is included, the other windows are
6015 scrolled to keep the same relative offset. When
6016 going back to the other window, it still uses the
6017 same relative offset.
6018 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006019 When 'diff' mode is active there always is vertical scroll binding,
6020 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021
6022 *'sections'* *'sect'*
6023'sections' 'sect' string (default "SHNHH HUnhsh")
6024 global
6025 Specifies the nroff macros that separate sections. These are pairs of
6026 two letters (See |object-motions|). The default makes a section start
6027 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6028
6029 *'secure'* *'nosecure'* *E523*
6030'secure' boolean (default off)
6031 global
6032 {not in Vi}
6033 When on, ":autocmd", shell and write commands are not allowed in
6034 ".vimrc" and ".exrc" in the current directory and map commands are
6035 displayed. Switch it off only if you know that you will not run into
6036 problems, or when the 'exrc' option is off. On Unix this option is
6037 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006038 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 'secure' at the end of your ~/.vimrc then.
6040 This option cannot be set from a |modeline| or in the |sandbox|, for
6041 security reasons.
6042
6043 *'selection'* *'sel'*
6044'selection' 'sel' string (default "inclusive")
6045 global
6046 {not in Vi}
6047 This option defines the behavior of the selection. It is only used
6048 in Visual and Select mode.
6049 Possible values:
6050 value past line inclusive ~
6051 old no yes
6052 inclusive yes yes
6053 exclusive yes no
6054 "past line" means that the cursor is allowed to be positioned one
6055 character past the line.
6056 "inclusive" means that the last character of the selection is included
6057 in an operation. For example, when "x" is used to delete the
6058 selection.
6059 Note that when "exclusive" is used and selecting from the end
6060 backwards, you cannot include the last character of a line, when
6061 starting in Normal mode and 'virtualedit' empty.
6062
6063 The 'selection' option is set by the |:behave| command.
6064
6065 *'selectmode'* *'slm'*
6066'selectmode' 'slm' string (default "")
6067 global
6068 {not in Vi}
6069 This is a comma separated list of words, which specifies when to start
6070 Select mode instead of Visual mode, when a selection is started.
6071 Possible values:
6072 mouse when using the mouse
6073 key when using shifted special keys
6074 cmd when using "v", "V" or CTRL-V
6075 See |Select-mode|.
6076 The 'selectmode' option is set by the |:behave| command.
6077
6078 *'sessionoptions'* *'ssop'*
6079'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006080 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 global
6082 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006083 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 feature}
6085 Changes the effect of the |:mksession| command. It is a comma
6086 separated list of words. Each word enables saving and restoring
6087 something:
6088 word save and restore ~
6089 blank empty windows
6090 buffers hidden and unloaded buffers, not just those in windows
6091 curdir the current directory
6092 folds manually created folds, opened/closed folds and local
6093 fold options
6094 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006095 and contain at least one lowercase letter. Only
6096 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 help the help window
6098 localoptions options and mappings local to a window or buffer (not
6099 global values for local options)
6100 options all options and mappings (also global values for local
6101 options)
6102 resize size of the Vim window: 'lines' and 'columns'
6103 sesdir the directory in which the session file is located
6104 will become the current directory (useful with
6105 projects accessed over a network from different
6106 systems)
6107 slash backslashes in file names replaced with forward
6108 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006109 tabpages all tab pages; without this only the current tab page
6110 is restored, so that you can make a session for each
6111 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 unix with Unix end-of-line format (single <NL>), even when
6113 on Windows or DOS
6114 winpos position of the whole Vim window
6115 winsize window sizes
6116
6117 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006118 When neither "curdir" nor "sesdir" is included, file names are stored
6119 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 "slash" and "unix" are useful on Windows when sharing session files
6121 with Unix. The Unix version of Vim cannot source dos format scripts,
6122 but the Windows version of Vim can source unix format scripts.
6123
6124 *'shell'* *'sh'* *E91*
6125'shell' 'sh' string (default $SHELL or "sh",
6126 MS-DOS and Win32: "command.com" or
6127 "cmd.exe", OS/2: "cmd")
6128 global
6129 Name of the shell to use for ! and :! commands. When changing the
6130 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6131 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006132 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006133 See |option-backslash| about including spaces and backslashes.
6134 Environment variables are expanded |:set_env|.
6135 If the name of the shell contains a space, you might need to enclose
6136 it in quotes. Example: >
6137 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6138< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006139 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006140 "-f" is not inside the quotes, because it is not part of the command
6141 name. And Vim automagically recognizes the backslashes that are path
6142 separators.
6143 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6144 variable to change the way external commands are executed. See the
6145 libc.inf file of DJGPP.
6146 Under MS-Windows, when the executable ends in ".com" it must be
6147 included. Thus setting the shell to "command.com" or "4dos.com"
6148 works, but "command" and "4dos" do not work for all commands (e.g.,
6149 filtering).
6150 For unknown reasons, when using "4dos.com" the current directory is
6151 changed to "C:\". To avoid this set 'shell' like this: >
6152 :set shell=command.com\ /c\ 4dos
6153< This option cannot be set from a |modeline| or in the |sandbox|, for
6154 security reasons.
6155
6156 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006157'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006158 MS-DOS and Win32, when 'shell' does not
6159 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160 global
6161 {not in Vi}
6162 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6163 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6164 systems, the default is set according to the value of 'shell', to
6165 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006166 OS/2 (EMX figures this out itself).
6167 On Unix it can have more than one flag. Each white space separated
6168 part is passed as an argument to the shell command.
6169 See |option-backslash| about including spaces and backslashes.
6170 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 This option cannot be set from a |modeline| or in the |sandbox|, for
6172 security reasons.
6173
6174 *'shellpipe'* *'sp'*
6175'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6176 global
6177 {not in Vi}
6178 {not available when compiled without the |+quickfix|
6179 feature}
6180 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006181 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006182 including spaces and backslashes.
6183 The name of the temporary file can be represented by "%s" if necessary
6184 (the file name is appended automatically if no %s appears in the value
6185 of this option).
6186 For the Amiga and MS-DOS the default is ">". The output is directly
6187 saved in a file and not echoed to the screen.
6188 For Unix the default it "| tee". The stdout of the compiler is saved
6189 in a file and echoed to the screen. If the 'shell' option is "csh" or
6190 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006191 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6192 default becomes "2>&1| tee". This means that stderr is also included.
6193 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6194 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 The initialization of this option is done after reading the ".vimrc"
6196 and the other initializations, so that when the 'shell' option is set
6197 there, the 'shellpipe' option changes automatically, unless it was
6198 explicitly set before.
6199 When 'shellpipe' is set to an empty string, no redirection of the
6200 ":make" output will be done. This is useful if you use a 'makeprg'
6201 that writes to 'makeef' by itself. If you want no piping, but do
6202 want to include the 'makeef', set 'shellpipe' to a single space.
6203 Don't forget to precede the space with a backslash: ":set sp=\ ".
6204 In the future pipes may be used for filtering and this option will
6205 become obsolete (at least for Unix).
6206 This option cannot be set from a |modeline| or in the |sandbox|, for
6207 security reasons.
6208
6209 *'shellquote'* *'shq'*
6210'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6211 contains "sh" somewhere: "\"")
6212 global
6213 {not in Vi}
6214 Quoting character(s), put around the command passed to the shell, for
6215 the "!" and ":!" commands. The redirection is kept outside of the
6216 quoting. See 'shellxquote' to include the redirection. It's
6217 probably not useful to set both options.
6218 This is an empty string by default. Only known to be useful for
6219 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6220 or bash, where it should be "\"". The default is adjusted according
6221 the value of 'shell', to reduce the need to set this option by the
6222 user. See |dos-shell|.
6223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
6225
6226 *'shellredir'* *'srr'*
6227'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6228 global
6229 {not in Vi}
6230 String to be used to put the output of a filter command in a temporary
6231 file. See also |:!|. See |option-backslash| about including spaces
6232 and backslashes.
6233 The name of the temporary file can be represented by "%s" if necessary
6234 (the file name is appended automatically if no %s appears in the value
6235 of this option).
6236 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6237 or "zsh" during initializations, the default becomes ">&". If the
6238 'shell' option is "sh", "ksh" or "bash" the default becomes
6239 ">%s 2>&1". This means that stderr is also included.
6240 For Win32, the Unix checks are done and additionally "cmd" is checked
6241 for, which makes the default ">%s 2>&1". Also, the same names with
6242 ".exe" appended are checked for.
6243 The initialization of this option is done after reading the ".vimrc"
6244 and the other initializations, so that when the 'shell' option is set
6245 there, the 'shellredir' option changes automatically unless it was
6246 explicitly set before.
6247 In the future pipes may be used for filtering and this option will
6248 become obsolete (at least for Unix).
6249 This option cannot be set from a |modeline| or in the |sandbox|, for
6250 security reasons.
6251
6252 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6253'shellslash' 'ssl' boolean (default off)
6254 global
6255 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6256 When set, a forward slash is used when expanding file names. This is
6257 useful when a Unix-like shell is used instead of command.com or
6258 cmd.exe. Backward slashes can still be typed, but they are changed to
6259 forward slashes by Vim.
6260 Note that setting or resetting this option has no effect for some
6261 existing file names, thus this option needs to be set before opening
6262 any file for best results. This might change in the future.
6263 'shellslash' only works when a backslash can be used as a path
6264 separator. To test if this is so use: >
6265 if exists('+shellslash')
6266<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006267 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6268'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6269 global
6270 {not in Vi}
6271 When on, use temp files for shell commands. When off use a pipe.
6272 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006273 Currently a pipe is only supported on Unix and MS-Windows 2K and
6274 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006275 :if has("filterpipe")
6276< The advantage of using a pipe is that nobody can read the temp file
6277 and the 'shell' command does not need to support redirection.
6278 The advantage of using a temp file is that the file type and encoding
6279 can be detected.
6280 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6281 |FilterWritePost| autocommands event are not triggered when
6282 'shelltemp' is off.
6283
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 *'shelltype'* *'st'*
6285'shelltype' 'st' number (default 0)
6286 global
6287 {not in Vi} {only for the Amiga}
6288 On the Amiga this option influences the way how the commands work
6289 which use a shell.
6290 0 and 1: always use the shell
6291 2 and 3: use the shell only to filter lines
6292 4 and 5: use shell only for ':sh' command
6293 When not using the shell, the command is executed directly.
6294
6295 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6296 1 and 3: use "shell cmd" to start external commands
6297
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006298 *'shellxescape'* *'sxe'*
6299'shellxescape' 'sxe' string (default: "";
6300 for MS-DOS and MS-Windows: "\"&|<>()@^")
6301 global
6302 {not in Vi}
6303 When 'shellxquote' is set to "(" then the characters listed in this
6304 option will be escaped with a '^' character. This makes it possible
6305 to execute most external commands with cmd.exe.
6306
Bram Moolenaar071d4272004-06-13 20:20:40 +00006307 *'shellxquote'* *'sxq'*
6308'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006309 for Win32, when 'shell' is cmd.exe: "("
6310 for Win32, when 'shell' contains "sh"
6311 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 for Unix, when using system(): "\"")
6313 global
6314 {not in Vi}
6315 Quoting character(s), put around the command passed to the shell, for
6316 the "!" and ":!" commands. Includes the redirection. See
6317 'shellquote' to exclude the redirection. It's probably not useful
6318 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006319 When the value is '(' then ')' is appended. When the value is '"('
6320 then ')"' is appended.
6321 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006322 This is an empty string by default on most systems, but is known to be
6323 useful for on Win32 version, either for cmd.exe which automatically
6324 strips off the first and last quote on a command, or 3rd-party shells
6325 such as the MKS Korn Shell or bash, where it should be "\"". The
6326 default is adjusted according the value of 'shell', to reduce the need
6327 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 This option cannot be set from a |modeline| or in the |sandbox|, for
6329 security reasons.
6330
6331 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6332'shiftround' 'sr' boolean (default off)
6333 global
6334 {not in Vi}
6335 Round indent to multiple of 'shiftwidth'. Applies to > and <
6336 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6337 a multiple of 'shiftwidth' (this is Vi compatible).
6338 NOTE: This option is reset when 'compatible' is set.
6339
6340 *'shiftwidth'* *'sw'*
6341'shiftwidth' 'sw' number (default 8)
6342 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006343 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006345 When zero the 'ts' value will be used. Use the |shiftwidth()|
6346 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347
6348 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006349'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6350 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 global
6352 {not in Vi}
6353 This option helps to avoid all the |hit-enter| prompts caused by file
6354 messages, for example with CTRL-G, and to avoid some other messages.
6355 It is a list of flags:
6356 flag meaning when present ~
6357 f use "(3 of 5)" instead of "(file 3 of 5)"
6358 i use "[noeol]" instead of "[Incomplete last line]"
6359 l use "999L, 888C" instead of "999 lines, 888 characters"
6360 m use "[+]" instead of "[Modified]"
6361 n use "[New]" instead of "[New File]"
6362 r use "[RO]" instead of "[readonly]"
6363 w use "[w]" instead of "written" for file write message
6364 and "[a]" instead of "appended" for ':w >> file' command
6365 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6366 "[unix format]" and "[mac]" instead of "[mac format]".
6367 a all of the above abbreviations
6368
6369 o overwrite message for writing a file with subsequent message
6370 for reading a file (useful for ":wn" or when 'autowrite' on)
6371 O message for reading a file overwrites any previous message.
6372 Also for quickfix message (e.g., ":cn").
6373 s don't give "search hit BOTTOM, continuing at TOP" or "search
6374 hit TOP, continuing at BOTTOM" messages
6375 t truncate file message at the start if it is too long to fit
6376 on the command-line, "<" will appear in the left most column.
6377 Ignored in Ex mode.
6378 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006379 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 Ignored in Ex mode.
6381 W don't give "written" or "[w]" when writing a file
6382 A don't give the "ATTENTION" message when an existing swap file
6383 is found.
6384 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006385 c don't give |ins-completion-menu| messages. For example,
6386 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6387 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388
6389 This gives you the opportunity to avoid that a change between buffers
6390 requires you to hit <Enter>, but still gives as useful a message as
6391 possible for the space available. To get the whole message that you
6392 would have got with 'shm' empty, use ":file!"
6393 Useful values:
6394 shm= No abbreviation of message.
6395 shm=a Abbreviation, but no loss of information.
6396 shm=at Abbreviation, and truncate message when necessary.
6397
6398 NOTE: This option is set to the Vi default value when 'compatible' is
6399 set and to the Vim default value when 'compatible' is reset.
6400
6401 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6402'shortname' 'sn' boolean (default off)
6403 local to buffer
6404 {not in Vi, not in MS-DOS versions}
6405 Filenames are assumed to be 8 characters plus one extension of 3
6406 characters. Multiple dots in file names are not allowed. When this
6407 option is on, dots in file names are replaced with underscores when
6408 adding an extension (".~" or ".swp"). This option is not available
6409 for MS-DOS, because then it would always be on. This option is useful
6410 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6411 or crossdos. When running the Win32 GUI version under Win32s, this
6412 option is always on by default.
6413
6414 *'showbreak'* *'sbr'* *E595*
6415'showbreak' 'sbr' string (default "")
6416 global
6417 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006418 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 feature}
6420 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006421 values are "> " or "+++ ": >
6422 :set showbreak=>\
6423< Note the backslash to escape the trailing space. It's easier like
6424 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006425 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006426< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 comma (in a future version the comma might be used to separate the
6428 part that is shown at the end and at the start of a line).
6429 The characters are highlighted according to the '@' flag in
6430 'highlight'.
6431 Note that tabs after the showbreak will be displayed differently.
6432 If you want the 'showbreak' to appear in between line numbers, add the
6433 "n" flag to 'cpoptions'.
6434
6435 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6436'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6437 off)
6438 global
6439 {not in Vi}
6440 {not available when compiled without the
6441 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006442 Show (partial) command in the last line of the screen. Set this
6443 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 In Visual mode the size of the selected area is shown:
6445 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006446 If the number of bytes is different it is also displayed: "2-6"
6447 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006448 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006449 - When selecting a block, the size in screen characters:
6450 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 NOTE: This option is set to the Vi default value when 'compatible' is
6452 set and to the Vim default value when 'compatible' is reset.
6453
6454 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6455'showfulltag' 'sft' boolean (default off)
6456 global
6457 {not in Vi}
6458 When completing a word in insert mode (see |ins-completion|) from the
6459 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006460 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 matched a C function, you can see a template for what arguments are
6462 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006463 Note that this doesn't work well together with having "longest" in
6464 'completeopt', because the completion from the search pattern may not
6465 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466
6467 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6468'showmatch' 'sm' boolean (default off)
6469 global
6470 When a bracket is inserted, briefly jump to the matching one. The
6471 jump is only done if the match can be seen on the screen. The time to
6472 show the match can be set with 'matchtime'.
6473 A Beep is given if there is no match (no matter if the match can be
6474 seen or not). This option is reset when the 'paste' option is set.
6475 When the 'm' flag is not included in 'cpoptions', typing a character
6476 will immediately move the cursor back to where it belongs.
6477 See the "sm" field in 'guicursor' for setting the cursor shape and
6478 blinking when showing the match.
6479 The 'matchpairs' option can be used to specify the characters to show
6480 matches for. 'rightleft' and 'revins' are used to look for opposite
6481 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006482 Also see the matchparen plugin for highlighting the match when moving
6483 around |pi_paren.txt|.
6484 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485
6486 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6487'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6488 global
6489 If in Insert, Replace or Visual mode put a message on the last line.
6490 Use the 'M' flag in 'highlight' to set the type of highlighting for
6491 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006492 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006493 doesn't mean XIM is really active, especially when 'imactivatekey' is
6494 not set.
6495 NOTE: This option is set to the Vi default value when 'compatible' is
6496 set and to the Vim default value when 'compatible' is reset.
6497
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006498 *'showtabline'* *'stal'*
6499'showtabline' 'stal' number (default 1)
6500 global
6501 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006502 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006503 feature}
6504 The value of this option specifies when the line with tab page labels
6505 will be displayed:
6506 0: never
6507 1: only if there are at least two tab pages
6508 2: always
6509 This is both for the GUI and non-GUI implementation of the tab pages
6510 line.
6511 See |tab-page| for more information about tab pages.
6512
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513 *'sidescroll'* *'ss'*
6514'sidescroll' 'ss' number (default 0)
6515 global
6516 {not in Vi}
6517 The minimal number of columns to scroll horizontally. Used only when
6518 the 'wrap' option is off and the cursor is moved off of the screen.
6519 When it is zero the cursor will be put in the middle of the screen.
6520 When using a slow terminal set it to a large number or 0. When using
6521 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6522 commands.
6523
6524 *'sidescrolloff'* *'siso'*
6525'sidescrolloff' 'siso' number (default 0)
6526 global
6527 {not in Vi}
6528 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006529 right of the cursor if 'nowrap' is set. Setting this option to a
6530 value greater than 0 while having |'sidescroll'| also at a non-zero
6531 value makes some context visible in the line you are scrolling in
6532 horizontally (except at beginning of the line). Setting this option
6533 to a large value (like 999) has the effect of keeping the cursor
6534 horizontally centered in the window, as long as one does not come too
6535 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006536 NOTE: This option is set to 0 when 'compatible' is set.
6537
6538 Example: Try this together with 'sidescroll' and 'listchars' as
6539 in the following example to never allow the cursor to move
6540 onto the "extends" character:
6541
6542 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6543 :set sidescrolloff=1
6544
6545
6546 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6547'smartcase' 'scs' boolean (default off)
6548 global
6549 {not in Vi}
6550 Override the 'ignorecase' option if the search pattern contains upper
6551 case characters. Only used when the search pattern is typed and
6552 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006553 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6555 recalling the search pattern from history and hitting <Enter>.
6556 NOTE: This option is reset when 'compatible' is set.
6557
6558 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6559'smartindent' 'si' boolean (default off)
6560 local to buffer
6561 {not in Vi}
6562 {not available when compiled without the
6563 |+smartindent| feature}
6564 Do smart autoindenting when starting a new line. Works for C-like
6565 programs, but can also be used for other languages. 'cindent' does
6566 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006567 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006568 setting 'si' has no effect. 'indentexpr' is a more advanced
6569 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 Normally 'autoindent' should also be on when using 'smartindent'.
6571 An indent is automatically inserted:
6572 - After a line ending in '{'.
6573 - After a line starting with a keyword from 'cinwords'.
6574 - Before a line starting with '}' (only with the "O" command).
6575 When typing '}' as the first character in a new line, that line is
6576 given the same indent as the matching '{'.
6577 When typing '#' as the first character in a new line, the indent for
6578 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006579 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6581 When using the ">>" command, lines starting with '#' are not shifted
6582 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006583 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 is set smart indenting is disabled.
6585
6586 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6587'smarttab' 'sta' boolean (default off)
6588 global
6589 {not in Vi}
6590 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006591 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6592 <BS> will delete a 'shiftwidth' worth of space at the start of the
6593 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006594 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006595 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6596 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006597 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006599 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 NOTE: This option is reset when 'compatible' is set.
6601
6602 *'softtabstop'* *'sts'*
6603'softtabstop' 'sts' number (default 0)
6604 local to buffer
6605 {not in Vi}
6606 Number of spaces that a <Tab> counts for while performing editing
6607 operations, like inserting a <Tab> or using <BS>. It "feels" like
6608 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6609 used. This is useful to keep the 'ts' setting at its standard value
6610 of 8, while being able to edit like it is set to 'sts'. However,
6611 commands like "x" still work on the actual characters.
6612 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006613 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 'softtabstop' is set to 0 when the 'paste' option is set.
6615 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6616 spaces is minimized by using <Tab>s.
6617 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6618 set.
6619 NOTE: This option is set to 0 when 'compatible' is set.
6620
Bram Moolenaar217ad922005-03-20 22:37:15 +00006621 *'spell'* *'nospell'*
6622'spell' boolean (default off)
6623 local to window
6624 {not in Vi}
6625 {not available when compiled without the |+syntax|
6626 feature}
6627 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006628 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006629
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006630 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006631'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006632 local to buffer
6633 {not in Vi}
6634 {not available when compiled without the |+syntax|
6635 feature}
6636 Pattern to locate the end of a sentence. The following word will be
6637 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006638 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006639 When this check is not wanted make this option empty.
6640 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006641 Be careful with special characters, see |option-backslash| about
6642 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006643 To set this option automatically depending on the language, see
6644 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006645
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006646 *'spellfile'* *'spf'*
6647'spellfile' 'spf' string (default empty)
6648 local to buffer
6649 {not in Vi}
6650 {not available when compiled without the |+syntax|
6651 feature}
6652 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006653 commands. It must end in ".{encoding}.add". You need to include the
6654 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006655 *E765*
6656 It may also be a comma separated list of names. A count before the
6657 |zg| and |zw| commands can be used to access each. This allows using
6658 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006659 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006660 you: Using the first directory in 'runtimepath' that is writable. If
6661 there is no "spell" directory yet it will be created. For the file
6662 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006663 ignoring the region.
6664 The resulting ".spl" file will be used for spell checking, it does not
6665 have to appear in 'spelllang'.
6666 Normally one file is used for all regions, but you can add the region
6667 name if you want to. However, it will then only be used when
6668 'spellfile' is set to it, for entries in 'spelllang' only files
6669 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006670 This option cannot be set from a |modeline| or in the |sandbox|, for
6671 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006672
Bram Moolenaar217ad922005-03-20 22:37:15 +00006673 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006674'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006675 local to buffer
6676 {not in Vi}
6677 {not available when compiled without the |+syntax|
6678 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006679 A comma separated list of word list names. When the 'spell' option is
6680 on spellchecking will be done for these languages. Example: >
6681 set spelllang=en_us,nl,medical
6682< This means US English, Dutch and medical words are recognized. Words
6683 that are not recognized will be highlighted.
6684 The word list name must not include a comma or dot. Using a dash is
6685 recommended to separate the two letter language name from a
6686 specification. Thus "en-rare" is used for rare English words.
6687 A region name must come last and have the form "_xx", where "xx" is
6688 the two-letter, lower case region name. You can use more than one
6689 region by listing them: "en_us,en_ca" supports both US and Canadian
6690 English, but not words specific for Australia, New Zealand or Great
6691 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006692 If the name "cjk" is included East Asian characters are excluded from
6693 spell checking. This is useful when editing text that also has Asian
6694 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006695 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006696 As a special case the name of a .spl file can be given as-is. The
6697 first "_xx" in the name is removed and used as the region name
6698 (_xx is an underscore, two letters and followed by a non-letter).
6699 This is mainly for testing purposes. You must make sure the correct
6700 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006701 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006702 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6703 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006704 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006705
Bram Moolenaar98692072006-02-04 00:57:42 +00006706 If the |spellfile.vim| plugin is active and you use a language name
6707 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6708 will ask you if you want to download the file.
6709
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006710 After this option has been set successfully, Vim will source the files
6711 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006712 up to the first comma, dot or underscore.
6713 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006714
6715
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006716 *'spellsuggest'* *'sps'*
6717'spellsuggest' 'sps' string (default "best")
6718 global
6719 {not in Vi}
6720 {not available when compiled without the |+syntax|
6721 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006722 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006723 the |spellsuggest()| function. This is a comma-separated list of
6724 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006725
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006726 best Internal method that works best for English. Finds
6727 changes like "fast" and uses a bit of sound-a-like
6728 scoring to improve the ordering.
6729
6730 double Internal method that uses two methods and mixes the
6731 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006732 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006733 word. That only works when the language specifies
6734 sound folding. Can be slow and doesn't always give
6735 better results.
6736
6737 fast Internal method that only checks for simple changes:
6738 character inserts/deletes/swaps. Works well for
6739 simple typing mistakes.
6740
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006741 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006742 Not used for |spellsuggest()|. The number of
6743 suggestions is never more than the value of 'lines'
6744 minus two.
6745
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006746 file:{filename} Read file {filename}, which must have two columns,
6747 separated by a slash. The first column contains the
6748 bad word, the second column the suggested good word.
6749 Example:
6750 theribal/terrible ~
6751 Use this for common mistakes that do not appear at the
6752 top of the suggestion list with the internal methods.
6753 Lines without a slash are ignored, use this for
6754 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006755 The word in the second column must be correct,
6756 otherwise it will not be used. Add the word to an
6757 ".add" file if it is currently flagged as a spelling
6758 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006759 The file is used for all languages.
6760
6761 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6762 trouble with spaces. |v:val| holds the badly spelled
6763 word. The expression must evaluate to a List of
6764 Lists, each with a suggestion and a score.
6765 Example:
6766 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006767 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006768 internal methods use. A lower score is better.
6769 This may invoke |spellsuggest()| if you temporarily
6770 set 'spellsuggest' to exclude the "expr:" part.
6771 Errors are silently ignored, unless you set the
6772 'verbose' option to a non-zero value.
6773
6774 Only one of "best", "double" or "fast" may be used. The others may
6775 appear several times in any order. Example: >
6776 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6777<
6778 This option cannot be set from a |modeline| or in the |sandbox|, for
6779 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006780
6781
Bram Moolenaar071d4272004-06-13 20:20:40 +00006782 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6783'splitbelow' 'sb' boolean (default off)
6784 global
6785 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006786 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 feature}
6788 When on, splitting a window will put the new window below the current
6789 one. |:split|
6790
6791 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6792'splitright' 'spr' boolean (default off)
6793 global
6794 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006795 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 feature}
6797 When on, splitting a window will put the new window right of the
6798 current one. |:vsplit|
6799
6800 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6801'startofline' 'sol' boolean (default on)
6802 global
6803 {not in Vi}
6804 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006805 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006806 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006807 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 with a linewise operator, with "%" with a count and to buffer changing
6809 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6810 only has a line number, e.g., ":25" or ":+".
6811 In case of buffer changing commands the cursor is placed at the column
6812 where it was the last time the buffer was edited.
6813 NOTE: This option is set when 'compatible' is set.
6814
Bram Moolenaar00654022011-02-25 14:42:19 +01006815 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006817 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 {not in Vi}
6819 {not available when compiled without the |+statusline|
6820 feature}
6821 When nonempty, this option determines the content of the status line.
6822 Also see |status-line|.
6823
6824 The option consists of printf style '%' items interspersed with
6825 normal text. Each status line item is of the form:
6826 %-0{minwid}.{maxwid}{item}
6827 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006828 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829
Bram Moolenaar238a5642006-02-21 22:12:05 +00006830 When the option starts with "%!" then it is used as an expression,
6831 evaluated and the result is used as the option value. Example: >
6832 :set statusline=%!MyStatusLine()
6833< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006834 Note that the "%!" expression is evaluated in the context of the
6835 current window and buffer, while %{} items are evaluated in the
6836 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006837
6838 When there is error while evaluating the option then it will be made
6839 empty to avoid further errors. Otherwise screen updating would loop.
6840
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 Note that the only effect of 'ruler' when this option is set (and
6842 'laststatus' is 2) is controlling the output of |CTRL-G|.
6843
6844 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006845 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006847 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 minwid Minimum width of the item, padding as set by '-' & '0'.
6849 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006850 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 on the left for text items. Numeric items will be
6852 shifted down to maxwid-2 digits followed by '>'number
6853 where number is the amount of missing digits, much like
6854 an exponential notation.
6855 item A one letter code as described below.
6856
6857 Following is a description of the possible statusline items. The
6858 second character in "item" is the type:
6859 N for number
6860 S for string
6861 F for flags as described below
6862 - not applicable
6863
6864 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006865 f S Path to the file in the buffer, as typed or relative to current
6866 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 F S Full path to the file in the buffer.
6868 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006869 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006871 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006873 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006875 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006877 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6879 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006880 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6882 being used: "<keymap>"
6883 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006884 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 B N As above, in hexadecimal.
6886 o N Byte number in file of byte under cursor, first byte is 1.
6887 Mnemonic: Offset from start of file (with one added)
6888 {not available when compiled without |+byte_offset| feature}
6889 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006890 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 l N Line number.
6892 L N Number of lines in buffer.
6893 c N Column number.
6894 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006895 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 p N Percentage through file in lines as in |CTRL-G|.
6897 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006898 percentage described for 'ruler'. Always 3 in length, unless
6899 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006900 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006902 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006903 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 ( - Start of item group. Can be used for setting the width and
6905 alignment of a section. Must be followed by %) somewhere.
6906 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006907 T N For 'tabline': start of tab page N label. Use %T after the last
6908 label. This information is used for mouse clicks.
6909 X N For 'tabline': start of close tab N label. Use %X after the
6910 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6911 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 < - Where to truncate line if too long. Default is at the start.
6913 No width fields allowed.
6914 = - Separation point between left and right aligned items.
6915 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006916 # - Set highlight group. The name must follow and then a # again.
6917 Thus use %#HLname# for highlight group HLname. The same
6918 highlighting is used, also for the statusline of non-current
6919 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006921 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 The difference between User{N} and StatusLine will be applied
6923 to StatusLineNC for the statusline of non-current windows.
6924 The number N must be between 1 and 9. See |hl-User1..9|
6925
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006926 When displaying a flag, Vim removes the leading comma, if any, when
6927 that flag comes right after plaintext. This will make a nice display
6928 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929
Bram Moolenaar582fd852005-03-28 20:58:01 +00006930 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 not set) and a minwid is not set for the group, the whole group will
6932 become empty. This will make a group like the following disappear
6933 completely from the statusline when none of the flags are set. >
6934 :set statusline=...%(\ [%M%R%H]%)...
6935<
6936 Beware that an expression is evaluated each and every time the status
6937 line is displayed. The current buffer and current window will be set
6938 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006939 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006941 real current buffer.
6942
Bram Moolenaar30b65812012-07-12 22:01:11 +02006943 The 'statusline' option will be evaluated in the |sandbox| if set from
6944 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006945
6946 It is not allowed to change text or jump to another window while
6947 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948
6949 If the statusline is not updated when you want it (e.g., after setting
6950 a variable that's used in an expression), you can force an update by
6951 setting an option without changing its value. Example: >
6952 :let &ro = &ro
6953
6954< A result of all digits is regarded a number for display purposes.
6955 Otherwise the result is taken as flag text and applied to the rules
6956 described above.
6957
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006958 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6960 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6961
6962 Examples:
6963 Emulate standard status line with 'ruler' set >
6964 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6965< Similar, but add ASCII value of char under the cursor (like "ga") >
6966 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6967< Display byte count and byte value, modified flag in red. >
6968 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6969 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6970< Display a ,GZ flag if a compressed file is loaded >
6971 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6972< In the |:autocmd|'s: >
6973 :let b:gzflag = 1
6974< And: >
6975 :unlet b:gzflag
6976< And define this function: >
6977 :function VarExists(var, val)
6978 : if exists(a:var) | return a:val | else | return '' | endif
6979 :endfunction
6980<
6981 *'suffixes'* *'su'*
6982'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6983 global
6984 {not in Vi}
6985 Files with these suffixes get a lower priority when multiple files
6986 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006987 suffixes. Spaces after the comma are ignored. A dot is also seen as
6988 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006989 separator, precede it with a backslash (see |option-backslash| about
6990 including spaces and backslashes).
6991 See 'wildignore' for completely ignoring files.
6992 The use of |:set+=| and |:set-=| is preferred when adding or removing
6993 suffixes from the list. This avoids problems when a future version
6994 uses another default.
6995
6996 *'suffixesadd'* *'sua'*
6997'suffixesadd' 'sua' string (default "")
6998 local to buffer
6999 {not in Vi}
7000 {not available when compiled without the
7001 |+file_in_path| feature}
7002 Comma separated list of suffixes, which are used when searching for a
7003 file for the "gf", "[I", etc. commands. Example: >
7004 :set suffixesadd=.java
7005<
7006 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7007'swapfile' 'swf' boolean (default on)
7008 local to buffer
7009 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007010 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 swapfile is not wanted for a specific buffer. For example, with
7012 confidential information that even root must not be able to access.
7013 Careful: All text will be in memory:
7014 - Don't use this for big files.
7015 - Recovery will be impossible!
7016 A swapfile will only be present when |'updatecount'| is non-zero and
7017 'swapfile' is set.
7018 When 'swapfile' is reset, the swap file for the current buffer is
7019 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7020 non-zero, a swap file is immediately created.
7021 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007022 If you want to open a new buffer without creating a swap file for it,
7023 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024
7025 This option is used together with 'bufhidden' and 'buftype' to
7026 specify special kinds of buffers. See |special-buffers|.
7027
7028 *'swapsync'* *'sws'*
7029'swapsync' 'sws' string (default "fsync")
7030 global
7031 {not in Vi}
7032 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 When this option is empty parts of the swap file may be in memory and
7035 not written to disk. When the system crashes you may lose more work.
7036 On Unix the system does a sync now and then without Vim asking for it,
7037 so the disadvantage of setting this option off is small. On some
7038 systems the swap file will not be written at all. For a unix system
7039 setting it to "sync" will use the sync() call instead of the default
7040 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007041 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042
7043 *'switchbuf'* *'swb'*
7044'switchbuf' 'swb' string (default "")
7045 global
7046 {not in Vi}
7047 This option controls the behavior when switching between buffers.
7048 Possible values (comma separated list):
7049 useopen If included, jump to the first open window that
7050 contains the specified buffer (if there is one).
7051 Otherwise: Do not examine other windows.
7052 This setting is checked with |quickfix| commands, when
7053 jumping to errors (":cc", ":cn", "cp", etc.). It is
7054 also used in all buffer related split commands, for
7055 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007056 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007057 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007059 a buffer for a |quickfix| command that display errors.
7060 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007061 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007062 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007063
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007064 *'synmaxcol'* *'smc'*
7065'synmaxcol' 'smc' number (default 3000)
7066 local to buffer
7067 {not in Vi}
7068 {not available when compiled without the |+syntax|
7069 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007070 Maximum column in which to search for syntax items. In long lines the
7071 text after this column is not highlighted and following lines may not
7072 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007073 This helps to avoid very slow redrawing for an XML file that is one
7074 long line.
7075 Set to zero to remove the limit.
7076
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 *'syntax'* *'syn'*
7078'syntax' 'syn' string (default empty)
7079 local to buffer
7080 {not in Vi}
7081 {not available when compiled without the |+syntax|
7082 feature}
7083 When this option is set, the syntax with this name is loaded, unless
7084 syntax highlighting has been switched off with ":syntax off".
7085 Otherwise this option does not always reflect the current syntax (the
7086 b:current_syntax variable does).
7087 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007088 not automatically recognized. Example, in an IDL file:
7089 /* vim: set syntax=idl : */ ~
7090 When a dot appears in the value then this separates two filetype
7091 names. Example:
7092 /* vim: set syntax=c.doxygen : */ ~
7093 This will use the "c" syntax first, then the "doxygen" syntax.
7094 Note that the second one must be prepared to be loaded as an addition,
7095 otherwise it will be skipped. More than one dot may appear.
7096 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007097 :set syntax=OFF
7098< To switch syntax highlighting on according to the current value of the
7099 'filetype' option: >
7100 :set syntax=ON
7101< What actually happens when setting the 'syntax' option is that the
7102 Syntax autocommand event is triggered with the value as argument.
7103 This option is not copied to another buffer, independent of the 's' or
7104 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007105 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007107 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007108'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007109 global
7110 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007111 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007112 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007113 When nonempty, this option determines the content of the tab pages
7114 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007115 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007116
7117 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007118 option and only when there is no GUI tab line. When 'e' is in
7119 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007120 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007121
7122 The value is evaluated like with 'statusline'. You can use
7123 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007124 the text to be displayed. Use "%1T" for the first label, "%2T" for
7125 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007126
7127 Keep in mind that only one of the tab pages is the current one, others
7128 are invisible and you can't jump to their windows.
7129
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007130
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007131 *'tabpagemax'* *'tpm'*
7132'tabpagemax' 'tpm' number (default 10)
7133 global
7134 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007135 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007136 feature}
7137 Maximum number of tab pages to be opened by the |-p| command line
7138 argument or the ":tab all" command. |tabpage|
7139
7140
7141 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142'tabstop' 'ts' number (default 8)
7143 local to buffer
7144 Number of spaces that a <Tab> in the file counts for. Also see
7145 |:retab| command, and 'softtabstop' option.
7146
7147 Note: Setting 'tabstop' to any other value than 8 can make your file
7148 appear wrong in many places (e.g., when printing it).
7149
7150 There are four main ways to use tabs in Vim:
7151 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7152 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007153 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 behave like a tab appears every 4 (or 3) characters.
7155 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7156 'expandtab'. This way you will always insert spaces. The
7157 formatting will never be messed up when 'tabstop' is changed.
7158 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 works when using Vim to edit the file.
7161 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7162 'noexpandtab'. This should then work (for initial indents only)
7163 for any tabstop setting that people use. It might be nice to have
7164 tabs after the first non-blank inserted as spaces if you do this
7165 though. Otherwise aligned comments will be wrong when 'tabstop' is
7166 changed.
7167
7168 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7169'tagbsearch' 'tbs' boolean (default on)
7170 global
7171 {not in Vi}
7172 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007173 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 searching makes searching for a tag a LOT faster, but a linear search
7175 will find more tags if the tags file wasn't properly sorted.
7176 Vim normally assumes that your tags files are sorted, or indicate that
7177 they are not sorted. Only when this is not the case does the
7178 'tagbsearch' option need to be switched off.
7179
7180 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007181 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 certain files, or retry all files with a linear search. When
7183 'tagbsearch' is off, only a linear search is done.
7184
7185 Linear searching is done anyway, for one file, when Vim finds a line
7186 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007187 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188< [The whitespace before and after the '0' must be a single <Tab>]
7189
7190 When a binary search was done and no match was found in any of the
7191 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7192 instead of a normal tag name, a retry is done with a linear search.
7193 Tags in unsorted tags files, and matches with different case will only
7194 be found in the retry.
7195
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007196 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 linear search can be avoided for the 'ignorecase' case. Use a value
7198 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7199 case-fold sorted with the -f switch to "sort" in most unices, as in
7200 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007201 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7202 for this as well. Note that case must be folded to uppercase for this
7203 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204
7205 When 'tagbsearch' is off, tags searching is slower when a full match
7206 exists, but faster when no full match exists. Tags in unsorted tags
7207 files may only be found with 'tagbsearch' off.
7208 When the tags file is not sorted, or sorted in a wrong way (not on
7209 ASCII byte value), 'tagbsearch' should be off, or the line given above
7210 must be included in the tags file.
7211 This option doesn't affect commands that find all matching tags (e.g.,
7212 command-line completion and ":help").
7213 {Vi: always uses binary search in some versions}
7214
7215 *'taglength'* *'tl'*
7216'taglength' 'tl' number (default 0)
7217 global
7218 If non-zero, tags are significant up to this number of characters.
7219
7220 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7221'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7222 global
7223 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007224 If on and using a tags file in another directory, file names in that
7225 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 NOTE: This option is set to the Vi default value when 'compatible' is
7227 set and to the Vim default value when 'compatible' is reset.
7228
7229 *'tags'* *'tag'* *E433*
7230'tags' 'tag' string (default "./tags,tags", when compiled with
7231 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7232 global or local to buffer |global-local|
7233 Filenames for the tag command, separated by spaces or commas. To
7234 include a space or comma in a file name, precede it with a backslash
7235 (see |option-backslash| about including spaces and backslashes).
7236 When a file name starts with "./", the '.' is replaced with the path
7237 of the current file. But only when the 'd' flag is not included in
7238 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7239 |tags-option|.
7240 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007241 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7242 find all files named "tags" below "/lib". The filename itself cannot
7243 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7244 files called "tags?". {not available when compiled without the
7245 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007246 The |tagfiles()| function can be used to get a list of the file names
7247 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7249 files are also supported. They are automatically recognized. The
7250 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7251 differences are ignored (MS-Windows). |emacs-tags|
7252 The use of |:set+=| and |:set-=| is preferred when adding or removing
7253 file names from the list. This avoids problems when a future version
7254 uses another default.
7255 {Vi: default is "tags /usr/lib/tags"}
7256
7257 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7258'tagstack' 'tgst' boolean (default on)
7259 global
7260 {not in all versions of Vi}
7261 When on, the |tagstack| is used normally. When off, a ":tag" or
7262 ":tselect" command with an argument will not push the tag onto the
7263 tagstack. A following ":tag" without an argument, a ":pop" command or
7264 any other command that uses the tagstack will use the unmodified
7265 tagstack, but does change the pointer to the active entry.
7266 Resetting this option is useful when using a ":tag" command in a
7267 mapping which should not change the tagstack.
7268
7269 *'term'* *E529* *E530* *E531*
7270'term' string (default is $TERM, if that fails:
7271 in the GUI: "builtin_gui"
7272 on Amiga: "amiga"
7273 on BeOS: "beos-ansi"
7274 on Mac: "mac-ansi"
7275 on MiNT: "vt52"
7276 on MS-DOS: "pcterm"
7277 on OS/2: "os2ansi"
7278 on Unix: "ansi"
7279 on VMS: "ansi"
7280 on Win 32: "win32")
7281 global
7282 Name of the terminal. Used for choosing the terminal control
7283 characters. Environment variables are expanded |:set_env|.
7284 For example: >
7285 :set term=$TERM
7286< See |termcap|.
7287
7288 *'termbidi'* *'tbidi'*
7289 *'notermbidi'* *'notbidi'*
7290'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7291 global
7292 {not in Vi}
7293 {only available when compiled with the |+arabic|
7294 feature}
7295 The terminal is in charge of Bi-directionality of text (as specified
7296 by Unicode). The terminal is also expected to do the required shaping
7297 that some languages (such as Arabic) require.
7298 Setting this option implies that 'rightleft' will not be set when
7299 'arabic' is set and the value of 'arabicshape' will be ignored.
7300 Note that setting 'termbidi' has the immediate effect that
7301 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7302 This option is reset when the GUI is started.
7303 For further details see |arabic.txt|.
7304
7305 *'termencoding'* *'tenc'*
7306'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7307 Macintosh GUI: "macroman")
7308 global
7309 {only available when compiled with the |+multi_byte|
7310 feature}
7311 {not in Vi}
7312 Encoding used for the terminal. This specifies what character
7313 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007314 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007315 display). Except for the Mac when 'macatsui' is off, then
7316 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 In the Win32 console version the default value is the console codepage
7318 when it differs from the ANSI codepage.
7319 *E617*
7320 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7321 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7322 Any attempts to set a different value will be rejected, and an error
7323 message is shown.
7324 For the Win32 GUI 'termencoding' is not used for typed characters,
7325 because the Win32 system always passes Unicode characters.
7326 When empty, the same encoding is used as for the 'encoding' option.
7327 This is the normal value.
7328 Not all combinations for 'termencoding' and 'encoding' are valid. See
7329 |encoding-table|.
7330 The value for this option must be supported by internal conversions or
7331 iconv(). When this is not possible no conversion will be done and you
7332 will probably experience problems with non-ASCII characters.
7333 Example: You are working with the locale set to euc-jp (Japanese) and
7334 want to edit a UTF-8 file: >
7335 :let &termencoding = &encoding
7336 :set encoding=utf-8
7337< You need to do this when your system has no locale support for UTF-8.
7338
7339 *'terse'* *'noterse'*
7340'terse' boolean (default off)
7341 global
7342 When set: Add 's' flag to 'shortmess' option (this makes the message
7343 for a search that hits the start or end of the file not being
7344 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7345 shortens a lot of messages}
7346
7347 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7348'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7349 global
7350 {not in Vi}
7351 This option is obsolete. Use 'fileformats'.
7352 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7353 set to the default value for the current system. When 'textauto' is
7354 reset, 'fileformats' is made empty.
7355 NOTE: This option is set to the Vi default value when 'compatible' is
7356 set and to the Vim default value when 'compatible' is reset.
7357
7358 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7359'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7360 others: default off)
7361 local to buffer
7362 {not in Vi}
7363 This option is obsolete. Use 'fileformat'.
7364 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7365 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7366 "unix".
7367
7368 *'textwidth'* *'tw'*
7369'textwidth' 'tw' number (default 0)
7370 local to buffer
7371 {not in Vi}
7372 Maximum width of text that is being inserted. A longer line will be
7373 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007374 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7375 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007377 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378 NOTE: This option is set to 0 when 'compatible' is set.
7379
7380 *'thesaurus'* *'tsr'*
7381'thesaurus' 'tsr' string (default "")
7382 global or local to buffer |global-local|
7383 {not in Vi}
7384 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007385 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 the file should contain words with similar meaning, separated by
7387 non-keyword characters (white space is preferred). Maximum line
7388 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007389 To obtain a file to be used here, check out this ftp site:
7390 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007391 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 after a comma are ignored, otherwise spaces are included in the file
7393 name. See |option-backslash| about using backslashes.
7394 The use of |:set+=| and |:set-=| is preferred when adding or removing
7395 directories from the list. This avoids problems when a future version
7396 uses another default.
7397 Backticks cannot be used in this option for security reasons.
7398
7399 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7400'tildeop' 'top' boolean (default off)
7401 global
7402 {not in Vi}
7403 When on: The tilde command "~" behaves like an operator.
7404 NOTE: This option is reset when 'compatible' is set.
7405
7406 *'timeout'* *'to'* *'notimeout'* *'noto'*
7407'timeout' 'to' boolean (default on)
7408 global
7409 *'ttimeout'* *'nottimeout'*
7410'ttimeout' boolean (default off)
7411 global
7412 {not in Vi}
7413 These two options together determine the behavior when part of a
7414 mapped key sequence or keyboard code has been received:
7415
7416 'timeout' 'ttimeout' action ~
7417 off off do not time out
7418 on on or off time out on :mappings and key codes
7419 off on time out on key codes
7420
7421 If both options are off, Vim will wait until either the complete
7422 mapping or key sequence has been received, or it is clear that there
7423 is no mapping or key sequence for the received characters. For
7424 example: if you have mapped "vl" and Vim has received 'v', the next
7425 character is needed to see if the 'v' is followed by an 'l'.
7426 When one of the options is on, Vim will wait for about 1 second for
7427 the next character to arrive. After that the already received
7428 characters are interpreted as single characters. The waiting time can
7429 be changed with the 'timeoutlen' option.
7430 On slow terminals or very busy systems timing out may cause
7431 malfunctioning cursor keys. If both options are off, Vim waits
7432 forever after an entered <Esc> if there are key codes that start
7433 with <Esc>. You will have to type <Esc> twice. If you do not have
7434 problems with key codes, but would like to have :mapped key
7435 sequences not timing out in 1 second, set the 'ttimeout' option and
7436 reset the 'timeout' option.
7437
7438 NOTE: 'ttimeout' is reset when 'compatible' is set.
7439
7440 *'timeoutlen'* *'tm'*
7441'timeoutlen' 'tm' number (default 1000)
7442 global
7443 {not in all versions of Vi}
7444 *'ttimeoutlen'* *'ttm'*
7445'ttimeoutlen' 'ttm' number (default -1)
7446 global
7447 {not in Vi}
7448 The time in milliseconds that is waited for a key code or mapped key
7449 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7450 when part of a command has been typed.
7451 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7452 different timeout value for key codes is desired set 'ttimeoutlen' to
7453 a non-negative number.
7454
7455 ttimeoutlen mapping delay key code delay ~
7456 < 0 'timeoutlen' 'timeoutlen'
7457 >= 0 'timeoutlen' 'ttimeoutlen'
7458
7459 The timeout only happens when the 'timeout' and 'ttimeout' options
7460 tell so. A useful setting would be >
7461 :set timeout timeoutlen=3000 ttimeoutlen=100
7462< (time out on mapping after three seconds, time out on key codes after
7463 a tenth of a second).
7464
7465 *'title'* *'notitle'*
7466'title' boolean (default off, on when title can be restored)
7467 global
7468 {not in Vi}
7469 {not available when compiled without the |+title|
7470 feature}
7471 When on, the title of the window will be set to the value of
7472 'titlestring' (if it is not empty), or to:
7473 filename [+=-] (path) - VIM
7474 Where:
7475 filename the name of the file being edited
7476 - indicates the file cannot be modified, 'ma' off
7477 + indicates the file was modified
7478 = indicates the file is read-only
7479 =+ indicates the file is read-only and modified
7480 (path) is the path of the file being edited
7481 - VIM the server name |v:servername| or "VIM"
7482 Only works if the terminal supports setting window titles
7483 (currently Amiga console, Win32 console, all GUI versions and
7484 terminals with a non- empty 't_ts' option - these are Unix xterm and
7485 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7486 *X11*
7487 When Vim was compiled with HAVE_X11 defined, the original title will
7488 be restored if possible. The output of ":version" will include "+X11"
7489 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7490 works for the icon name |'icon'|.
7491 But: When Vim was started with the |-X| argument, restoring the title
7492 will not work (except in the GUI).
7493 If the title cannot be restored, it is set to the value of 'titleold'.
7494 You might want to restore the title outside of Vim then.
7495 When using an xterm from a remote machine you can use this command:
7496 rsh machine_name xterm -display $DISPLAY &
7497 then the WINDOWID environment variable should be inherited and the
7498 title of the window should change back to what it should be after
7499 exiting Vim.
7500
7501 *'titlelen'*
7502'titlelen' number (default 85)
7503 global
7504 {not in Vi}
7505 {not available when compiled without the |+title|
7506 feature}
7507 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007508 title. When the title is longer, only the end of the path name is
7509 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007510 Using a percentage makes this adapt to the width of the window. But
7511 it won't work perfectly, because the actual number of characters
7512 available also depends on the font used and other things in the title
7513 bar. When 'titlelen' is zero the full path is used. Otherwise,
7514 values from 1 to 30000 percent can be used.
7515 'titlelen' is also used for the 'titlestring' option.
7516
7517 *'titleold'*
7518'titleold' string (default "Thanks for flying Vim")
7519 global
7520 {not in Vi}
7521 {only available when compiled with the |+title|
7522 feature}
7523 This option will be used for the window title when exiting Vim if the
7524 original title cannot be restored. Only happens if 'title' is on or
7525 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007526 This option cannot be set from a |modeline| or in the |sandbox|, for
7527 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 *'titlestring'*
7529'titlestring' string (default "")
7530 global
7531 {not in Vi}
7532 {not available when compiled without the |+title|
7533 feature}
7534 When this option is not empty, it will be used for the title of the
7535 window. This happens only when the 'title' option is on.
7536 Only works if the terminal supports setting window titles (currently
7537 Amiga console, Win32 console, all GUI versions and terminals with a
7538 non-empty 't_ts' option).
7539 When Vim was compiled with HAVE_X11 defined, the original title will
7540 be restored if possible |X11|.
7541 When this option contains printf-style '%' items, they will be
7542 expanded according to the rules used for 'statusline'.
7543 Example: >
7544 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7545 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7546< The value of 'titlelen' is used to align items in the middle or right
7547 of the available space.
7548 Some people prefer to have the file name first: >
7549 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7550< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007551 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 separating space only when needed.
7553 NOTE: Use of special characters in 'titlestring' may cause the display
7554 to be garbled (e.g., when it contains a CR or NL character).
7555 {not available when compiled without the |+statusline| feature}
7556
7557 *'toolbar'* *'tb'*
7558'toolbar' 'tb' string (default "icons,tooltips")
7559 global
7560 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7561 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007562 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 possible values are:
7564 icons Toolbar buttons are shown with icons.
7565 text Toolbar buttons shown with text.
7566 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007567 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 tooltips Tooltips are active for toolbar buttons.
7569 Tooltips refer to the popup help text which appears after the mouse
7570 cursor is placed over a toolbar button for a brief moment.
7571
7572 If you want the toolbar to be shown with icons as well as text, do the
7573 following: >
7574 :set tb=icons,text
7575< Motif and Athena cannot display icons and text at the same time. They
7576 will show icons if both are requested.
7577
7578 If none of the strings specified in 'toolbar' are valid or if
7579 'toolbar' is empty, this option is ignored. If you want to disable
7580 the toolbar, you need to set the 'guioptions' option. For example: >
7581 :set guioptions-=T
7582< Also see |gui-toolbar|.
7583
7584 *'toolbariconsize'* *'tbis'*
7585'toolbariconsize' 'tbis' string (default "small")
7586 global
7587 {not in Vi}
7588 {only in the GTK+ 2 GUI}
7589 Controls the size of toolbar icons. The possible values are:
7590 tiny Use tiny toolbar icons.
7591 small Use small toolbar icons (default).
7592 medium Use medium-sized toolbar icons.
7593 large Use large toolbar icons.
7594 The exact dimensions in pixels of the various icon sizes depend on
7595 the current theme. Common dimensions are large=32x32, medium=24x24,
7596 small=20x20 and tiny=16x16.
7597
7598 If 'toolbariconsize' is empty, the global default size as determined
7599 by user preferences or the current theme is used.
7600
7601 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7602'ttybuiltin' 'tbi' boolean (default on)
7603 global
7604 {not in Vi}
7605 When on, the builtin termcaps are searched before the external ones.
7606 When off the builtin termcaps are searched after the external ones.
7607 When this option is changed, you should set the 'term' option next for
7608 the change to take effect, for example: >
7609 :set notbi term=$TERM
7610< See also |termcap|.
7611 Rationale: The default for this option is "on", because the builtin
7612 termcap entries are generally better (many systems contain faulty
7613 xterm entries...).
7614
7615 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7616'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7617 sun-cmd, screen, rxvt, dtterm or
7618 iris-ansi; also on when running Vim in
7619 a DOS console)
7620 global
7621 {not in Vi}
7622 Indicates a fast terminal connection. More characters will be sent to
7623 the screen for redrawing, instead of using insert/delete line
7624 commands. Improves smoothness of redrawing when there are multiple
7625 windows and the terminal does not support a scrolling region.
7626 Also enables the extra writing of characters at the end of each screen
7627 line for lines that wrap. This helps when using copy/paste with the
7628 mouse in an xterm and other terminals.
7629
7630 *'ttymouse'* *'ttym'*
7631'ttymouse' 'ttym' string (default depends on 'term')
7632 global
7633 {not in Vi}
7634 {only in Unix and VMS, doesn't work in the GUI; not
7635 available when compiled without |+mouse|}
7636 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007637 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 *xterm-mouse*
7639 xterm xterm-like mouse handling. The mouse generates
7640 "<Esc>[Mscr", where "scr" is three bytes:
7641 "s" = button state
7642 "c" = column plus 33
7643 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007644 This only works up to 223 columns! See "dec",
7645 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 xterm2 Works like "xterm", but with the xterm reporting the
7647 mouse position while the mouse is dragged. This works
7648 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007649 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 work. See below for how Vim detects this
7651 automatically.
7652 *netterm-mouse*
7653 netterm NetTerm mouse handling. The mouse generates
7654 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7655 for the row and column.
7656 *dec-mouse*
7657 dec DEC terminal mouse handling. The mouse generates a
7658 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007659 This is also available for an Xterm, if it was
7660 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 *jsbterm-mouse*
7662 jsbterm JSB term mouse handling.
7663 *pterm-mouse*
7664 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007665 *urxvt-mouse*
7666 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007667 The mouse works only if the terminal supports this
7668 encoding style, but it does not have 223 columns limit
7669 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007670 *sgr-mouse*
7671 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007672 mouse reporting. The mouse works even in columns
7673 beyond 223. This option is backward compatible with
7674 "xterm2" because it can also decode "xterm2" style
7675 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007676
7677 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007678 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7679 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007680 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7681 recognized, if enabled at compile time. DEC terminal mouse codes
7682 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007683 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7684 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007685 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007686 set to a name that starts with "xterm", "mlterm", or "screen", and
7687 'ttymouse' is not set already.
7688 Additionally, if vim is compiled with the |+termresponse| feature and
7689 |t_RV| is set to the escape sequence to request the xterm version
7690 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007692 from 95 to 276. The "sgr" value will be set if the xterm version is
7693 277 or highter.
7694 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7695 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 :set t_RV=
7697<
7698 *'ttyscroll'* *'tsl'*
7699'ttyscroll' 'tsl' number (default 999)
7700 global
7701 Maximum number of lines to scroll the screen. If there are more lines
7702 to scroll the window is redrawn. For terminals where scrolling is
7703 very slow and redrawing is not slow this can be set to a small number,
7704 e.g., 3, to speed up displaying.
7705
7706 *'ttytype'* *'tty'*
7707'ttytype' 'tty' string (default from $TERM)
7708 global
7709 Alias for 'term', see above.
7710
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007711 *'undodir'* *'udir'*
7712'undodir' 'udir' string (default ".")
7713 global
7714 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007715 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007716 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007717 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007718 "." means using the directory of the file. The undo file name for
7719 "file.txt" is ".file.txt.un~".
7720 For other directories the file name is the full path of the edited
7721 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007722 When writing: The first directory that exists is used. "." always
7723 works, no directories after "." will be used for writing.
7724 When reading all entries are tried to find an undo file. The first
7725 undo file that exists is used. When it cannot be read an error is
7726 given, no further entry is used.
7727 See |undo-persistence|.
7728
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007729 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007730'undofile' 'udf' boolean (default off)
7731 local to buffer
7732 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007733 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007734 When on, Vim automatically saves undo history to an undo file when
7735 writing a buffer to a file, and restores undo history from the same
7736 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007737 The directory where the undo file is stored is specified by 'undodir'.
7738 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007739 The undo file is not read when 'undoreload' causes the buffer from
7740 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007741 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007742
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 *'undolevels'* *'ul'*
7744'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7745 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007746 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 {not in Vi}
7748 Maximum number of changes that can be undone. Since undo information
7749 is kept in memory, higher numbers will cause more memory to be used
7750 (nevertheless, a single change can use an unlimited amount of memory).
7751 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7752 itself: >
7753 set ul=0
7754< But you can also get Vi compatibility by including the 'u' flag in
7755 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007756 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007757 Set to -1 for no undo at all. You might want to do this only for the
7758 current buffer: >
7759 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007761
7762 The local value is set to -123456 when the global value is to be used.
7763
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007764 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007766 *'undoreload'* *'ur'*
7767'undoreload' 'ur' number (default 10000)
7768 global
7769 {not in Vi}
7770 Save the whole buffer for undo when reloading it. This applies to the
7771 ":e!" command and reloading for when the buffer changed outside of
7772 Vim. |FileChangedShell|
7773 The save only happens when this options is negative or when the number
7774 of lines is smaller than the value of this option.
7775 Set this option to zero to disable undo for a reload.
7776
7777 When saving undo for a reload, any undo file is not read.
7778
7779 Note that this causes the whole buffer to be stored in memory. Set
7780 this option to a lower value if you run out of memory.
7781
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 *'updatecount'* *'uc'*
7783'updatecount' 'uc' number (default: 200)
7784 global
7785 {not in Vi}
7786 After typing this many characters the swap file will be written to
7787 disk. When zero, no swap file will be created at all (see chapter on
7788 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7789 Vim with the "-n" option, see |startup|. When editing in readonly
7790 mode this option will be initialized to 10000.
7791 The swapfile can be disabled per buffer with |'swapfile'|.
7792 When 'updatecount' is set from zero to non-zero, swap files are
7793 created for all buffers that have 'swapfile' set. When 'updatecount'
7794 is set to zero, existing swap files are not deleted.
7795 Also see |'swapsync'|.
7796 This option has no meaning in buffers where |'buftype'| is "nofile"
7797 or "nowrite".
7798
7799 *'updatetime'* *'ut'*
7800'updatetime' 'ut' number (default 4000)
7801 global
7802 {not in Vi}
7803 If this many milliseconds nothing is typed the swap file will be
7804 written to disk (see |crash-recovery|). Also used for the
7805 |CursorHold| autocommand event.
7806
7807 *'verbose'* *'vbs'*
7808'verbose' 'vbs' number (default 0)
7809 global
7810 {not in Vi, although some versions have a boolean
7811 verbose option}
7812 When bigger than zero, Vim will give messages about what it is doing.
7813 Currently, these messages are given:
7814 >= 1 When the viminfo file is read or written.
7815 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007816 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 >= 8 Files for which a group of autocommands is executed.
7818 >= 9 Every executed autocommand.
7819 >= 12 Every executed function.
7820 >= 13 When an exception is thrown, caught, finished, or discarded.
7821 >= 14 Anything pending in a ":finally" clause.
7822 >= 15 Every executed Ex command (truncated at 200 characters).
7823
7824 This option can also be set with the "-V" argument. See |-V|.
7825 This option is also set by the |:verbose| command.
7826
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007827 When the 'verbosefile' option is set then the verbose messages are not
7828 displayed.
7829
7830 *'verbosefile'* *'vfile'*
7831'verbosefile' 'vfile' string (default empty)
7832 global
7833 {not in Vi}
7834 When not empty all messages are written in a file with this name.
7835 When the file exists messages are appended.
7836 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007837 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007838 Setting 'verbosefile' to a new value is like making it empty first.
7839 The difference with |:redir| is that verbose messages are not
7840 displayed when 'verbosefile' is set.
7841
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 *'viewdir'* *'vdir'*
7843'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7844 "$VIM/vimfiles/view",
7845 for Unix: "~/.vim/view",
7846 for Macintosh: "$VIM:vimfiles:view"
7847 for VMS: "sys$login:vimfiles/view"
7848 for RiscOS: "Choices:vimfiles/view")
7849 global
7850 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007851 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007852 feature}
7853 Name of the directory where to store files for |:mkview|.
7854 This option cannot be set from a |modeline| or in the |sandbox|, for
7855 security reasons.
7856
7857 *'viewoptions'* *'vop'*
7858'viewoptions' 'vop' string (default: "folds,options,cursor")
7859 global
7860 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007861 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 feature}
7863 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007864 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 word save and restore ~
7866 cursor cursor position in file and in window
7867 folds manually created folds, opened/closed folds and local
7868 fold options
7869 options options and mappings local to a window or buffer (not
7870 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007871 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 slash backslashes in file names replaced with forward
7873 slashes
7874 unix with Unix end-of-line format (single <NL>), even when
7875 on Windows or DOS
7876
7877 "slash" and "unix" are useful on Windows when sharing view files
7878 with Unix. The Unix version of Vim cannot source dos format scripts,
7879 but the Windows version of Vim can source unix format scripts.
7880
7881 *'viminfo'* *'vi'* *E526* *E527* *E528*
7882'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007883 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7884 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7885 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 global
7887 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007888 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 feature}
7890 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007891 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 separated list of parameters, each consisting of a single character
7893 identifying the particular parameter, followed by a number or string
7894 which specifies the value of that parameter. If a particular
7895 character is left out, then the default value is used for that
7896 parameter. The following is a list of the identifying characters and
7897 the effect of their value.
7898 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007899 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 ! When included, save and restore global variables that start
7901 with an uppercase letter, and don't contain a lowercase
7902 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007903 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007904 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007905 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007906 " Maximum number of lines saved for each register. Old name of
7907 the '<' item, with the disadvantage that you need to put a
7908 backslash before the ", otherwise it will be recognized as the
7909 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007910 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 % When included, save and restore the buffer list. If Vim is
7912 started with a file name argument, the buffer list is not
7913 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007914 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007915 without a file name and buffers for help files are not written
7916 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007917 When followed by a number, the number specifies the maximum
7918 number of buffers that are stored. Without a number all
7919 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007920 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 ' Maximum number of previously edited files for which the marks
7922 are remembered. This parameter must always be included when
7923 'viminfo' is non-empty.
7924 Including this item also means that the |jumplist| and the
7925 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007926 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007928 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 patterns are also saved. When not included, the value of
7930 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007931 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007933 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007934 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 < Maximum number of lines saved for each register. If zero then
7936 registers are not saved. When not included, all lines are
7937 saved. '"' is the old name for this item.
7938 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007939 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007941 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007942 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 c When included, convert the text in the viminfo file from the
7944 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007945 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007946 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 f Whether file marks need to be stored. If zero, file marks ('0
7948 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007949 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007951 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 h Disable the effect of 'hlsearch' when loading the viminfo
7953 file. When not included, it depends on whether ":nohlsearch"
7954 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007955 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 n Name of the viminfo file. The name must immediately follow
7957 the 'n'. Must be the last one! If the "-i" argument was
7958 given when starting Vim, that file name overrides the one
7959 given here with 'viminfo'. Environment variables are expanded
7960 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007961 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007962 r Removable media. The argument is a string (up to the next
7963 ','). This parameter can be given several times. Each
7964 specifies the start of a path for which no marks will be
7965 stored. This is to avoid removable media. For MS-DOS you
7966 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7967 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7968 ignored. Maximum length of each 'r' argument is 50
7969 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007970 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 s Maximum size of an item in Kbyte. If zero then registers are
7972 not saved. Currently only applies to registers. The default
7973 "s10" will exclude registers with more than 10 Kbyte of text.
7974 Also see the '<' item above: line count limit.
7975
7976 Example: >
7977 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7978<
7979 '50 Marks will be remembered for the last 50 files you
7980 edited.
7981 <1000 Contents of registers (up to 1000 lines each) will be
7982 remembered.
7983 s100 Registers with more than 100 Kbyte text are skipped.
7984 :0 Command-line history will not be saved.
7985 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7986 no / Since '/' is not specified, the default will be used,
7987 that is, save all of the search history, and also the
7988 previous search and substitute patterns.
7989 no % The buffer list will not be saved nor read back.
7990 no h 'hlsearch' highlighting will be restored.
7991
7992 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7993 load the contents of the file, this is not done automatically.
7994
7995 This option cannot be set from a |modeline| or in the |sandbox|, for
7996 security reasons.
7997
7998 *'virtualedit'* *'ve'*
7999'virtualedit' 've' string (default "")
8000 global
8001 {not in Vi}
8002 {not available when compiled without the
8003 |+virtualedit| feature}
8004 A comma separated list of these words:
8005 block Allow virtual editing in Visual block mode.
8006 insert Allow virtual editing in Insert mode.
8007 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008008 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008009
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008011 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 of the line. Useful for selecting a rectangle in Visual mode and
8013 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008014 "onemore" is not the same, it will only allow moving the cursor just
8015 after the last character of the line. This makes some commands more
8016 consistent. Previously the cursor was always past the end of the line
8017 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008018 break some plugins or Vim scripts. For example because |l| can move
8019 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008020 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008021 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008022 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008023 It doesn't make sense to combine "all" with "onemore", but you will
8024 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025
8026 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8027'visualbell' 'vb' boolean (default off)
8028 global
8029 {not in Vi}
8030 Use visual bell instead of beeping. The terminal code to display the
8031 visual bell is given with 't_vb'. When no beep or flash is wanted,
8032 use ":set vb t_vb=".
8033 Note: When the GUI starts, 't_vb' is reset to its default value. You
8034 might want to set it again in your |gvimrc|.
8035 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8036 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8037 where 40 is the time in msec.
8038 Does not work on the Amiga, you always get a screen flash.
8039 Also see 'errorbells'.
8040
8041 *'warn'* *'nowarn'*
8042'warn' boolean (default on)
8043 global
8044 Give a warning message when a shell command is used while the buffer
8045 has been changed.
8046
8047 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8048'weirdinvert' 'wiv' boolean (default off)
8049 global
8050 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008051 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 It is provided for backwards compatibility with version 4.x.
8053 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8054 vice versa. Has no effect when the GUI is running.
8055
8056 *'whichwrap'* *'ww'*
8057'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8058 global
8059 {not in Vi}
8060 Allow specified keys that move the cursor left/right to move to the
8061 previous/next line when the cursor is on the first/last character in
8062 the line. Concatenate characters to allow this for these keys:
8063 char key mode ~
8064 b <BS> Normal and Visual
8065 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008066 h "h" Normal and Visual (not recommended)
8067 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 < <Left> Normal and Visual
8069 > <Right> Normal and Visual
8070 ~ "~" Normal
8071 [ <Left> Insert and Replace
8072 ] <Right> Insert and Replace
8073 For example: >
8074 :set ww=<,>,[,]
8075< allows wrap only when cursor keys are used.
8076 When the movement keys are used in combination with a delete or change
8077 operator, the <EOL> also counts for a character. This makes "3h"
8078 different from "3dh" when the cursor crosses the end of a line. This
8079 is also true for "x" and "X", because they do the same as "dl" and
8080 "dh". If you use this, you may also want to use the mapping
8081 ":map <BS> X" to make backspace delete the character in front of the
8082 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008083 When 'l' is included and it is used after an operator at the end of a
8084 line then it will not move to the next line. This makes "dl", "cl",
8085 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 NOTE: This option is set to the Vi default value when 'compatible' is
8087 set and to the Vim default value when 'compatible' is reset.
8088
8089 *'wildchar'* *'wc'*
8090'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8091 global
8092 {not in Vi}
8093 Character you have to type to start wildcard expansion in the
8094 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008095 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008096 The character is not recognized when used inside a macro. See
8097 'wildcharm' for that.
8098 Although 'wc' is a number option, you can set it to a special key: >
8099 :set wc=<Esc>
8100< NOTE: This option is set to the Vi default value when 'compatible' is
8101 set and to the Vim default value when 'compatible' is reset.
8102
8103 *'wildcharm'* *'wcm'*
8104'wildcharm' 'wcm' number (default: none (0))
8105 global
8106 {not in Vi}
8107 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008108 recognized when used inside a macro. You can find "spare" command-line
8109 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008110 you'll never actually type 'wildcharm', just use it in mappings that
8111 automatically invoke completion mode, e.g.: >
8112 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008113 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114< Then after typing :ss you can use CTRL-P & CTRL-N.
8115
8116 *'wildignore'* *'wig'*
8117'wildignore' 'wig' string (default "")
8118 global
8119 {not in Vi}
8120 {not available when compiled without the |+wildignore|
8121 feature}
8122 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008123 patterns is ignored when expanding |wildcards|, completing file or
8124 directory names, and influences the result of |expand()|, |glob()| and
8125 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008126 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8127 Also see 'suffixes'.
8128 Example: >
8129 :set wildignore=*.o,*.obj
8130< The use of |:set+=| and |:set-=| is preferred when adding or removing
8131 a pattern from the list. This avoids problems when a future version
8132 uses another default.
8133
Bram Moolenaar94950a92010-12-02 16:01:29 +01008134
Bram Moolenaar81af9252010-12-10 20:35:50 +01008135 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008136'wildignorecase' 'wic' boolean (default off)
8137 global
8138 {not in Vi}
8139 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008140 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008141 Does not apply when the shell is used to expand wildcards, which
8142 happens when there are special characters.
8143
8144
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8146'wildmenu' 'wmnu' boolean (default off)
8147 global
8148 {not in Vi}
8149 {not available if compiled without the |+wildmenu|
8150 feature}
8151 When 'wildmenu' is on, command-line completion operates in an enhanced
8152 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8153 the possible matches are shown just above the command line, with the
8154 first match highlighted (overwriting the status line, if there is
8155 one). Keys that show the previous/next match, such as <Tab> or
8156 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8157 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8158 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008159 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008160 If there are more matches than can fit in the line, a ">" is shown on
8161 the right and/or a "<" is shown on the left. The status line scrolls
8162 as needed.
8163 The "wildmenu" mode is abandoned when a key is hit that is not used
8164 for selecting a completion.
8165 While the "wildmenu" is active the following keys have special
8166 meanings:
8167
8168 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8169 <Down> - in filename/menu name completion: move into a
8170 subdirectory or submenu.
8171 <CR> - in menu completion, when the cursor is just after a
8172 dot: move into a submenu.
8173 <Up> - in filename/menu name completion: move up into
8174 parent directory or parent menu.
8175
8176 This makes the menus accessible from the console |console-menus|.
8177
8178 If you prefer the <Left> and <Right> keys to move the cursor instead
8179 of selecting a different match, use this: >
8180 :cnoremap <Left> <Space><BS><Left>
8181 :cnoremap <Right> <Space><BS><Right>
8182<
8183 The "WildMenu" highlighting is used for displaying the current match
8184 |hl-WildMenu|.
8185
8186 *'wildmode'* *'wim'*
8187'wildmode' 'wim' string (Vim default: "full")
8188 global
8189 {not in Vi}
8190 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008191 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008192 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 first part specifies the behavior for the first use of 'wildchar',
8194 The second part for the second use, etc.
8195 These are the possible values for each part:
8196 "" Complete only the first match.
8197 "full" Complete the next full match. After the last match,
8198 the original string is used and then the first match
8199 again.
8200 "longest" Complete till longest common string. If this doesn't
8201 result in a longer string, use the next part.
8202 "longest:full" Like "longest", but also start 'wildmenu' if it is
8203 enabled.
8204 "list" When more than one match, list all matches.
8205 "list:full" When more than one match, list all matches and
8206 complete first match.
8207 "list:longest" When more than one match, list all matches and
8208 complete till longest common string.
8209 When there is only a single match, it is fully completed in all cases.
8210
8211 Examples: >
8212 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008213< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008214 :set wildmode=longest,full
8215< Complete longest common string, then each full match >
8216 :set wildmode=list:full
8217< List all matches and complete each full match >
8218 :set wildmode=list,full
8219< List all matches without completing, then each full match >
8220 :set wildmode=longest,list
8221< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008222 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008223
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008224 *'wildoptions'* *'wop'*
8225'wildoptions' 'wop' string (default "")
8226 global
8227 {not in Vi}
8228 {not available when compiled without the |+wildignore|
8229 feature}
8230 A list of words that change how command line completion is done.
8231 Currently only one word is allowed:
8232 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008233 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008234 is displayed per line. Often used tag kinds are:
8235 d #define
8236 f function
8237 Also see |cmdline-completion|.
8238
Bram Moolenaar071d4272004-06-13 20:20:40 +00008239 *'winaltkeys'* *'wak'*
8240'winaltkeys' 'wak' string (default "menu")
8241 global
8242 {not in Vi}
8243 {only used in Win32, Motif, GTK and Photon GUI}
8244 Some GUI versions allow the access to menu entries by using the ALT
8245 key in combination with a character that appears underlined in the
8246 menu. This conflicts with the use of the ALT key for mappings and
8247 entering special characters. This option tells what to do:
8248 no Don't use ALT keys for menus. ALT key combinations can be
8249 mapped, but there is no automatic handling. This can then be
8250 done with the |:simalt| command.
8251 yes ALT key handling is done by the windowing system. ALT key
8252 combinations cannot be mapped.
8253 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008254 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008255 keys can be mapped.
8256 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8257 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008258 This option is not used for <F10>; on Win32 and with GTK <F10> will
8259 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008260
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008261 *'window'* *'wi'*
8262'window' 'wi' number (default screen height - 1)
8263 global
8264 Window height. Do not confuse this with the height of the Vim window,
8265 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008266 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8267 value is smaller than 'lines' minus one. The screen will scroll
8268 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008269 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8270 in a much smarter way, taking care of wrapping lines.
8271 When resizing the Vim window, the value is smaller than 1 or more than
8272 or equal to 'lines' it will be set to 'lines' minus 1.
8273 {Vi also uses the option to specify the number of displayed lines}
8274
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 *'winheight'* *'wh'* *E591*
8276'winheight' 'wh' number (default 1)
8277 global
8278 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008279 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008280 feature}
8281 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008282 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008283 focus goes to a window that is smaller, its size is increased, at the
8284 cost of the height of other windows.
8285 Set 'winheight' to a small number for normal editing.
8286 Set it to 999 to make the current window fill most of the screen.
8287 Other windows will be only 'winminheight' high. This has the drawback
8288 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8289 to create only two windows, set the option after startup is done,
8290 using the |VimEnter| event: >
8291 au VimEnter * set winheight=999
8292< Minimum value is 1.
8293 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008294 height of the current window.
8295 'winheight' applies to the current window. Use 'winminheight' to set
8296 the minimal height for other windows.
8297
8298 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8299'winfixheight' 'wfh' boolean (default off)
8300 local to window
8301 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008302 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 feature}
8304 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008305 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8306 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 The height may be changed anyway when running out of room.
8308
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008309 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8310'winfixwidth' 'wfw' boolean (default off)
8311 local to window
8312 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008313 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008314 feature}
8315 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008316 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008317 The width may be changed anyway when running out of room.
8318
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 *'winminheight'* *'wmh'*
8320'winminheight' 'wmh' number (default 1)
8321 global
8322 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008323 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 feature}
8325 The minimal height of a window, when it's not the current window.
8326 This is a hard minimum, windows will never become smaller.
8327 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8328 status bar) if necessary. They will return to at least one line when
8329 they become active (since the cursor has to have somewhere to go.)
8330 Use 'winheight' to set the minimal height of the current window.
8331 This option is only checked when making a window smaller. Don't use a
8332 large number, it will cause errors when opening more than a few
8333 windows. A value of 0 to 3 is reasonable.
8334
8335 *'winminwidth'* *'wmw'*
8336'winminwidth' 'wmw' number (default 1)
8337 global
8338 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008339 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340 feature}
8341 The minimal width of a window, when it's not the current window.
8342 This is a hard minimum, windows will never become smaller.
8343 When set to zero, windows may be "squashed" to zero columns (i.e. just
8344 a vertical separator) if necessary. They will return to at least one
8345 line when they become active (since the cursor has to have somewhere
8346 to go.)
8347 Use 'winwidth' to set the minimal width of the current window.
8348 This option is only checked when making a window smaller. Don't use a
8349 large number, it will cause errors when opening more than a few
8350 windows. A value of 0 to 12 is reasonable.
8351
8352 *'winwidth'* *'wiw'* *E592*
8353'winwidth' 'wiw' number (default 20)
8354 global
8355 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008356 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 feature}
8358 Minimal number of columns for the current window. This is not a hard
8359 minimum, Vim will use fewer columns if there is not enough room. If
8360 the current window is smaller, its size is increased, at the cost of
8361 the width of other windows. Set it to 999 to make the current window
8362 always fill the screen. Set it to a small number for normal editing.
8363 The width is not adjusted after one of the commands to change the
8364 width of the current window.
8365 'winwidth' applies to the current window. Use 'winminwidth' to set
8366 the minimal width for other windows.
8367
8368 *'wrap'* *'nowrap'*
8369'wrap' boolean (default on)
8370 local to window
8371 {not in Vi}
8372 This option changes how text is displayed. It doesn't change the text
8373 in the buffer, see 'textwidth' for that.
8374 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008375 displaying continues on the next line. When off lines will not wrap
8376 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 moved to a part that is not shown, the screen will scroll
8378 horizontally.
8379 The line will be broken in the middle of a word if necessary. See
8380 'linebreak' to get the break at a word boundary.
8381 To make scrolling horizontally a bit more useful, try this: >
8382 :set sidescroll=5
8383 :set listchars+=precedes:<,extends:>
8384< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008385 This option can't be set from a |modeline| when the 'diff' option is
8386 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387
8388 *'wrapmargin'* *'wm'*
8389'wrapmargin' 'wm' number (default 0)
8390 local to buffer
8391 Number of characters from the right window border where wrapping
8392 starts. When typing text beyond this limit, an <EOL> will be inserted
8393 and inserting continues on the next line.
8394 Options that add a margin, such as 'number' and 'foldcolumn', cause
8395 the text width to be further reduced. This is Vi compatible.
8396 When 'textwidth' is non-zero, this option is not used.
8397 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8398 and less usefully}
8399
8400 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8401'wrapscan' 'ws' boolean (default on) *E384* *E385*
8402 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008403 Searches wrap around the end of the file. Also applies to |]s| and
8404 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405
8406 *'write'* *'nowrite'*
8407'write' boolean (default on)
8408 global
8409 {not in Vi}
8410 Allows writing files. When not set, writing a file is not allowed.
8411 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008412 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 argument. Filtering text is still possible, even though this requires
8414 writing a temporary file.
8415
8416 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8417'writeany' 'wa' boolean (default off)
8418 global
8419 Allows writing to any file with no need for "!" override.
8420
8421 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8422'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8423 otherwise)
8424 global
8425 {not in Vi}
8426 Make a backup before overwriting a file. The backup is removed after
8427 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008428 also on.
8429 WARNING: Switching this option off means that when Vim fails to write
8430 your buffer correctly and then, for whatever reason, Vim exits, you
8431 lose both the original file and what you were writing. Only reset
8432 this option if your file system is almost full and it makes the write
8433 fail (and make sure not to exit Vim until the write was successful).
8434 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 When the 'backupskip' pattern matches, a backup is not made anyway.
8436 NOTE: This option is set to the default value when 'compatible' is
8437 set.
8438
8439 *'writedelay'* *'wd'*
8440'writedelay' 'wd' number (default 0)
8441 global
8442 {not in Vi}
8443 The number of microseconds to wait for each character sent to the
8444 screen. When non-zero, characters are sent to the terminal one by
8445 one. For MS-DOS pcterm this does not work. For debugging purposes.
8446
8447 vim:tw=78:ts=8:ft=help:norl: