blob: 209e1ba87ffc3a84df135e44693a97292870cee2 [file] [log] [blame]
Bram Moolenaar86ae7202015-07-10 19:31:35 +02001*options.txt* For Vim version 7.4. Last change: 2015 Jul 10
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
Bram Moolenaar18400e62015-01-27 15:58:40 +010062 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000063 The old value can be inserted by typing 'wildchar' (by
64 default this is a <Tab> or CTRL-E if 'compatible' is
65 set). See |cmdline-completion|.
66 White space between {option} and '=' is allowed and
67 will be ignored. White space between '=' and {value}
68 is not allowed.
69 See |option-backslash| for using white space and
70 backslashes in {value}.
71
72:se[t] {option}+={value} *:set+=*
73 Add the {value} to a number option, or append the
74 {value} to a string option. When the option is a
75 comma separated list, a comma is added, unless the
76 value was empty.
77 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000078 are removed. When adding a flag that was already
79 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000080 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 {not in Vi}
82
83:se[t] {option}^={value} *:set^=*
84 Multiply the {value} to a number option, or prepend
85 the {value} to a string option. When the option is a
86 comma separated list, a comma is added, unless the
87 value was empty.
88 Also see |:set-args| above.
89 {not in Vi}
90
91:se[t] {option}-={value} *:set-=*
92 Subtract the {value} from a number option, or remove
93 the {value} from a string option, if it is there.
94 If the {value} is not found in a string option, there
95 is no error or warning. When the option is a comma
96 separated list, a comma is deleted, unless the option
97 becomes empty.
98 When the option is a list of flags, {value} must be
99 exactly as they appear in the option. Remove flags
100 one by one to avoid problems.
101 Also see |:set-args| above.
102 {not in Vi}
103
104The {option} arguments to ":set" may be repeated. For example: >
105 :set ai nosi sw=3 ts=3
106If you make an error in one of the arguments, an error message will be given
107and the following arguments will be ignored.
108
109 *:set-verbose*
110When 'verbose' is non-zero, displaying an option value will also tell where it
111was last set. Example: >
112 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000113< shiftwidth=4 ~
114 Last set from modeline ~
115 cindent ~
116 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
117This is only done when specific option values are requested, not for ":verbose
118set all" or ":verbose set" without an argument.
119When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120When the option was set while executing a function, user command or
121autocommand, the script in which it was defined is reported.
122Note that an option may also have been set as a side effect of setting
123'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000124A few special texts:
125 Last set from modeline ~
126 Option was set in a |modeline|.
127 Last set from --cmd argument ~
128 Option was set with command line argument |--cmd| or +.
129 Last set from -c argument ~
130 Option was set with command line argument |-c|, +, |-S| or
131 |-q|.
132 Last set from environment variable ~
133 Option was set from an environment variable, $VIMINIT,
134 $GVIMINIT or $EXINIT.
135 Last set from error handler ~
136 Option was cleared when evaluating it resulted in an error.
137
Bram Moolenaardb84e452010-08-15 13:50:43 +0200138{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139
140 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000141For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142override the value from the termcap. You can then use it in a mapping. If
143the "xx" part contains special characters, use the <t_xx> form: >
144 :set <t_#4>=^[Ot
145This can also be used to translate a special code for a normal key. For
146example, if Alt-b produces <Esc>b, use this: >
147 :set <M-b>=^[b
148(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
149The advantage over a mapping is that it works in all situations.
150
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100151You can define any key codes, e.g.: >
152 :set t_xy=^[foo;
153There is no warning for using a name that isn't recognized. You can map these
154codes as you like: >
155 :map <t_xy> something
156< *E846*
157When a key code is not set, it's like it does not exist. Trying to get its
158value will result in an error: >
159 :set t_kb=
160 :set t_kb
161 E846: Key code not set: t_kb
162
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000163The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
164security reasons.
165
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000167at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168"set all" probably does not fit on the screen, causing Vim to give the
169|more-prompt|.
170
171 *option-backslash*
172To include white space in a string option value it has to be preceded with a
173backslash. To include a backslash you have to use two. Effectively this
174means that the number of backslashes in an option value is halved (rounded
175down).
176A few examples: >
177 :set tags=tags\ /usr/tags results in "tags /usr/tags"
178 :set tags=tags\\,file results in "tags\,file"
179 :set tags=tags\\\ file results in "tags\ file"
180
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181The "|" character separates a ":set" command from a following command. To
182include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183'titlestring' option to "hi|there": >
184 :set titlestring=hi\|there
185This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
186 :set titlestring=hi|set iconstring=there
187
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000188Similarly, the double quote character starts a comment. To include the '"' in
189the option value, use '\"' instead. This example sets the 'titlestring'
190option to 'hi "there"': >
191 :set titlestring=hi\ \"there\"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194precise: For options that expect a file name (those where environment
195variables are expanded) a backslash before a normal file name character is not
196removed. But a backslash before a special character (space, backslash, comma,
197etc.) is used like explained above.
198There is one special situation, when the value starts with "\\": >
199 :set dir=\\machine\path results in "\\machine\path"
200 :set dir=\\\\machine\\path results in "\\machine\path"
201 :set dir=\\path\\file results in "\\path\file" (wrong!)
202For the first one the start is kept, but for the second one the backslashes
203are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000204halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205result which is probably not what you want. Avoid it.
206
207 *add-option-flags* *remove-option-flags*
208 *E539* *E550* *E551* *E552*
209Some options are a list of flags. When you want to add a flag to such an
210option, without changing the existing ones, you can do it like this: >
211 :set guioptions+=a
212Remove a flag from an option like this: >
213 :set guioptions-=a
214This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000215Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
217doesn't appear.
218
219 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000220Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221environment variable exists the '$' and the following environment variable
222name is replaced with its value. If it does not exist the '$' and the name
223are not modified. Any non-id character (not a letter, digit or '_') may
224follow the environment variable name. That character and what follows is
225appended to the value of the environment variable. Examples: >
226 :set term=$TERM.new
227 :set path=/usr/$INCLUDE,$HOME/include,.
228When adding or removing a string from an option with ":set opt-=val" or ":set
229opt+=val" the expansion is done before the adding or removing.
230
231
232Handling of local options *local-options*
233
234Some of the options only apply to a window or buffer. Each window or buffer
235has its own copy of this option, thus can each have their own value. This
236allows you to set 'list' in one window but not in another. And set
237'shiftwidth' to 3 in one buffer and 4 in another.
238
239The following explains what happens to these local options in specific
240situations. You don't really need to know all of this, since Vim mostly uses
241the option values you would expect. Unfortunately, doing what the user
242expects is a bit complicated...
243
244When splitting a window, the local options are copied to the new window. Thus
245right after the split the contents of the two windows look the same.
246
247When editing a new buffer, its local option values must be initialized. Since
248the local options of the current buffer might be specifically for that buffer,
249these are not used. Instead, for each buffer-local option there also is a
250global value, which is used for new buffers. With ":set" both the local and
251global value is changed. With "setlocal" only the local value is changed,
252thus this value is not used when editing a new buffer.
253
254When editing a buffer that has been edited before, the last used window
255options are used again. If this buffer has been edited in this window, the
256values from back then are used. Otherwise the values from the window where
257the buffer was edited last are used.
258
259It's possible to set a local window option specifically for a type of buffer.
260When you edit another buffer in the same window, you don't want to keep
261using these local window options. Therefore Vim keeps a global value of the
262local window options, which is used when editing another buffer. Each window
263has its own copy of these values. Thus these are local to the window, but
264global to all buffers in the window. With this you can do: >
265 :e one
266 :set list
267 :e two
268Now the 'list' option will also be set in "two", since with the ":set list"
269command you have also set the global value. >
270 :set nolist
271 :e one
272 :setlocal list
273 :e two
274Now the 'list' option is not set, because ":set nolist" resets the global
275value, ":setlocal list" only changes the local value and ":e two" gets the
276global value. Note that if you do this next: >
277 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200278You will get back the 'list' value as it was the last time you edited "one".
279The options local to a window are remembered for each buffer. This also
280happens when the buffer is not loaded, but they are lost when the buffer is
281wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100304:se[t] {option}< For |global-local| options: Remove the local value of
305 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {not in Vi}
307
308 *:setg* *:setglobal*
309:setg[lobal] ... Like ":set" but set only the global value for a local
310 option without changing the local value.
311 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200312 With the "all" argument: display global values for all
313 local options.
314 Without argument: display global values for all local
315 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318For buffer-local and window-local options:
319 Command global value local value ~
320 :set option=value set set
321 :setlocal option=value - set
322:setglobal option=value set -
323 :set option? - display
324 :setlocal option? - display
325:setglobal option? display -
326
327
328Global options with a local value *global-local*
329
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000330Options are global when you mostly use one value for all buffers and windows.
331For some global options it's useful to sometimes have a different local value.
332You can set the local value with ":setlocal". That buffer or window will then
333use the local value, while other buffers and windows continue using the global
334value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336For example, you have two windows, both on C source code. They use the global
337'makeprg' option. If you do this in one of the two windows: >
338 :set makeprg=gmake
339then the other window will switch to the same value. There is no need to set
340the 'makeprg' option in the other C source window too.
341However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000342another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000343files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 :setlocal makeprg=perlmake
345You can switch back to using the global value by making the local value empty: >
346 :setlocal makeprg=
347This only works for a string option. For a boolean option you need to use the
348"<" flag, like this: >
349 :setlocal autoread<
350Note that for non-boolean options using "<" copies the global value to the
351local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000352when the global value changes later). You can also use: >
353 :set path<
354This will make the local value of 'path' empty, so that the global value is
355used. Thus it does the same as: >
356 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357Note: In the future more global options can be made global-local. Using
358":setlocal" on a global option might work differently then.
359
360
361Setting the filetype
362
363:setf[iletype] {filetype} *:setf* *:setfiletype*
364 Set the 'filetype' option to {filetype}, but only if
365 not done yet in a sequence of (nested) autocommands.
366 This is short for: >
367 :if !did_filetype()
368 : setlocal filetype={filetype}
369 :endif
370< This command is used in a filetype.vim file to avoid
371 setting the 'filetype' option twice, causing different
372 settings and syntax files to be loaded.
373 {not in Vi}
374
Bram Moolenaard58e9292011-02-09 17:07:58 +0100375 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
377:opt[ions] Open a window for viewing and setting all options.
378 Options are grouped by function.
379 Offers short help for each option. Hit <CR> on the
380 short help to open a help window with more help for
381 the option.
382 Modify the value of the option and hit <CR> on the
383 "set" line to set the new value. For window and
384 buffer specific options, the last accessed window is
385 used to set the option value in, unless this is a help
386 window, in which case the window below help window is
387 used (skipping the option-window).
388 {not available when compiled without the |+eval| or
389 |+autocmd| features}
390
391 *$HOME*
392Using "~" is like using "$HOME", but it is only recognized at the start of an
393option and after a space or comma.
394
395On Unix systems "~user" can be used too. It is replaced by the home directory
396of user "user". Example: >
397 :set path=~mool/include,/usr/include,.
398
399On Unix systems the form "${HOME}" can be used too. The name between {} can
400contain non-id characters then. Note that if you want to use this for the
401"gf" command, you need to add the '{' and '}' characters to 'isfname'.
402
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100403On MS-Windows, if $HOME is not defined as an environment variable, then
404at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406NOTE: expanding environment variables and "~/" is only done with the ":set"
407command, not when assigning a value to an option with ":let".
408
409
410Note the maximum length of an expanded option is limited. How much depends on
411the system, mostly it is something like 256 or 1024 characters.
412
413 *:fix* *:fixdel*
414:fix[del] Set the value of 't_kD':
415 't_kb' is 't_kD' becomes ~
416 CTRL-? CTRL-H
417 not CTRL-? CTRL-?
418
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
420
421 If your delete key terminal code is wrong, but the
422 code for backspace is alright, you can put this in
423 your .vimrc: >
424 :fixdel
425< This works no matter what the actual code for
426 backspace is.
427
428 If the backspace key terminal code is wrong you can
429 use this: >
430 :if &term == "termname"
431 : set t_kb=^V<BS>
432 : fixdel
433 :endif
434< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000435 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 with your terminal name.
437
438 If your <Delete> key sends a strange key sequence (not
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
440 :if &term == "termname"
441 : set t_kD=^V<Delete>
442 :endif
443< Where "^V" is CTRL-V and "<Delete>" is the delete key
444 (don't type eight characters!). Replace "termname"
445 with your terminal name.
446
447 *Linux-backspace*
448 Note about Linux: By default the backspace key
449 produces CTRL-?, which is wrong. You can fix it by
450 putting this line in your rc.local: >
451 echo "keycode 14 = BackSpace" | loadkeys
452<
453 *NetBSD-backspace*
454 Note about NetBSD: If your backspace doesn't produce
455 the right code, try this: >
456 xmodmap -e "keycode 22 = BackSpace"
457< If this works, add this in your .Xmodmap file: >
458 keysym 22 = BackSpace
459< You need to restart for this to take effect.
460
461==============================================================================
4622. Automatically setting options *auto-setting*
463
464Besides changing options with the ":set" command, there are three alternatives
465to set options automatically for one or more files:
466
4671. When starting Vim initializations are read from various places. See
468 |initialization|. Most of them are performed for all editing sessions,
469 and some of them depend on the directory where Vim is started.
470 You can create an initialization file with |:mkvimrc|, |:mkview| and
471 |:mksession|.
4722. If you start editing a new file, the automatic commands are executed.
473 This can be used to set options for files matching a particular pattern and
474 many other things. See |autocommand|.
4753. If you start editing a new file, and the 'modeline' option is on, a
476 number of lines at the beginning and end of the file are checked for
477 modelines. This is explained here.
478
479 *modeline* *vim:* *vi:* *ex:* *E520*
480There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200481 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200486[white] optional white space
487{options} a list of option settings, separated with white space
488 or ':', where each part between ':' is the argument
489 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494
495The second form (this is compatible with some versions of Vi):
496
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200497 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499[text] any text or empty
500{white} at least one blank character (<Space> or <Tab>)
501{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
502[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503se[t] the string "set " or "se " (note the space); When
504 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200505{options} a list of options, separated with white space, which
506 is the argument for a ":set" command
507: a colon
508[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000511 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
515chance that a normal word like "lex:" is caught. There is one exception:
516"vi:" and "vim:" can also be at the start of the line (for compatibility with
517version 3.0). Using "ex:" at the start of the line will be ignored (this
518could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
520 *modeline-local*
521The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000522buffer and window that contain the file. Although it's possible to set global
523options from a modeline, this is unusual. If you have two windows open and
524the files in it set the same global option to a different value, the result
525depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000527When editing a file that was already loaded, only the window-local options
528from the modeline are used. Thus if you manually changed a buffer-local
529option after opening the file, it won't be changed if you edit the same buffer
530in another window. But window-local options will be set.
531
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 *modeline-version*
533If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200534number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535 vim{vers}: version {vers} or later
536 vim<{vers}: version before {vers}
537 vim={vers}: version {vers}
538 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100539{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
540For example, to use a modeline only for Vim 7.0:
541 /* vim700: set foldmethod=marker */ ~
542To use a modeline for Vim after version 7.2:
543 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544There can be no blanks between "vim" and the ":".
545
546
547The number of lines that are checked can be set with the 'modelines' option.
548If 'modeline' is off or 'modelines' is 0 no lines are checked.
549
550Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000551like:
552 /* vi:ts=4: */ ~
553will give an error message for the trailing "*/". This line is OK:
554 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555
556If an error is detected the rest of the line is skipped.
557
558If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000559backslash in front of the ':' will be removed. Example:
560 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561This sets the 'dir' option to "c:\tmp". Only a single backslash before the
562':' is removed. Thus to include "\:" you have to specify "\\:".
563
564No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565might create a Trojan horse text file with modelines). And not all options
566can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000567|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000568causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
569are wrapped unexpectedly. So disable modelines before editing untrusted text.
570The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571
572Hint: If you would like to do something else than setting an option, you could
573define an autocommand that checks the file for a specific string. For
574example: >
575 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
576And define a function SetVar() that does something with the line containing
577"VAR".
578
579==============================================================================
5803. Options summary *option-summary*
581
582In the list below all the options are mentioned with their full name and with
583an abbreviation if there is one. Both forms may be used.
584
585In this document when a boolean option is "set" that means that ":set option"
586is entered. When an option is "reset", ":set nooption" is used.
587
588For some options there are two default values: The "Vim default", which is
589used when 'compatible' is not set, and the "Vi default", which is used when
590'compatible' is set.
591
592Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594different value in each window. For example the 'list' option can be set in
595one window and reset in another for the same text, giving both types of view
596at the same time. There are a few options that are specific to a certain
597file. These can have a different value for each file or buffer. For example
598the 'textwidth' option can be 78 for a normal text file and 0 for a C
599program.
600
601 global one option for all buffers and windows
602 local to window each window has its own copy of this option
603 local to buffer each buffer has its own copy of this option
604
605When creating a new window the option values from the currently active window
606are used as a default value for the window-specific options. For the
607buffer-specific options this depends on the 's' and 'S' flags in the
608'cpoptions' option. If 's' is included (which is the default) the values for
609buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000610first entered. If 'S' is present the options are copied each time the buffer
611is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612present, the options are copied from the currently active buffer when the
613buffer is created.
614
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000615Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Not all options are supported in all versions. This depends on the supported
618features and sometimes on the system. A remark about this is in curly braces
619below. When an option is not supported it may still be set without getting an
620error, this is called a hidden option. You can't get the value of a hidden
621option though, it is not stored.
622
623To test if option "foo" can be used with ":set" use something like this: >
624 if exists('&foo')
625This also returns true for a hidden option. To test if option "foo" is really
626supported use something like this: >
627 if exists('+foo')
628<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 *E355*
630A jump table for the options with a short description can be found at |Q_op|.
631
632 *'aleph'* *'al'* *aleph* *Aleph*
633'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
634 global
635 {not in Vi}
636 {only available when compiled with the |+rightleft|
637 feature}
638 The ASCII code for the first letter of the Hebrew alphabet. The
639 routine that maps the keyboard in Hebrew mode, both in Insert mode
640 (when hkmap is set) and on the command-line (when hitting CTRL-_)
641 outputs the Hebrew characters in the range [aleph..aleph+26].
642 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
643 See |rileft.txt|.
644
645 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
646'allowrevins' 'ari' boolean (default off)
647 global
648 {not in Vi}
649 {only available when compiled with the |+rightleft|
650 feature}
651 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
652 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
653 into reverse Insert mode, and don't know how to get out. See
654 'revins'.
655 NOTE: This option is reset when 'compatible' is set.
656
657 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
658'altkeymap' 'akm' boolean (default off)
659 global
660 {not in Vi}
661 {only available when compiled with the |+farsi|
662 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 the keyboard map between Farsi and English, when 'allowrevins' set.
665
Bram Moolenaar582fd852005-03-28 20:58:01 +0000666 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 is useful to start the Vim in native mode i.e. English (left-to-right
668 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000669 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670
671 *'ambiwidth'* *'ambw'*
672'ambiwidth' 'ambw' string (default: "single")
673 global
674 {not in Vi}
675 {only available when compiled with the |+multi_byte|
676 feature}
677 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
678 Tells Vim what to do with characters with East Asian Width Class
679 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
680 letters, Cyrillic letters).
681
682 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000683 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 expected by most users.
685 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200686 *E834* *E835*
687 The value "double" cannot be used if 'listchars' or 'fillchars'
688 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 There are a number of CJK fonts for which the width of glyphs for
691 those characters are solely based on how many octets they take in
692 legacy/traditional CJK encodings. In those encodings, Euro,
693 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 Vim is running inside a terminal (emulators) that uses a CJK font
698 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
699 this option should be set to "double" to match the width perceived
700 by Vim with the width of glyphs in the font. Perhaps it also has
701 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
702 when the system locale is set to one of CJK locales. See Unicode
703 Standard Annex #11 (http://www.unicode.org/reports/tr11).
704
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100705 Vim may set this option automatically at startup time when Vim is
706 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200707 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100708
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
710'antialias' 'anti' boolean (default: off)
711 global
712 {not in Vi}
713 {only available when compiled with GUI enabled
714 on Mac OS X}
715 This option only has an effect in the GUI version of Vim on Mac OS X
716 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
717 which can be easier to read at certain sizes on certain displays.
718 Setting this option can sometimes cause problems if 'guifont' is set
719 to its default (empty string).
720
721 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
722'autochdir' 'acd' boolean (default off)
723 global
724 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200725 {only available when compiled with it, use
726 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000727 When on, Vim will change the current working directory whenever you
728 open a file, switch buffers, delete a buffer or open/close a window.
729 It will change to the directory containing the file which was opened
730 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000731 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
734'arabic' 'arab' boolean (default off)
735 local to window
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 This option can be set to start editing Arabic text.
740 Setting this option will:
741 - Set the 'rightleft' option, unless 'termbidi' is set.
742 - Set the 'arabicshape' option, unless 'termbidi' is set.
743 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
744 between typing English and Arabic key mapping.
745 - Set the 'delcombine' option
746 Note that 'encoding' must be "utf-8" for working with Arabic text.
747
748 Resetting this option will:
749 - Reset the 'rightleft' option.
750 - Disable the use of 'keymap' (without changing its value).
751 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200752 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 Also see |arabic.txt|.
754
755 *'arabicshape'* *'arshape'*
756 *'noarabicshape'* *'noarshape'*
757'arabicshape' 'arshape' boolean (default on)
758 global
759 {not in Vi}
760 {only available when compiled with the |+arabic|
761 feature}
762 When on and 'termbidi' is off, the required visual character
763 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200764 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 one which encompasses:
766 a) the changing/morphing of characters based on their location
767 within a word (initial, medial, final and stand-alone).
768 b) the enabling of the ability to compose characters
769 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100770 When disabled the display shows each character's true stand-alone
771 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Arabic is a complex language which requires other settings, for
773 further details see |arabic.txt|.
774
775 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
776'autoindent' 'ai' boolean (default off)
777 local to buffer
778 Copy indent from current line when starting a new line (typing <CR>
779 in Insert mode or when using the "o" or "O" command). If you do not
780 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000781 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
782 to another line has the same effect, unless the 'I' flag is included
783 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000784 When autoindent is on, formatting (with the "gq" command or when you
785 reach 'textwidth' in Insert mode) uses the indentation of the first
786 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 When 'smartindent' or 'cindent' is on the indent is changed in
788 a different way.
789 The 'autoindent' option is reset when the 'paste' option is set.
790 {small difference from Vi: After the indent is deleted when typing
791 <Esc> or <CR>, the cursor position when moving up or down is after the
792 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
793
794 *'autoread'* *'ar'* *'noautoread'* *'noar'*
795'autoread' 'ar' boolean (default off)
796 global or local to buffer |global-local|
797 {not in Vi}
798 When a file has been detected to have been changed outside of Vim and
799 it has not been changed inside of Vim, automatically read it again.
800 When the file has been deleted this is not done. |timestamp|
801 If this option has a local value, use this command to switch back to
802 using the global value: >
803 :set autoread<
804<
805 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
806'autowrite' 'aw' boolean (default off)
807 global
808 Write the contents of the file, if it has been modified, on each
809 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000810 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
812 Note that for some commands the 'autowrite' option is not used, see
813 'autowriteall' for that.
814
815 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
816'autowriteall' 'awa' boolean (default off)
817 global
818 {not in Vi}
819 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
820 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
821 Setting this option also implies that Vim behaves like 'autowrite' has
822 been set.
823
824 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200825'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 global
827 {not in Vi}
828 When set to "dark", Vim will try to use colors that look good on a
829 dark background. When set to "light", Vim will try to use colors that
830 look good on a light background. Any other value is illegal.
831 Vim tries to set the default value according to the terminal used.
832 This will not always be correct.
833 Setting this option does not change the background color, it tells Vim
834 what the background color looks like. For changing the background
835 color, see |:hi-normal|.
836
837 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000838 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000839 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100840 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 setting 'background' will cause the color scheme to be reloaded. If
842 the color scheme adjusts to the value of 'background' this will work.
843 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 When setting 'background' to the default value with: >
847 :set background&
848< Vim will guess the value. In the GUI this should work correctly,
849 in other cases Vim might not be able to guess the right value.
850
851 When starting the GUI, the default value for 'background' will be
852 "light". When the value is not set in the .gvimrc, and Vim detects
853 that the background is actually quite dark, 'background' is set to
854 "dark". But this happens only AFTER the .gvimrc file has been read
855 (because the window needs to be opened to find the actual background
856 color). To get around this, force the GUI window to be opened by
857 putting a ":gui" command in the .gvimrc file, before where the value
858 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200859
860 For MS-DOS, Windows and OS/2 the default is "dark".
861 For other systems "dark" is used when 'term' is "linux",
862 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
863 background. Otherwise the default is "light".
864
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 Normally this option would be set in the .vimrc file. Possibly
866 depending on the terminal name. Example: >
867 :if &term == "pcterm"
868 : set background=dark
869 :endif
870< When this option is set, the default settings for the highlight groups
871 will change. To use other settings, place ":highlight" commands AFTER
872 the setting of the 'background' option.
873 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
874 to select the colors for syntax highlighting. After changing this
875 option, you must load syntax.vim again to see the result. This can be
876 done with ":syntax on".
877
878 *'backspace'* *'bs'*
879'backspace' 'bs' string (default "")
880 global
881 {not in Vi}
882 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
883 mode. This is a list of items, separated by commas. Each item allows
884 a way to backspace over something:
885 value effect ~
886 indent allow backspacing over autoindent
887 eol allow backspacing over line breaks (join lines)
888 start allow backspacing over the start of insert; CTRL-W and CTRL-U
889 stop once at the start of insert.
890
891 When the value is empty, Vi compatible backspacing is used.
892
893 For backwards compatibility with version 5.4 and earlier:
894 value effect ~
895 0 same as ":set backspace=" (Vi compatible)
896 1 same as ":set backspace=indent,eol"
897 2 same as ":set backspace=indent,eol,start"
898
899 See |:fixdel| if your <BS> or <Del> key does not do what you want.
900 NOTE: This option is set to "" when 'compatible' is set.
901
902 *'backup'* *'bk'* *'nobackup'* *'nobk'*
903'backup' 'bk' boolean (default off)
904 global
905 {not in Vi}
906 Make a backup before overwriting a file. Leave it around after the
907 file has been successfully written. If you do not want to keep the
908 backup file, but you do want a backup while the file is being
909 written, reset this option and set the 'writebackup' option (this is
910 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 |backup-table| for more explanations.
913 When the 'backupskip' pattern matches, a backup is not made anyway.
914 When 'patchmode' is set, the backup may be renamed to become the
915 oldest version of a file.
916 NOTE: This option is reset when 'compatible' is set.
917
918 *'backupcopy'* *'bkc'*
919'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200920 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 {not in Vi}
922 When writing a file and a backup is made, this option tells how it's
923 done. This is a comma separated list of words.
924
925 The main values are:
926 "yes" make a copy of the file and overwrite the original one
927 "no" rename the file and write a new one
928 "auto" one of the previous, what works best
929
930 Extra values that can be combined with the ones above are:
931 "breaksymlink" always break symlinks when writing
932 "breakhardlink" always break hardlinks when writing
933
934 Making a copy and overwriting the original file:
935 - Takes extra time to copy the file.
936 + When the file has special attributes, is a (hard/symbolic) link or
937 has a resource fork, all this is preserved.
938 - When the file is a link the backup will have the name of the link,
939 not of the real file.
940
941 Renaming the file and writing a new one:
942 + It's fast.
943 - Sometimes not all attributes of the file can be copied to the new
944 file.
945 - When the file is a link the new file will not be a link.
946
947 The "auto" value is the middle way: When Vim sees that renaming file
948 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000949 the file is not a link) that is used. When problems are expected, a
950 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952 The "breaksymlink" and "breakhardlink" values can be used in
953 combination with any of "yes", "no" and "auto". When included, they
954 force Vim to always break either symbolic or hard links by doing
955 exactly what the "no" option does, renaming the original file to
956 become the backup and writing a new file in its place. This can be
957 useful for example in source trees where all the files are symbolic or
958 hard links and any changes should stay in the local source tree, not
959 be propagated back to the original source.
960 *crontab*
961 One situation where "no" and "auto" will cause problems: A program
962 that opens a file, invokes Vim to edit that file, and then tests if
963 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000964 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 example.
966
967 When a copy is made, the original file is truncated and then filled
968 with the new text. This means that protection bits, owner and
969 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000970 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 group of the backup is set to the group of the original file. If this
972 fails, the protection bits for the group are made the same as for
973 others.
974
975 When the file is renamed this is the other way around: The backup has
976 the same attributes of the original file, and the newly written file
977 is owned by the current user. When the file was a (hard/symbolic)
978 link, the new file will not! That's why the "auto" value doesn't
979 rename when the file is a link. The owner and group of the newly
980 written file will be set to the same ones as the original file, but
981 the system may refuse to do this. In that case the "auto" value will
982 again not rename the file.
983
984 *'backupdir'* *'bdir'*
985'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100986 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 for Unix: ".,~/tmp,~/")
988 global
989 {not in Vi}
990 List of directories for the backup file, separated with commas.
991 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100992 where this is possible. The directory must exist, Vim will not
993 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100994 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 impossible!). Writing may fail because of this.
996 - A directory "." means to put the backup file in the same directory
997 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000998 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 put the backup file relative to where the edited file is. The
1000 leading "." is replaced with the path name of the edited file.
1001 ("." inside a directory name has no special meaning).
1002 - Spaces after the comma are ignored, other spaces are considered part
1003 of the directory name. To have a space at the start of a directory
1004 name, precede it with a backslash.
1005 - To include a comma in a directory name precede it with a backslash.
1006 - A directory name may end in an '/'.
1007 - Environment variables are expanded |:set_env|.
1008 - Careful with '\' characters, type one before a space, type two to
1009 get one in the option (see |option-backslash|), for example: >
1010 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1011< - For backwards compatibility with Vim version 3.0 a '>' at the start
1012 of the option is removed.
1013 See also 'backup' and 'writebackup' options.
1014 If you want to hide your backup files on Unix, consider this value: >
1015 :set backupdir=./.backup,~/.backup,.,/tmp
1016< You must create a ".backup" directory in each directory and in your
1017 home directory for this to work properly.
1018 The use of |:set+=| and |:set-=| is preferred when adding or removing
1019 directories from the list. This avoids problems when a future version
1020 uses another default.
1021 This option cannot be set from a |modeline| or in the |sandbox|, for
1022 security reasons.
1023
1024 *'backupext'* *'bex'* *E589*
1025'backupext' 'bex' string (default "~", for VMS: "_")
1026 global
1027 {not in Vi}
1028 String which is appended to a file name to make the name of the
1029 backup file. The default is quite unusual, because this avoids
1030 accidentally overwriting existing files with a backup file. You might
1031 prefer using ".bak", but make sure that you don't have files with
1032 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001033 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001035 If you like to keep a lot of backups, you could use a BufWritePre
1036 autocommand to change 'backupext' just before writing the file to
1037 include a timestamp. >
1038 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1039< Use 'backupdir' to put the backup in a different directory.
1040
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 *'backupskip'* *'bsk'*
1042'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1043 global
1044 {not in Vi}
1045 {not available when compiled without the |+wildignore|
1046 feature}
1047 A list of file patterns. When one of the patterns matches with the
1048 name of the file which is written, no backup file is created. Both
1049 the specified file name and the full path name of the file are used.
1050 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1051 Watch out for special characters, see |option-backslash|.
1052 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001053 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001054
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001055 WARNING: Not having a backup file means that when Vim fails to write
1056 your buffer correctly and then, for whatever reason, Vim exits, you
1057 lose both the original file and what you were writing. Only disable
1058 backups if you don't care about losing the file.
1059
Bram Moolenaar02467872007-05-06 13:22:01 +00001060 Note that environment variables are not expanded. If you want to use
1061 $HOME you must expand it explicitly, e.g.: >
1062 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1063
1064< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001065 backup would be made by renaming the original file crontab won't see
1066 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
1068 *'balloondelay'* *'bdlay'*
1069'balloondelay' 'bdlay' number (default: 600)
1070 global
1071 {not in Vi}
1072 {only available when compiled with the |+balloon_eval|
1073 feature}
1074 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1075
1076 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1077'ballooneval' 'beval' boolean (default off)
1078 global
1079 {not in Vi}
1080 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001081 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 Switch on the |balloon-eval| functionality.
1083
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001084 *'balloonexpr'* *'bexpr'*
1085'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001086 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001087 {not in Vi}
1088 {only available when compiled with the |+balloon_eval|
1089 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001090 Expression for text to show in evaluation balloon. It is only used
1091 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001092
1093 v:beval_bufnr number of the buffer in which balloon is going to show
1094 v:beval_winnr number of the window
1095 v:beval_lnum line number
1096 v:beval_col column number (byte index)
1097 v:beval_text word under or after the mouse pointer
1098
1099 The evaluation of the expression must not have side effects!
1100 Example: >
1101 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001102 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001103 \', column ' . v:beval_col .
1104 \ ' of file ' . bufname(v:beval_bufnr) .
1105 \ ' on word "' . v:beval_text . '"'
1106 endfunction
1107 set bexpr=MyBalloonExpr()
1108 set ballooneval
1109<
1110 NOTE: The balloon is displayed only if the cursor is on a text
1111 character. If the result of evaluating 'balloonexpr' is not empty,
1112 Vim does not try to send a message to an external debugger (Netbeans
1113 or Sun Workshop).
1114
Bram Moolenaar30b65812012-07-12 22:01:11 +02001115 The expression will be evaluated in the |sandbox| when set from a
1116 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001117
1118 It is not allowed to change text or jump to another window while
1119 evaluating 'balloonexpr' |textlock|.
1120
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001121 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001122 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001123< When they are supported "\n" characters will start a new line. If the
1124 expression evaluates to a |List| this is equal to using each List item
1125 as a string and putting "\n" in between them.
1126
Bram 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 Moolenaar2b8388b2015-02-28 13:11:45 +01001319 both: When using ":e bufname" and already editing "bufname"
1320 the buffer is made empty and autocommands are
1321 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001322 *E676*
1323 "acwrite" implies that the buffer name is not related to a file, like
1324 "nofile", but it will be written. Thus, in contrast to "nofile" and
1325 "nowrite", ":w" does work and a modified buffer can't be abandoned
1326 without saving. For writing there must be matching |BufWriteCmd|,
1327 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328
1329 *'casemap'* *'cmp'*
1330'casemap' 'cmp' string (default: "internal,keepascii")
1331 global
1332 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001333 {only available when compiled with the |+multi_byte|
1334 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 Specifies details about changing the case of letters. It may contain
1336 these words, separated by a comma:
1337 internal Use internal case mapping functions, the current
1338 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001339 matters when 'encoding' is a Unicode encoding,
1340 "latin1" or "iso-8859-15". When "internal" is
1341 omitted, the towupper() and towlower() system library
1342 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1344 case mapping, the current locale is not effective.
1345 This probably only matters for Turkish.
1346
1347 *'cdpath'* *'cd'* *E344* *E346*
1348'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1349 global
1350 {not in Vi}
1351 {not available when compiled without the
1352 |+file_in_path| feature}
1353 This is a list of directories which will be searched when using the
1354 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001355 for has a relative path, not an absolute part starting with "/", "./"
1356 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 The 'cdpath' option's value has the same form and semantics as
1358 |'path'|. Also see |file-searching|.
1359 The default value is taken from $CDPATH, with a "," prepended to look
1360 in the current directory first.
1361 If the default value taken from $CDPATH is not what you want, include
1362 a modified version of the following command in your vimrc file to
1363 override it: >
1364 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1365< This option cannot be set from a |modeline| or in the |sandbox|, for
1366 security reasons.
1367 (parts of 'cdpath' can be passed to the shell to expand file names).
1368
1369 *'cedit'*
1370'cedit' string (Vi default: "", Vim default: CTRL-F)
1371 global
1372 {not in Vi}
1373 {not available when compiled without the |+vertsplit|
1374 feature}
1375 The key used in Command-line Mode to open the command-line window.
1376 The default is CTRL-F when 'compatible' is off.
1377 Only non-printable keys are allowed.
1378 The key can be specified as a single character, but it is difficult to
1379 type. The preferred way is to use the <> notation. Examples: >
1380 :set cedit=<C-Y>
1381 :set cedit=<Esc>
1382< |Nvi| also has this option, but it only uses the first character.
1383 See |cmdwin|.
1384
1385 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1386'charconvert' 'ccv' string (default "")
1387 global
1388 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001389 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 {not in Vi}
1391 An expression that is used for character encoding conversion. It is
1392 evaluated when a file that is to be read or has been written has a
1393 different encoding from what is desired.
1394 'charconvert' is not used when the internal iconv() function is
1395 supported and is able to do the conversion. Using iconv() is
1396 preferred, because it is much faster.
1397 'charconvert' is not used when reading stdin |--|, because there is no
1398 file to convert from. You will have to save the text in a file first.
1399 The expression must return zero or an empty string for success,
1400 non-zero for failure.
1401 The possible encoding names encountered are in 'encoding'.
1402 Additionally, names given in 'fileencodings' and 'fileencoding' are
1403 used.
1404 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1405 is done internally by Vim, 'charconvert' is not used for this.
1406 'charconvert' is also used to convert the viminfo file, if the 'c'
1407 flag is present in 'viminfo'. Also used for Unicode conversion.
1408 Example: >
1409 set charconvert=CharConvert()
1410 fun CharConvert()
1411 system("recode "
1412 \ . v:charconvert_from . ".." . v:charconvert_to
1413 \ . " <" . v:fname_in . " >" v:fname_out)
1414 return v:shell_error
1415 endfun
1416< The related Vim variables are:
1417 v:charconvert_from name of the current encoding
1418 v:charconvert_to name of the desired encoding
1419 v:fname_in name of the input file
1420 v:fname_out name of the output file
1421 Note that v:fname_in and v:fname_out will never be the same.
1422 Note that v:charconvert_from and v:charconvert_to may be different
1423 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1424 Encryption is not done by Vim when using 'charconvert'. If you want
1425 to encrypt the file after conversion, 'charconvert' should take care
1426 of this.
1427 This option cannot be set from a |modeline| or in the |sandbox|, for
1428 security reasons.
1429
1430 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1431'cindent' 'cin' boolean (default off)
1432 local to buffer
1433 {not in Vi}
1434 {not available when compiled without the |+cindent|
1435 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001436 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001437 that trigger reindenting in insert mode and 'cinoptions' to set your
1438 preferred indent style.
1439 If 'indentexpr' is not empty, it overrules 'cindent'.
1440 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1441 the "=" operator indents using this algorithm rather than calling an
1442 external program.
1443 See |C-indenting|.
1444 When you don't like the way 'cindent' works, try the 'smartindent'
1445 option or 'indentexpr'.
1446 This option is not used when 'paste' is set.
1447 NOTE: This option is reset when 'compatible' is set.
1448
1449 *'cinkeys'* *'cink'*
1450'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1451 local to buffer
1452 {not in Vi}
1453 {not available when compiled without the |+cindent|
1454 feature}
1455 A list of keys that, when typed in Insert mode, cause reindenting of
1456 the current line. Only used if 'cindent' is on and 'indentexpr' is
1457 empty.
1458 For the format of this option see |cinkeys-format|.
1459 See |C-indenting|.
1460
1461 *'cinoptions'* *'cino'*
1462'cinoptions' 'cino' string (default "")
1463 local to buffer
1464 {not in Vi}
1465 {not available when compiled without the |+cindent|
1466 feature}
1467 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1468 program. See |cinoptions-values| for the values of this option, and
1469 |C-indenting| for info on C indenting in general.
1470
1471
1472 *'cinwords'* *'cinw'*
1473'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1474 local to buffer
1475 {not in Vi}
1476 {not available when compiled without both the
1477 |+cindent| and the |+smartindent| features}
1478 These keywords start an extra indent in the next line when
1479 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1480 an appropriate place (inside {}).
1481 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1482 matter, include the keyword both the uppercase and lowercase:
1483 "if,If,IF".
1484
1485 *'clipboard'* *'cb'*
1486'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1487 for X-windows, "" otherwise)
1488 global
1489 {not in Vi}
1490 {only in GUI versions or when the |+xterm_clipboard|
1491 feature is included}
1492 This option is a list of comma separated names.
1493 These names are recognized:
1494
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001495 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 unnamed When included, Vim will use the clipboard register '*'
1497 for all yank, delete, change and put operations which
1498 would normally go to the unnamed register. When a
1499 register is explicitly specified, it will always be
1500 used regardless of whether "unnamed" is in 'clipboard'
1501 or not. The clipboard register can always be
1502 explicitly accessed using the "* notation. Also see
1503 |gui-clipboard|.
1504
Bram Moolenaar30b65812012-07-12 22:01:11 +02001505 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001506 unnamedplus A variant of the "unnamed" flag which uses the
1507 clipboard register '+' (|quoteplus|) instead of
1508 register '*' for all yank, delete, change and put
1509 operations which would normally go to the unnamed
1510 register. When "unnamed" is also included to the
1511 option, yank operations (but not delete, change or
1512 put) will additionally copy the text into register
1513 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001514 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001515 Availability can be checked with: >
1516 if has('unnamedplus')
1517<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001518 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 autoselect Works like the 'a' flag in 'guioptions': If present,
1520 then whenever Visual mode is started, or the Visual
1521 area extended, Vim tries to become the owner of the
1522 windowing system's global selection or put the
1523 selected text on the clipboard used by the selection
1524 register "*. See |guioptions_a| and |quotestar| for
1525 details. When the GUI is active, the 'a' flag in
1526 'guioptions' is used, when the GUI is not active, this
1527 "autoselect" flag is used.
1528 Also applies to the modeless selection.
1529
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001530 *clipboard-autoselectplus*
1531 autoselectplus Like "autoselect" but using the + register instead of
1532 the * register. Compare to the 'P' flag in
1533 'guioptions'.
1534
1535 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 autoselectml Like "autoselect", but for the modeless selection
1537 only. Compare to the 'A' flag in 'guioptions'.
1538
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001539 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001540 html When the clipboard contains HTML, use this when
1541 pasting. When putting text on the clipboard, mark it
1542 as HTML. This works to copy rendered HTML from
1543 Firefox, paste it as raw HTML in Vim, select the HTML
1544 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001545 You probably want to add this only temporarily,
1546 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001547 Only supported for GTK version 2 and later.
1548 Only available with the |+multi_byte| feature.
1549
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001550 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001551 exclude:{pattern}
1552 Defines a pattern that is matched against the name of
1553 the terminal 'term'. If there is a match, no
1554 connection will be made to the X server. This is
1555 useful in this situation:
1556 - Running Vim in a console.
1557 - $DISPLAY is set to start applications on another
1558 display.
1559 - You do not want to connect to the X server in the
1560 console, but do want this in a terminal emulator.
1561 To never connect to the X server use: >
1562 exclude:.*
1563< This has the same effect as using the |-X| argument.
1564 Note that when there is no connection to the X server
1565 the window title won't be restored and the clipboard
1566 cannot be accessed.
1567 The value of 'magic' is ignored, {pattern} is
1568 interpreted as if 'magic' was on.
1569 The rest of the option value will be used for
1570 {pattern}, this must be the last entry.
1571
1572 *'cmdheight'* *'ch'*
1573'cmdheight' 'ch' number (default 1)
1574 global
1575 {not in Vi}
1576 Number of screen lines to use for the command-line. Helps avoiding
1577 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001578 The value of this option is stored with the tab page, so that each tab
1579 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
1581 *'cmdwinheight'* *'cwh'*
1582'cmdwinheight' 'cwh' number (default 7)
1583 global
1584 {not in Vi}
1585 {not available when compiled without the |+vertsplit|
1586 feature}
1587 Number of screen lines to use for the command-line window. |cmdwin|
1588
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001589 *'colorcolumn'* *'cc'*
1590'colorcolumn' 'cc' string (default "")
1591 local to window
1592 {not in Vi}
1593 {not available when compiled without the |+syntax|
1594 feature}
1595 'colorcolumn' is a comma separated list of screen columns that are
1596 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1597 text. Will make screen redrawing slower.
1598 The screen column can be an absolute number, or a number preceded with
1599 '+' or '-', which is added to or subtracted from 'textwidth'. >
1600
1601 :set cc=+1 " highlight column after 'textwidth'
1602 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1603 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1604<
1605 When 'textwidth' is zero then the items with '-' and '+' are not used.
1606 A maximum of 256 columns are highlighted.
1607
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 *'columns'* *'co'* *E594*
1609'columns' 'co' number (default 80 or terminal width)
1610 global
1611 {not in Vi}
1612 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001613 initialization and does not have to be set by hand. Also see
1614 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 When Vim is running in the GUI or in a resizable window, setting this
1616 option will cause the window size to be changed. When you only want
1617 to use the size for the GUI, put the command in your |gvimrc| file.
1618 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001619 number of columns of the display, the display may be messed up. For
1620 the GUI it is always possible and Vim limits the number of columns to
1621 what fits on the screen. You can use this command to get the widest
1622 window possible: >
1623 :set columns=9999
1624< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625
1626 *'comments'* *'com'* *E524* *E525*
1627'comments' 'com' string (default
1628 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1629 local to buffer
1630 {not in Vi}
1631 {not available when compiled without the |+comments|
1632 feature}
1633 A comma separated list of strings that can start a comment line. See
1634 |format-comments|. See |option-backslash| about using backslashes to
1635 insert a space.
1636
1637 *'commentstring'* *'cms'* *E537*
1638'commentstring' 'cms' string (default "/*%s*/")
1639 local to buffer
1640 {not in Vi}
1641 {not available when compiled without the |+folding|
1642 feature}
1643 A template for a comment. The "%s" in the value is replaced with the
1644 comment text. Currently only used to add markers for folding, see
1645 |fold-marker|.
1646
1647 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001648'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1649 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001650 global
1651 {not in Vi}
1652 This option has the effect of making Vim either more Vi-compatible, or
1653 make Vim behave in a more useful way.
1654 This is a special kind of option, because when it's set or reset,
1655 other options are also changed as a side effect. CAREFUL: Setting or
1656 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001657 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 set this option in your vimrc file, you should probably put it at the
1659 very start.
1660 By default this option is on and the Vi defaults are used for the
1661 options. This default was chosen for those people who want to use Vim
1662 just like Vi, and don't even (want to) know about the 'compatible'
1663 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001664 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001665 this option is switched off, and all options that have not been
1666 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001667 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001668 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001669 happen for the system-wide vimrc or gvimrc file, nor for a file given
1670 with the |-u| argument). Also see |compatible-default| and
1671 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 You can also set this option with the "-C" argument, and reset it with
1673 "-N". See |-C| and |-N|.
1674 Switching this option off makes the Vim defaults be used for options
1675 that have a different Vi and Vim default value. See the options
1676 marked with a '+' below. Other options are not modified.
1677 At the moment this option is set, several other options will be set
1678 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001679 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 editing.
1681 See also 'cpoptions'.
1682
1683 option + set value effect ~
1684
1685 'allowrevins' off no CTRL-_ command
1686 'backupcopy' Unix: "yes" backup file is a copy
1687 others: "auto" copy or rename backup file
1688 'backspace' "" normal backspace
1689 'backup' off no backup file
1690 'cindent' off no C code indentation
1691 'cedit' + "" no key to open the |cmdwin|
1692 'cpoptions' + (all flags) Vi-compatible flags
1693 'cscopetag' off don't use cscope for ":tag"
1694 'cscopetagorder' 0 see |cscopetagorder|
1695 'cscopeverbose' off see |cscopeverbose|
1696 'digraph' off no digraphs
1697 'esckeys' + off no <Esc>-keys in Insert mode
1698 'expandtab' off tabs not expanded to spaces
1699 'fileformats' + "" no automatic file format detection,
1700 "dos,unix" except for DOS, Windows and OS/2
1701 'formatoptions' + "vt" Vi compatible formatting
1702 'gdefault' off no default 'g' flag for ":s"
1703 'history' + 0 no commandline history
1704 'hkmap' off no Hebrew keyboard mapping
1705 'hkmapp' off no phonetic Hebrew keyboard mapping
1706 'hlsearch' off no highlighting of search matches
1707 'incsearch' off no incremental searching
1708 'indentexpr' "" no indenting by expression
1709 'insertmode' off do not start in Insert mode
1710 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1711 characters and '_'
1712 'joinspaces' on insert 2 spaces after period
1713 'modeline' + off no modelines
1714 'more' + off no pauses in listings
1715 'revins' off no reverse insert
1716 'ruler' off no ruler
1717 'scrolljump' 1 no jump scroll
1718 'scrolloff' 0 no scroll offset
1719 'shiftround' off indent not rounded to shiftwidth
1720 'shortmess' + "" no shortening of messages
1721 'showcmd' + off command characters not shown
1722 'showmode' + off current mode not shown
1723 'smartcase' off no automatic ignore case switch
1724 'smartindent' off no smart indentation
1725 'smarttab' off no smart tab size
1726 'softtabstop' 0 tabs are always 'tabstop' positions
1727 'startofline' on goto startofline with some commands
1728 'tagrelative' + off tag file names are not relative
1729 'textauto' + off no automatic textmode detection
1730 'textwidth' 0 no automatic line wrap
1731 'tildeop' off tilde is not an operator
1732 'ttimeout' off no terminal timeout
1733 'whichwrap' + "" left-right movements don't wrap
1734 'wildchar' + CTRL-E only when the current value is <Tab>
1735 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001736 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 *'complete'* *'cpt'* *E535*
1739'complete' 'cpt' string (default: ".,w,b,u,t,i")
1740 local to buffer
1741 {not in Vi}
1742 This option specifies how keyword completion |ins-completion| works
1743 when CTRL-P or CTRL-N are used. It is also used for whole-line
1744 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1745 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001746 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001747 w scan buffers from other windows
1748 b scan other loaded buffers that are in the buffer list
1749 u scan the unloaded buffers that are in the buffer list
1750 U scan the buffers that are not in the buffer list
1751 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001752 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 k{dict} scan the file {dict}. Several "k" flags can be given,
1754 patterns are valid too. For example: >
1755 :set cpt=k/usr/dict/*,k~/spanish
1756< s scan the files given with the 'thesaurus' option
1757 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1758 are valid too.
1759 i scan current and included files
1760 d scan current and included files for defined name or macro
1761 |i_CTRL-X_CTRL-D|
1762 ] tag completion
1763 t same as "]"
1764
1765 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1766 not executed, this may lead to unexpected completions from some files
1767 (gzipped files for example). Unloaded buffers are not scanned for
1768 whole-line completion.
1769
1770 The default is ".,w,b,u,t,i", which means to scan:
1771 1. the current buffer
1772 2. buffers in other windows
1773 3. other loaded buffers
1774 4. unloaded buffers
1775 5. tags
1776 6. included files
1777
1778 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001779 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1780 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001782 *'completefunc'* *'cfu'*
1783'completefunc' 'cfu' string (default: empty)
1784 local to buffer
1785 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001786 {not available when compiled without the |+eval|
1787 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001788 This option specifies a function to be used for Insert mode completion
1789 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001790 See |complete-functions| for an explanation of how the function is
1791 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001792 This option cannot be set from a |modeline| or in the |sandbox|, for
1793 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001794
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001795 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001796'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001797 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001798 {not available when compiled without the
1799 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001800 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001801 A comma separated list of options for Insert mode completion
1802 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001803
1804 menu Use a popup menu to show the possible completions. The
1805 menu is only shown when there is more than one match and
1806 sufficient colors are available. |ins-completion-menu|
1807
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001808 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001809 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001810 match, e.g., what file it comes from.
1811
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001812 longest Only insert the longest common text of the matches. If
1813 the menu is displayed you can use CTRL-L to add more
1814 characters. Whether case is ignored depends on the kind
1815 of completion. For buffer text the 'ignorecase' option is
1816 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001817
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001818 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001819 completion in the preview window. Only works in
1820 combination with "menu" or "menuone".
1821
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001822 noinsert Do not insert any text for a match until the user selects
1823 a match from the menu. Only works in combination with
1824 "menu" or "menuone". No effect if "longest" is present.
1825
1826 noselect Do not select a match in the menu, force the user to
1827 select one from the menu. Only works in combination with
1828 "menu" or "menuone".
1829
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001830
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001831 *'concealcursor'* *'cocu'*
1832'concealcursor' 'cocu' string (default: "")
1833 local to window
1834 {not in Vi}
1835 {not available when compiled without the |+conceal|
1836 feature}
1837 Sets the modes in which text in the cursor line can also be concealed.
1838 When the current mode is listed then concealing happens just like in
1839 other lines.
1840 n Normal mode
1841 v Visual mode
1842 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001843 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001844
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001845 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001846 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001847 are moving around text is concealed, but when starting to insert text
1848 or selecting a Visual area the concealed text is displayed, so that
1849 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001850 Keep in mind that the cursor position is not always where it's
1851 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001852
1853
1854'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001855 number (default 0)
1856 local to window
1857 {not in Vi}
1858 {not available when compiled without the |+conceal|
1859 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001860 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1861 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001862
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001863 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001864 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001865 1 Each block of concealed text is replaced with one
1866 character. If the syntax item does not have a custom
1867 replacement character defined (see |:syn-cchar|) the
1868 character defined in 'listchars' is used (default is a
1869 space).
1870 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001871 2 Concealed text is completely hidden unless it has a
1872 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001873 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001874 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001875
Bram Moolenaara7781e02010-07-19 20:13:22 +02001876 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001877 edit and copy the text. This can be changed with the 'concealcursor'
1878 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001879
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1881'confirm' 'cf' boolean (default off)
1882 global
1883 {not in Vi}
1884 When 'confirm' is on, certain operations that would normally
1885 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1886 instead raise a |dialog| asking if you wish to save the current
1887 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1888 If 'confirm' is off you can still activate confirmation for one
1889 command only (this is most useful in mappings) with the |:confirm|
1890 command.
1891 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1892
1893 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1894'conskey' 'consk' boolean (default off)
1895 global
1896 {not in Vi} {only for MS-DOS}
1897 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001898 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 three methods of console input are available:
1900 'conskey' 'bioskey' action ~
1901 on on or off direct console input
1902 off on BIOS
1903 off off STDIN
1904
1905 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1906'copyindent' 'ci' boolean (default off)
1907 local to buffer
1908 {not in Vi}
1909 Copy the structure of the existing lines indent when autoindenting a
1910 new line. Normally the new indent is reconstructed by a series of
1911 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1912 in which case only spaces are used). Enabling this option makes the
1913 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001914 existing line. 'expandtab' has no effect on these characters, a Tab
1915 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 line, the remaining space is filled in the normal manner.
1917 NOTE: 'copyindent' is reset when 'compatible' is set.
1918 Also see 'preserveindent'.
1919
1920 *'cpoptions'* *'cpo'*
1921'cpoptions' 'cpo' string (Vim default: "aABceFs",
1922 Vi default: all flags)
1923 global
1924 {not in Vi}
1925 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001926 this indicates Vi-compatible behavior. This is used for things where
1927 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 'cpoptions' stands for "compatible-options".
1929 Commas can be added for readability.
1930 To avoid problems with flags that are added in the future, use the
1931 "+=" and "-=" feature of ":set" |add-option-flags|.
1932 NOTE: This option is set to the Vi default value when 'compatible' is
1933 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001934 NOTE: This option is set to the POSIX default value at startup when
1935 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001936 variable exists |posix|. This means Vim tries to behave like the
1937 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938
1939 contains behavior ~
1940 *cpo-a*
1941 a When included, a ":read" command with a file name
1942 argument will set the alternate file name for the
1943 current window.
1944 *cpo-A*
1945 A When included, a ":write" command with a file name
1946 argument will set the alternate file name for the
1947 current window.
1948 *cpo-b*
1949 b "\|" in a ":map" command is recognized as the end of
1950 the map command. The '\' is included in the mapping,
1951 the text after the '|' is interpreted as the next
1952 command. Use a CTRL-V instead of a backslash to
1953 include the '|' in the mapping. Applies to all
1954 mapping, abbreviation, menu and autocmd commands.
1955 See also |map_bar|.
1956 *cpo-B*
1957 B A backslash has no special meaning in mappings,
1958 abbreviations and the "to" part of the menu commands.
1959 Remove this flag to be able to use a backslash like a
1960 CTRL-V. For example, the command ":map X \<Esc>"
1961 results in X being mapped to:
1962 'B' included: "\^[" (^[ is a real <Esc>)
1963 'B' excluded: "<Esc>" (5 characters)
1964 ('<' excluded in both cases)
1965 *cpo-c*
1966 c Searching continues at the end of any match at the
1967 cursor position, but not further than the start of the
1968 next line. When not present searching continues
1969 one character from the cursor position. With 'c'
1970 "abababababab" only gets three matches when repeating
1971 "/abab", without 'c' there are five matches.
1972 *cpo-C*
1973 C Do not concatenate sourced lines that start with a
1974 backslash. See |line-continuation|.
1975 *cpo-d*
1976 d Using "./" in the 'tags' option doesn't mean to use
1977 the tags file relative to the current file, but the
1978 tags file in the current directory.
1979 *cpo-D*
1980 D Can't use CTRL-K to enter a digraph after Normal mode
1981 commands with a character argument, like |r|, |f| and
1982 |t|.
1983 *cpo-e*
1984 e When executing a register with ":@r", always add a
1985 <CR> to the last line, also when the register is not
1986 linewise. If this flag is not present, the register
1987 is not linewise and the last line does not end in a
1988 <CR>, then the last line is put on the command-line
1989 and can be edited before hitting <CR>.
1990 *cpo-E*
1991 E It is an error when using "y", "d", "c", "g~", "gu" or
1992 "gU" on an Empty region. The operators only work when
1993 at least one character is to be operate on. Example:
1994 This makes "y0" fail in the first column.
1995 *cpo-f*
1996 f When included, a ":read" command with a file name
1997 argument will set the file name for the current buffer,
1998 if the current buffer doesn't have a file name yet.
1999 *cpo-F*
2000 F When included, a ":write" command with a file name
2001 argument will set the file name for the current
2002 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002003 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 *cpo-g*
2005 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002006 *cpo-H*
2007 H When using "I" on a line with only blanks, insert
2008 before the last blank. Without this flag insert after
2009 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002010 *cpo-i*
2011 i When included, interrupting the reading of a file will
2012 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002013 *cpo-I*
2014 I When moving the cursor up or down just after inserting
2015 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 *cpo-j*
2017 j When joining lines, only add two spaces after a '.',
2018 not after '!' or '?'. Also see 'joinspaces'.
2019 *cpo-J*
2020 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002021 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022 white space.
2023 *cpo-k*
2024 k Disable the recognition of raw key codes in
2025 mappings, abbreviations, and the "to" part of menu
2026 commands. For example, if <Key> sends ^[OA (where ^[
2027 is <Esc>), the command ":map X ^[OA" results in X
2028 being mapped to:
2029 'k' included: "^[OA" (3 characters)
2030 'k' excluded: "<Key>" (one key code)
2031 Also see the '<' flag below.
2032 *cpo-K*
2033 K Don't wait for a key code to complete when it is
2034 halfway a mapping. This breaks mapping <F1><F1> when
2035 only part of the second <F1> has been read. It
2036 enables cancelling the mapping by typing <F1><Esc>.
2037 *cpo-l*
2038 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002039 literally, only "\]", "\^", "\-" and "\\" are special.
2040 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2042 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002043 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 *cpo-L*
2045 L When the 'list' option is set, 'wrapmargin',
2046 'textwidth', 'softtabstop' and Virtual Replace mode
2047 (see |gR|) count a <Tab> as two characters, instead of
2048 the normal behavior of a <Tab>.
2049 *cpo-m*
2050 m When included, a showmatch will always wait half a
2051 second. When not included, a showmatch will wait half
2052 a second or until a character is typed. |'showmatch'|
2053 *cpo-M*
2054 M When excluded, "%" matching will take backslashes into
2055 account. Thus in "( \( )" and "\( ( \)" the outer
2056 parenthesis match. When included "%" ignores
2057 backslashes, which is Vi compatible.
2058 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002059 n When included, the column used for 'number' and
2060 'relativenumber' will also be used for text of wrapped
2061 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 *cpo-o*
2063 o Line offset to search command is not remembered for
2064 next search.
2065 *cpo-O*
2066 O Don't complain if a file is being overwritten, even
2067 when it didn't exist when editing it. This is a
2068 protection against a file unexpectedly created by
2069 someone else. Vi didn't complain about this.
2070 *cpo-p*
2071 p Vi compatible Lisp indenting. When not present, a
2072 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002073 *cpo-P*
2074 P When included, a ":write" command that appends to a
2075 file will set the file name for the current buffer, if
2076 the current buffer doesn't have a file name yet and
2077 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002078 *cpo-q*
2079 q When joining multiple lines leave the cursor at the
2080 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 *cpo-r*
2082 r Redo ("." command) uses "/" to repeat a search
2083 command, instead of the actually used search string.
2084 *cpo-R*
2085 R Remove marks from filtered lines. Without this flag
2086 marks are kept like |:keepmarks| was used.
2087 *cpo-s*
2088 s Set buffer options when entering the buffer for the
2089 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002090 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091 set when the buffer is created.
2092 *cpo-S*
2093 S Set buffer options always when entering a buffer
2094 (except 'readonly', 'fileformat', 'filetype' and
2095 'syntax'). This is the (most) Vi compatible setting.
2096 The options are set to the values in the current
2097 buffer. When you change an option and go to another
2098 buffer, the value is copied. Effectively makes the
2099 buffer options global to all buffers.
2100
2101 's' 'S' copy buffer options
2102 no no when buffer created
2103 yes no when buffer first entered (default)
2104 X yes each time when buffer entered (vi comp.)
2105 *cpo-t*
2106 t Search pattern for the tag command is remembered for
2107 "n" command. Otherwise Vim only puts the pattern in
2108 the history for search pattern, but doesn't change the
2109 last used search pattern.
2110 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002111 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002112 *cpo-v*
2113 v Backspaced characters remain visible on the screen in
2114 Insert mode. Without this flag the characters are
2115 erased from the screen right away. With this flag the
2116 screen newly typed text overwrites backspaced
2117 characters.
2118 *cpo-w*
2119 w When using "cw" on a blank character, only change one
2120 character and not all blanks until the start of the
2121 next word.
2122 *cpo-W*
2123 W Don't overwrite a readonly file. When omitted, ":w!"
2124 overwrites a readonly file, if possible.
2125 *cpo-x*
2126 x <Esc> on the command-line executes the command-line.
2127 The default in Vim is to abandon the command-line,
2128 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002129 *cpo-X*
2130 X When using a count with "R" the replaced text is
2131 deleted only once. Also when repeating "R" with "."
2132 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 *cpo-y*
2134 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002135 *cpo-Z*
2136 Z When using "w!" while the 'readonly' option is set,
2137 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 *cpo-!*
2139 ! When redoing a filter command, use the last used
2140 external command, whatever it was. Otherwise the last
2141 used -filter- command is used.
2142 *cpo-$*
2143 $ When making a change to one line, don't redisplay the
2144 line, but put a '$' at the end of the changed text.
2145 The changed text will be overwritten when you type the
2146 new text. The line is redisplayed if you type any
2147 command that moves the cursor from the insertion
2148 point.
2149 *cpo-%*
2150 % Vi-compatible matching is done for the "%" command.
2151 Does not recognize "#if", "#endif", etc.
2152 Does not recognize "/*" and "*/".
2153 Parens inside single and double quotes are also
2154 counted, causing a string that contains a paren to
2155 disturb the matching. For example, in a line like
2156 "if (strcmp("foo(", s))" the first paren does not
2157 match the last one. When this flag is not included,
2158 parens inside single and double quotes are treated
2159 specially. When matching a paren outside of quotes,
2160 everything inside quotes is ignored. When matching a
2161 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002162 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002163 This flag is also used for other features, such as
2164 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002165 *cpo--*
2166 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002167 it would go above the first line or below the last
2168 line. Without it the cursor moves to the first or
2169 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002170 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002171 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002172 *cpo-+*
2173 + When included, a ":write file" command will reset the
2174 'modified' flag of the buffer, even though the buffer
2175 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002176 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 * Use ":*" in the same way as ":@". When not included,
2178 ":*" is an alias for ":'<,'>", select the Visual area.
2179 *cpo-<*
2180 < Disable the recognition of special key codes in |<>|
2181 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002182 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 ":map X <Tab>" results in X being mapped to:
2184 '<' included: "<Tab>" (5 characters)
2185 '<' excluded: "^I" (^I is a real <Tab>)
2186 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002187 *cpo->*
2188 > When appending to a register, put a line break before
2189 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002190 *cpo-;*
2191 ; When using |,| or |;| to repeat the last |t| search
2192 and the cursor is right in front of the searched
2193 character, the cursor won't move. When not included,
2194 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002195 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002196
2197 POSIX flags. These are not included in the Vi default value, except
2198 when $VIM_POSIX was set on startup. |posix|
2199
2200 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002201 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002202 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002203 *cpo-&*
2204 & When ":preserve" was used keep the swap file when
2205 exiting normally while this buffer is still loaded.
2206 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002207 *cpo-\*
2208 \ Backslash in a [] range in a search pattern is taken
2209 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002210 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2211 '\' excluded: "/[ \-]" finds <Space> and '-'
2212 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002213 *cpo-/*
2214 / When "%" is used as the replacement string in a |:s|
2215 command, use the previous replacement string. |:s%|
2216 *cpo-{*
2217 { The |{| and |}| commands also stop at a "{" character
2218 at the start of a line.
2219 *cpo-.*
2220 . The ":chdir" and ":cd" commands fail if the current
2221 buffer is modified, unless ! is used. Vim doesn't
2222 need this, since it remembers the full path of an
2223 opened file.
2224 *cpo-bar*
2225 | The value of the $LINES and $COLUMNS environment
2226 variables overrule the terminal size values obtained
2227 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002228
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002230 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002231'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002232 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002233 {not in Vi}
2234 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002235 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002236 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002237 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002238 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002239 blowfish Blowfish method. Medium strong encryption but it has
2240 an implementation flaw. Requires Vim 7.3 or later,
2241 files can NOT be read by Vim 7.2 and older. This adds
2242 a "seed" to the file, every time you write the file
2243 the encrypted bytes will be different.
2244 *blowfish2*
2245 blowfish2 Blowfish method. Medium strong encryption. Requires
2246 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2247 and older. This adds a "seed" to the file, every time
2248 you write the file the encrypted bytes will be
2249 different. The whole undo file is encrypted, not just
2250 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002251
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002252 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002253 to the detected method of the file being read. Thus if you write it
2254 without changing 'cryptmethod' the same method will be used.
2255 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002256 explicitly write it, you don't get a warning unless there are other
2257 modifications. Also see |:X|.
2258
2259 When setting the global value to an empty string, it will end up with
2260 the value "zip". When setting the local value to an empty string the
2261 buffer will use the global value.
2262
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002263 When a new encryption method is added in a later version of Vim, and
2264 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002265 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002266
2267
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 *'cscopepathcomp'* *'cspc'*
2269'cscopepathcomp' 'cspc' number (default 0)
2270 global
2271 {not available when compiled without the |+cscope|
2272 feature}
2273 {not in Vi}
2274 Determines how many components of the path to show in a list of tags.
2275 See |cscopepathcomp|.
2276
2277 *'cscopeprg'* *'csprg'*
2278'cscopeprg' 'csprg' string (default "cscope")
2279 global
2280 {not available when compiled without the |+cscope|
2281 feature}
2282 {not in Vi}
2283 Specifies the command to execute cscope. See |cscopeprg|.
2284 This option cannot be set from a |modeline| or in the |sandbox|, for
2285 security reasons.
2286
2287 *'cscopequickfix'* *'csqf'*
2288'cscopequickfix' 'csqf' string (default "")
2289 global
2290 {not available when compiled without the |+cscope|
2291 or |+quickfix| features}
2292 {not in Vi}
2293 Specifies whether to use quickfix window to show cscope results.
2294 See |cscopequickfix|.
2295
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002296 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002297'cscoperelative' 'csre' boolean (default off)
2298 global
2299 {not available when compiled without the |+cscope|
2300 feature}
2301 {not in Vi}
2302 In the absence of a prefix (-P) for cscope. setting this option enables
2303 to use the basename of cscope.out path as the prefix.
2304 See |cscoperelative|.
2305
Bram Moolenaar071d4272004-06-13 20:20:40 +00002306 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2307'cscopetag' 'cst' boolean (default off)
2308 global
2309 {not available when compiled without the |+cscope|
2310 feature}
2311 {not in Vi}
2312 Use cscope for tag commands. See |cscope-options|.
2313 NOTE: This option is reset when 'compatible' is set.
2314
2315 *'cscopetagorder'* *'csto'*
2316'cscopetagorder' 'csto' number (default 0)
2317 global
2318 {not available when compiled without the |+cscope|
2319 feature}
2320 {not in Vi}
2321 Determines the order in which ":cstag" performs a search. See
2322 |cscopetagorder|.
2323 NOTE: This option is set to 0 when 'compatible' is set.
2324
2325 *'cscopeverbose'* *'csverb'*
2326 *'nocscopeverbose'* *'nocsverb'*
2327'cscopeverbose' 'csverb' boolean (default off)
2328 global
2329 {not available when compiled without the |+cscope|
2330 feature}
2331 {not in Vi}
2332 Give messages when adding a cscope database. See |cscopeverbose|.
2333 NOTE: This option is reset when 'compatible' is set.
2334
Bram Moolenaar860cae12010-06-05 23:22:07 +02002335 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2336'cursorbind' 'crb' boolean (default off)
2337 local to window
2338 {not in Vi}
2339 {not available when compiled without the |+cursorbind|
2340 feature}
2341 When this option is set, as the cursor in the current
2342 window moves other cursorbound windows (windows that also have
2343 this option set) move their cursors to the corresponding line and
2344 column. This option is useful for viewing the
2345 differences between two versions of a file (see 'diff'); in diff mode,
2346 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002347 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002348
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002349
2350 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2351'cursorcolumn' 'cuc' boolean (default off)
2352 local to window
2353 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002354 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002355 feature}
2356 Highlight the screen column of the cursor with CursorColumn
2357 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2358 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002359 If you only want the highlighting in the current window you can use
2360 these autocommands: >
2361 au WinLeave * set nocursorline nocursorcolumn
2362 au WinEnter * set cursorline cursorcolumn
2363<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002364
2365 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2366'cursorline' 'cul' boolean (default off)
2367 local to window
2368 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002369 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002370 feature}
2371 Highlight the screen line of the cursor with CursorLine
2372 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2373 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002374 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002375 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002376
2377
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 *'debug'*
2379'debug' string (default "")
2380 global
2381 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002382 These values can be used:
2383 msg Error messages that would otherwise be omitted will be given
2384 anyway.
2385 throw Error messages that would otherwise be omitted will be given
2386 anyway and also throw an exception and set |v:errmsg|.
2387 beep A message will be given when otherwise only a beep would be
2388 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002389 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002390 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2391 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393 *'define'* *'def'*
2394'define' 'def' string (default "^\s*#\s*define")
2395 global or local to buffer |global-local|
2396 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 pattern, just like for the "/" command. This option is used for the
2399 commands like "[i" and "[d" |include-search|. The 'isident' option is
2400 used to recognize the defined name after the match:
2401 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2402 See |option-backslash| about inserting backslashes to include a space
2403 or backslash.
2404 The default value is for C programs. For C++ this value would be
2405 useful, to include const type declarations: >
2406 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2407< When using the ":set" command, you need to double the backslashes!
2408
2409 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2410'delcombine' 'deco' boolean (default off)
2411 global
2412 {not in Vi}
2413 {only available when compiled with the |+multi_byte|
2414 feature}
2415 If editing Unicode and this option is set, backspace and Normal mode
2416 "x" delete each combining character on its own. When it is off (the
2417 default) the character along with its combining characters are
2418 deleted.
2419 Note: When 'delcombine' is set "xx" may work different from "2x"!
2420
2421 This is useful for Arabic, Hebrew and many other languages where one
2422 may have combining characters overtop of base characters, and want
2423 to remove only the combining ones.
2424
2425 *'dictionary'* *'dict'*
2426'dictionary' 'dict' string (default "")
2427 global or local to buffer |global-local|
2428 {not in Vi}
2429 List of file names, separated by commas, that are used to lookup words
2430 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2431 contain a list of words. This can be one word per line, or several
2432 words per line, separated by non-keyword characters (white space is
2433 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002434 When this option is empty, or an entry "spell" is present, spell
2435 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002436 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 after a comma are ignored, otherwise spaces are included in the file
2438 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002439 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 Where to find a list of words?
2441 - On FreeBSD, there is the file "/usr/share/dict/words".
2442 - In the Simtel archive, look in the "msdos/linguist" directory.
2443 - In "miscfiles" of the GNU collection.
2444 The use of |:set+=| and |:set-=| is preferred when adding or removing
2445 directories from the list. This avoids problems when a future version
2446 uses another default.
2447 Backticks cannot be used in this option for security reasons.
2448
2449 *'diff'* *'nodiff'*
2450'diff' boolean (default off)
2451 local to window
2452 {not in Vi}
2453 {not available when compiled without the |+diff|
2454 feature}
2455 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002456 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457
2458 *'dex'* *'diffexpr'*
2459'diffexpr' 'dex' string (default "")
2460 global
2461 {not in Vi}
2462 {not available when compiled without the |+diff|
2463 feature}
2464 Expression which is evaluated to obtain an ed-style diff file from two
2465 versions of a file. See |diff-diffexpr|.
2466 This option cannot be set from a |modeline| or in the |sandbox|, for
2467 security reasons.
2468
2469 *'dip'* *'diffopt'*
2470'diffopt' 'dip' string (default "filler")
2471 global
2472 {not in Vi}
2473 {not available when compiled without the |+diff|
2474 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002475 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 All are optional. Items must be separated by a comma.
2477
2478 filler Show filler lines, to keep the text
2479 synchronized with a window that has inserted
2480 lines at the same position. Mostly useful
2481 when windows are side-by-side and 'scrollbind'
2482 is set.
2483
2484 context:{n} Use a context of {n} lines between a change
2485 and a fold that contains unchanged lines.
2486 When omitted a context of six lines is used.
2487 See |fold-diff|.
2488
2489 icase Ignore changes in case of text. "a" and "A"
2490 are considered the same. Adds the "-i" flag
2491 to the "diff" command if 'diffexpr' is empty.
2492
2493 iwhite Ignore changes in amount of white space. Adds
2494 the "-b" flag to the "diff" command if
2495 'diffexpr' is empty. Check the documentation
2496 of the "diff" command for what this does
2497 exactly. It should ignore adding trailing
2498 white space, but not leading white space.
2499
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002500 horizontal Start diff mode with horizontal splits (unless
2501 explicitly specified otherwise).
2502
2503 vertical Start diff mode with vertical splits (unless
2504 explicitly specified otherwise).
2505
2506 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2507 starting diff mode. Without this 2 is used.
2508
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 Examples: >
2510
2511 :set diffopt=filler,context:4
2512 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002513 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514<
2515 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2516'digraph' 'dg' boolean (default off)
2517 global
2518 {not in Vi}
2519 {not available when compiled without the |+digraphs|
2520 feature}
2521 Enable the entering of digraphs in Insert mode with {char1} <BS>
2522 {char2}. See |digraphs|.
2523 NOTE: This option is reset when 'compatible' is set.
2524
2525 *'directory'* *'dir'*
2526'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002527 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 for Unix: ".,~/tmp,/var/tmp,/tmp")
2529 global
2530 List of directory names for the swap file, separated with commas.
2531 - The swap file will be created in the first directory where this is
2532 possible.
2533 - Empty means that no swap file will be used (recovery is
2534 impossible!).
2535 - A directory "." means to put the swap file in the same directory as
2536 the edited file. On Unix, a dot is prepended to the file name, so
2537 it doesn't show in a directory listing. On MS-Windows the "hidden"
2538 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002539 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 put the swap file relative to where the edited file is. The leading
2541 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002542 - For Unix and Win32, if a directory ends in two path separators "//"
2543 or "\\", the swap file name will be built from the complete path to
2544 the file with all path separators substituted to percent '%' signs.
2545 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002546 On Win32, when a separating comma is following, you must use "//",
2547 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 - Spaces after the comma are ignored, other spaces are considered part
2549 of the directory name. To have a space at the start of a directory
2550 name, precede it with a backslash.
2551 - To include a comma in a directory name precede it with a backslash.
2552 - A directory name may end in an ':' or '/'.
2553 - Environment variables are expanded |:set_env|.
2554 - Careful with '\' characters, type one before a space, type two to
2555 get one in the option (see |option-backslash|), for example: >
2556 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2557< - For backwards compatibility with Vim version 3.0 a '>' at the start
2558 of the option is removed.
2559 Using "." first in the list is recommended. This means that editing
2560 the same file twice will result in a warning. Using "/tmp" on Unix is
2561 discouraged: When the system crashes you lose the swap file.
2562 "/var/tmp" is often not cleared when rebooting, thus is a better
2563 choice than "/tmp". But it can contain a lot of files, your swap
2564 files get lost in the crowd. That is why a "tmp" directory in your
2565 home directory is tried first.
2566 The use of |:set+=| and |:set-=| is preferred when adding or removing
2567 directories from the list. This avoids problems when a future version
2568 uses another default.
2569 This option cannot be set from a |modeline| or in the |sandbox|, for
2570 security reasons.
2571 {Vi: directory to put temp file in, defaults to "/tmp"}
2572
2573 *'display'* *'dy'*
2574'display' 'dy' string (default "")
2575 global
2576 {not in Vi}
2577 Change the way text is displayed. This is comma separated list of
2578 flags:
2579 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 last line that doesn't fit is replaced with "@" lines.
2582 uhex Show unprintable characters hexadecimal as <xx>
2583 instead of using ^C and ~C.
2584
2585 *'eadirection'* *'ead'*
2586'eadirection' 'ead' string (default "both")
2587 global
2588 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002589 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 feature}
2591 Tells when the 'equalalways' option applies:
2592 ver vertically, width of windows is not affected
2593 hor horizontally, height of windows is not affected
2594 both width and height of windows is affected
2595
2596 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2597'edcompatible' 'ed' boolean (default off)
2598 global
2599 Makes the 'g' and 'c' flags of the ":substitute" command to be
2600 toggled each time the flag is given. See |complex-change|. See
2601 also 'gdefault' option.
2602 Switching this option on is discouraged!
2603
2604 *'encoding'* *'enc'* *E543*
2605'encoding' 'enc' string (default: "latin1" or value from $LANG)
2606 global
2607 {only available when compiled with the |+multi_byte|
2608 feature}
2609 {not in Vi}
2610 Sets the character encoding used inside Vim. It applies to text in
2611 the buffers, registers, Strings in expressions, text stored in the
2612 viminfo file, etc. It sets the kind of characters which Vim can work
2613 with. See |encoding-names| for the possible values.
2614
2615 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002616 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002617 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002618 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619
Bram Moolenaar865242e2010-07-14 21:12:05 +02002620 This option cannot be set from a |modeline|. It would most likely
2621 corrupt the text.
2622
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2624 "utf-8". Although care has been taken to allow different values of
2625 'encoding', "utf-8" is the natural choice for the environment and
2626 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002627 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 versions, and to avoid changing the encoding of newly created files
2629 without your knowledge (in case 'fileencodings' is empty).
2630
2631 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 iconv() or as specified with 'charconvert'.
2634
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002635 If you need to know whether 'encoding' is a multi-byte encoding, you
2636 can use: >
2637 if has("multi_byte_encoding")
2638<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 Normally 'encoding' will be equal to your current locale. This will
2640 be the default if Vim recognizes your environment settings. If
2641 'encoding' is not set to the current locale, 'termencoding' must be
2642 set to convert typed and displayed text. See |encoding-table|.
2643
2644 When you set this option, it fires the |EncodingChanged| autocommand
2645 event so that you can set up fonts if necessary.
2646
2647 When the option is set, the value is converted to lowercase. Thus
2648 you can set it with uppercase values too. Underscores are translated
2649 to '-' signs.
2650 When the encoding is recognized, it is changed to the standard name.
2651 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2652 "iso-8859-2" and "utf8" becomes "utf-8".
2653
2654 Note: "latin1" is also used when the encoding could not be detected.
2655 This only works when editing files in the same encoding! When the
2656 actual character set is not latin1, make sure 'fileencoding' and
2657 'fileencodings' are empty. When conversion is needed, switch to using
2658 utf-8.
2659
2660 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2661 You don't notice this while editing, but it does matter for the
2662 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2663 setting 'encoding' to one of these values instead of utf-8 only has
2664 effect for encoding used for files when 'fileencoding' is empty.
2665
Bram Moolenaar661b1822005-07-28 22:36:45 +00002666 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2667 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668
2669 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2670'endofline' 'eol' boolean (default on)
2671 local to buffer
2672 {not in Vi}
2673 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002674 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 option is automatically set when starting to edit a new file, unless
2676 the file does not have an <EOL> for the last line in the file, in
2677 which case it is reset. Normally you don't have to set or reset this
2678 option. When 'binary' is off the value is not used when writing the
2679 file. When 'binary' is on it is used to remember the presence of a
2680 <EOL> for the last line in the file, so that when you write the file
2681 the situation from the original file can be kept. But you can change
2682 it if you want to.
2683
2684 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2685'equalalways' 'ea' boolean (default on)
2686 global
2687 {not in Vi}
2688 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002689 splitting or closing a window. This also happens the moment the
2690 option is switched on. When off, splitting a window will reduce the
2691 size of the current window and leave the other windows the same. When
2692 closing a window the extra lines are given to the window next to it
2693 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 When mixing vertically and horizontally split windows, a minimal size
2695 is computed and some windows may be larger if there is room. The
2696 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002697 Changing the height and width of a window can be avoided by setting
2698 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002699 If a window size is specified when creating a new window sizes are
2700 currently not equalized (it's complicated, but may be implemented in
2701 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702
2703 *'equalprg'* *'ep'*
2704'equalprg' 'ep' string (default "")
2705 global or local to buffer |global-local|
2706 {not in Vi}
2707 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002708 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002709 or 'indentexpr'. When Vim was compiled without internal formatting,
2710 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 about including spaces and backslashes.
2713 This option cannot be set from a |modeline| or in the |sandbox|, for
2714 security reasons.
2715
2716 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2717'errorbells' 'eb' boolean (default off)
2718 global
2719 Ring the bell (beep or screen flash) for error messages. This only
2720 makes a difference for error messages, the bell will be used always
2721 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002722 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 screen flash or do nothing.
2724
2725 *'errorfile'* *'ef'*
2726'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2727 others: "errors.err")
2728 global
2729 {not in Vi}
2730 {not available when compiled without the |+quickfix|
2731 feature}
2732 Name of the errorfile for the QuickFix mode (see |:cf|).
2733 When the "-q" command-line argument is used, 'errorfile' is set to the
2734 following argument. See |-q|.
2735 NOT used for the ":make" command. See 'makeef' for that.
2736 Environment variables are expanded |:set_env|.
2737 See |option-backslash| about including spaces and backslashes.
2738 This option cannot be set from a |modeline| or in the |sandbox|, for
2739 security reasons.
2740
2741 *'errorformat'* *'efm'*
2742'errorformat' 'efm' string (default is very long)
2743 global or local to buffer |global-local|
2744 {not in Vi}
2745 {not available when compiled without the |+quickfix|
2746 feature}
2747 Scanf-like description of the format for the lines in the error file
2748 (see |errorformat|).
2749
2750 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2751'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2752 global
2753 {not in Vi}
2754 Function keys that start with an <Esc> are recognized in Insert
2755 mode. When this option is off, the cursor and function keys cannot be
2756 used in Insert mode if they start with an <Esc>. The advantage of
2757 this is that the single <Esc> is recognized immediately, instead of
2758 after one second. Instead of resetting this option, you might want to
2759 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2760 when 'esckeys' is off, you can still map anything, but the cursor keys
2761 won't work by default.
2762 NOTE: This option is set to the Vi default value when 'compatible' is
2763 set and to the Vim default value when 'compatible' is reset.
2764
2765 *'eventignore'* *'ei'*
2766'eventignore' 'ei' string (default "")
2767 global
2768 {not in Vi}
2769 {not available when compiled without the |+autocmd|
2770 feature}
2771 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002772 When set to "all" or when "all" is one of the items, all autocommand
2773 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 Otherwise this is a comma separated list of event names. Example: >
2775 :set ei=WinEnter,WinLeave
2776<
2777 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2778'expandtab' 'et' boolean (default off)
2779 local to buffer
2780 {not in Vi}
2781 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002782 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2784 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2785 NOTE: This option is reset when 'compatible' is set.
2786
2787 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2788'exrc' 'ex' boolean (default off)
2789 global
2790 {not in Vi}
2791 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2792 directory. If you switch this option on you should also consider
2793 setting the 'secure' option (see |initialization|). Using a local
2794 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2795 also see |.vimrc| and |gui-init|.
2796 This option cannot be set from a |modeline| or in the |sandbox|, for
2797 security reasons.
2798
2799 *'fileencoding'* *'fenc'* *E213*
2800'fileencoding' 'fenc' string (default: "")
2801 local to buffer
2802 {only available when compiled with the |+multi_byte|
2803 feature}
2804 {not in Vi}
2805 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002806
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002808 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 When 'fileencoding' is empty, the same value as 'encoding' will be
2810 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002811 Conversion will also be done when 'encoding' and 'fileencoding' are
2812 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2813 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002815 'encoding' is "utf-8" or another Unicode encoding, conversion
2816 is most likely done in a way that the reverse conversion
2817 results in the same text. When 'encoding' is not "utf-8" some
2818 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002819
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 See 'encoding' for the possible values. Additionally, values may be
2821 specified that can be handled by the converter, see
2822 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002823
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824 When reading a file 'fileencoding' will be set from 'fileencodings'.
2825 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002826 'fileencoding', use the |++enc| argument. One exception: when
2827 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002828 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002829
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2831 When the option is set, the value is converted to lowercase. Thus
2832 you can set it with uppercase values too. '_' characters are
2833 replaced with '-'. If a name is recognized from the list for
2834 'encoding', it is replaced by the standard name. For example
2835 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002836
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 When this option is set, after starting to edit a file, the 'modified'
2838 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002839
2840 Keep in mind that changing 'fenc' from a modeline happens
2841 AFTER the text has been read, thus it applies to when the file will be
2842 written. If you do set 'fenc' in a modeline, you might want to set
2843 'nomodified' to avoid not being able to ":q".
2844
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 This option can not be changed when 'modifiable' is off.
2846
2847 *'fe'*
2848 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 old short name was 'fe', which is no longer used.
2851
2852 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002853'fileencodings' 'fencs' string (default: "ucs-bom",
2854 "ucs-bom,utf-8,default,latin1" when
2855 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 global
2857 {only available when compiled with the |+multi_byte|
2858 feature}
2859 {not in Vi}
2860 This is a list of character encodings considered when starting to edit
2861 an existing file. When a file is read, Vim tries to use the first
2862 mentioned character encoding. If an error is detected, the next one
2863 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002864 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 an empty string, which means the value of 'encoding' is used.
2866 WARNING: Conversion can cause loss of information! When
2867 'encoding' is "utf-8" (or one of the other Unicode variants)
2868 conversion is most likely done in a way that the reverse
2869 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002870 "utf-8" some non-ASCII characters may be lost! You can use
2871 the |++bad| argument to specify what is done with characters
2872 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 For an empty file or a file with only ASCII characters most encodings
2874 will work and the first entry of 'fileencodings' will be used (except
2875 "ucs-bom", which requires the BOM to be present). If you prefer
2876 another encoding use an BufReadPost autocommand event to test if your
2877 preferred encoding is to be used. Example: >
2878 au BufReadPost * if search('\S', 'w') == 0 |
2879 \ set fenc=iso-2022-jp | endif
2880< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2881 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002882 When the |++enc| argument is used then the value of 'fileencodings' is
2883 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002884 Note that 'fileencodings' is not used for a new file, the global value
2885 of 'fileencoding' is used instead. You can set it with: >
2886 :setglobal fenc=iso-8859-2
2887< This means that a non-existing file may get a different encoding than
2888 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 The special value "ucs-bom" can be used to check for a Unicode BOM
2890 (Byte Order Mark) at the start of the file. It must not be preceded
2891 by "utf-8" or another Unicode encoding for this to work properly.
2892 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2893 because Vim cannot detect an error, thus the encoding is always
2894 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002895 The special value "default" can be used for the encoding from the
2896 environment. This is the default value for 'encoding'. It is useful
2897 when 'encoding' is set to "utf-8" and your environment uses a
2898 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002899 When 'encoding' is "utf-8" and a file contains an illegal byte
2900 sequence it won't be recognized as UTF-8. You can use the |8g8|
2901 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 WRONG VALUES: WHAT'S WRONG:
2903 latin1,utf-8 "latin1" will always be used
2904 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2905 file
2906 cp1250,latin1 "cp1250" will always be used
2907 If 'fileencodings' is empty, 'fileencoding' is not modified.
2908 See 'fileencoding' for the possible values.
2909 Setting this option does not have an effect until the next time a file
2910 is read.
2911
2912 *'fileformat'* *'ff'*
2913'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2914 Unix default: "unix",
2915 Macintosh default: "mac")
2916 local to buffer
2917 {not in Vi}
2918 This gives the <EOL> of the current buffer, which is used for
2919 reading/writing the buffer from/to a file:
2920 dos <CR> <NL>
2921 unix <NL>
2922 mac <CR>
2923 When "dos" is used, CTRL-Z at the end of a file is ignored.
2924 See |file-formats| and |file-read|.
2925 For the character encoding of the file see 'fileencoding'.
2926 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002927 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 This option is set automatically when starting to edit a file and
2929 'fileformats' is not empty and 'binary' is off.
2930 When this option is set, after starting to edit a file, the 'modified'
2931 option is set, because the file would be different when written.
2932 This option can not be changed when 'modifiable' is off.
2933 For backwards compatibility: When this option is set to "dos",
2934 'textmode' is set, otherwise 'textmode' is reset.
2935
2936 *'fileformats'* *'ffs'*
2937'fileformats' 'ffs' string (default:
2938 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2939 Vim Unix: "unix,dos",
2940 Vim Mac: "mac,unix,dos",
2941 Vi Cygwin: "unix,dos",
2942 Vi others: "")
2943 global
2944 {not in Vi}
2945 This gives the end-of-line (<EOL>) formats that will be tried when
2946 starting to edit a new buffer and when reading a file into an existing
2947 buffer:
2948 - When empty, the format defined with 'fileformat' will be used
2949 always. It is not set automatically.
2950 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002951 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 'fileformats' name will be used when a file is read into an existing
2953 buffer, no matter what 'fileformat' for that buffer is set to.
2954 - When more than one name is present, separated by commas, automatic
2955 <EOL> detection will be done when reading a file. When starting to
2956 edit a file, a check is done for the <EOL>:
2957 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2958 'fileformat' is set to "dos".
2959 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002960 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01002962 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
2963 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02002964 This means that "mac" is only chosen when:
2965 "unix" is not present or no <NL> is found in the file, and
2966 "dos" is not present or no <CR><NL> is found in the file.
2967 Except: if "unix" was chosen, but there is a <CR> before
2968 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002969 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 4. If 'fileformat' is still not set, the first name from
2971 'fileformats' is used.
2972 When reading a file into an existing buffer, the same is done, but
2973 this happens like 'fileformat' has been set appropriately for that
2974 file only, the option is not changed.
2975 When 'binary' is set, the value of 'fileformats' is not used.
2976
Bram Moolenaar81af9252010-12-10 20:35:50 +01002977 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002978 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002979
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2981 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2982 done:
2983 - When 'fileformats' is empty, there is no automatic detection. Dos
2984 format will be used.
2985 - When 'fileformats' is set to one or more names, automatic detection
2986 is done. This is based on the first <NL> in the file: If there is a
2987 <CR> in front of it, Dos format is used, otherwise Unix format is
2988 used.
2989 Also see |file-formats|.
2990 For backwards compatibility: When this option is set to an empty
2991 string or one format (no comma is included), 'textauto' is reset,
2992 otherwise 'textauto' is set.
2993 NOTE: This option is set to the Vi default value when 'compatible' is
2994 set and to the Vim default value when 'compatible' is reset.
2995
Bram Moolenaarbf884932013-04-05 22:26:15 +02002996 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2997'fileignorecase' 'fic' boolean (default on for systems where case in file
2998 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002999 global
3000 {not in Vi}
3001 When set case is ignored when using file names and directories.
3002 See 'wildignorecase' for only ignoring case when doing completion.
3003
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 *'filetype'* *'ft'*
3005'filetype' 'ft' string (default: "")
3006 local to buffer
3007 {not in Vi}
3008 {not available when compiled without the |+autocmd|
3009 feature}
3010 When this option is set, the FileType autocommand event is triggered.
3011 All autocommands that match with the value of this option will be
3012 executed. Thus the value of 'filetype' is used in place of the file
3013 name.
3014 Otherwise this option does not always reflect the current file type.
3015 This option is normally set when the file type is detected. To enable
3016 this use the ":filetype on" command. |:filetype|
3017 Setting this option to a different value is most useful in a modeline,
3018 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003019 Example, for in an IDL file:
3020 /* vim: set filetype=idl : */ ~
3021 |FileType| |filetypes|
3022 When a dot appears in the value then this separates two filetype
3023 names. Example:
3024 /* vim: set filetype=c.doxygen : */ ~
3025 This will use the "c" filetype first, then the "doxygen" filetype.
3026 This works both for filetype plugins and for syntax files. More than
3027 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 This option is not copied to another buffer, independent of the 's' or
3029 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003030 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031
3032 *'fillchars'* *'fcs'*
3033'fillchars' 'fcs' string (default "vert:|,fold:-")
3034 global
3035 {not in Vi}
3036 {not available when compiled without the |+windows|
3037 and |+folding| features}
3038 Characters to fill the statuslines and vertical separators.
3039 It is a comma separated list of items:
3040
3041 item default Used for ~
3042 stl:c ' ' or '^' statusline of the current window
3043 stlnc:c ' ' or '-' statusline of the non-current windows
3044 vert:c '|' vertical separators |:vsplit|
3045 fold:c '-' filling 'foldtext'
3046 diff:c '-' deleted lines of the 'diff' option
3047
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003048 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 "stlnc" the space will be used when there is highlighting, '^' or '-'
3050 otherwise.
3051
3052 Example: >
3053 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3054< This is similar to the default, except that these characters will also
3055 be used when there is highlighting.
3056
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003057 for "stl" and "stlnc" only single-byte values are supported.
3058
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059 The highlighting used for these items:
3060 item highlight group ~
3061 stl:c StatusLine |hl-StatusLine|
3062 stlnc:c StatusLineNC |hl-StatusLineNC|
3063 vert:c VertSplit |hl-VertSplit|
3064 fold:c Folded |hl-Folded|
3065 diff:c DiffDelete |hl-DiffDelete|
3066
3067 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3068'fkmap' 'fk' boolean (default off) *E198*
3069 global
3070 {not in Vi}
3071 {only available when compiled with the |+rightleft|
3072 feature}
3073 When on, the keyboard is mapped for the Farsi character set.
3074 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003075 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'foldclose'* *'fcl'*
3078'foldclose' 'fcl' string (default "")
3079 global
3080 {not in Vi}
3081 {not available when compiled without the |+folding|
3082 feature}
3083 When set to "all", a fold is closed when the cursor isn't in it and
3084 its level is higher than 'foldlevel'. Useful if you want folds to
3085 automatically close when moving out of them.
3086
3087 *'foldcolumn'* *'fdc'*
3088'foldcolumn' 'fdc' number (default 0)
3089 local to window
3090 {not in Vi}
3091 {not available when compiled without the |+folding|
3092 feature}
3093 When non-zero, a column with the specified width is shown at the side
3094 of the window which indicates open and closed folds. The maximum
3095 value is 12.
3096 See |folding|.
3097
3098 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3099'foldenable' 'fen' boolean (default on)
3100 local to window
3101 {not in Vi}
3102 {not available when compiled without the |+folding|
3103 feature}
3104 When off, all folds are open. This option can be used to quickly
3105 switch between showing all text unfolded and viewing the text with
3106 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 'foldenable' is off.
3109 This option is set by commands that create a new fold or close a fold.
3110 See |folding|.
3111
3112 *'foldexpr'* *'fde'*
3113'foldexpr' 'fde' string (default: "0")
3114 local to window
3115 {not in Vi}
3116 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003117 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003119 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003120
Bram Moolenaar30b65812012-07-12 22:01:11 +02003121 The expression will be evaluated in the |sandbox| if set from a
3122 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003123 This option can't be set from a |modeline| when the 'diff' option is
3124 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003125
3126 It is not allowed to change text or jump to another window while
3127 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128
3129 *'foldignore'* *'fdi'*
3130'foldignore' 'fdi' string (default: "#")
3131 local to window
3132 {not in Vi}
3133 {not available when compiled without the |+folding|
3134 feature}
3135 Used only when 'foldmethod' is "indent". Lines starting with
3136 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003137 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 The default "#" works well for C programs. See |fold-indent|.
3139
3140 *'foldlevel'* *'fdl'*
3141'foldlevel' 'fdl' number (default: 0)
3142 local to window
3143 {not in Vi}
3144 {not available when compiled without the |+folding|
3145 feature}
3146 Sets the fold level: Folds with a higher level will be closed.
3147 Setting this option to zero will close all folds. Higher numbers will
3148 close fewer folds.
3149 This option is set by commands like |zm|, |zM| and |zR|.
3150 See |fold-foldlevel|.
3151
3152 *'foldlevelstart'* *'fdls'*
3153'foldlevelstart' 'fdls' number (default: -1)
3154 global
3155 {not in Vi}
3156 {not available when compiled without the |+folding|
3157 feature}
3158 Sets 'foldlevel' when starting to edit another buffer in a window.
3159 Useful to always start editing with all folds closed (value zero),
3160 some folds closed (one) or no folds closed (99).
3161 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003162 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 ignores this option and closes all folds.
3164 It is also done before BufReadPre autocommands, to allow an autocmd to
3165 overrule the 'foldlevel' value for specific files.
3166 When the value is negative, it is not used.
3167
3168 *'foldmarker'* *'fmr'* *E536*
3169'foldmarker' 'fmr' string (default: "{{{,}}}")
3170 local to window
3171 {not in Vi}
3172 {not available when compiled without the |+folding|
3173 feature}
3174 The start and end marker used when 'foldmethod' is "marker". There
3175 must be one comma, which separates the start and end marker. The
3176 marker is a literal string (a regular expression would be too slow).
3177 See |fold-marker|.
3178
3179 *'foldmethod'* *'fdm'*
3180'foldmethod' 'fdm' string (default: "manual")
3181 local to window
3182 {not in Vi}
3183 {not available when compiled without the |+folding|
3184 feature}
3185 The kind of folding used for the current window. Possible values:
3186 |fold-manual| manual Folds are created manually.
3187 |fold-indent| indent Lines with equal indent form a fold.
3188 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3189 |fold-marker| marker Markers are used to specify folds.
3190 |fold-syntax| syntax Syntax highlighting items specify folds.
3191 |fold-diff| diff Fold text that is not changed.
3192
3193 *'foldminlines'* *'fml'*
3194'foldminlines' 'fml' number (default: 1)
3195 local to window
3196 {not in Vi}
3197 {not available when compiled without the |+folding|
3198 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003199 Sets the number of screen lines above which a fold can be displayed
3200 closed. Also for manually closed folds. With the default value of
3201 one a fold can only be closed if it takes up two or more screen lines.
3202 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003203 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 "zc" to close a fold, which is displayed open because it's smaller
3205 than 'foldminlines', a following "zc" may close a containing fold.
3206
3207 *'foldnestmax'* *'fdn'*
3208'foldnestmax' 'fdn' number (default: 20)
3209 local to window
3210 {not in Vi}
3211 {not available when compiled without the |+folding|
3212 feature}
3213 Sets the maximum nesting of folds for the "indent" and "syntax"
3214 methods. This avoids that too many folds will be created. Using more
3215 than 20 doesn't work, because the internal limit is 20.
3216
3217 *'foldopen'* *'fdo'*
3218'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3219 search,tag,undo")
3220 global
3221 {not in Vi}
3222 {not available when compiled without the |+folding|
3223 feature}
3224 Specifies for which type of commands folds will be opened, if the
3225 command moves the cursor into a closed fold. It is a comma separated
3226 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003227 NOTE: When the command is part of a mapping this option is not used.
3228 Add the |zv| command to the mapping to get the same effect.
3229 (rationale: the mapping may want to control opening folds itself)
3230
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 item commands ~
3232 all any
3233 block "(", "{", "[[", "[{", etc.
3234 hor horizontal movements: "l", "w", "fx", etc.
3235 insert any command in Insert mode
3236 jump far jumps: "G", "gg", etc.
3237 mark jumping to a mark: "'m", CTRL-O, etc.
3238 percent "%"
3239 quickfix ":cn", ":crew", ":make", etc.
3240 search search for a pattern: "/", "n", "*", "gd", etc.
3241 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003242 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 tag jumping to a tag: ":ta", CTRL-T, etc.
3244 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 When a movement command is used for an operator (e.g., "dl" or "y%")
3246 this option is not used. This means the operator will include the
3247 whole closed fold.
3248 Note that vertical movements are not here, because it would make it
3249 very difficult to move onto a closed fold.
3250 In insert mode the folds containing the cursor will always be open
3251 when text is inserted.
3252 To close folds you can re-apply 'foldlevel' with the |zx| command or
3253 set the 'foldclose' option to "all".
3254
3255 *'foldtext'* *'fdt'*
3256'foldtext' 'fdt' string (default: "foldtext()")
3257 local to window
3258 {not in Vi}
3259 {not available when compiled without the |+folding|
3260 feature}
3261 An expression which is used to specify the text displayed for a closed
3262 fold. See |fold-foldtext|.
3263
Bram Moolenaar30b65812012-07-12 22:01:11 +02003264 The expression will be evaluated in the |sandbox| if set from a
3265 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003266
3267 It is not allowed to change text or jump to another window while
3268 evaluating 'foldtext' |textlock|.
3269
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 *'formatoptions'* *'fo'*
3271'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3272 local to buffer
3273 {not in Vi}
3274 This is a sequence of letters which describes how automatic
3275 formatting is to be done. See |fo-table|. When the 'paste' option is
3276 on, no formatting is done (like 'formatoptions' is empty). Commas can
3277 be inserted for readability.
3278 To avoid problems with flags that are added in the future, use the
3279 "+=" and "-=" feature of ":set" |add-option-flags|.
3280 NOTE: This option is set to the Vi default value when 'compatible' is
3281 set and to the Vim default value when 'compatible' is reset.
3282
Bram Moolenaar86b68352004-12-27 21:59:20 +00003283 *'formatlistpat'* *'flp'*
3284'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3285 local to buffer
3286 {not in Vi}
3287 A pattern that is used to recognize a list header. This is used for
3288 the "n" flag in 'formatoptions'.
3289 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003290 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003291 while still checking more characters. There must be a character
3292 following the pattern, when it matches the whole line it is handled
3293 like there is no match.
3294 The default recognizes a number, followed by an optional punctuation
3295 character and white space.
3296
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297 *'formatprg'* *'fp'*
3298'formatprg' 'fp' string (default "")
3299 global
3300 {not in Vi}
3301 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003302 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003304 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003305 If the 'formatexpr' option is not empty it will be used instead.
3306 Otherwise, if 'formatprg' option is an empty string, the internal
3307 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003308 Environment variables are expanded |:set_env|. See |option-backslash|
3309 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003310 This option cannot be set from a |modeline| or in the |sandbox|, for
3311 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003313 *'formatexpr'* *'fex'*
3314'formatexpr' 'fex' string (default "")
3315 local to buffer
3316 {not in Vi}
3317 {not available when compiled without the |+eval|
3318 feature}
3319 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003320 operator or automatic formatting (see 'formatoptions'). When this
3321 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003322
3323 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003324 The |v:count| variable holds the number of lines to be formatted.
3325 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003326 inserted if the expression is being evaluated due to
3327 automatic formatting. This can be empty. Don't insert
3328 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003329
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003330 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003331 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003332< This will invoke the mylang#Format() function in the
3333 autoload/mylang.vim file in 'runtimepath'. |autoload|
3334
3335 The expression is also evaluated when 'textwidth' is set and adding
3336 text beyond that limit. This happens under the same conditions as
3337 when internal formatting is used. Make sure the cursor is kept in the
3338 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003339 return "i" or "R" in this situation.
3340
3341 When the expression evaluates to non-zero Vim will fall back to using
3342 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003343
Bram Moolenaar30b65812012-07-12 22:01:11 +02003344 The expression will be evaluated in the |sandbox| when set from a
3345 modeline, see |sandbox-option|. That stops the option from working,
3346 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003347
3348 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003349'fsync' 'fs' boolean (default on)
3350 global
3351 {not in Vi}
3352 When on, the library function fsync() will be called after writing a
3353 file. This will flush a file to disk, ensuring that it is safely
3354 written even on filesystems which do metadata-only journaling. This
3355 will force the harddrive to spin up on Linux systems running in laptop
3356 mode, so it may be undesirable in some situations. Be warned that
3357 turning this off increases the chances of data loss after a crash. On
3358 systems without an fsync() implementation, this variable is always
3359 off.
3360 Also see 'swapsync' for controlling fsync() on swap files.
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3363'gdefault' 'gd' boolean (default off)
3364 global
3365 {not in Vi}
3366 When on, the ":substitute" flag 'g' is default on. This means that
3367 all matches in a line are substituted instead of one. When a 'g' flag
3368 is given to a ":substitute" command, this will toggle the substitution
3369 of all or one match. See |complex-change|.
3370
3371 command 'gdefault' on 'gdefault' off ~
3372 :s/// subst. all subst. one
3373 :s///g subst. one subst. all
3374 :s///gg subst. all subst. one
3375
3376 NOTE: This option is reset when 'compatible' is set.
3377
3378 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003379'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 global
3381 {not in Vi}
3382 Format to recognize for the ":grep" command output.
3383 This is a scanf-like string that uses the same format as the
3384 'errorformat' option: see |errorformat|.
3385
3386 *'grepprg'* *'gp'*
3387'grepprg' 'gp' string (default "grep -n ",
3388 Unix: "grep -n $* /dev/null",
3389 Win32: "findstr /n" or "grep -n",
3390 VMS: "SEARCH/NUMBERS ")
3391 global or local to buffer |global-local|
3392 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003393 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 and '#' characters, which are expanded like when used in a command-
3395 line. The placeholder "$*" is allowed to specify where the arguments
3396 will be included. Environment variables are expanded |:set_env|. See
3397 |option-backslash| about including spaces and backslashes.
3398 When your "grep" accepts the "-H" argument, use this to make ":grep"
3399 also work well with a single file: >
3400 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003401< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003402 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3403 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003404 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 apply equally to 'grepprg'.
3406 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3407 otherwise it's "grep -n".
3408 This option cannot be set from a |modeline| or in the |sandbox|, for
3409 security reasons.
3410
3411 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3412'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3413 ve:ver35-Cursor,
3414 o:hor50-Cursor,
3415 i-ci:ver25-Cursor/lCursor,
3416 r-cr:hor20-Cursor/lCursor,
3417 sm:block-Cursor
3418 -blinkwait175-blinkoff150-blinkon175",
3419 for MS-DOS and Win32 console:
3420 "n-v-c:block,o:hor50,i-ci:hor15,
3421 r-cr:hor30,sm:block")
3422 global
3423 {not in Vi}
3424 {only available when compiled with GUI enabled, and
3425 for MS-DOS and Win32 console}
3426 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003427 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003428 the height of the cursor can be changed. This can be done by
3429 specifying a block cursor, or a percentage for a vertical or
3430 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003431 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3432 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003434 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 mode-list and an argument-list:
3436 mode-list:argument-list,mode-list:argument-list,..
3437 The mode-list is a dash separated list of these modes:
3438 n Normal mode
3439 v Visual mode
3440 ve Visual mode with 'selection' "exclusive" (same as 'v',
3441 if not specified)
3442 o Operator-pending mode
3443 i Insert mode
3444 r Replace mode
3445 c Command-line Normal (append) mode
3446 ci Command-line Insert mode
3447 cr Command-line Replace mode
3448 sm showmatch in Insert mode
3449 a all modes
3450 The argument-list is a dash separated list of these arguments:
3451 hor{N} horizontal bar, {N} percent of the character height
3452 ver{N} vertical bar, {N} percent of the character width
3453 block block cursor, fills the whole character
3454 [only one of the above three should be present]
3455 blinkwait{N} *cursor-blinking*
3456 blinkon{N}
3457 blinkoff{N}
3458 blink times for cursor: blinkwait is the delay before
3459 the cursor starts blinking, blinkon is the time that
3460 the cursor is shown and blinkoff is the time that the
3461 cursor is not shown. The times are in msec. When one
3462 of the numbers is zero, there is no blinking. The
3463 default is: "blinkwait700-blinkon400-blinkoff250".
3464 These numbers are used for a missing entry. This
3465 means that blinking is enabled by default. To switch
3466 blinking off you can use "blinkon0". The cursor only
3467 blinks when Vim is waiting for input, not while
3468 executing a command.
3469 To make the cursor blink in an xterm, see
3470 |xterm-blink|.
3471 {group-name}
3472 a highlight group name, that sets the color and font
3473 for the cursor
3474 {group-name}/{group-name}
3475 Two highlight group names, the first is used when
3476 no language mappings are used, the other when they
3477 are. |language-mapping|
3478
3479 Examples of parts:
3480 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3481 block cursor with colors from the "nCursor"
3482 highlight group
3483 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3484 In Insert and Command-line Insert mode, use a
3485 30% vertical bar cursor with colors from the
3486 "iCursor" highlight group. Blink a bit
3487 faster.
3488
3489 The 'a' mode is different. It will set the given argument-list for
3490 all modes. It does not reset anything to defaults. This can be used
3491 to do a common setting for all modes. For example, to switch off
3492 blinking: "a:blinkon0"
3493
3494 Examples of cursor highlighting: >
3495 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3496 :highlight Cursor gui=NONE guifg=bg guibg=fg
3497<
3498 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003499 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500'guifont' 'gfn' string (default "")
3501 global
3502 {not in Vi}
3503 {only available when compiled with GUI enabled}
3504 This is a list of fonts which will be used for the GUI version of Vim.
3505 In its simplest form the value is just one font name. When
3506 the font cannot be found you will get an error message. To try other
3507 font names a list can be specified, font names separated with commas.
3508 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003509
Bram Moolenaar05159a02005-02-26 23:04:13 +00003510 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3511 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003512
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 Spaces after a comma are ignored. To include a comma in a font name
3514 precede it with a backslash. Setting an option requires an extra
3515 backslash before a space and a backslash. See also
3516 |option-backslash|. For example: >
3517 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003518< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003520
3521 If none of the fonts can be loaded, Vim will keep the current setting.
3522 If an empty font list is given, Vim will try using other resource
3523 settings (for X, it will use the Vim.font resource), and finally it
3524 will try some builtin default which should always be there ("7x13" in
3525 the case of X). The font names given should be "normal" fonts. Vim
3526 will try to find the related bold and italic fonts.
3527
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003528 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003529 :set guifont=*
3530< will bring up a font requester, where you can pick the font you want.
3531
3532 The font name depends on the GUI used. See |setting-guifont| for a
3533 way to set 'guifont' for various systems.
3534
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 For the GTK+ 2 GUI the font name looks like this: >
3536 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003537< That's all. XLFDs are not used. For Chinese this is reported to work
3538 well: >
3539 if has("gui_gtk2")
3540 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3541 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3542 endif
3543<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003544 For Mac OSX you can use something like this: >
3545 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003546< Also see 'macatsui', it can help fix display problems.
3547 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003549 width). An exception is GTK 2: all fonts are accepted, but
3550 mono-spaced fonts look best.
3551
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 To preview a font on X11, you might be able to use the "xfontsel"
3553 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003554
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 For the Win32 GUI *E244* *E245*
3556 - takes these options in the font name:
3557 hXX - height is XX (points, can be floating-point)
3558 wXX - width is XX (points, can be floating-point)
3559 b - bold
3560 i - italic
3561 u - underline
3562 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003563 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3565 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3566 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003567 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568
3569 Use a ':' to separate the options.
3570 - A '_' can be used in the place of a space, so you don't need to use
3571 backslashes to escape the spaces.
3572 - Examples: >
3573 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3574 :set guifont=Andale_Mono:h7.5:w4.5
3575< See also |font-sizes|.
3576
3577 *'guifontset'* *'gfs'*
3578 *E250* *E252* *E234* *E597* *E598*
3579'guifontset' 'gfs' string (default "")
3580 global
3581 {not in Vi}
3582 {only available when compiled with GUI enabled and
3583 with the |+xfontset| feature}
3584 {not available in the GTK+ 2 GUI}
3585 When not empty, specifies two (or more) fonts to be used. The first
3586 one for normal English, the second one for your special language. See
3587 |xfontset|.
3588 Setting this option also means that all font names will be handled as
3589 a fontset name. Also the ones used for the "font" argument of the
3590 |:highlight| command.
3591 The fonts must match with the current locale. If fonts for the
3592 character sets that the current locale uses are not included, setting
3593 'guifontset' will fail.
3594 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3595 the comma-separated names are alternative names, one of which will be
3596 used. In 'guifontset' the whole string is one fontset name,
3597 including the commas. It is not possible to specify alternative
3598 fontset names.
3599 This example works on many X11 systems: >
3600 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3601<
3602 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3603'guifontwide' 'gfw' string (default "")
3604 global
3605 {not in Vi}
3606 {only available when compiled with GUI enabled}
3607 When not empty, specifies a comma-separated list of fonts to be used
3608 for double-width characters. The first font that can be loaded is
3609 used.
3610 Note: The size of these fonts must be exactly twice as wide as the one
3611 specified with 'guifont' and the same height.
3612
3613 All GUI versions but GTK+ 2:
3614
3615 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3616 'guifontset' is empty or invalid.
3617 When 'guifont' is set and a valid font is found in it and
3618 'guifontwide' is empty Vim will attempt to find a matching
3619 double-width font and set 'guifontwide' to it.
3620
3621 GTK+ 2 GUI only: *guifontwide_gtk2*
3622
3623 If set and valid, 'guifontwide' is always used for double width
3624 characters, even if 'encoding' is not set to "utf-8".
3625 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 font for characters not available in 'guifont'. Thus you do not need
3628 to set 'guifontwide' at all unless you want to override the choice
3629 made by Pango/Xft.
3630
Bram Moolenaar0f272122013-01-23 18:37:40 +01003631 Windows +multibyte only: *guifontwide_win_mbyte*
3632
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003633 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003634
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 *'guiheadroom'* *'ghr'*
3636'guiheadroom' 'ghr' number (default 50)
3637 global
3638 {not in Vi} {only for GTK and X11 GUI}
3639 The number of pixels subtracted from the screen height when fitting
3640 the GUI window on the screen. Set this before the GUI is started,
3641 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003642 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 lines will be left for window decorations and other items on the
3644 screen. Set it to a negative value to allow windows taller than the
3645 screen.
3646
3647 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003648'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3649 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 global
3651 {not in Vi}
3652 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003653 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 sequence of letters which describes what components and options of the
3655 GUI should be used.
3656 To avoid problems with flags that are added in the future, use the
3657 "+=" and "-=" feature of ":set" |add-option-flags|.
3658
3659 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003660 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 'a' Autoselect: If present, then whenever VISUAL mode is started,
3662 or the Visual area extended, Vim tries to become the owner of
3663 the windowing system's global selection. This means that the
3664 Visually highlighted text is available for pasting into other
3665 applications as well as into Vim itself. When the Visual mode
3666 ends, possibly due to an operation on the text, or when an
3667 application wants to paste the selection, the highlighted text
3668 is automatically yanked into the "* selection register.
3669 Thus the selection is still available for pasting into other
3670 applications after the VISUAL mode has ended.
3671 If not present, then Vim won't become the owner of the
3672 windowing system's global selection unless explicitly told to
3673 by a yank or delete operation for the "* register.
3674 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003675 *'go-P'*
3676 'P' Like autoselect but using the "+ register instead of the "*
3677 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003678 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003679 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 applies to the modeless selection.
3681
3682 'guioptions' autoselect Visual autoselect modeless ~
3683 "" - -
3684 "a" yes yes
3685 "A" - yes
3686 "aA" yes yes
3687
Bram Moolenaar02467872007-05-06 13:22:01 +00003688 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 'c' Use console dialogs instead of popup dialogs for simple
3690 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003691 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003692 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003693 'guitablabel' can be used to change the text in the labels.
3694 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003695 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003696 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003697 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 'f' Foreground: Don't use fork() to detach the GUI from the shell
3699 where it was started. Use this for programs that wait for the
3700 editor to finish (e.g., an e-mail program). Alternatively you
3701 can use "gvim -f" or ":gui -f" to start the GUI in the
3702 foreground. |gui-fork|
3703 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003704 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003705 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3707 corner of the window. It's black&white on non-GTK, because of
3708 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003709 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003711 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003714 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 file is sourced the system menu has already been loaded; the
3716 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003717 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 'g' Grey menu items: Make menu items that are not active grey. If
3719 'g' is not included inactive menu items are not shown at all.
3720 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003721 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 't' Include tearoff menu items. Currently only works for Win32,
3723 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003724 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003725 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003726 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003727 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003729 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 'R' Right-hand scrollbar is present when there is a vertically
3731 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003732 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003734 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 'L' Left-hand scrollbar is present when there is a vertically
3736 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003737 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3739 the longest visible line, or on the cursor line if the 'h'
3740 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003741 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 'h' Limit horizontal scrollbar size to the length of the cursor
3743 line. Reduces computations. |gui-horiz-scroll|
3744
3745 And yes, you may even have scrollbars on the left AND the right if
3746 you really want to :-). See |gui-scrollbars| for more information.
3747
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003748 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749 'v' Use a vertical button layout for dialogs. When not included,
3750 a horizontal layout is preferred, but when it doesn't fit a
3751 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003752 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 'p' Use Pointer callbacks for X11 GUI. This is required for some
3754 window managers. If the cursor is not blinking or hollow at
3755 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003756 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003758 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003759 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760
Bram Moolenaar02467872007-05-06 13:22:01 +00003761
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 *'guipty'* *'noguipty'*
3763'guipty' boolean (default on)
3764 global
3765 {not in Vi}
3766 {only available when compiled with GUI enabled}
3767 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3768 I/O to/from shell commands. See |gui-pty|.
3769
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003770 *'guitablabel'* *'gtl'*
3771'guitablabel' 'gtl' string (default empty)
3772 global
3773 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003774 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003775 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003776 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003777 pages line. When empty and when the result is empty Vim will use a
3778 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003779
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003780 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003781 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003782
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003783 Only used when the GUI tab pages line is displayed. 'e' must be
3784 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3785 used.
3786
Bram Moolenaar57657d82006-04-21 22:12:41 +00003787 *'guitabtooltip'* *'gtt'*
3788'guitabtooltip' 'gtt' string (default empty)
3789 global
3790 {not in Vi}
3791 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003792 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003793 When nonempty describes the text to use in a tooltip for the GUI tab
3794 pages line. When empty Vim will use a default tooltip.
3795 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003796 You can include a line break. Simplest method is to use |:let|: >
3797 :let &guitabtooltip = "line one\nline two"
3798<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003799
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 *'helpfile'* *'hf'*
3801'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3802 (others) "$VIMRUNTIME/doc/help.txt")
3803 global
3804 {not in Vi}
3805 Name of the main help file. All distributed help files should be
3806 placed together in one directory. Additionally, all "doc" directories
3807 in 'runtimepath' will be used.
3808 Environment variables are expanded |:set_env|. For example:
3809 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003810 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 spaces and backslashes.
3812 This option cannot be set from a |modeline| or in the |sandbox|, for
3813 security reasons.
3814
3815 *'helpheight'* *'hh'*
3816'helpheight' 'hh' number (default 20)
3817 global
3818 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003819 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 feature}
3821 Minimal initial height of the help window when it is opened with the
3822 ":help" command. The initial height of the help window is half of the
3823 current window, or (when the 'ea' option is on) the same as other
3824 windows. When the height is less than 'helpheight', the height is
3825 set to 'helpheight'. Set to zero to disable.
3826
3827 *'helplang'* *'hlg'*
3828'helplang' 'hlg' string (default: messages language or empty)
3829 global
3830 {only available when compiled with the |+multi_lang|
3831 feature}
3832 {not in Vi}
3833 Comma separated list of languages. Vim will use the first language
3834 for which the desired help can be found. The English help will always
3835 be used as a last resort. You can add "en" to prefer English over
3836 another language, but that will only find tags that exist in that
3837 language and not in the English help.
3838 Example: >
3839 :set helplang=de,it
3840< This will first search German, then Italian and finally English help
3841 files.
3842 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3843 try to find the tag in the current language before using this option.
3844 See |help-translated|.
3845
3846 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3847'hidden' 'hid' boolean (default off)
3848 global
3849 {not in Vi}
3850 When off a buffer is unloaded when it is |abandon|ed. When on a
3851 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3852 displayed in another window, it does not become hidden, of course.
3853 The commands that move through the buffer list sometimes make a buffer
3854 hidden although the 'hidden' option is off: When the buffer is
3855 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003856 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003857 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 This option is set for one command with ":hide {command}" |:hide|.
3859 WARNING: It's easy to forget that you have changes in hidden buffers.
3860 Think twice when using ":q!" or ":qa!".
3861
3862 *'highlight'* *'hl'*
3863'highlight' 'hl' string (default (as a single string):
3864 "8:SpecialKey,@:NonText,d:Directory,
3865 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003866 M:ModeMsg,n:LineNr,N:CursorLineNr,
3867 r:Question,s:StatusLine,S:StatusLineNC,
3868 c:VertSplit, t:Title,v:Visual,
3869 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 f:Folded,F:FoldColumn,A:DiffAdd,
3871 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003872 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003873 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003874 +:Pmenu,=:PmenuSel,
3875 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 global
3877 {not in Vi}
3878 This option can be used to set highlighting mode for various
3879 occasions. It is a comma separated list of character pairs. The
3880 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003881 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3883 |hl-NonText| @ '~' and '@' at the end of the window and
3884 characters from 'showbreak'
3885 |hl-Directory| d directories in CTRL-D listing and other special
3886 things in listings
3887 |hl-ErrorMsg| e error messages
3888 h (obsolete, ignored)
3889 |hl-IncSearch| i 'incsearch' highlighting
3890 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3891 |hl-MoreMsg| m |more-prompt|
3892 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003893 |hl-LineNr| n line number for ":number" and ":#" commands, and
3894 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003895 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3896 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 |hl-Question| r |hit-enter| prompt and yes/no questions
3898 |hl-StatusLine| s status line of current window |status-line|
3899 |hl-StatusLineNC| S status lines of not-current windows
3900 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3901 |hl-VertSplit| c column used to separate vertically split windows
3902 |hl-Visual| v Visual mode
3903 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3904 Selection" Only X11 Gui's |gui-x11| and
3905 |xterm-clipboard|.
3906 |hl-WarningMsg| w warning messages
3907 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3908 |hl-Folded| f line used for closed folds
3909 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003910 |hl-DiffAdd| A added line in diff mode
3911 |hl-DiffChange| C changed line in diff mode
3912 |hl-DiffDelete| D deleted line in diff mode
3913 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003915 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003916 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003917 |hl-SpellRare| R rare word |spell|
3918 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003919 |hl-Conceal| - the placeholders used for concealed characters
3920 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003921 |hl-Pmenu| + popup menu normal line
3922 |hl-PmenuSel| = popup menu normal line
3923 |hl-PmenuSbar| x popup menu scrollbar
3924 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925
3926 The display modes are:
3927 r reverse (termcap entry "mr" and "me")
3928 i italic (termcap entry "ZH" and "ZR")
3929 b bold (termcap entry "md" and "me")
3930 s standout (termcap entry "so" and "se")
3931 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003932 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 n no highlighting
3934 - no highlighting
3935 : use a highlight group
3936 The default is used for occasions that are not included.
3937 If you want to change what the display modes do, see |dos-colors|
3938 for an example.
3939 When using the ':' display mode, this must be followed by the name of
3940 a highlight group. A highlight group can be used to define any type
3941 of highlighting, including using color. See |:highlight| on how to
3942 define one. The default uses a different group for each occasion.
3943 See |highlight-default| for the default highlight groups.
3944
3945 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3946'hlsearch' 'hls' boolean (default off)
3947 global
3948 {not in Vi}
3949 {not available when compiled without the
3950 |+extra_search| feature}
3951 When there is a previous search pattern, highlight all its matches.
3952 The type of highlighting used can be set with the 'l' occasion in the
3953 'highlight' option. This uses the "Search" highlight group by
3954 default. Note that only the matching text is highlighted, any offsets
3955 are not applied.
3956 See also: 'incsearch' and |:match|.
3957 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003958 off with |:nohlsearch|. This does not change the option value, as
3959 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003960 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 When the search pattern can match an end-of-line, Vim will try to
3962 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003963 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003965 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003966 You can specify whether the highlight status is restored on startup
3967 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003968 NOTE: This option is reset when 'compatible' is set.
3969
3970 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003971'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 global
3973 {not in Vi}
3974 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003975 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003977 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 NOTE: This option is set to the Vi default value when 'compatible' is
3979 set and to the Vim default value when 'compatible' is reset.
3980
3981 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3982'hkmap' 'hk' boolean (default off)
3983 global
3984 {not in Vi}
3985 {only available when compiled with the |+rightleft|
3986 feature}
3987 When on, the keyboard is mapped for the Hebrew character set.
3988 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3989 toggle this option. See |rileft.txt|.
3990 NOTE: This option is reset when 'compatible' is set.
3991
3992 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3993'hkmapp' 'hkp' boolean (default off)
3994 global
3995 {not in Vi}
3996 {only available when compiled with the |+rightleft|
3997 feature}
3998 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3999 This is useful if you have a non-Hebrew keyboard.
4000 See |rileft.txt|.
4001 NOTE: This option is reset when 'compatible' is set.
4002
4003 *'icon'* *'noicon'*
4004'icon' boolean (default off, on when title can be restored)
4005 global
4006 {not in Vi}
4007 {not available when compiled without the |+title|
4008 feature}
4009 When on, the icon text of the window will be set to the value of
4010 'iconstring' (if it is not empty), or to the name of the file
4011 currently being edited. Only the last part of the name is used.
4012 Overridden by the 'iconstring' option.
4013 Only works if the terminal supports setting window icons (currently
4014 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4015 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4016 builtin termcap).
4017 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004018 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004020 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021
4022 *'iconstring'*
4023'iconstring' string (default "")
4024 global
4025 {not in Vi}
4026 {not available when compiled without the |+title|
4027 feature}
4028 When this option is not empty, it will be used for the icon text of
4029 the window. This happens only when the 'icon' option is on.
4030 Only works if the terminal supports setting window icon text
4031 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4032 Does not work for MS Windows.
4033 When Vim was compiled with HAVE_X11 defined, the original icon will be
4034 restored if possible |X11|.
4035 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004036 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 'titlestring' for example settings.
4038 {not available when compiled without the |+statusline| feature}
4039
4040 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4041'ignorecase' 'ic' boolean (default off)
4042 global
4043 Ignore case in search patterns. Also used when searching in the tags
4044 file.
4045 Also see 'smartcase'.
4046 Can be overruled by using "\c" or "\C" in the pattern, see
4047 |/ignorecase|.
4048
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004049 *'imactivatefunc'* *'imaf'*
4050'imactivatefunc' 'imaf' string (default "")
4051 global
4052 {not in Vi}
4053 {only available when compiled with |+xim| and
4054 |+GUI_GTK|}
4055 This option specifies a function that will be called to
4056 activate/inactivate Input Method.
4057
4058 Example: >
4059 function ImActivateFunc(active)
4060 if a:active
4061 ... do something
4062 else
4063 ... do something
4064 endif
4065 " return value is not used
4066 endfunction
4067 set imactivatefunc=ImActivateFunc
4068<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 *'imactivatekey'* *'imak'*
4070'imactivatekey' 'imak' string (default "")
4071 global
4072 {not in Vi}
4073 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004074 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 Specifies the key that your Input Method in X-Windows uses for
4076 activation. When this is specified correctly, vim can fully control
4077 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4078 You can't use this option to change the activation key, the option
4079 tells Vim what the key is.
4080 Format:
4081 [MODIFIER_FLAG-]KEY_STRING
4082
4083 These characters can be used for MODIFIER_FLAG (case is ignored):
4084 S Shift key
4085 L Lock key
4086 C Control key
4087 1 Mod1 key
4088 2 Mod2 key
4089 3 Mod3 key
4090 4 Mod4 key
4091 5 Mod5 key
4092 Combinations are allowed, for example "S-C-space" or "SC-space" are
4093 both shift+ctrl+space.
4094 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4095
4096 Example: >
4097 :set imactivatekey=S-space
4098< "S-space" means shift+space. This is the activation key for kinput2 +
4099 canna (Japanese), and ami (Korean).
4100
4101 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4102'imcmdline' 'imc' boolean (default off)
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 always on when starting to edit a command
4108 line, unless entering a search pattern (see 'imsearch' for that).
4109 Setting this option is useful when your input method allows entering
4110 English characters directly, e.g., when it's used to type accented
4111 characters with dead keys.
4112
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004113 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4115 global
4116 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004117 {only available when compiled with the |+xim|,
4118 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 When set the Input Method is never used. This is useful to disable
4120 the IM when it doesn't work properly.
4121 Currently this option is on by default for SGI/IRIX machines. This
4122 may change in later releases.
4123
4124 *'iminsert'* *'imi'*
4125'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4126 local to buffer
4127 {not in Vi}
4128 Specifies whether :lmap or an Input Method (IM) is to be used in
4129 Insert mode. Valid values:
4130 0 :lmap is off and IM is off
4131 1 :lmap is ON and IM is off
4132 2 :lmap is off and IM is ON
4133 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4134 or |global-ime|.
4135 To always reset the option to zero when leaving Insert mode with <Esc>
4136 this can be used: >
4137 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4138< This makes :lmap and IM turn off automatically when leaving Insert
4139 mode.
4140 Note that this option changes when using CTRL-^ in Insert mode
4141 |i_CTRL-^|.
4142 The value is set to 1 when setting 'keymap' to a valid keymap name.
4143 It is also used for the argument of commands like "r" and "f".
4144 The value 0 may not work correctly with Athena and Motif with some XIM
4145 methods. Use 'imdisable' to disable XIM then.
4146
4147 *'imsearch'* *'ims'*
4148'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4149 local to buffer
4150 {not in Vi}
4151 Specifies whether :lmap or an Input Method (IM) is to be used when
4152 entering a search pattern. Valid values:
4153 -1 the value of 'iminsert' is used, makes it look like
4154 'iminsert' is also used when typing a search pattern
4155 0 :lmap is off and IM is off
4156 1 :lmap is ON and IM is off
4157 2 :lmap is off and IM is ON
4158 Note that this option changes when using CTRL-^ in Command-line mode
4159 |c_CTRL-^|.
4160 The value is set to 1 when it is not -1 and setting the 'keymap'
4161 option to a valid keymap name.
4162 The value 0 may not work correctly with Athena and Motif with some XIM
4163 methods. Use 'imdisable' to disable XIM then.
4164
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004165 *'imstatusfunc'* *'imsf'*
4166'imstatusfunc' 'imsf' string (default "")
4167 global
4168 {not in Vi}
4169 {only available when compiled with |+xim| and
4170 |+GUI_GTK|}
4171 This option specifies a function that is called to obtain the status
4172 of Input Method. It must return a positive number when IME is active.
4173
4174 Example: >
4175 function ImStatusFunc()
4176 let is_active = ...do something
4177 return is_active ? 1 : 0
4178 endfunction
4179 set imstatusfunc=ImStatusFunc
4180<
4181 NOTE: This function is invoked very often. Keep it fast.
4182
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 *'include'* *'inc'*
4184'include' 'inc' string (default "^\s*#\s*include")
4185 global or local to buffer |global-local|
4186 {not in Vi}
4187 {not available when compiled without the
4188 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004189 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190 pattern, just like for the "/" command (See |pattern|). The default
4191 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004192 "]I", "[d", etc.
4193 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004194 comes after the matched pattern. But if "\zs" appears in the pattern
4195 then the text matched from "\zs" to the end, or until "\ze" if it
4196 appears, is used as the file name. Use this to include characters
4197 that are not in 'isfname', such as a space. You can then use
4198 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004199 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200
4201 *'includeexpr'* *'inex'*
4202'includeexpr' 'inex' string (default "")
4203 local to buffer
4204 {not in Vi}
4205 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004206 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004208 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 :set includeexpr=substitute(v:fname,'\\.','/','g')
4210< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004211
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004213 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 Also used for |<cfile>|.
4215
Bram Moolenaar30b65812012-07-12 22:01:11 +02004216 The expression will be evaluated in the |sandbox| when set from a
4217 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004218
4219 It is not allowed to change text or jump to another window while
4220 evaluating 'includeexpr' |textlock|.
4221
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4223'incsearch' 'is' boolean (default off)
4224 global
4225 {not in Vi}
4226 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004227 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004228 While typing a search command, show where the pattern, as it was typed
4229 so far, matches. The matched string is highlighted. If the pattern
4230 is invalid or not found, nothing is shown. The screen will be updated
4231 often, this is only useful on fast terminals.
4232 Note that the match will be shown, but the cursor will return to its
4233 original position when no match is found and when pressing <Esc>. You
4234 still need to finish the search command with <Enter> to move the
4235 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004236 When compiled with the |+reltime| feature Vim only searches for about
4237 half a second. With a complicated pattern and/or a lot of text the
4238 match may not be found. This is to avoid that Vim hangs while you
4239 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004240 The highlighting can be set with the 'i' flag in 'highlight'.
4241 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004242 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004243 to the command line. If 'ignorecase' and 'smartcase' are set and the
4244 command line has no uppercase characters, the added character is
4245 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004246 CTRL-R CTRL-W can be used to add the word at the end of the current
4247 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248 NOTE: This option is reset when 'compatible' is set.
4249
4250 *'indentexpr'* *'inde'*
4251'indentexpr' 'inde' string (default "")
4252 local to buffer
4253 {not in Vi}
4254 {not available when compiled without the |+cindent|
4255 or |+eval| features}
4256 Expression which is evaluated to obtain the proper indent for a line.
4257 It is used when a new line is created, for the |=| operator and
4258 in Insert mode as specified with the 'indentkeys' option.
4259 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004260 'smartindent' indenting. When 'lisp' is set, this option is
4261 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262 When 'paste' is set this option is not used for indenting.
4263 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004264 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265 when the expression is evaluated (but it may be moved around).
4266 The expression must return the number of spaces worth of indent. It
4267 can return "-1" to keep the current indent (this means 'autoindent' is
4268 used for the indent).
4269 Functions useful for computing the indent are |indent()|, |cindent()|
4270 and |lispindent()|.
4271 The evaluation of the expression must not have side effects! It must
4272 not change the text, jump to another window, etc. Afterwards the
4273 cursor position is always restored, thus the cursor may be moved.
4274 Normally this option would be set to call a function: >
4275 :set indentexpr=GetMyIndent()
4276< Error messages will be suppressed, unless the 'debug' option contains
4277 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004278 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 NOTE: This option is made empty when 'compatible' is set.
4280
Bram Moolenaar30b65812012-07-12 22:01:11 +02004281 The expression will be evaluated in the |sandbox| when set from a
4282 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004283
4284 It is not allowed to change text or jump to another window while
4285 evaluating 'indentexpr' |textlock|.
4286
4287
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 *'indentkeys'* *'indk'*
4289'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4290 local to buffer
4291 {not in Vi}
4292 {not available when compiled without the |+cindent|
4293 feature}
4294 A list of keys that, when typed in Insert mode, cause reindenting of
4295 the current line. Only happens if 'indentexpr' isn't empty.
4296 The format is identical to 'cinkeys', see |indentkeys-format|.
4297 See |C-indenting| and |indent-expression|.
4298
4299 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4300'infercase' 'inf' boolean (default off)
4301 local to buffer
4302 {not in Vi}
4303 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004304 'ignorecase' is also on, the case of the match is adjusted depending
4305 on the typed text. If the typed text contains a lowercase letter
4306 where the match has an upper case letter, the completed part is made
4307 lowercase. If the typed text has no lowercase letters and the match
4308 has a lowercase letter where the typed text has an uppercase letter,
4309 and there is a letter before it, the completed part is made uppercase.
4310 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311
4312 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4313'insertmode' 'im' boolean (default off)
4314 global
4315 {not in Vi}
4316 Makes Vim work in a way that Insert mode is the default mode. Useful
4317 if you want to use Vim as a modeless editor. Used for |evim|.
4318 These Insert mode commands will be useful:
4319 - Use the cursor keys to move around.
4320 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4321 this is a mapping, it is executed as if 'insertmode' was off.
4322 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004324 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4325 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326
4327 These items change when 'insertmode' is set:
4328 - when starting to edit of a file, Vim goes to Insert mode.
4329 - <Esc> in Insert mode is a no-op and beeps.
4330 - <Esc> in Normal mode makes Vim go to Insert mode.
4331 - CTRL-L in Insert mode is a command, it is not inserted.
4332 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4333 However, when <Esc> is used inside a mapping, it behaves like
4334 'insertmode' was not set. This was done to be able to use the same
4335 mappings with 'insertmode' set or not set.
4336 When executing commands with |:normal| 'insertmode' is not used.
4337
4338 NOTE: This option is reset when 'compatible' is set.
4339
4340 *'isfname'* *'isf'*
4341'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4342 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4343 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4344 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4345 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4346 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4347 global
4348 {not in Vi}
4349 The characters specified by this option are included in file names and
4350 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004351 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Multi-byte characters 256 and above are always included, only the
4353 characters up to 255 are specified with this option.
4354 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004355 Think twice before adding white space to this option. Although a
4356 space may appear inside a file name, the effect will be that Vim
4357 doesn't know where a file name starts or ends when doing completion.
4358 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
4360 Note that on systems using a backslash as path separator, Vim tries to
4361 do its best to make it work as you would expect. That is a bit
4362 tricky, since Vi originally used the backslash to escape special
4363 characters. Vim will not remove a backslash in front of a normal file
4364 name character on these systems, but it will on Unix and alikes. The
4365 '&' and '^' are not included by default, because these are special for
4366 cmd.exe.
4367
4368 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004369 Each part can be a single character number or a range. A range is two
4370 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 decimal number between 0 and 255 or the ASCII character itself (does
4372 not work for digits). Example:
4373 "_,-,128-140,#-43" (include '_' and '-' and the range
4374 128 to 140 and '#' to 43)
4375 If a part starts with '^', the following character number or range
4376 will be excluded from the option. The option is interpreted from left
4377 to right. Put the excluded character after the range where it is
4378 included. To include '^' itself use it as the last character of the
4379 option or the end of a range. Example:
4380 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4381 If the character is '@', all characters where isalpha() returns TRUE
4382 are included. Normally these are the characters a to z and A to Z,
4383 plus accented characters. To include '@' itself use "@-@". Examples:
4384 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004385 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 "a-z,A-Z,@-@" All letters plus the '@' character.
4387 A comma can be included by using it where a character number is
4388 expected. Example:
4389 "48-57,,,_" Digits, comma and underscore.
4390 A comma can be excluded by prepending a '^'. Example:
4391 " -~,^,,9" All characters from space to '~', excluding
4392 comma, plus <Tab>.
4393 See |option-backslash| about including spaces and backslashes.
4394
4395 *'isident'* *'isi'*
4396'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4397 "@,48-57,_,128-167,224-235"
4398 otherwise: "@,48-57,_,192-255")
4399 global
4400 {not in Vi}
4401 The characters given by this option are included in identifiers.
4402 Identifiers are used in recognizing environment variables and after a
4403 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004404 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 option.
4406 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4409
4410 *'iskeyword'* *'isk'*
4411'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4412 "@,48-57,_,128-167,224-235"
4413 otherwise: "@,48-57,_,192-255"
4414 Vi default: "@,48-57,_")
4415 local to buffer
4416 {not in Vi}
4417 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004418 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 'isfname' for a description of the format of this option. For C
4420 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4421 For a help file it is set to all non-blank printable characters except
4422 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4423 command).
4424 When the 'lisp' option is on the '-' character is always included.
4425 NOTE: This option is set to the Vi default value when 'compatible' is
4426 set and to the Vim default value when 'compatible' is reset.
4427
4428 *'isprint'* *'isp'*
4429'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4430 "@,~-255"; otherwise: "@,161-255")
4431 global
4432 {not in Vi}
4433 The characters given by this option are displayed directly on the
4434 screen. It is also used for "\p" in a |pattern|. The characters from
4435 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4436 even when they are not included in 'isprint' or excluded. See
4437 'isfname' for a description of the format of this option.
4438
4439 Non-printable characters are displayed with two characters:
4440 0 - 31 "^@" - "^_"
4441 32 - 126 always single characters
4442 127 "^?"
4443 128 - 159 "~@" - "~_"
4444 160 - 254 "| " - "|~"
4445 255 "~?"
4446 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4447 displayed as <xx>, with the hexadecimal value of the byte.
4448 When 'display' contains "uhex" all unprintable characters are
4449 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004450 The SpecialKey highlighting will be used for unprintable characters.
4451 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452
4453 Multi-byte characters 256 and above are always included, only the
4454 characters up to 255 are specified with this option. When a character
4455 is printable but it is not available in the current font, a
4456 replacement character will be shown.
4457 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4458 There is no option to specify these characters.
4459
4460 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4461'joinspaces' 'js' boolean (default on)
4462 global
4463 {not in Vi}
4464 Insert two spaces after a '.', '?' and '!' with a join command.
4465 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4466 Otherwise only one space is inserted.
4467 NOTE: This option is set when 'compatible' is set.
4468
4469 *'key'*
4470'key' string (default "")
4471 local to buffer
4472 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004473 {only available when compiled with the |+cryptv|
4474 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004476 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 Careful: Do not set the key value by hand, someone might see the typed
4478 key. Use the |:X| command. But you can make 'key' empty: >
4479 :set key=
4480< It is not possible to get the value of this option with ":set key" or
4481 "echo &key". This is to avoid showing it to someone who shouldn't
4482 know. It also means you cannot see it yourself once you have set it,
4483 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004484 You can use "&key" in an expression to detect whether encryption is
4485 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
4487 *'keymap'* *'kmp'* *E544*
4488'keymap' 'kmp' string (default "")
4489 local to buffer
4490 {not in Vi}
4491 {only available when compiled with the |+keymap|
4492 feature}
4493 Name of a keyboard mapping. See |mbyte-keymap|.
4494 Setting this option to a valid keymap name has the side effect of
4495 setting 'iminsert' to one, so that the keymap becomes effective.
4496 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004497 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498
4499 *'keymodel'* *'km'*
4500'keymodel' 'km' string (default "")
4501 global
4502 {not in Vi}
4503 List of comma separated words, which enable special things that keys
4504 can do. These values can be used:
4505 startsel Using a shifted special key starts selection (either
4506 Select mode or Visual mode, depending on "key" being
4507 present in 'selectmode').
4508 stopsel Using a not-shifted special key stops selection.
4509 Special keys in this context are the cursor keys, <End>, <Home>,
4510 <PageUp> and <PageDown>.
4511 The 'keymodel' option is set by the |:behave| command.
4512
4513 *'keywordprg'* *'kp'*
4514'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4515 OS/2: "view /", VMS: "help")
4516 global or local to buffer |global-local|
4517 {not in Vi}
4518 Program to use for the |K| command. Environment variables are
4519 expanded |:set_env|. ":help" may be used to access the Vim internal
4520 help. (Note that previously setting the global option to the empty
4521 value did this, which is now deprecated.)
4522 When "man" is used, Vim will automatically translate a count for the
4523 "K" command to a section number. Also for "man -s", in which case the
4524 "-s" is removed when there is no count.
4525 See |option-backslash| about including spaces and backslashes.
4526 Example: >
4527 :set keywordprg=man\ -s
4528< This option cannot be set from a |modeline| or in the |sandbox|, for
4529 security reasons.
4530
4531 *'langmap'* *'lmap'* *E357* *E358*
4532'langmap' 'lmap' string (default "")
4533 global
4534 {not in Vi}
4535 {only available when compiled with the |+langmap|
4536 feature}
4537 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004538 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 inserted directly. When in command mode the 'langmap' option takes
4540 care of translating these special characters to the original meaning
4541 of the key. This means you don't have to change the keyboard mode to
4542 be able to execute Normal mode commands.
4543 This is the opposite of the 'keymap' option, where characters are
4544 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004545 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4546 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004547 This option cannot be set from a |modeline| or in the |sandbox|, for
4548 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004550 Example (for Greek, in UTF-8): *greek* >
4551 :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 +00004552< Example (exchanges meaning of z and y for commands): >
4553 :set langmap=zy,yz,ZY,YZ
4554<
4555 The 'langmap' option is a list of parts, separated with commas. Each
4556 part can be in one of two forms:
4557 1. A list of pairs. Each pair is a "from" character immediately
4558 followed by the "to" character. Examples: "aA", "aAbBcC".
4559 2. A list of "from" characters, a semi-colon and a list of "to"
4560 characters. Example: "abc;ABC"
4561 Example: "aA,fgh;FGH,cCdDeE"
4562 Special characters need to be preceded with a backslash. These are
4563 ";", ',' and backslash itself.
4564
4565 This will allow you to activate vim actions without having to switch
4566 back and forth between the languages. Your language characters will
4567 be understood as normal vim English characters (according to the
4568 langmap mappings) in the following cases:
4569 o Normal/Visual mode (commands, buffer/register names, user mappings)
4570 o Insert/Replace Mode: Register names after CTRL-R
4571 o Insert/Replace Mode: Mappings
4572 Characters entered in Command-line mode will NOT be affected by
4573 this option. Note that this option can be changed at any time
4574 allowing to switch between mappings for different languages/encodings.
4575 Use a mapping to avoid having to type it each time!
4576
4577 *'langmenu'* *'lm'*
4578'langmenu' 'lm' string (default "")
4579 global
4580 {not in Vi}
4581 {only available when compiled with the |+menu| and
4582 |+multi_lang| features}
4583 Language to use for menu translation. Tells which file is loaded
4584 from the "lang" directory in 'runtimepath': >
4585 "lang/menu_" . &langmenu . ".vim"
4586< (without the spaces). For example, to always use the Dutch menus, no
4587 matter what $LANG is set to: >
4588 :set langmenu=nl_NL.ISO_8859-1
4589< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004590 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 If your $LANG is set to a non-English language but you do want to use
4592 the English menus: >
4593 :set langmenu=none
4594< This option must be set before loading menus, switching on filetype
4595 detection or syntax highlighting. Once the menus are defined setting
4596 this option has no effect. But you could do this: >
4597 :source $VIMRUNTIME/delmenu.vim
4598 :set langmenu=de_DE.ISO_8859-1
4599 :source $VIMRUNTIME/menu.vim
4600< Warning: This deletes all menus that you defined yourself!
4601
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004602 *'langnoremap'* *'lnr'*
4603'langnoremap' 'lnr' boolean (default off)
4604 global
4605 {not in Vi}
4606 {only available when compiled with the |+langmap|
4607 feature}
4608 When on, setting 'langmap' does not apply to characters resulting from
4609 a mapping. This basically means, if you noticed that setting
4610 'langmap' disables some of your mappings, try setting this option.
4611 This option defaults to off for backwards compatibility. Set it on if
4612 that works for you to avoid mappings to break.
4613
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 *'laststatus'* *'ls'*
4615'laststatus' 'ls' number (default 1)
4616 global
4617 {not in Vi}
4618 The value of this option influences when the last window will have a
4619 status line:
4620 0: never
4621 1: only if there are at least two windows
4622 2: always
4623 The screen looks nicer with a status line if you have several
4624 windows, but it takes another screen line. |status-line|
4625
4626 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4627'lazyredraw' 'lz' boolean (default off)
4628 global
4629 {not in Vi}
4630 When this option is set, the screen will not be redrawn while
4631 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004632 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 update use |:redraw|.
4634
4635 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4636'linebreak' 'lbr' boolean (default off)
4637 local to window
4638 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004639 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004641 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642 than at the last character that fits on the screen. Unlike
4643 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004644 it only affects the way the file is displayed, not its contents.
4645 If 'breakindent' is set, line is visually indented. Then, the value
4646 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004647 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 Note that <Tab> characters after an <EOL> are mostly not displayed
4649 with the right amount of white space.
4650
4651 *'lines'* *E593*
4652'lines' number (default 24 or terminal height)
4653 global
4654 Number of lines of the Vim window.
4655 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004656 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657 When Vim is running in the GUI or in a resizable window, setting this
4658 option will cause the window size to be changed. When you only want
4659 to use the size for the GUI, put the command in your |gvimrc| file.
4660 Vim limits the number of lines to what fits on the screen. You can
4661 use this command to get the tallest window possible: >
4662 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004663< Minimum value is 2, maximum value is 1000.
4664 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 When you set this option and Vim is unable to change the physical
4666 number of lines of the display, the display may be messed up.
4667
4668 *'linespace'* *'lsp'*
4669'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4670 global
4671 {not in Vi}
4672 {only in the GUI}
4673 Number of pixel lines inserted between characters. Useful if the font
4674 uses the full character cell height, making lines touch each other.
4675 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004676 With some fonts there can be too much room between lines (to have
4677 space for ascents and descents). Then it makes sense to set
4678 'linespace' to a negative value. This may cause display problems
4679 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
4681 *'lisp'* *'nolisp'*
4682'lisp' boolean (default off)
4683 local to buffer
4684 {not available when compiled without the |+lispindent|
4685 feature}
4686 Lisp mode: When <Enter> is typed in insert mode set the indent for
4687 the next line to Lisp standards (well, sort of). Also happens with
4688 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4689 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4690 better. Also see 'lispwords'.
4691 The '-' character is included in keyword characters. Redefines the
4692 "=" operator to use this same indentation algorithm rather than
4693 calling an external program if 'equalprg' is empty.
4694 This option is not used when 'paste' is set.
4695 {Vi: Does it a little bit differently}
4696
4697 *'lispwords'* *'lw'*
4698'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004699 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 {not in Vi}
4701 {not available when compiled without the |+lispindent|
4702 feature}
4703 Comma separated list of words that influence the Lisp indenting.
4704 |'lisp'|
4705
4706 *'list'* *'nolist'*
4707'list' boolean (default off)
4708 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004709 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4710 line. Useful to see the difference between tabs and spaces and for
4711 trailing blanks. Further changed by the 'listchars' option.
4712
4713 The cursor is displayed at the start of the space a Tab character
4714 occupies, not at the end as usual in Normal mode. To get this cursor
4715 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004716 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004717<
4718 Note that list mode will also affect formatting (set with 'textwidth'
4719 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 changing the way tabs are displayed.
4721
4722 *'listchars'* *'lcs'*
4723'listchars' 'lcs' string (default "eol:$")
4724 global
4725 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004726 Strings to use in 'list' mode and for the |:list| command. It is a
4727 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004728 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 eol:c Character to show at the end of each line. When
4730 omitted, there is no extra character at the end of the
4731 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004732 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004733 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004735 fill the space that the tab normally occupies.
4736 "tab:>-" will show a tab that takes four spaces as
4737 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004738 *lcs-space*
4739 space:c Character to show for a space. When omitted, spaces
4740 are left blank.
4741 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004742 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004743 trailing spaces are blank. Overrides the "space"
4744 setting for trailing spaces.
4745 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746 extends:c Character to show in the last column, when 'wrap' is
4747 off and the line continues beyond the right of the
4748 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004749 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 precedes:c Character to show in the first column, when 'wrap'
4751 is off and there is text preceding the character
4752 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004753 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004754 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004755 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004756 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004757 nbsp:c Character to show for a non-breakable space character
4758 (0xA0 (160 decimal) and U+202F). Left blank when
4759 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004761 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004763 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764
4765 Examples: >
4766 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004767 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 :set lcs=extends:>,precedes:<
4769< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004770 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004771 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772
4773 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4774'loadplugins' 'lpl' boolean (default on)
4775 global
4776 {not in Vi}
4777 When on the plugin scripts are loaded when starting up |load-plugins|.
4778 This option can be reset in your |vimrc| file to disable the loading
4779 of plugins.
4780 Note that using the "-u NONE" and "--noplugin" command line arguments
4781 reset this option. |-u| |--noplugin|
4782
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004783 *'macatsui'* *'nomacatsui'*
4784'macatsui' boolean (default on)
4785 global
4786 {only available in Mac GUI version}
4787 This is a workaround for when drawing doesn't work properly. When set
4788 and compiled with multi-byte support ATSUI text drawing is used. When
4789 not set ATSUI text drawing is not used. Switch this option off when
4790 you experience drawing problems. In a future version the problems may
4791 be solved and this option becomes obsolete. Therefore use this method
4792 to unset it: >
4793 if exists('&macatsui')
4794 set nomacatsui
4795 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004796< Another option to check if you have drawing problems is
4797 'termencoding'.
4798
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799 *'magic'* *'nomagic'*
4800'magic' boolean (default on)
4801 global
4802 Changes the special characters that can be used in search patterns.
4803 See |pattern|.
4804 NOTE: To avoid portability problems with using patterns, always keep
4805 this option at the default "on". Only switch it off when working with
4806 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004807 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808
4809 *'makeef'* *'mef'*
4810'makeef' 'mef' string (default: "")
4811 global
4812 {not in Vi}
4813 {not available when compiled without the |+quickfix|
4814 feature}
4815 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4816 and the |:grep| command.
4817 When it is empty, an internally generated temp file will be used.
4818 When "##" is included, it is replaced by a number to make the name
4819 unique. This makes sure that the ":make" command doesn't overwrite an
4820 existing file.
4821 NOT used for the ":cf" command. See 'errorfile' for that.
4822 Environment variables are expanded |:set_env|.
4823 See |option-backslash| about including spaces and backslashes.
4824 This option cannot be set from a |modeline| or in the |sandbox|, for
4825 security reasons.
4826
4827 *'makeprg'* *'mp'*
4828'makeprg' 'mp' string (default "make", VMS: "MMS")
4829 global or local to buffer |global-local|
4830 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004831 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004832 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4833 which are expanded to the current and alternate file name. Use |::S|
4834 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004835 Environment variables are expanded |:set_env|. See |option-backslash|
4836 about including spaces and backslashes.
4837 Note that a '|' must be escaped twice: once for ":set" and once for
4838 the interpretation of a command. When you use a filter called
4839 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 :set makeprg=gmake\ \\\|\ myfilter
4841< The placeholder "$*" can be given (even multiple times) to specify
4842 where the arguments will be included, for example: >
4843 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4844< This option cannot be set from a |modeline| or in the |sandbox|, for
4845 security reasons.
4846
4847 *'matchpairs'* *'mps'*
4848'matchpairs' 'mps' string (default "(:),{:},[:]")
4849 local to buffer
4850 {not in Vi}
4851 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004852 other.
4853 Only character pairs are allowed that are different, thus you cannot
4854 jump between two double quotes.
4855 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004856 The pairs must be separated by a comma. Example for including '<' and
4857 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 :set mps+=<:>
4859
4860< A more exotic example, to jump between the '=' and ';' in an
4861 assignment, useful for languages like C and Java: >
4862 :au FileType c,cpp,java set mps+==:;
4863
4864< For a more advanced way of using "%", see the matchit.vim plugin in
4865 the $VIMRUNTIME/macros directory. |add-local-help|
4866
4867 *'matchtime'* *'mat'*
4868'matchtime' 'mat' number (default 5)
4869 global
4870 {not in Vi}{in Nvi}
4871 Tenths of a second to show the matching paren, when 'showmatch' is
4872 set. Note that this is not in milliseconds, like other options that
4873 set a time. This is to be compatible with Nvi.
4874
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004875 *'maxcombine'* *'mco'*
4876'maxcombine' 'mco' number (default 2)
4877 global
4878 {not in Vi}
4879 {only available when compiled with the |+multi_byte|
4880 feature}
4881 The maximum number of combining characters supported for displaying.
4882 Only used when 'encoding' is "utf-8".
4883 The default is OK for most languages. Hebrew may require 4.
4884 Maximum value is 6.
4885 Even when this option is set to 2 you can still edit text with more
4886 combining characters, you just can't see them. Use |g8| or |ga|.
4887 See |mbyte-combining|.
4888
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 *'maxfuncdepth'* *'mfd'*
4890'maxfuncdepth' 'mfd' number (default 100)
4891 global
4892 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004893 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004894 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895 Maximum depth of function calls for user functions. This normally
4896 catches endless recursion. When using a recursive function with
4897 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4898 more memory, there is the danger of failing when memory is exhausted.
4899 See also |:function|.
4900
4901 *'maxmapdepth'* *'mmd'* *E223*
4902'maxmapdepth' 'mmd' number (default 1000)
4903 global
4904 {not in Vi}
4905 Maximum number of times a mapping is done without resulting in a
4906 character to be used. This normally catches endless mappings, like
4907 ":map x y" with ":map y x". It still does not catch ":map g wg",
4908 because the 'w' is used before the next mapping is done. See also
4909 |key-mapping|.
4910
4911 *'maxmem'* *'mm'*
4912'maxmem' 'mm' number (default between 256 to 5120 (system
4913 dependent) or half the amount of memory
4914 available)
4915 global
4916 {not in Vi}
4917 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4918 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004919 other memory to be freed. The maximum usable value is about 2000000.
4920 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004922 *'maxmempattern'* *'mmp'*
4923'maxmempattern' 'mmp' number (default 1000)
4924 global
4925 {not in Vi}
4926 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004927 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004928 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004929 When Vim runs into the limit it gives an error message and mostly
4930 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004931 Running into the limit often means that the pattern is very
4932 inefficient or too complex. This may already happen with the pattern
4933 "\(.\)*" on a very long line. ".*" works much better.
4934 Vim may run out of memory before hitting the 'maxmempattern' limit.
4935
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 *'maxmemtot'* *'mmt'*
4937'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4938 dependent) or half the amount of memory
4939 available)
4940 global
4941 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004942 Maximum amount of memory in Kbyte to use for all buffers together.
4943 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4944 without a limit. On 64 bit machines higher values might work. But
4945 hey, do you really need more than 2 Gbyte for text editing?
4946 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947
4948 *'menuitems'* *'mis'*
4949'menuitems' 'mis' number (default 25)
4950 global
4951 {not in Vi}
4952 {not available when compiled without the |+menu|
4953 feature}
4954 Maximum number of items to use in a menu. Used for menus that are
4955 generated from a list of items, e.g., the Buffers menu. Changing this
4956 option has no direct effect, the menu must be refreshed first.
4957
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004958 *'mkspellmem'* *'msm'*
4959'mkspellmem' 'msm' string (default "460000,2000,500")
4960 global
4961 {not in Vi}
4962 {not available when compiled without the |+syntax|
4963 feature}
4964 Parameters for |:mkspell|. This tunes when to start compressing the
4965 word tree. Compression can be slow when there are many words, but
4966 it's needed to avoid running out of memory. The amount of memory used
4967 per word depends very much on how similar the words are, that's why
4968 this tuning is complicated.
4969
4970 There are three numbers, separated by commas:
4971 {start},{inc},{added}
4972
4973 For most languages the uncompressed word tree fits in memory. {start}
4974 gives the amount of memory in Kbyte that can be used before any
4975 compression is done. It should be a bit smaller than the amount of
4976 memory that is available to Vim.
4977
4978 When going over the {start} limit the {inc} number specifies the
4979 amount of memory in Kbyte that can be allocated before another
4980 compression is done. A low number means compression is done after
4981 less words are added, which is slow. A high number means more memory
4982 will be allocated.
4983
4984 After doing compression, {added} times 1024 words can be added before
4985 the {inc} limit is ignored and compression is done when any extra
4986 amount of memory is needed. A low number means there is a smaller
4987 chance of hitting the {inc} limit, less memory is used but it's
4988 slower.
4989
4990 The languages for which these numbers are important are Italian and
4991 Hungarian. The default works for when you have about 512 Mbyte. If
4992 you have 1 Gbyte you could use: >
4993 :set mkspellmem=900000,3000,800
4994< If you have less than 512 Mbyte |:mkspell| may fail for some
4995 languages, no matter what you set 'mkspellmem' to.
4996
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004998'modeline' 'ml' boolean (Vim default: on (off for root),
4999 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 local to buffer
5001 *'modelines'* *'mls'*
5002'modelines' 'mls' number (default 5)
5003 global
5004 {not in Vi}
5005 If 'modeline' is on 'modelines' gives the number of lines that is
5006 checked for set commands. If 'modeline' is off or 'modelines' is zero
5007 no lines are checked. See |modeline|.
5008 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5009 set and to the Vim default value when 'compatible' is reset.
5010
5011 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5012'modifiable' 'ma' boolean (default on)
5013 local to buffer
5014 {not in Vi} *E21*
5015 When off the buffer contents cannot be changed. The 'fileformat' and
5016 'fileencoding' options also can't be changed.
5017 Can be reset with the |-M| command line argument.
5018
5019 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5020'modified' 'mod' boolean (default off)
5021 local to buffer
5022 {not in Vi}
5023 When on, the buffer is considered to be modified. This option is set
5024 when:
5025 1. A change was made to the text since it was last written. Using the
5026 |undo| command to go back to the original text will reset the
5027 option. But undoing changes that were made before writing the
5028 buffer will set the option again, since the text is different from
5029 when it was written.
5030 2. 'fileformat' or 'fileencoding' is different from its original
5031 value. The original value is set when the buffer is read or
5032 written. A ":set nomodified" command also resets the original
5033 values to the current values and the 'modified' option will be
5034 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005035 This option is not set when a change is made to the buffer as the
5036 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5037 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5038 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5040 will be ignored.
5041
5042 *'more'* *'nomore'*
5043'more' boolean (Vim default: on, Vi default: off)
5044 global
5045 {not in Vi}
5046 When on, listings pause when the whole screen is filled. You will get
5047 the |more-prompt|. When this option is off there are no pauses, the
5048 listing continues until finished.
5049 NOTE: This option is set to the Vi default value when 'compatible' is
5050 set and to the Vim default value when 'compatible' is reset.
5051
5052 *'mouse'* *E538*
5053'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5054 global
5055 {not in Vi}
5056 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005057 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5058 sysmouse and Linux console with gpm). For using the mouse in the
5059 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 The mouse can be enabled for different modes:
5061 n Normal mode
5062 v Visual mode
5063 i Insert mode
5064 c Command-line mode
5065 h all previous modes when editing a help file
5066 a all previous modes
5067 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 Normally you would enable the mouse in all four modes with: >
5069 :set mouse=a
5070< When the mouse is not enabled, the GUI will still use the mouse for
5071 modeless selection. This doesn't move the text cursor.
5072
5073 See |mouse-using|. Also see |'clipboard'|.
5074
5075 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005076 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 the mouse buttons can still be used by keeping the shift key pressed.
5078 Also see the 'clipboard' option.
5079
5080 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5081'mousefocus' 'mousef' boolean (default off)
5082 global
5083 {not in Vi}
5084 {only works in the GUI}
5085 The window that the mouse pointer is on is automatically activated.
5086 When changing the window layout or window focus in another way, the
5087 mouse pointer is moved to the window with keyboard focus. Off is the
5088 default because it makes using the pull down menus a little goofy, as
5089 a pointer transit may activate a window unintentionally.
5090
5091 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5092'mousehide' 'mh' boolean (default on)
5093 global
5094 {not in Vi}
5095 {only works in the GUI}
5096 When on, the mouse pointer is hidden when characters are typed.
5097 The mouse pointer is restored when the mouse is moved.
5098
5099 *'mousemodel'* *'mousem'*
5100'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5101 global
5102 {not in Vi}
5103 Sets the model to use for the mouse. The name mostly specifies what
5104 the right mouse button is used for:
5105 extend Right mouse button extends a selection. This works
5106 like in an xterm.
5107 popup Right mouse button pops up a menu. The shifted left
5108 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005109 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 popup_setpos Like "popup", but the cursor will be moved to the
5111 position where the mouse was clicked, and thus the
5112 selected operation will act upon the clicked object.
5113 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005114 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 course, that right clicking outside a selection will
5116 end Visual mode.
5117 Overview of what button does what for each model:
5118 mouse extend popup(_setpos) ~
5119 left click place cursor place cursor
5120 left drag start selection start selection
5121 shift-left search word extend selection
5122 right click extend selection popup menu (place cursor)
5123 right drag extend selection -
5124 middle click paste paste
5125
5126 In the "popup" model the right mouse button produces a pop-up menu.
5127 You need to define this first, see |popup-menu|.
5128
5129 Note that you can further refine the meaning of buttons with mappings.
5130 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5131 selection (because that's handled in the GUI code directly).
5132
5133 The 'mousemodel' option is set by the |:behave| command.
5134
5135 *'mouseshape'* *'mouses'* *E547*
5136'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005137 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 global
5139 {not in Vi}
5140 {only available when compiled with the |+mouseshape|
5141 feature}
5142 This option tells Vim what the mouse pointer should look like in
5143 different modes. The option is a comma separated list of parts, much
5144 like used for 'guicursor'. Each part consist of a mode/location-list
5145 and an argument-list:
5146 mode-list:shape,mode-list:shape,..
5147 The mode-list is a dash separated list of these modes/locations:
5148 In a normal window: ~
5149 n Normal mode
5150 v Visual mode
5151 ve Visual mode with 'selection' "exclusive" (same as 'v',
5152 if not specified)
5153 o Operator-pending mode
5154 i Insert mode
5155 r Replace mode
5156
5157 Others: ~
5158 c appending to the command-line
5159 ci inserting in the command-line
5160 cr replacing in the command-line
5161 m at the 'Hit ENTER' or 'More' prompts
5162 ml idem, but cursor in the last line
5163 e any mode, pointer below last window
5164 s any mode, pointer on a status line
5165 sd any mode, while dragging a status line
5166 vs any mode, pointer on a vertical separator line
5167 vd any mode, while dragging a vertical separator line
5168 a everywhere
5169
5170 The shape is one of the following:
5171 avail name looks like ~
5172 w x arrow Normal mouse pointer
5173 w x blank no pointer at all (use with care!)
5174 w x beam I-beam
5175 w x updown up-down sizing arrows
5176 w x leftright left-right sizing arrows
5177 w x busy The system's usual busy pointer
5178 w x no The system's usual 'no input' pointer
5179 x udsizing indicates up-down resizing
5180 x lrsizing indicates left-right resizing
5181 x crosshair like a big thin +
5182 x hand1 black hand
5183 x hand2 white hand
5184 x pencil what you write with
5185 x question big ?
5186 x rightup-arrow arrow pointing right-up
5187 w x up-arrow arrow pointing up
5188 x <number> any X11 pointer number (see X11/cursorfont.h)
5189
5190 The "avail" column contains a 'w' if the shape is available for Win32,
5191 x for X11.
5192 Any modes not specified or shapes not available use the normal mouse
5193 pointer.
5194
5195 Example: >
5196 :set mouseshape=s:udsizing,m:no
5197< will make the mouse turn to a sizing arrow over the status lines and
5198 indicate no input when the hit-enter prompt is displayed (since
5199 clicking the mouse has no effect in this state.)
5200
5201 *'mousetime'* *'mouset'*
5202'mousetime' 'mouset' number (default 500)
5203 global
5204 {not in Vi}
5205 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5206 time in msec between two mouse clicks for the second click to be
5207 recognized as a multi click.
5208
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005209 *'mzquantum'* *'mzq'*
5210'mzquantum' 'mzq' number (default 100)
5211 global
5212 {not in Vi}
5213 {not available when compiled without the |+mzscheme|
5214 feature}
5215 The number of milliseconds between polls for MzScheme threads.
5216 Negative or zero value means no thread scheduling.
5217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 *'nrformats'* *'nf'*
5219'nrformats' 'nf' string (default "octal,hex")
5220 local to buffer
5221 {not in Vi}
5222 This defines what bases Vim will consider for numbers when using the
5223 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5224 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005225 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005227 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005228 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005230 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 considered to be hexadecimal. Example: Using CTRL-X on
5232 "0x100" results in "0x0ff".
5233 Numbers which simply begin with a digit in the range 1-9 are always
5234 considered decimal. This also happens for numbers that are not
5235 recognized as octal or hex.
5236
5237 *'number'* *'nu'* *'nonumber'* *'nonu'*
5238'number' 'nu' boolean (default off)
5239 local to window
5240 Print the line number in front of each line. When the 'n' option is
5241 excluded from 'cpoptions' a wrapped line will not use the column of
5242 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005243 The 'numberwidth' option can be used to set the room used for the line
5244 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 When a long, wrapped line doesn't start with the first character, '-'
5246 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005247 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5248 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005249 *number_relativenumber*
5250 The 'relativenumber' option changes the displayed number to be
5251 relative to the cursor. Together with 'number' there are these
5252 four combinations (cursor in line 3):
5253
5254 'nonu' 'nu' 'nonu' 'nu'
5255 'nornu' 'nornu' 'rnu' 'rnu'
5256
5257 |apple | 1 apple | 2 apple | 2 apple
5258 |pear | 2 pear | 1 pear | 1 pear
5259 |nobody | 3 nobody | 0 nobody |3 nobody
5260 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005262 *'numberwidth'* *'nuw'*
5263'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5264 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005265 {not in Vi}
5266 {only available when compiled with the |+linebreak|
5267 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005268 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005269 when the 'number' or 'relativenumber' option is set or printing lines
5270 with a line number. Since one space is always between the number and
5271 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005272 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005273 fit the highest line number in the buffer respectively the number of
5274 rows in the window, depending on whether 'number' or 'relativenumber'
5275 is set. Thus with the Vim default of 4 there is room for a line number
5276 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005277 The minimum value is 1, the maximum value is 10.
5278 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5279
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005280 *'omnifunc'* *'ofu'*
5281'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005282 local to buffer
5283 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005284 {not available when compiled without the |+eval|
5285 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005286 This option specifies a function to be used for Insert mode omni
5287 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005288 See |complete-functions| for an explanation of how the function is
5289 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005290 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005291 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005292 This option cannot be set from a |modeline| or in the |sandbox|, for
5293 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005294
5295
Bram Moolenaar02467872007-05-06 13:22:01 +00005296 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005297'opendevice' 'odev' boolean (default off)
5298 global
5299 {not in Vi}
5300 {only for MS-DOS, MS-Windows and OS/2}
5301 Enable reading and writing from devices. This may get Vim stuck on a
5302 device that can be opened but doesn't actually do the I/O. Therefore
5303 it is off by default.
5304 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5305 result in editing a device.
5306
5307
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005308 *'operatorfunc'* *'opfunc'*
5309'operatorfunc' 'opfunc' string (default: empty)
5310 global
5311 {not in Vi}
5312 This option specifies a function to be called by the |g@| operator.
5313 See |:map-operator| for more info and an example.
5314
5315 This option cannot be set from a |modeline| or in the |sandbox|, for
5316 security reasons.
5317
5318
Bram Moolenaar251e1912011-06-19 05:09:16 +02005319 *'osfiletype'* *'oft'*
5320'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 local to buffer
5322 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005323 This option was supported on RISC OS, which has been removed.
5324
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005327'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 global
5329 Specifies the nroff macros that separate paragraphs. These are pairs
5330 of two letters (see |object-motions|).
5331
5332 *'paste'* *'nopaste'*
5333'paste' boolean (default off)
5334 global
5335 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005336 Put Vim in Paste mode. This is useful if you want to cut or copy
5337 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338 unexpected effects.
5339 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005340 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 knows about pasting and will mostly do the right thing without 'paste'
5342 being set. The same is true for a terminal where Vim handles the
5343 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005344 This option is reset when starting the GUI. Thus if you set it in
5345 your .vimrc it will work in a terminal, but not in the GUI. Setting
5346 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5347 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 When the 'paste' option is switched on (also when it was already on):
5349 - mapping in Insert mode and Command-line mode is disabled
5350 - abbreviations are disabled
5351 - 'textwidth' is set to 0
5352 - 'wrapmargin' is set to 0
5353 - 'autoindent' is reset
5354 - 'smartindent' is reset
5355 - 'softtabstop' is set to 0
5356 - 'revins' is reset
5357 - 'ruler' is reset
5358 - 'showmatch' is reset
5359 - 'formatoptions' is used like it is empty
5360 These options keep their value, but their effect is disabled:
5361 - 'lisp'
5362 - 'indentexpr'
5363 - 'cindent'
5364 NOTE: When you start editing another file while the 'paste' option is
5365 on, settings from the modelines or autocommands may change the
5366 settings again, causing trouble when pasting text. You might want to
5367 set the 'paste' option again.
5368 When the 'paste' option is reset the mentioned options are restored to
5369 the value before the moment 'paste' was switched from off to on.
5370 Resetting 'paste' before ever setting it does not have any effect.
5371 Since mapping doesn't work while 'paste' is active, you need to use
5372 the 'pastetoggle' option to toggle the 'paste' option with some key.
5373
5374 *'pastetoggle'* *'pt'*
5375'pastetoggle' 'pt' string (default "")
5376 global
5377 {not in Vi}
5378 When non-empty, specifies the key sequence that toggles the 'paste'
5379 option. This is like specifying a mapping: >
5380 :map {keys} :set invpaste<CR>
5381< Where {keys} is the value of 'pastetoggle'.
5382 The difference is that it will work even when 'paste' is set.
5383 'pastetoggle' works in Insert mode and Normal mode, but not in
5384 Command-line mode.
5385 Mappings are checked first, thus overrule 'pastetoggle'. However,
5386 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5387 this: >
5388 :map <F10> :set paste<CR>
5389 :map <F11> :set nopaste<CR>
5390 :imap <F10> <C-O>:set paste<CR>
5391 :imap <F11> <nop>
5392 :set pastetoggle=<F11>
5393< This will make <F10> start paste mode and <F11> stop paste mode.
5394 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5395 mode everything is inserted literally, except the 'pastetoggle' key
5396 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005397 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398
5399 *'pex'* *'patchexpr'*
5400'patchexpr' 'pex' string (default "")
5401 global
5402 {not in Vi}
5403 {not available when compiled without the |+diff|
5404 feature}
5405 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005406 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407
Bram Moolenaardbc28022014-07-26 13:40:44 +02005408 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409'patchmode' 'pm' string (default "")
5410 global
5411 {not in Vi}
5412 When non-empty the oldest version of a file is kept. This can be used
5413 to keep the original version of a file if you are changing files in a
5414 source distribution. Only the first time that a file is written a
5415 copy of the original file will be kept. The name of the copy is the
5416 name of the original file with the string in the 'patchmode' option
5417 appended. This option should start with a dot. Use a string like
5418 ".org". 'backupdir' must not be empty for this to work (Detail: The
5419 backup file is renamed to the patchmode file after the new file has
5420 been successfully written, that's why it must be possible to write a
5421 backup file). If there was no file to be backed up, an empty file is
5422 created.
5423 When the 'backupskip' pattern matches, a patchmode file is not made.
5424 Using 'patchmode' for compressed files appends the extension at the
5425 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5426 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005427 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005428
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005429 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430'path' 'pa' string (default on Unix: ".,/usr/include,,"
5431 on OS/2: ".,/emx/include,,"
5432 other systems: ".,,")
5433 global or local to buffer |global-local|
5434 {not in Vi}
5435 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005436 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5437 provided that the file being searched for has a relative path (not
5438 starting with "/", "./" or "../"). The directories in the 'path'
5439 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 - Use commas to separate directory names: >
5441 :set path=.,/usr/local/include,/usr/include
5442< - Spaces can also be used to separate directory names (for backwards
5443 compatibility with version 3.0). To have a space in a directory
5444 name, precede it with an extra backslash, and escape the space: >
5445 :set path=.,/dir/with\\\ space
5446< - To include a comma in a directory name precede it with an extra
5447 backslash: >
5448 :set path=.,/dir/with\\,comma
5449< - To search relative to the directory of the current file, use: >
5450 :set path=.
5451< - To search in the current directory use an empty string between two
5452 commas: >
5453 :set path=,,
5454< - A directory name may end in a ':' or '/'.
5455 - Environment variables are expanded |:set_env|.
5456 - When using |netrw.vim| URLs can be used. For example, adding
5457 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005458 - Search upwards and downwards in a directory tree using "*", "**" and
5459 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 {not available when compiled without the |+path_extra| feature}
5461 - Careful with '\' characters, type two to get one in the option: >
5462 :set path=.,c:\\include
5463< Or just use '/' instead: >
5464 :set path=.,c:/include
5465< Don't forget "." or files won't even be found in the same directory as
5466 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005467 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 it is something like 256 or 1024 characters.
5469 You can check if all the include files are found, using the value of
5470 'path', see |:checkpath|.
5471 The use of |:set+=| and |:set-=| is preferred when adding or removing
5472 directories from the list. This avoids problems when a future version
5473 uses another default. To remove the current directory use: >
5474 :set path-=
5475< To add the current directory use: >
5476 :set path+=
5477< To use an environment variable, you probably need to replace the
5478 separator. Here is an example to append $INCL, in which directory
5479 names are separated with a semi-colon: >
5480 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5481< Replace the ';' with a ':' or whatever separator is used. Note that
5482 this doesn't work when $INCL contains a comma or white space.
5483
5484 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5485'preserveindent' 'pi' boolean (default off)
5486 local to buffer
5487 {not in Vi}
5488 When changing the indent of the current line, preserve as much of the
5489 indent structure as possible. Normally the indent is replaced by a
5490 series of tabs followed by spaces as required (unless |'expandtab'| is
5491 enabled, in which case only spaces are used). Enabling this option
5492 means the indent will preserve as many existing characters as possible
5493 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005494 'expandtab' does not apply to the preserved white space, a Tab remains
5495 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 NOTE: When using ">>" multiple times the resulting indent is a mix of
5497 tabs and spaces. You might not like this.
5498 NOTE: 'preserveindent' is reset when 'compatible' is set.
5499 Also see 'copyindent'.
5500 Use |:retab| to clean up white space.
5501
5502 *'previewheight'* *'pvh'*
5503'previewheight' 'pvh' number (default 12)
5504 global
5505 {not in Vi}
5506 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005507 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 Default height for a preview window. Used for |:ptag| and associated
5509 commands. Used for |CTRL-W_}| when no count is given.
5510
5511 *'previewwindow'* *'nopreviewwindow'*
5512 *'pvw'* *'nopvw'* *E590*
5513'previewwindow' 'pvw' boolean (default off)
5514 local to window
5515 {not in Vi}
5516 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005517 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005518 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 set. It's normally not set directly, but by using one of the commands
5520 |:ptag|, |:pedit|, etc.
5521
5522 *'printdevice'* *'pdev'*
5523'printdevice' 'pdev' string (default empty)
5524 global
5525 {not in Vi}
5526 {only available when compiled with the |+printer|
5527 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005528 The name of the printer to be used for |:hardcopy|.
5529 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005530 This option cannot be set from a |modeline| or in the |sandbox|, for
5531 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532
Bram Moolenaar8299df92004-07-10 09:47:34 +00005533 *'printencoding'* *'penc'*
5534'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 global
5536 {not in Vi}
5537 {only available when compiled with the |+printer|
5538 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005539 Sets the character encoding used when printing.
5540 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541
5542 *'printexpr'* *'pexpr'*
5543'printexpr' 'pexpr' String (default: see below)
5544 global
5545 {not in Vi}
5546 {only available when compiled with the |+printer|
5547 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005548 Expression used to print the PostScript produced with |:hardcopy|.
5549 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550
Bram Moolenaar8299df92004-07-10 09:47:34 +00005551 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552'printfont' 'pfn' string (default "courier")
5553 global
5554 {not in Vi}
5555 {only available when compiled with the |+printer|
5556 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005557 The name of the font that will be used for |:hardcopy|.
5558 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005559
5560 *'printheader'* *'pheader'*
5561'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5562 global
5563 {not in Vi}
5564 {only available when compiled with the |+printer|
5565 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005566 The format of the header produced in |:hardcopy| output.
5567 See |pheader-option|.
5568
5569 *'printmbcharset'* *'pmbcs'*
5570'printmbcharset' 'pmbcs' string (default "")
5571 global
5572 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005573 {only available when compiled with the |+printer|,
5574 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005575 The CJK character set to be used for CJK output from |:hardcopy|.
5576 See |pmbcs-option|.
5577
5578 *'printmbfont'* *'pmbfn'*
5579'printmbfont' 'pmbfn' string (default "")
5580 global
5581 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005582 {only available when compiled with the |+printer|,
5583 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005584 List of font names to be used for CJK output from |:hardcopy|.
5585 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586
5587 *'printoptions'* *'popt'*
5588'printoptions' 'popt' string (default "")
5589 global
5590 {not in Vi}
5591 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005592 List of items that control the format of the output of |:hardcopy|.
5593 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005595 *'prompt'* *'noprompt'*
5596'prompt' boolean (default on)
5597 global
5598 When on a ":" prompt is used in Ex mode.
5599
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005600 *'pumheight'* *'ph'*
5601'pumheight' 'ph' number (default 0)
5602 global
5603 {not available when compiled without the
5604 |+insert_expand| feature}
5605 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005606 Determines the maximum number of items to show in the popup menu for
5607 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005608 |ins-completion-menu|.
5609
5610
Bram Moolenaar677ee682005-01-27 14:41:15 +00005611 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005612'quoteescape' 'qe' string (default "\")
5613 local to buffer
5614 {not in Vi}
5615 The characters that are used to escape quotes in a string. Used for
5616 objects like a', a" and a` |a'|.
5617 When one of the characters in this option is found inside a string,
5618 the following character will be skipped. The default value makes the
5619 text "foo\"bar\\" considered to be one string.
5620
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5622'readonly' 'ro' boolean (default off)
5623 local to buffer
5624 If on, writes fail unless you use a '!'. Protects you from
5625 accidentally overwriting a file. Default on when Vim is started
5626 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005627 When using ":w!" the 'readonly' option is reset for the current
5628 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005630 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005632 *'redrawtime'* *'rdt'*
5633'redrawtime' 'rdt' number (default 2000)
5634 global
5635 {not in Vi}
5636 {only available when compiled with the |+reltime|
5637 feature}
5638 The time in milliseconds for redrawing the display. This applies to
5639 searching for patterns for 'hlsearch' and |:match| highlighting.
5640 When redrawing takes more than this many milliseconds no further
5641 matches will be highlighted. This is used to avoid that Vim hangs
5642 when using a very complicated pattern.
5643
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005644 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005645'regexpengine' 're' number (default 0)
5646 global
5647 {not in Vi}
5648 This selects the default regexp engine. |two-engines|
5649 The possible values are:
5650 0 automatic selection
5651 1 old engine
5652 2 NFA engine
5653 Note that when using the NFA engine and the pattern contains something
5654 that is not supported the pattern will not match. This is only useful
5655 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005656 Using automatic selection enables Vim to switch the engine, if the
5657 default engine becomes too costly. E.g., when the NFA engine uses too
5658 many states. This should prevent Vim from hanging on a combination of
5659 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005660
Bram Moolenaar64486672010-05-16 15:46:46 +02005661 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5662'relativenumber' 'rnu' boolean (default off)
5663 local to window
5664 {not in Vi}
5665 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005666 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005667 precede some vertical motion commands (e.g. j k + -) with, without
5668 having to calculate it yourself. Especially useful in combination with
5669 other commands (e.g. y d c < > gq gw =).
5670 When the 'n' option is excluded from 'cpoptions' a wrapped
5671 line will not use the column of line numbers (this is the default when
5672 'compatible' isn't set).
5673 The 'numberwidth' option can be used to set the room used for the line
5674 number.
5675 When a long, wrapped line doesn't start with the first character, '-'
5676 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005677 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5678 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005679
5680 The number in front of the cursor line also depends on the value of
5681 'number', see |number_relativenumber| for all combinations of the two
5682 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005683
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 *'remap'* *'noremap'*
5685'remap' boolean (default on)
5686 global
5687 Allows for mappings to work recursively. If you do not want this for
5688 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005689 NOTE: To avoid portability problems with Vim scripts, always keep
5690 this option at the default "on". Only switch it off when working with
5691 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005692
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005693 *'renderoptions'* *'rop'*
5694'renderoptions' 'rop' string (default: empty)
5695 global
5696 {not in Vi}
5697 {only available when compiled with GUI and DIRECTX on
5698 MS-Windows}
5699 Select a text renderer and set its options. The options depend on the
5700 renderer.
5701
5702 Syntax: >
5703 set rop=type:{renderer}(,{name}:{value})*
5704<
5705 Currently, only one optional renderer is available.
5706
5707 render behavior ~
5708 directx Vim will draw text using DirectX (DirectWrite). It makes
5709 drawn glyphs more beautiful than default GDI.
5710 It requires 'encoding' is "utf-8", and only works on
5711 MS-Windows Vista or newer version.
5712
5713 Options:
5714 name meaning type value ~
5715 gamma gamma float 1.0 - 2.2 (maybe)
5716 contrast enhancedContrast float (unknown)
5717 level clearTypeLevel float (unknown)
5718 geom pixelGeometry int 0 - 2 (see below)
5719 renmode renderingMode int 0 - 6 (see below)
5720 taamode textAntialiasMode int 0 - 3 (see below)
5721
5722 See this URL for detail:
5723 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5724
5725 For geom: structure of a device pixel.
5726 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5727 1 - DWRITE_PIXEL_GEOMETRY_RGB
5728 2 - DWRITE_PIXEL_GEOMETRY_BGR
5729
5730 See this URL for detail:
5731 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5732
5733 For renmode: method of rendering glyphs.
5734 0 - DWRITE_RENDERING_MODE_DEFAULT
5735 1 - DWRITE_RENDERING_MODE_ALIASED
5736 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5737 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5738 4 - DWRITE_RENDERING_MODE_NATURAL
5739 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5740 6 - DWRITE_RENDERING_MODE_OUTLINE
5741
5742 See this URL for detail:
5743 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5744
5745 For taamode: antialiasing mode used for drawing text.
5746 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5747 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5748 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5749 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5750
5751 See this URL for detail:
5752 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5753
5754 Example: >
5755 set encoding=utf-8
5756 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5757 set rop=type:directx
5758<
5759 If select a raster font (Courier, Terminal or FixedSys) to
5760 'guifont', it fallbacks to be drawn by GDI automatically.
5761
5762 Other render types are currently not supported.
5763
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 *'report'*
5765'report' number (default 2)
5766 global
5767 Threshold for reporting number of lines changed. When the number of
5768 changed lines is more than 'report' a message will be given for most
5769 ":" commands. If you want it always, set 'report' to 0.
5770 For the ":substitute" command the number of substitutions is used
5771 instead of the number of lines.
5772
5773 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5774'restorescreen' 'rs' boolean (default on)
5775 global
5776 {not in Vi} {only in Windows 95/NT console version}
5777 When set, the screen contents is restored when exiting Vim. This also
5778 happens when executing external commands.
5779
5780 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5781 options in your .vimrc. To disable restoring:
5782 set t_ti= t_te=
5783 To enable restoring (for an xterm):
5784 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5785 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5786
5787 *'revins'* *'ri'* *'norevins'* *'nori'*
5788'revins' 'ri' boolean (default off)
5789 global
5790 {not in Vi}
5791 {only available when compiled with the |+rightleft|
5792 feature}
5793 Inserting characters in Insert mode will work backwards. See "typing
5794 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5795 command in Insert mode, when 'allowrevins' is set.
5796 NOTE: This option is reset when 'compatible' or 'paste' is set.
5797
5798 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5799'rightleft' 'rl' boolean (default off)
5800 local to window
5801 {not in Vi}
5802 {only available when compiled with the |+rightleft|
5803 feature}
5804 When on, display orientation becomes right-to-left, i.e., characters
5805 that are stored in the file appear from the right to the left.
5806 Using this option, it is possible to edit files for languages that
5807 are written from the right to the left such as Hebrew and Arabic.
5808 This option is per window, so it is possible to edit mixed files
5809 simultaneously, or to view the same file in both ways (this is
5810 useful whenever you have a mixed text file with both right-to-left
5811 and left-to-right strings so that both sets are displayed properly
5812 in different windows). Also see |rileft.txt|.
5813
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005814 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005815'rightleftcmd' 'rlc' string (default "search")
5816 local to window
5817 {not in Vi}
5818 {only available when compiled with the |+rightleft|
5819 feature}
5820 Each word in this option enables the command line editing to work in
5821 right-to-left mode for a group of commands:
5822
5823 search "/" and "?" commands
5824
5825 This is useful for languages such as Hebrew, Arabic and Farsi.
5826 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5827
5828 *'ruler'* *'ru'* *'noruler'* *'noru'*
5829'ruler' 'ru' boolean (default off)
5830 global
5831 {not in Vi}
5832 {not available when compiled without the
5833 |+cmdline_info| feature}
5834 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005835 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 text in the file is shown on the far right:
5837 Top first line is visible
5838 Bot last line is visible
5839 All first and last line are visible
5840 45% relative position in the file
5841 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005842 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005844 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005845 this option takes precedence over 'ruler' and 'rulerformat'
5846 If the number of characters displayed is different from the number of
5847 bytes in the text (e.g., for a TAB or a multi-byte character), both
5848 the text column (byte number) and the screen column are shown,
5849 separated with a dash.
5850 For an empty line "0-1" is shown.
5851 For an empty buffer the line number will also be zero: "0,0-1".
5852 This option is reset when the 'paste' option is set.
5853 If you don't want to see the ruler all the time but want to know where
5854 you are, use "g CTRL-G" |g_CTRL-G|.
5855 NOTE: This option is reset when 'compatible' is set.
5856
5857 *'rulerformat'* *'ruf'*
5858'rulerformat' 'ruf' string (default empty)
5859 global
5860 {not in Vi}
5861 {not available when compiled without the |+statusline|
5862 feature}
5863 When this option is not empty, it determines the content of the ruler
5864 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005865 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 The default ruler width is 17 characters. To make the ruler 15
5867 characters wide, put "%15(" at the start and "%)" at the end.
5868 Example: >
5869 :set rulerformat=%15(%c%V\ %p%%%)
5870<
5871 *'runtimepath'* *'rtp'* *vimfiles*
5872'runtimepath' 'rtp' string (default:
5873 Unix: "$HOME/.vim,
5874 $VIM/vimfiles,
5875 $VIMRUNTIME,
5876 $VIM/vimfiles/after,
5877 $HOME/.vim/after"
5878 Amiga: "home:vimfiles,
5879 $VIM/vimfiles,
5880 $VIMRUNTIME,
5881 $VIM/vimfiles/after,
5882 home:vimfiles/after"
5883 PC, OS/2: "$HOME/vimfiles,
5884 $VIM/vimfiles,
5885 $VIMRUNTIME,
5886 $VIM/vimfiles/after,
5887 $HOME/vimfiles/after"
5888 Macintosh: "$VIM:vimfiles,
5889 $VIMRUNTIME,
5890 $VIM:vimfiles:after"
5891 RISC-OS: "Choices:vimfiles,
5892 $VIMRUNTIME,
5893 Choices:vimfiles/after"
5894 VMS: "sys$login:vimfiles,
5895 $VIM/vimfiles,
5896 $VIMRUNTIME,
5897 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005898 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 global
5900 {not in Vi}
5901 This is a list of directories which will be searched for runtime
5902 files:
5903 filetype.vim filetypes by file name |new-filetype|
5904 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005905 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 colors/ color scheme files |:colorscheme|
5907 compiler/ compiler files |:compiler|
5908 doc/ documentation |write-local-help|
5909 ftplugin/ filetype plugins |write-filetype-plugin|
5910 indent/ indent scripts |indent-expression|
5911 keymap/ key mapping files |mbyte-keymap|
5912 lang/ menu translations |:menutrans|
5913 menu.vim GUI menus |menu.vim|
5914 plugin/ plugin scripts |write-plugin|
5915 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005916 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 syntax/ syntax files |mysyntaxfile|
5918 tutor/ files for vimtutor |tutor|
5919
5920 And any other file searched for with the |:runtime| command.
5921
5922 The defaults for most systems are setup to search five locations:
5923 1. In your home directory, for your personal preferences.
5924 2. In a system-wide Vim directory, for preferences from the system
5925 administrator.
5926 3. In $VIMRUNTIME, for files distributed with Vim.
5927 *after-directory*
5928 4. In the "after" directory in the system-wide Vim directory. This is
5929 for the system administrator to overrule or add to the distributed
5930 defaults (rarely needed)
5931 5. In the "after" directory in your home directory. This is for
5932 personal preferences to overrule or add to the distributed defaults
5933 or system-wide settings (rarely needed).
5934
5935 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5936 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005937 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 wildcards.
5939 See |:runtime|.
5940 Example: >
5941 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5942< This will use the directory "~/vimruntime" first (containing your
5943 personal Vim runtime files), then "/mygroup/vim" (shared between a
5944 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5945 files).
5946 You probably should always include $VIMRUNTIME somewhere, to use the
5947 distributed runtime files. You can put a directory before $VIMRUNTIME
5948 to find files which replace a distributed runtime files. You can put
5949 a directory after $VIMRUNTIME to find files which add to distributed
5950 runtime files.
5951 This option cannot be set from a |modeline| or in the |sandbox|, for
5952 security reasons.
5953
5954 *'scroll'* *'scr'*
5955'scroll' 'scr' number (default: half the window height)
5956 local to window
5957 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5958 set to half the number of lines in the window when the window size
5959 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005960 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5962 the number of screen lines instead of file lines, makes a difference
5963 when lines wrap}
5964
5965 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5966'scrollbind' 'scb' boolean (default off)
5967 local to window
5968 {not in Vi}
5969 {not available when compiled without the |+scrollbind|
5970 feature}
5971 See also |scroll-binding|. When this option is set, the current
5972 window scrolls as other scrollbind windows (windows that also have
5973 this option set) scroll. This option is useful for viewing the
5974 differences between two versions of a file, see 'diff'.
5975 See |'scrollopt'| for options that determine how this option should be
5976 interpreted.
5977 This option is mostly reset when splitting a window to edit another
5978 file. This means that ":split | edit file" results in two windows
5979 with scroll-binding, but ":split file" does not.
5980
5981 *'scrolljump'* *'sj'*
5982'scrolljump' 'sj' number (default 1)
5983 global
5984 {not in Vi}
5985 Minimal number of lines to scroll when the cursor gets off the
5986 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5987 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005988 When set to a negative number from -1 to -100 this is used as the
5989 percentage of the window height. Thus -50 scrolls half the window
5990 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005991 NOTE: This option is set to 1 when 'compatible' is set.
5992
5993 *'scrolloff'* *'so'*
5994'scrolloff' 'so' number (default 0)
5995 global
5996 {not in Vi}
5997 Minimal number of screen lines to keep above and below the cursor.
5998 This will make some context visible around where you are working. If
5999 you set it to a very large value (999) the cursor line will always be
6000 in the middle of the window (except at the start or end of the file or
6001 when long lines wrap).
6002 For scrolling horizontally see 'sidescrolloff'.
6003 NOTE: This option is set to 0 when 'compatible' is set.
6004
6005 *'scrollopt'* *'sbo'*
6006'scrollopt' 'sbo' string (default "ver,jump")
6007 global
6008 {not available when compiled without the |+scrollbind|
6009 feature}
6010 {not in Vi}
6011 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006012 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6013 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006014 The following words are available:
6015 ver Bind vertical scrolling for 'scrollbind' windows
6016 hor Bind horizontal scrolling for 'scrollbind' windows
6017 jump Applies to the offset between two windows for vertical
6018 scrolling. This offset is the difference in the first
6019 displayed line of the bound windows. When moving
6020 around in a window, another 'scrollbind' window may
6021 reach a position before the start or after the end of
6022 the buffer. The offset is not changed though, when
6023 moving back the 'scrollbind' window will try to scroll
6024 to the desired position when possible.
6025 When now making that window the current one, two
6026 things can be done with the relative offset:
6027 1. When "jump" is not included, the relative offset is
6028 adjusted for the scroll position in the new current
6029 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006030 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 2. When "jump" is included, the other windows are
6032 scrolled to keep the same relative offset. When
6033 going back to the other window, it still uses the
6034 same relative offset.
6035 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006036 When 'diff' mode is active there always is vertical scroll binding,
6037 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038
6039 *'sections'* *'sect'*
6040'sections' 'sect' string (default "SHNHH HUnhsh")
6041 global
6042 Specifies the nroff macros that separate sections. These are pairs of
6043 two letters (See |object-motions|). The default makes a section start
6044 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6045
6046 *'secure'* *'nosecure'* *E523*
6047'secure' boolean (default off)
6048 global
6049 {not in Vi}
6050 When on, ":autocmd", shell and write commands are not allowed in
6051 ".vimrc" and ".exrc" in the current directory and map commands are
6052 displayed. Switch it off only if you know that you will not run into
6053 problems, or when the 'exrc' option is off. On Unix this option is
6054 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006055 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 'secure' at the end of your ~/.vimrc then.
6057 This option cannot be set from a |modeline| or in the |sandbox|, for
6058 security reasons.
6059
6060 *'selection'* *'sel'*
6061'selection' 'sel' string (default "inclusive")
6062 global
6063 {not in Vi}
6064 This option defines the behavior of the selection. It is only used
6065 in Visual and Select mode.
6066 Possible values:
6067 value past line inclusive ~
6068 old no yes
6069 inclusive yes yes
6070 exclusive yes no
6071 "past line" means that the cursor is allowed to be positioned one
6072 character past the line.
6073 "inclusive" means that the last character of the selection is included
6074 in an operation. For example, when "x" is used to delete the
6075 selection.
6076 Note that when "exclusive" is used and selecting from the end
6077 backwards, you cannot include the last character of a line, when
6078 starting in Normal mode and 'virtualedit' empty.
6079
6080 The 'selection' option is set by the |:behave| command.
6081
6082 *'selectmode'* *'slm'*
6083'selectmode' 'slm' string (default "")
6084 global
6085 {not in Vi}
6086 This is a comma separated list of words, which specifies when to start
6087 Select mode instead of Visual mode, when a selection is started.
6088 Possible values:
6089 mouse when using the mouse
6090 key when using shifted special keys
6091 cmd when using "v", "V" or CTRL-V
6092 See |Select-mode|.
6093 The 'selectmode' option is set by the |:behave| command.
6094
6095 *'sessionoptions'* *'ssop'*
6096'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006097 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 global
6099 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006100 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 feature}
6102 Changes the effect of the |:mksession| command. It is a comma
6103 separated list of words. Each word enables saving and restoring
6104 something:
6105 word save and restore ~
6106 blank empty windows
6107 buffers hidden and unloaded buffers, not just those in windows
6108 curdir the current directory
6109 folds manually created folds, opened/closed folds and local
6110 fold options
6111 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006112 and contain at least one lowercase letter. Only
6113 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 help the help window
6115 localoptions options and mappings local to a window or buffer (not
6116 global values for local options)
6117 options all options and mappings (also global values for local
6118 options)
6119 resize size of the Vim window: 'lines' and 'columns'
6120 sesdir the directory in which the session file is located
6121 will become the current directory (useful with
6122 projects accessed over a network from different
6123 systems)
6124 slash backslashes in file names replaced with forward
6125 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006126 tabpages all tab pages; without this only the current tab page
6127 is restored, so that you can make a session for each
6128 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 unix with Unix end-of-line format (single <NL>), even when
6130 on Windows or DOS
6131 winpos position of the whole Vim window
6132 winsize window sizes
6133
6134 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006135 When neither "curdir" nor "sesdir" is included, file names are stored
6136 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006137 "slash" and "unix" are useful on Windows when sharing session files
6138 with Unix. The Unix version of Vim cannot source dos format scripts,
6139 but the Windows version of Vim can source unix format scripts.
6140
6141 *'shell'* *'sh'* *E91*
6142'shell' 'sh' string (default $SHELL or "sh",
6143 MS-DOS and Win32: "command.com" or
6144 "cmd.exe", OS/2: "cmd")
6145 global
6146 Name of the shell to use for ! and :! commands. When changing the
6147 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6148 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006149 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 See |option-backslash| about including spaces and backslashes.
6151 Environment variables are expanded |:set_env|.
6152 If the name of the shell contains a space, you might need to enclose
6153 it in quotes. Example: >
6154 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6155< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006156 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 "-f" is not inside the quotes, because it is not part of the command
6158 name. And Vim automagically recognizes the backslashes that are path
6159 separators.
6160 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6161 variable to change the way external commands are executed. See the
6162 libc.inf file of DJGPP.
6163 Under MS-Windows, when the executable ends in ".com" it must be
6164 included. Thus setting the shell to "command.com" or "4dos.com"
6165 works, but "command" and "4dos" do not work for all commands (e.g.,
6166 filtering).
6167 For unknown reasons, when using "4dos.com" the current directory is
6168 changed to "C:\". To avoid this set 'shell' like this: >
6169 :set shell=command.com\ /c\ 4dos
6170< This option cannot be set from a |modeline| or in the |sandbox|, for
6171 security reasons.
6172
6173 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006174'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006175 MS-DOS and Win32, when 'shell' does not
6176 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 global
6178 {not in Vi}
6179 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6180 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6181 systems, the default is set according to the value of 'shell', to
6182 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006183 OS/2 (EMX figures this out itself).
6184 On Unix it can have more than one flag. Each white space separated
6185 part is passed as an argument to the shell command.
6186 See |option-backslash| about including spaces and backslashes.
6187 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 This option cannot be set from a |modeline| or in the |sandbox|, for
6189 security reasons.
6190
6191 *'shellpipe'* *'sp'*
6192'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6193 global
6194 {not in Vi}
6195 {not available when compiled without the |+quickfix|
6196 feature}
6197 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006198 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 including spaces and backslashes.
6200 The name of the temporary file can be represented by "%s" if necessary
6201 (the file name is appended automatically if no %s appears in the value
6202 of this option).
6203 For the Amiga and MS-DOS the default is ">". The output is directly
6204 saved in a file and not echoed to the screen.
6205 For Unix the default it "| tee". The stdout of the compiler is saved
6206 in a file and echoed to the screen. If the 'shell' option is "csh" or
6207 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006208 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6209 default becomes "2>&1| tee". This means that stderr is also included.
6210 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6211 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 The initialization of this option is done after reading the ".vimrc"
6213 and the other initializations, so that when the 'shell' option is set
6214 there, the 'shellpipe' option changes automatically, unless it was
6215 explicitly set before.
6216 When 'shellpipe' is set to an empty string, no redirection of the
6217 ":make" output will be done. This is useful if you use a 'makeprg'
6218 that writes to 'makeef' by itself. If you want no piping, but do
6219 want to include the 'makeef', set 'shellpipe' to a single space.
6220 Don't forget to precede the space with a backslash: ":set sp=\ ".
6221 In the future pipes may be used for filtering and this option will
6222 become obsolete (at least for Unix).
6223 This option cannot be set from a |modeline| or in the |sandbox|, for
6224 security reasons.
6225
6226 *'shellquote'* *'shq'*
6227'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6228 contains "sh" somewhere: "\"")
6229 global
6230 {not in Vi}
6231 Quoting character(s), put around the command passed to the shell, for
6232 the "!" and ":!" commands. The redirection is kept outside of the
6233 quoting. See 'shellxquote' to include the redirection. It's
6234 probably not useful to set both options.
6235 This is an empty string by default. Only known to be useful for
6236 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6237 or bash, where it should be "\"". The default is adjusted according
6238 the value of 'shell', to reduce the need to set this option by the
6239 user. See |dos-shell|.
6240 This option cannot be set from a |modeline| or in the |sandbox|, for
6241 security reasons.
6242
6243 *'shellredir'* *'srr'*
6244'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6245 global
6246 {not in Vi}
6247 String to be used to put the output of a filter command in a temporary
6248 file. See also |:!|. See |option-backslash| about including spaces
6249 and backslashes.
6250 The name of the temporary file can be represented by "%s" if necessary
6251 (the file name is appended automatically if no %s appears in the value
6252 of this option).
6253 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6254 or "zsh" during initializations, the default becomes ">&". If the
6255 'shell' option is "sh", "ksh" or "bash" the default becomes
6256 ">%s 2>&1". This means that stderr is also included.
6257 For Win32, the Unix checks are done and additionally "cmd" is checked
6258 for, which makes the default ">%s 2>&1". Also, the same names with
6259 ".exe" appended are checked for.
6260 The initialization of this option is done after reading the ".vimrc"
6261 and the other initializations, so that when the 'shell' option is set
6262 there, the 'shellredir' option changes automatically unless it was
6263 explicitly set before.
6264 In the future pipes may be used for filtering and this option will
6265 become obsolete (at least for Unix).
6266 This option cannot be set from a |modeline| or in the |sandbox|, for
6267 security reasons.
6268
6269 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6270'shellslash' 'ssl' boolean (default off)
6271 global
6272 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6273 When set, a forward slash is used when expanding file names. This is
6274 useful when a Unix-like shell is used instead of command.com or
6275 cmd.exe. Backward slashes can still be typed, but they are changed to
6276 forward slashes by Vim.
6277 Note that setting or resetting this option has no effect for some
6278 existing file names, thus this option needs to be set before opening
6279 any file for best results. This might change in the future.
6280 'shellslash' only works when a backslash can be used as a path
6281 separator. To test if this is so use: >
6282 if exists('+shellslash')
6283<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006284 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6285'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6286 global
6287 {not in Vi}
6288 When on, use temp files for shell commands. When off use a pipe.
6289 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006290 Currently a pipe is only supported on Unix and MS-Windows 2K and
6291 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006292 :if has("filterpipe")
6293< The advantage of using a pipe is that nobody can read the temp file
6294 and the 'shell' command does not need to support redirection.
6295 The advantage of using a temp file is that the file type and encoding
6296 can be detected.
6297 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6298 |FilterWritePost| autocommands event are not triggered when
6299 'shelltemp' is off.
6300
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 *'shelltype'* *'st'*
6302'shelltype' 'st' number (default 0)
6303 global
6304 {not in Vi} {only for the Amiga}
6305 On the Amiga this option influences the way how the commands work
6306 which use a shell.
6307 0 and 1: always use the shell
6308 2 and 3: use the shell only to filter lines
6309 4 and 5: use shell only for ':sh' command
6310 When not using the shell, the command is executed directly.
6311
6312 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6313 1 and 3: use "shell cmd" to start external commands
6314
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006315 *'shellxescape'* *'sxe'*
6316'shellxescape' 'sxe' string (default: "";
6317 for MS-DOS and MS-Windows: "\"&|<>()@^")
6318 global
6319 {not in Vi}
6320 When 'shellxquote' is set to "(" then the characters listed in this
6321 option will be escaped with a '^' character. This makes it possible
6322 to execute most external commands with cmd.exe.
6323
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 *'shellxquote'* *'sxq'*
6325'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006326 for Win32, when 'shell' is cmd.exe: "("
6327 for Win32, when 'shell' contains "sh"
6328 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 for Unix, when using system(): "\"")
6330 global
6331 {not in Vi}
6332 Quoting character(s), put around the command passed to the shell, for
6333 the "!" and ":!" commands. Includes the redirection. See
6334 'shellquote' to exclude the redirection. It's probably not useful
6335 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006336 When the value is '(' then ')' is appended. When the value is '"('
6337 then ')"' is appended.
6338 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006339 This is an empty string by default on most systems, but is known to be
6340 useful for on Win32 version, either for cmd.exe which automatically
6341 strips off the first and last quote on a command, or 3rd-party shells
6342 such as the MKS Korn Shell or bash, where it should be "\"". The
6343 default is adjusted according the value of 'shell', to reduce the need
6344 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 This option cannot be set from a |modeline| or in the |sandbox|, for
6346 security reasons.
6347
6348 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6349'shiftround' 'sr' boolean (default off)
6350 global
6351 {not in Vi}
6352 Round indent to multiple of 'shiftwidth'. Applies to > and <
6353 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6354 a multiple of 'shiftwidth' (this is Vi compatible).
6355 NOTE: This option is reset when 'compatible' is set.
6356
6357 *'shiftwidth'* *'sw'*
6358'shiftwidth' 'sw' number (default 8)
6359 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006360 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006362 When zero the 'ts' value will be used. Use the |shiftwidth()|
6363 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364
6365 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006366'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6367 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 global
6369 {not in Vi}
6370 This option helps to avoid all the |hit-enter| prompts caused by file
6371 messages, for example with CTRL-G, and to avoid some other messages.
6372 It is a list of flags:
6373 flag meaning when present ~
6374 f use "(3 of 5)" instead of "(file 3 of 5)"
6375 i use "[noeol]" instead of "[Incomplete last line]"
6376 l use "999L, 888C" instead of "999 lines, 888 characters"
6377 m use "[+]" instead of "[Modified]"
6378 n use "[New]" instead of "[New File]"
6379 r use "[RO]" instead of "[readonly]"
6380 w use "[w]" instead of "written" for file write message
6381 and "[a]" instead of "appended" for ':w >> file' command
6382 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6383 "[unix format]" and "[mac]" instead of "[mac format]".
6384 a all of the above abbreviations
6385
6386 o overwrite message for writing a file with subsequent message
6387 for reading a file (useful for ":wn" or when 'autowrite' on)
6388 O message for reading a file overwrites any previous message.
6389 Also for quickfix message (e.g., ":cn").
6390 s don't give "search hit BOTTOM, continuing at TOP" or "search
6391 hit TOP, continuing at BOTTOM" messages
6392 t truncate file message at the start if it is too long to fit
6393 on the command-line, "<" will appear in the left most column.
6394 Ignored in Ex mode.
6395 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006396 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 Ignored in Ex mode.
6398 W don't give "written" or "[w]" when writing a file
6399 A don't give the "ATTENTION" message when an existing swap file
6400 is found.
6401 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006402 c don't give |ins-completion-menu| messages. For example,
6403 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6404 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405
6406 This gives you the opportunity to avoid that a change between buffers
6407 requires you to hit <Enter>, but still gives as useful a message as
6408 possible for the space available. To get the whole message that you
6409 would have got with 'shm' empty, use ":file!"
6410 Useful values:
6411 shm= No abbreviation of message.
6412 shm=a Abbreviation, but no loss of information.
6413 shm=at Abbreviation, and truncate message when necessary.
6414
6415 NOTE: This option is set to the Vi default value when 'compatible' is
6416 set and to the Vim default value when 'compatible' is reset.
6417
6418 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6419'shortname' 'sn' boolean (default off)
6420 local to buffer
6421 {not in Vi, not in MS-DOS versions}
6422 Filenames are assumed to be 8 characters plus one extension of 3
6423 characters. Multiple dots in file names are not allowed. When this
6424 option is on, dots in file names are replaced with underscores when
6425 adding an extension (".~" or ".swp"). This option is not available
6426 for MS-DOS, because then it would always be on. This option is useful
6427 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6428 or crossdos. When running the Win32 GUI version under Win32s, this
6429 option is always on by default.
6430
6431 *'showbreak'* *'sbr'* *E595*
6432'showbreak' 'sbr' string (default "")
6433 global
6434 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006435 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 feature}
6437 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006438 values are "> " or "+++ ": >
6439 :set showbreak=>\
6440< Note the backslash to escape the trailing space. It's easier like
6441 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006442 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006443< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 comma (in a future version the comma might be used to separate the
6445 part that is shown at the end and at the start of a line).
6446 The characters are highlighted according to the '@' flag in
6447 'highlight'.
6448 Note that tabs after the showbreak will be displayed differently.
6449 If you want the 'showbreak' to appear in between line numbers, add the
6450 "n" flag to 'cpoptions'.
6451
6452 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6453'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6454 off)
6455 global
6456 {not in Vi}
6457 {not available when compiled without the
6458 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006459 Show (partial) command in the last line of the screen. Set this
6460 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 In Visual mode the size of the selected area is shown:
6462 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006463 If the number of bytes is different it is also displayed: "2-6"
6464 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006466 - When selecting a block, the size in screen characters:
6467 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 NOTE: This option is set to the Vi default value when 'compatible' is
6469 set and to the Vim default value when 'compatible' is reset.
6470
6471 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6472'showfulltag' 'sft' boolean (default off)
6473 global
6474 {not in Vi}
6475 When completing a word in insert mode (see |ins-completion|) from the
6476 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006477 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 matched a C function, you can see a template for what arguments are
6479 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006480 Note that this doesn't work well together with having "longest" in
6481 'completeopt', because the completion from the search pattern may not
6482 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483
6484 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6485'showmatch' 'sm' boolean (default off)
6486 global
6487 When a bracket is inserted, briefly jump to the matching one. The
6488 jump is only done if the match can be seen on the screen. The time to
6489 show the match can be set with 'matchtime'.
6490 A Beep is given if there is no match (no matter if the match can be
6491 seen or not). This option is reset when the 'paste' option is set.
6492 When the 'm' flag is not included in 'cpoptions', typing a character
6493 will immediately move the cursor back to where it belongs.
6494 See the "sm" field in 'guicursor' for setting the cursor shape and
6495 blinking when showing the match.
6496 The 'matchpairs' option can be used to specify the characters to show
6497 matches for. 'rightleft' and 'revins' are used to look for opposite
6498 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006499 Also see the matchparen plugin for highlighting the match when moving
6500 around |pi_paren.txt|.
6501 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502
6503 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6504'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6505 global
6506 If in Insert, Replace or Visual mode put a message on the last line.
6507 Use the 'M' flag in 'highlight' to set the type of highlighting for
6508 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006509 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 doesn't mean XIM is really active, especially when 'imactivatekey' is
6511 not set.
6512 NOTE: This option is set to the Vi default value when 'compatible' is
6513 set and to the Vim default value when 'compatible' is reset.
6514
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006515 *'showtabline'* *'stal'*
6516'showtabline' 'stal' number (default 1)
6517 global
6518 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006519 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006520 feature}
6521 The value of this option specifies when the line with tab page labels
6522 will be displayed:
6523 0: never
6524 1: only if there are at least two tab pages
6525 2: always
6526 This is both for the GUI and non-GUI implementation of the tab pages
6527 line.
6528 See |tab-page| for more information about tab pages.
6529
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 *'sidescroll'* *'ss'*
6531'sidescroll' 'ss' number (default 0)
6532 global
6533 {not in Vi}
6534 The minimal number of columns to scroll horizontally. Used only when
6535 the 'wrap' option is off and the cursor is moved off of the screen.
6536 When it is zero the cursor will be put in the middle of the screen.
6537 When using a slow terminal set it to a large number or 0. When using
6538 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6539 commands.
6540
6541 *'sidescrolloff'* *'siso'*
6542'sidescrolloff' 'siso' number (default 0)
6543 global
6544 {not in Vi}
6545 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006546 right of the cursor if 'nowrap' is set. Setting this option to a
6547 value greater than 0 while having |'sidescroll'| also at a non-zero
6548 value makes some context visible in the line you are scrolling in
6549 horizontally (except at beginning of the line). Setting this option
6550 to a large value (like 999) has the effect of keeping the cursor
6551 horizontally centered in the window, as long as one does not come too
6552 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 NOTE: This option is set to 0 when 'compatible' is set.
6554
6555 Example: Try this together with 'sidescroll' and 'listchars' as
6556 in the following example to never allow the cursor to move
6557 onto the "extends" character:
6558
6559 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6560 :set sidescrolloff=1
6561
6562
6563 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6564'smartcase' 'scs' boolean (default off)
6565 global
6566 {not in Vi}
6567 Override the 'ignorecase' option if the search pattern contains upper
6568 case characters. Only used when the search pattern is typed and
6569 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006570 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6572 recalling the search pattern from history and hitting <Enter>.
6573 NOTE: This option is reset when 'compatible' is set.
6574
6575 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6576'smartindent' 'si' boolean (default off)
6577 local to buffer
6578 {not in Vi}
6579 {not available when compiled without the
6580 |+smartindent| feature}
6581 Do smart autoindenting when starting a new line. Works for C-like
6582 programs, but can also be used for other languages. 'cindent' does
6583 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006584 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006585 setting 'si' has no effect. 'indentexpr' is a more advanced
6586 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 Normally 'autoindent' should also be on when using 'smartindent'.
6588 An indent is automatically inserted:
6589 - After a line ending in '{'.
6590 - After a line starting with a keyword from 'cinwords'.
6591 - Before a line starting with '}' (only with the "O" command).
6592 When typing '}' as the first character in a new line, that line is
6593 given the same indent as the matching '{'.
6594 When typing '#' as the first character in a new line, the indent for
6595 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006596 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6598 When using the ">>" command, lines starting with '#' are not shifted
6599 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 is set smart indenting is disabled.
6602
6603 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6604'smarttab' 'sta' boolean (default off)
6605 global
6606 {not in Vi}
6607 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006608 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6609 <BS> will delete a 'shiftwidth' worth of space at the start of the
6610 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006611 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006612 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6613 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006614 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006616 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 NOTE: This option is reset when 'compatible' is set.
6618
6619 *'softtabstop'* *'sts'*
6620'softtabstop' 'sts' number (default 0)
6621 local to buffer
6622 {not in Vi}
6623 Number of spaces that a <Tab> counts for while performing editing
6624 operations, like inserting a <Tab> or using <BS>. It "feels" like
6625 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6626 used. This is useful to keep the 'ts' setting at its standard value
6627 of 8, while being able to edit like it is set to 'sts'. However,
6628 commands like "x" still work on the actual characters.
6629 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006630 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 'softtabstop' is set to 0 when the 'paste' option is set.
6632 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6633 spaces is minimized by using <Tab>s.
6634 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6635 set.
6636 NOTE: This option is set to 0 when 'compatible' is set.
6637
Bram Moolenaar217ad922005-03-20 22:37:15 +00006638 *'spell'* *'nospell'*
6639'spell' boolean (default off)
6640 local to window
6641 {not in Vi}
6642 {not available when compiled without the |+syntax|
6643 feature}
6644 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006645 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006646
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006647 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006648'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006649 local to buffer
6650 {not in Vi}
6651 {not available when compiled without the |+syntax|
6652 feature}
6653 Pattern to locate the end of a sentence. The following word will be
6654 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006655 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006656 When this check is not wanted make this option empty.
6657 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006658 Be careful with special characters, see |option-backslash| about
6659 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006660 To set this option automatically depending on the language, see
6661 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006662
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006663 *'spellfile'* *'spf'*
6664'spellfile' 'spf' string (default empty)
6665 local to buffer
6666 {not in Vi}
6667 {not available when compiled without the |+syntax|
6668 feature}
6669 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006670 commands. It must end in ".{encoding}.add". You need to include the
6671 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006672 *E765*
6673 It may also be a comma separated list of names. A count before the
6674 |zg| and |zw| commands can be used to access each. This allows using
6675 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006676 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006677 you: Using the first directory in 'runtimepath' that is writable. If
6678 there is no "spell" directory yet it will be created. For the file
6679 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006680 ignoring the region.
6681 The resulting ".spl" file will be used for spell checking, it does not
6682 have to appear in 'spelllang'.
6683 Normally one file is used for all regions, but you can add the region
6684 name if you want to. However, it will then only be used when
6685 'spellfile' is set to it, for entries in 'spelllang' only files
6686 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006687 This option cannot be set from a |modeline| or in the |sandbox|, for
6688 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006689
Bram Moolenaar217ad922005-03-20 22:37:15 +00006690 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006691'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006692 local to buffer
6693 {not in Vi}
6694 {not available when compiled without the |+syntax|
6695 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006696 A comma separated list of word list names. When the 'spell' option is
6697 on spellchecking will be done for these languages. Example: >
6698 set spelllang=en_us,nl,medical
6699< This means US English, Dutch and medical words are recognized. Words
6700 that are not recognized will be highlighted.
6701 The word list name must not include a comma or dot. Using a dash is
6702 recommended to separate the two letter language name from a
6703 specification. Thus "en-rare" is used for rare English words.
6704 A region name must come last and have the form "_xx", where "xx" is
6705 the two-letter, lower case region name. You can use more than one
6706 region by listing them: "en_us,en_ca" supports both US and Canadian
6707 English, but not words specific for Australia, New Zealand or Great
6708 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006709 If the name "cjk" is included East Asian characters are excluded from
6710 spell checking. This is useful when editing text that also has Asian
6711 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006712 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006713 As a special case the name of a .spl file can be given as-is. The
6714 first "_xx" in the name is removed and used as the region name
6715 (_xx is an underscore, two letters and followed by a non-letter).
6716 This is mainly for testing purposes. You must make sure the correct
6717 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006718 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006719 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6720 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006721 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006722
Bram Moolenaar98692072006-02-04 00:57:42 +00006723 If the |spellfile.vim| plugin is active and you use a language name
6724 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6725 will ask you if you want to download the file.
6726
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006727 After this option has been set successfully, Vim will source the files
6728 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006729 up to the first comma, dot or underscore.
6730 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006731
6732
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006733 *'spellsuggest'* *'sps'*
6734'spellsuggest' 'sps' string (default "best")
6735 global
6736 {not in Vi}
6737 {not available when compiled without the |+syntax|
6738 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006739 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006740 the |spellsuggest()| function. This is a comma-separated list of
6741 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006742
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006743 best Internal method that works best for English. Finds
6744 changes like "fast" and uses a bit of sound-a-like
6745 scoring to improve the ordering.
6746
6747 double Internal method that uses two methods and mixes the
6748 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006749 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006750 word. That only works when the language specifies
6751 sound folding. Can be slow and doesn't always give
6752 better results.
6753
6754 fast Internal method that only checks for simple changes:
6755 character inserts/deletes/swaps. Works well for
6756 simple typing mistakes.
6757
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006758 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006759 Not used for |spellsuggest()|. The number of
6760 suggestions is never more than the value of 'lines'
6761 minus two.
6762
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006763 file:{filename} Read file {filename}, which must have two columns,
6764 separated by a slash. The first column contains the
6765 bad word, the second column the suggested good word.
6766 Example:
6767 theribal/terrible ~
6768 Use this for common mistakes that do not appear at the
6769 top of the suggestion list with the internal methods.
6770 Lines without a slash are ignored, use this for
6771 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006772 The word in the second column must be correct,
6773 otherwise it will not be used. Add the word to an
6774 ".add" file if it is currently flagged as a spelling
6775 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006776 The file is used for all languages.
6777
6778 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6779 trouble with spaces. |v:val| holds the badly spelled
6780 word. The expression must evaluate to a List of
6781 Lists, each with a suggestion and a score.
6782 Example:
6783 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006784 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006785 internal methods use. A lower score is better.
6786 This may invoke |spellsuggest()| if you temporarily
6787 set 'spellsuggest' to exclude the "expr:" part.
6788 Errors are silently ignored, unless you set the
6789 'verbose' option to a non-zero value.
6790
6791 Only one of "best", "double" or "fast" may be used. The others may
6792 appear several times in any order. Example: >
6793 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6794<
6795 This option cannot be set from a |modeline| or in the |sandbox|, for
6796 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006797
6798
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6800'splitbelow' 'sb' boolean (default off)
6801 global
6802 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006803 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 feature}
6805 When on, splitting a window will put the new window below the current
6806 one. |:split|
6807
6808 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6809'splitright' 'spr' boolean (default off)
6810 global
6811 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006812 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 feature}
6814 When on, splitting a window will put the new window right of the
6815 current one. |:vsplit|
6816
6817 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6818'startofline' 'sol' boolean (default on)
6819 global
6820 {not in Vi}
6821 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006822 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006823 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006824 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 with a linewise operator, with "%" with a count and to buffer changing
6826 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6827 only has a line number, e.g., ":25" or ":+".
6828 In case of buffer changing commands the cursor is placed at the column
6829 where it was the last time the buffer was edited.
6830 NOTE: This option is set when 'compatible' is set.
6831
Bram Moolenaar00654022011-02-25 14:42:19 +01006832 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006834 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 {not in Vi}
6836 {not available when compiled without the |+statusline|
6837 feature}
6838 When nonempty, this option determines the content of the status line.
6839 Also see |status-line|.
6840
6841 The option consists of printf style '%' items interspersed with
6842 normal text. Each status line item is of the form:
6843 %-0{minwid}.{maxwid}{item}
6844 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006845 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006846
Bram Moolenaar238a5642006-02-21 22:12:05 +00006847 When the option starts with "%!" then it is used as an expression,
6848 evaluated and the result is used as the option value. Example: >
6849 :set statusline=%!MyStatusLine()
6850< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006851 Note that the "%!" expression is evaluated in the context of the
6852 current window and buffer, while %{} items are evaluated in the
6853 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006854
6855 When there is error while evaluating the option then it will be made
6856 empty to avoid further errors. Otherwise screen updating would loop.
6857
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 Note that the only effect of 'ruler' when this option is set (and
6859 'laststatus' is 2) is controlling the output of |CTRL-G|.
6860
6861 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006862 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006864 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 minwid Minimum width of the item, padding as set by '-' & '0'.
6866 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006867 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 on the left for text items. Numeric items will be
6869 shifted down to maxwid-2 digits followed by '>'number
6870 where number is the amount of missing digits, much like
6871 an exponential notation.
6872 item A one letter code as described below.
6873
6874 Following is a description of the possible statusline items. The
6875 second character in "item" is the type:
6876 N for number
6877 S for string
6878 F for flags as described below
6879 - not applicable
6880
6881 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006882 f S Path to the file in the buffer, as typed or relative to current
6883 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 F S Full path to the file in the buffer.
6885 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006886 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006888 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006890 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006892 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006894 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6896 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006897 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6899 being used: "<keymap>"
6900 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006901 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 B N As above, in hexadecimal.
6903 o N Byte number in file of byte under cursor, first byte is 1.
6904 Mnemonic: Offset from start of file (with one added)
6905 {not available when compiled without |+byte_offset| feature}
6906 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006907 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 l N Line number.
6909 L N Number of lines in buffer.
6910 c N Column number.
6911 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 p N Percentage through file in lines as in |CTRL-G|.
6914 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006915 percentage described for 'ruler'. Always 3 in length, unless
6916 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006917 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006919 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006920 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 ( - Start of item group. Can be used for setting the width and
6922 alignment of a section. Must be followed by %) somewhere.
6923 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006924 T N For 'tabline': start of tab page N label. Use %T after the last
6925 label. This information is used for mouse clicks.
6926 X N For 'tabline': start of close tab N label. Use %X after the
6927 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6928 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 < - Where to truncate line if too long. Default is at the start.
6930 No width fields allowed.
6931 = - Separation point between left and right aligned items.
6932 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006933 # - Set highlight group. The name must follow and then a # again.
6934 Thus use %#HLname# for highlight group HLname. The same
6935 highlighting is used, also for the statusline of non-current
6936 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006938 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006939 The difference between User{N} and StatusLine will be applied
6940 to StatusLineNC for the statusline of non-current windows.
6941 The number N must be between 1 and 9. See |hl-User1..9|
6942
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006943 When displaying a flag, Vim removes the leading comma, if any, when
6944 that flag comes right after plaintext. This will make a nice display
6945 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946
Bram Moolenaar582fd852005-03-28 20:58:01 +00006947 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 not set) and a minwid is not set for the group, the whole group will
6949 become empty. This will make a group like the following disappear
6950 completely from the statusline when none of the flags are set. >
6951 :set statusline=...%(\ [%M%R%H]%)...
6952<
6953 Beware that an expression is evaluated each and every time the status
6954 line is displayed. The current buffer and current window will be set
6955 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006956 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006958 real current buffer.
6959
Bram Moolenaar30b65812012-07-12 22:01:11 +02006960 The 'statusline' option will be evaluated in the |sandbox| if set from
6961 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006962
6963 It is not allowed to change text or jump to another window while
6964 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965
6966 If the statusline is not updated when you want it (e.g., after setting
6967 a variable that's used in an expression), you can force an update by
6968 setting an option without changing its value. Example: >
6969 :let &ro = &ro
6970
6971< A result of all digits is regarded a number for display purposes.
6972 Otherwise the result is taken as flag text and applied to the rules
6973 described above.
6974
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006975 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6977 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6978
6979 Examples:
6980 Emulate standard status line with 'ruler' set >
6981 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6982< Similar, but add ASCII value of char under the cursor (like "ga") >
6983 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6984< Display byte count and byte value, modified flag in red. >
6985 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6986 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6987< Display a ,GZ flag if a compressed file is loaded >
6988 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6989< In the |:autocmd|'s: >
6990 :let b:gzflag = 1
6991< And: >
6992 :unlet b:gzflag
6993< And define this function: >
6994 :function VarExists(var, val)
6995 : if exists(a:var) | return a:val | else | return '' | endif
6996 :endfunction
6997<
6998 *'suffixes'* *'su'*
6999'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7000 global
7001 {not in Vi}
7002 Files with these suffixes get a lower priority when multiple files
7003 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007004 suffixes. Spaces after the comma are ignored. A dot is also seen as
7005 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007006 separator, precede it with a backslash (see |option-backslash| about
7007 including spaces and backslashes).
7008 See 'wildignore' for completely ignoring files.
7009 The use of |:set+=| and |:set-=| is preferred when adding or removing
7010 suffixes from the list. This avoids problems when a future version
7011 uses another default.
7012
7013 *'suffixesadd'* *'sua'*
7014'suffixesadd' 'sua' string (default "")
7015 local to buffer
7016 {not in Vi}
7017 {not available when compiled without the
7018 |+file_in_path| feature}
7019 Comma separated list of suffixes, which are used when searching for a
7020 file for the "gf", "[I", etc. commands. Example: >
7021 :set suffixesadd=.java
7022<
7023 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7024'swapfile' 'swf' boolean (default on)
7025 local to buffer
7026 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007027 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007028 swapfile is not wanted for a specific buffer. For example, with
7029 confidential information that even root must not be able to access.
7030 Careful: All text will be in memory:
7031 - Don't use this for big files.
7032 - Recovery will be impossible!
7033 A swapfile will only be present when |'updatecount'| is non-zero and
7034 'swapfile' is set.
7035 When 'swapfile' is reset, the swap file for the current buffer is
7036 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7037 non-zero, a swap file is immediately created.
7038 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007039 If you want to open a new buffer without creating a swap file for it,
7040 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007041
7042 This option is used together with 'bufhidden' and 'buftype' to
7043 specify special kinds of buffers. See |special-buffers|.
7044
7045 *'swapsync'* *'sws'*
7046'swapsync' 'sws' string (default "fsync")
7047 global
7048 {not in Vi}
7049 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007050 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007051 When this option is empty parts of the swap file may be in memory and
7052 not written to disk. When the system crashes you may lose more work.
7053 On Unix the system does a sync now and then without Vim asking for it,
7054 so the disadvantage of setting this option off is small. On some
7055 systems the swap file will not be written at all. For a unix system
7056 setting it to "sync" will use the sync() call instead of the default
7057 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007058 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059
7060 *'switchbuf'* *'swb'*
7061'switchbuf' 'swb' string (default "")
7062 global
7063 {not in Vi}
7064 This option controls the behavior when switching between buffers.
7065 Possible values (comma separated list):
7066 useopen If included, jump to the first open window that
7067 contains the specified buffer (if there is one).
7068 Otherwise: Do not examine other windows.
7069 This setting is checked with |quickfix| commands, when
7070 jumping to errors (":cc", ":cn", "cp", etc.). It is
7071 also used in all buffer related split commands, for
7072 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007073 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007074 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007075 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007076 a buffer for a |quickfix| command that display errors.
7077 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007078 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007079 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007080 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007081
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007082 *'synmaxcol'* *'smc'*
7083'synmaxcol' 'smc' number (default 3000)
7084 local to buffer
7085 {not in Vi}
7086 {not available when compiled without the |+syntax|
7087 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007088 Maximum column in which to search for syntax items. In long lines the
7089 text after this column is not highlighted and following lines may not
7090 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007091 This helps to avoid very slow redrawing for an XML file that is one
7092 long line.
7093 Set to zero to remove the limit.
7094
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 *'syntax'* *'syn'*
7096'syntax' 'syn' string (default empty)
7097 local to buffer
7098 {not in Vi}
7099 {not available when compiled without the |+syntax|
7100 feature}
7101 When this option is set, the syntax with this name is loaded, unless
7102 syntax highlighting has been switched off with ":syntax off".
7103 Otherwise this option does not always reflect the current syntax (the
7104 b:current_syntax variable does).
7105 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007106 not automatically recognized. Example, in an IDL file:
7107 /* vim: set syntax=idl : */ ~
7108 When a dot appears in the value then this separates two filetype
7109 names. Example:
7110 /* vim: set syntax=c.doxygen : */ ~
7111 This will use the "c" syntax first, then the "doxygen" syntax.
7112 Note that the second one must be prepared to be loaded as an addition,
7113 otherwise it will be skipped. More than one dot may appear.
7114 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 :set syntax=OFF
7116< To switch syntax highlighting on according to the current value of the
7117 'filetype' option: >
7118 :set syntax=ON
7119< What actually happens when setting the 'syntax' option is that the
7120 Syntax autocommand event is triggered with the value as argument.
7121 This option is not copied to another buffer, independent of the 's' or
7122 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007123 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007125 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007126'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007127 global
7128 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007129 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007130 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007131 When nonempty, this option determines the content of the tab pages
7132 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007133 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007134
7135 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007136 option and only when there is no GUI tab line. When 'e' is in
7137 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007138 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007139
7140 The value is evaluated like with 'statusline'. You can use
7141 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007142 the text to be displayed. Use "%1T" for the first label, "%2T" for
7143 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007144
7145 Keep in mind that only one of the tab pages is the current one, others
7146 are invisible and you can't jump to their windows.
7147
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007148
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007149 *'tabpagemax'* *'tpm'*
7150'tabpagemax' 'tpm' number (default 10)
7151 global
7152 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007153 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007154 feature}
7155 Maximum number of tab pages to be opened by the |-p| command line
7156 argument or the ":tab all" command. |tabpage|
7157
7158
7159 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160'tabstop' 'ts' number (default 8)
7161 local to buffer
7162 Number of spaces that a <Tab> in the file counts for. Also see
7163 |:retab| command, and 'softtabstop' option.
7164
7165 Note: Setting 'tabstop' to any other value than 8 can make your file
7166 appear wrong in many places (e.g., when printing it).
7167
7168 There are four main ways to use tabs in Vim:
7169 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7170 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007171 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 behave like a tab appears every 4 (or 3) characters.
7173 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7174 'expandtab'. This way you will always insert spaces. The
7175 formatting will never be messed up when 'tabstop' is changed.
7176 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007177 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 works when using Vim to edit the file.
7179 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7180 'noexpandtab'. This should then work (for initial indents only)
7181 for any tabstop setting that people use. It might be nice to have
7182 tabs after the first non-blank inserted as spaces if you do this
7183 though. Otherwise aligned comments will be wrong when 'tabstop' is
7184 changed.
7185
7186 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7187'tagbsearch' 'tbs' boolean (default on)
7188 global
7189 {not in Vi}
7190 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007191 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 searching makes searching for a tag a LOT faster, but a linear search
7193 will find more tags if the tags file wasn't properly sorted.
7194 Vim normally assumes that your tags files are sorted, or indicate that
7195 they are not sorted. Only when this is not the case does the
7196 'tagbsearch' option need to be switched off.
7197
7198 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007199 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 certain files, or retry all files with a linear search. When
7201 'tagbsearch' is off, only a linear search is done.
7202
7203 Linear searching is done anyway, for one file, when Vim finds a line
7204 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007205 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206< [The whitespace before and after the '0' must be a single <Tab>]
7207
7208 When a binary search was done and no match was found in any of the
7209 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7210 instead of a normal tag name, a retry is done with a linear search.
7211 Tags in unsorted tags files, and matches with different case will only
7212 be found in the retry.
7213
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007214 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 linear search can be avoided for the 'ignorecase' case. Use a value
7216 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7217 case-fold sorted with the -f switch to "sort" in most unices, as in
7218 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007219 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7220 for this as well. Note that case must be folded to uppercase for this
7221 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222
7223 When 'tagbsearch' is off, tags searching is slower when a full match
7224 exists, but faster when no full match exists. Tags in unsorted tags
7225 files may only be found with 'tagbsearch' off.
7226 When the tags file is not sorted, or sorted in a wrong way (not on
7227 ASCII byte value), 'tagbsearch' should be off, or the line given above
7228 must be included in the tags file.
7229 This option doesn't affect commands that find all matching tags (e.g.,
7230 command-line completion and ":help").
7231 {Vi: always uses binary search in some versions}
7232
7233 *'taglength'* *'tl'*
7234'taglength' 'tl' number (default 0)
7235 global
7236 If non-zero, tags are significant up to this number of characters.
7237
7238 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7239'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7240 global
7241 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007242 If on and using a tags file in another directory, file names in that
7243 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 NOTE: This option is set to the Vi default value when 'compatible' is
7245 set and to the Vim default value when 'compatible' is reset.
7246
7247 *'tags'* *'tag'* *E433*
7248'tags' 'tag' string (default "./tags,tags", when compiled with
7249 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7250 global or local to buffer |global-local|
7251 Filenames for the tag command, separated by spaces or commas. To
7252 include a space or comma in a file name, precede it with a backslash
7253 (see |option-backslash| about including spaces and backslashes).
7254 When a file name starts with "./", the '.' is replaced with the path
7255 of the current file. But only when the 'd' flag is not included in
7256 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7257 |tags-option|.
7258 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007259 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7260 find all files named "tags" below "/lib". The filename itself cannot
7261 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7262 files called "tags?". {not available when compiled without the
7263 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007264 The |tagfiles()| function can be used to get a list of the file names
7265 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7267 files are also supported. They are automatically recognized. The
7268 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7269 differences are ignored (MS-Windows). |emacs-tags|
7270 The use of |:set+=| and |:set-=| is preferred when adding or removing
7271 file names from the list. This avoids problems when a future version
7272 uses another default.
7273 {Vi: default is "tags /usr/lib/tags"}
7274
7275 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7276'tagstack' 'tgst' boolean (default on)
7277 global
7278 {not in all versions of Vi}
7279 When on, the |tagstack| is used normally. When off, a ":tag" or
7280 ":tselect" command with an argument will not push the tag onto the
7281 tagstack. A following ":tag" without an argument, a ":pop" command or
7282 any other command that uses the tagstack will use the unmodified
7283 tagstack, but does change the pointer to the active entry.
7284 Resetting this option is useful when using a ":tag" command in a
7285 mapping which should not change the tagstack.
7286
7287 *'term'* *E529* *E530* *E531*
7288'term' string (default is $TERM, if that fails:
7289 in the GUI: "builtin_gui"
7290 on Amiga: "amiga"
7291 on BeOS: "beos-ansi"
7292 on Mac: "mac-ansi"
7293 on MiNT: "vt52"
7294 on MS-DOS: "pcterm"
7295 on OS/2: "os2ansi"
7296 on Unix: "ansi"
7297 on VMS: "ansi"
7298 on Win 32: "win32")
7299 global
7300 Name of the terminal. Used for choosing the terminal control
7301 characters. Environment variables are expanded |:set_env|.
7302 For example: >
7303 :set term=$TERM
7304< See |termcap|.
7305
7306 *'termbidi'* *'tbidi'*
7307 *'notermbidi'* *'notbidi'*
7308'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7309 global
7310 {not in Vi}
7311 {only available when compiled with the |+arabic|
7312 feature}
7313 The terminal is in charge of Bi-directionality of text (as specified
7314 by Unicode). The terminal is also expected to do the required shaping
7315 that some languages (such as Arabic) require.
7316 Setting this option implies that 'rightleft' will not be set when
7317 'arabic' is set and the value of 'arabicshape' will be ignored.
7318 Note that setting 'termbidi' has the immediate effect that
7319 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7320 This option is reset when the GUI is started.
7321 For further details see |arabic.txt|.
7322
7323 *'termencoding'* *'tenc'*
7324'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7325 Macintosh GUI: "macroman")
7326 global
7327 {only available when compiled with the |+multi_byte|
7328 feature}
7329 {not in Vi}
7330 Encoding used for the terminal. This specifies what character
7331 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007332 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007333 display). Except for the Mac when 'macatsui' is off, then
7334 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 In the Win32 console version the default value is the console codepage
7336 when it differs from the ANSI codepage.
7337 *E617*
7338 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7339 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7340 Any attempts to set a different value will be rejected, and an error
7341 message is shown.
7342 For the Win32 GUI 'termencoding' is not used for typed characters,
7343 because the Win32 system always passes Unicode characters.
7344 When empty, the same encoding is used as for the 'encoding' option.
7345 This is the normal value.
7346 Not all combinations for 'termencoding' and 'encoding' are valid. See
7347 |encoding-table|.
7348 The value for this option must be supported by internal conversions or
7349 iconv(). When this is not possible no conversion will be done and you
7350 will probably experience problems with non-ASCII characters.
7351 Example: You are working with the locale set to euc-jp (Japanese) and
7352 want to edit a UTF-8 file: >
7353 :let &termencoding = &encoding
7354 :set encoding=utf-8
7355< You need to do this when your system has no locale support for UTF-8.
7356
7357 *'terse'* *'noterse'*
7358'terse' boolean (default off)
7359 global
7360 When set: Add 's' flag to 'shortmess' option (this makes the message
7361 for a search that hits the start or end of the file not being
7362 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7363 shortens a lot of messages}
7364
7365 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7366'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7367 global
7368 {not in Vi}
7369 This option is obsolete. Use 'fileformats'.
7370 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7371 set to the default value for the current system. When 'textauto' is
7372 reset, 'fileformats' is made empty.
7373 NOTE: This option is set to the Vi default value when 'compatible' is
7374 set and to the Vim default value when 'compatible' is reset.
7375
7376 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7377'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7378 others: default off)
7379 local to buffer
7380 {not in Vi}
7381 This option is obsolete. Use 'fileformat'.
7382 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7383 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7384 "unix".
7385
7386 *'textwidth'* *'tw'*
7387'textwidth' 'tw' number (default 0)
7388 local to buffer
7389 {not in Vi}
7390 Maximum width of text that is being inserted. A longer line will be
7391 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007392 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7393 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007395 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 NOTE: This option is set to 0 when 'compatible' is set.
7397
7398 *'thesaurus'* *'tsr'*
7399'thesaurus' 'tsr' string (default "")
7400 global or local to buffer |global-local|
7401 {not in Vi}
7402 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007403 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007404 the file should contain words with similar meaning, separated by
7405 non-keyword characters (white space is preferred). Maximum line
7406 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007407 To obtain a file to be used here, check out this ftp site:
7408 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007409 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 after a comma are ignored, otherwise spaces are included in the file
7411 name. See |option-backslash| about using backslashes.
7412 The use of |:set+=| and |:set-=| is preferred when adding or removing
7413 directories from the list. This avoids problems when a future version
7414 uses another default.
7415 Backticks cannot be used in this option for security reasons.
7416
7417 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7418'tildeop' 'top' boolean (default off)
7419 global
7420 {not in Vi}
7421 When on: The tilde command "~" behaves like an operator.
7422 NOTE: This option is reset when 'compatible' is set.
7423
7424 *'timeout'* *'to'* *'notimeout'* *'noto'*
7425'timeout' 'to' boolean (default on)
7426 global
7427 *'ttimeout'* *'nottimeout'*
7428'ttimeout' boolean (default off)
7429 global
7430 {not in Vi}
7431 These two options together determine the behavior when part of a
7432 mapped key sequence or keyboard code has been received:
7433
7434 'timeout' 'ttimeout' action ~
7435 off off do not time out
7436 on on or off time out on :mappings and key codes
7437 off on time out on key codes
7438
7439 If both options are off, Vim will wait until either the complete
7440 mapping or key sequence has been received, or it is clear that there
7441 is no mapping or key sequence for the received characters. For
7442 example: if you have mapped "vl" and Vim has received 'v', the next
7443 character is needed to see if the 'v' is followed by an 'l'.
7444 When one of the options is on, Vim will wait for about 1 second for
7445 the next character to arrive. After that the already received
7446 characters are interpreted as single characters. The waiting time can
7447 be changed with the 'timeoutlen' option.
7448 On slow terminals or very busy systems timing out may cause
7449 malfunctioning cursor keys. If both options are off, Vim waits
7450 forever after an entered <Esc> if there are key codes that start
7451 with <Esc>. You will have to type <Esc> twice. If you do not have
7452 problems with key codes, but would like to have :mapped key
7453 sequences not timing out in 1 second, set the 'ttimeout' option and
7454 reset the 'timeout' option.
7455
7456 NOTE: 'ttimeout' is reset when 'compatible' is set.
7457
7458 *'timeoutlen'* *'tm'*
7459'timeoutlen' 'tm' number (default 1000)
7460 global
7461 {not in all versions of Vi}
7462 *'ttimeoutlen'* *'ttm'*
7463'ttimeoutlen' 'ttm' number (default -1)
7464 global
7465 {not in Vi}
7466 The time in milliseconds that is waited for a key code or mapped key
7467 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7468 when part of a command has been typed.
7469 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7470 different timeout value for key codes is desired set 'ttimeoutlen' to
7471 a non-negative number.
7472
7473 ttimeoutlen mapping delay key code delay ~
7474 < 0 'timeoutlen' 'timeoutlen'
7475 >= 0 'timeoutlen' 'ttimeoutlen'
7476
7477 The timeout only happens when the 'timeout' and 'ttimeout' options
7478 tell so. A useful setting would be >
7479 :set timeout timeoutlen=3000 ttimeoutlen=100
7480< (time out on mapping after three seconds, time out on key codes after
7481 a tenth of a second).
7482
7483 *'title'* *'notitle'*
7484'title' boolean (default off, on when title can be restored)
7485 global
7486 {not in Vi}
7487 {not available when compiled without the |+title|
7488 feature}
7489 When on, the title of the window will be set to the value of
7490 'titlestring' (if it is not empty), or to:
7491 filename [+=-] (path) - VIM
7492 Where:
7493 filename the name of the file being edited
7494 - indicates the file cannot be modified, 'ma' off
7495 + indicates the file was modified
7496 = indicates the file is read-only
7497 =+ indicates the file is read-only and modified
7498 (path) is the path of the file being edited
7499 - VIM the server name |v:servername| or "VIM"
7500 Only works if the terminal supports setting window titles
7501 (currently Amiga console, Win32 console, all GUI versions and
7502 terminals with a non- empty 't_ts' option - these are Unix xterm and
7503 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7504 *X11*
7505 When Vim was compiled with HAVE_X11 defined, the original title will
7506 be restored if possible. The output of ":version" will include "+X11"
7507 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7508 works for the icon name |'icon'|.
7509 But: When Vim was started with the |-X| argument, restoring the title
7510 will not work (except in the GUI).
7511 If the title cannot be restored, it is set to the value of 'titleold'.
7512 You might want to restore the title outside of Vim then.
7513 When using an xterm from a remote machine you can use this command:
7514 rsh machine_name xterm -display $DISPLAY &
7515 then the WINDOWID environment variable should be inherited and the
7516 title of the window should change back to what it should be after
7517 exiting Vim.
7518
7519 *'titlelen'*
7520'titlelen' number (default 85)
7521 global
7522 {not in Vi}
7523 {not available when compiled without the |+title|
7524 feature}
7525 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007526 title. When the title is longer, only the end of the path name is
7527 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 Using a percentage makes this adapt to the width of the window. But
7529 it won't work perfectly, because the actual number of characters
7530 available also depends on the font used and other things in the title
7531 bar. When 'titlelen' is zero the full path is used. Otherwise,
7532 values from 1 to 30000 percent can be used.
7533 'titlelen' is also used for the 'titlestring' option.
7534
7535 *'titleold'*
7536'titleold' string (default "Thanks for flying Vim")
7537 global
7538 {not in Vi}
7539 {only available when compiled with the |+title|
7540 feature}
7541 This option will be used for the window title when exiting Vim if the
7542 original title cannot be restored. Only happens if 'title' is on or
7543 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007544 This option cannot be set from a |modeline| or in the |sandbox|, for
7545 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 *'titlestring'*
7547'titlestring' string (default "")
7548 global
7549 {not in Vi}
7550 {not available when compiled without the |+title|
7551 feature}
7552 When this option is not empty, it will be used for the title of the
7553 window. This happens only when the 'title' option is on.
7554 Only works if the terminal supports setting window titles (currently
7555 Amiga console, Win32 console, all GUI versions and terminals with a
7556 non-empty 't_ts' option).
7557 When Vim was compiled with HAVE_X11 defined, the original title will
7558 be restored if possible |X11|.
7559 When this option contains printf-style '%' items, they will be
7560 expanded according to the rules used for 'statusline'.
7561 Example: >
7562 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7563 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7564< The value of 'titlelen' is used to align items in the middle or right
7565 of the available space.
7566 Some people prefer to have the file name first: >
7567 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7568< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007569 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 separating space only when needed.
7571 NOTE: Use of special characters in 'titlestring' may cause the display
7572 to be garbled (e.g., when it contains a CR or NL character).
7573 {not available when compiled without the |+statusline| feature}
7574
7575 *'toolbar'* *'tb'*
7576'toolbar' 'tb' string (default "icons,tooltips")
7577 global
7578 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7579 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007580 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 possible values are:
7582 icons Toolbar buttons are shown with icons.
7583 text Toolbar buttons shown with text.
7584 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007585 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 tooltips Tooltips are active for toolbar buttons.
7587 Tooltips refer to the popup help text which appears after the mouse
7588 cursor is placed over a toolbar button for a brief moment.
7589
7590 If you want the toolbar to be shown with icons as well as text, do the
7591 following: >
7592 :set tb=icons,text
7593< Motif and Athena cannot display icons and text at the same time. They
7594 will show icons if both are requested.
7595
7596 If none of the strings specified in 'toolbar' are valid or if
7597 'toolbar' is empty, this option is ignored. If you want to disable
7598 the toolbar, you need to set the 'guioptions' option. For example: >
7599 :set guioptions-=T
7600< Also see |gui-toolbar|.
7601
7602 *'toolbariconsize'* *'tbis'*
7603'toolbariconsize' 'tbis' string (default "small")
7604 global
7605 {not in Vi}
7606 {only in the GTK+ 2 GUI}
7607 Controls the size of toolbar icons. The possible values are:
7608 tiny Use tiny toolbar icons.
7609 small Use small toolbar icons (default).
7610 medium Use medium-sized toolbar icons.
7611 large Use large toolbar icons.
7612 The exact dimensions in pixels of the various icon sizes depend on
7613 the current theme. Common dimensions are large=32x32, medium=24x24,
7614 small=20x20 and tiny=16x16.
7615
7616 If 'toolbariconsize' is empty, the global default size as determined
7617 by user preferences or the current theme is used.
7618
7619 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7620'ttybuiltin' 'tbi' boolean (default on)
7621 global
7622 {not in Vi}
7623 When on, the builtin termcaps are searched before the external ones.
7624 When off the builtin termcaps are searched after the external ones.
7625 When this option is changed, you should set the 'term' option next for
7626 the change to take effect, for example: >
7627 :set notbi term=$TERM
7628< See also |termcap|.
7629 Rationale: The default for this option is "on", because the builtin
7630 termcap entries are generally better (many systems contain faulty
7631 xterm entries...).
7632
7633 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7634'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7635 sun-cmd, screen, rxvt, dtterm or
7636 iris-ansi; also on when running Vim in
7637 a DOS console)
7638 global
7639 {not in Vi}
7640 Indicates a fast terminal connection. More characters will be sent to
7641 the screen for redrawing, instead of using insert/delete line
7642 commands. Improves smoothness of redrawing when there are multiple
7643 windows and the terminal does not support a scrolling region.
7644 Also enables the extra writing of characters at the end of each screen
7645 line for lines that wrap. This helps when using copy/paste with the
7646 mouse in an xterm and other terminals.
7647
7648 *'ttymouse'* *'ttym'*
7649'ttymouse' 'ttym' string (default depends on 'term')
7650 global
7651 {not in Vi}
7652 {only in Unix and VMS, doesn't work in the GUI; not
7653 available when compiled without |+mouse|}
7654 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007655 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007656 *xterm-mouse*
7657 xterm xterm-like mouse handling. The mouse generates
7658 "<Esc>[Mscr", where "scr" is three bytes:
7659 "s" = button state
7660 "c" = column plus 33
7661 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007662 This only works up to 223 columns! See "dec",
7663 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 xterm2 Works like "xterm", but with the xterm reporting the
7665 mouse position while the mouse is dragged. This works
7666 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007667 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007668 work. See below for how Vim detects this
7669 automatically.
7670 *netterm-mouse*
7671 netterm NetTerm mouse handling. The mouse generates
7672 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7673 for the row and column.
7674 *dec-mouse*
7675 dec DEC terminal mouse handling. The mouse generates a
7676 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007677 This is also available for an Xterm, if it was
7678 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 *jsbterm-mouse*
7680 jsbterm JSB term mouse handling.
7681 *pterm-mouse*
7682 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007683 *urxvt-mouse*
7684 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007685 The mouse works only if the terminal supports this
7686 encoding style, but it does not have 223 columns limit
7687 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007688 *sgr-mouse*
7689 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007690 mouse reporting. The mouse works even in columns
7691 beyond 223. This option is backward compatible with
7692 "xterm2" because it can also decode "xterm2" style
7693 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694
7695 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007696 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7697 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7699 recognized, if enabled at compile time. DEC terminal mouse codes
7700 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007701 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7702 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007704 set to a name that starts with "xterm", "mlterm", or "screen", and
7705 'ttymouse' is not set already.
7706 Additionally, if vim is compiled with the |+termresponse| feature and
7707 |t_RV| is set to the escape sequence to request the xterm version
7708 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007710 from 95 to 276. The "sgr" value will be set if the xterm version is
7711 277 or highter.
7712 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7713 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 :set t_RV=
7715<
7716 *'ttyscroll'* *'tsl'*
7717'ttyscroll' 'tsl' number (default 999)
7718 global
7719 Maximum number of lines to scroll the screen. If there are more lines
7720 to scroll the window is redrawn. For terminals where scrolling is
7721 very slow and redrawing is not slow this can be set to a small number,
7722 e.g., 3, to speed up displaying.
7723
7724 *'ttytype'* *'tty'*
7725'ttytype' 'tty' string (default from $TERM)
7726 global
7727 Alias for 'term', see above.
7728
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007729 *'undodir'* *'udir'*
7730'undodir' 'udir' string (default ".")
7731 global
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 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007735 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007736 "." means using the directory of the file. The undo file name for
7737 "file.txt" is ".file.txt.un~".
7738 For other directories the file name is the full path of the edited
7739 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007740 When writing: The first directory that exists is used. "." always
7741 works, no directories after "." will be used for writing.
7742 When reading all entries are tried to find an undo file. The first
7743 undo file that exists is used. When it cannot be read an error is
7744 given, no further entry is used.
7745 See |undo-persistence|.
7746
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007747 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007748'undofile' 'udf' boolean (default off)
7749 local to buffer
7750 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007751 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007752 When on, Vim automatically saves undo history to an undo file when
7753 writing a buffer to a file, and restores undo history from the same
7754 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007755 The directory where the undo file is stored is specified by 'undodir'.
7756 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007757 The undo file is not read when 'undoreload' causes the buffer from
7758 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007759 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007760
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 *'undolevels'* *'ul'*
7762'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7763 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007764 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007765 {not in Vi}
7766 Maximum number of changes that can be undone. Since undo information
7767 is kept in memory, higher numbers will cause more memory to be used
7768 (nevertheless, a single change can use an unlimited amount of memory).
7769 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7770 itself: >
7771 set ul=0
7772< But you can also get Vi compatibility by including the 'u' flag in
7773 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007774 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007775 Set to -1 for no undo at all. You might want to do this only for the
7776 current buffer: >
7777 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007779
7780 The local value is set to -123456 when the global value is to be used.
7781
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007782 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007784 *'undoreload'* *'ur'*
7785'undoreload' 'ur' number (default 10000)
7786 global
7787 {not in Vi}
7788 Save the whole buffer for undo when reloading it. This applies to the
7789 ":e!" command and reloading for when the buffer changed outside of
7790 Vim. |FileChangedShell|
7791 The save only happens when this options is negative or when the number
7792 of lines is smaller than the value of this option.
7793 Set this option to zero to disable undo for a reload.
7794
7795 When saving undo for a reload, any undo file is not read.
7796
7797 Note that this causes the whole buffer to be stored in memory. Set
7798 this option to a lower value if you run out of memory.
7799
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 *'updatecount'* *'uc'*
7801'updatecount' 'uc' number (default: 200)
7802 global
7803 {not in Vi}
7804 After typing this many characters the swap file will be written to
7805 disk. When zero, no swap file will be created at all (see chapter on
7806 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7807 Vim with the "-n" option, see |startup|. When editing in readonly
7808 mode this option will be initialized to 10000.
7809 The swapfile can be disabled per buffer with |'swapfile'|.
7810 When 'updatecount' is set from zero to non-zero, swap files are
7811 created for all buffers that have 'swapfile' set. When 'updatecount'
7812 is set to zero, existing swap files are not deleted.
7813 Also see |'swapsync'|.
7814 This option has no meaning in buffers where |'buftype'| is "nofile"
7815 or "nowrite".
7816
7817 *'updatetime'* *'ut'*
7818'updatetime' 'ut' number (default 4000)
7819 global
7820 {not in Vi}
7821 If this many milliseconds nothing is typed the swap file will be
7822 written to disk (see |crash-recovery|). Also used for the
7823 |CursorHold| autocommand event.
7824
7825 *'verbose'* *'vbs'*
7826'verbose' 'vbs' number (default 0)
7827 global
7828 {not in Vi, although some versions have a boolean
7829 verbose option}
7830 When bigger than zero, Vim will give messages about what it is doing.
7831 Currently, these messages are given:
7832 >= 1 When the viminfo file is read or written.
7833 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007834 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 >= 8 Files for which a group of autocommands is executed.
7836 >= 9 Every executed autocommand.
7837 >= 12 Every executed function.
7838 >= 13 When an exception is thrown, caught, finished, or discarded.
7839 >= 14 Anything pending in a ":finally" clause.
7840 >= 15 Every executed Ex command (truncated at 200 characters).
7841
7842 This option can also be set with the "-V" argument. See |-V|.
7843 This option is also set by the |:verbose| command.
7844
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007845 When the 'verbosefile' option is set then the verbose messages are not
7846 displayed.
7847
7848 *'verbosefile'* *'vfile'*
7849'verbosefile' 'vfile' string (default empty)
7850 global
7851 {not in Vi}
7852 When not empty all messages are written in a file with this name.
7853 When the file exists messages are appended.
7854 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007855 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007856 Setting 'verbosefile' to a new value is like making it empty first.
7857 The difference with |:redir| is that verbose messages are not
7858 displayed when 'verbosefile' is set.
7859
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 *'viewdir'* *'vdir'*
7861'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7862 "$VIM/vimfiles/view",
7863 for Unix: "~/.vim/view",
7864 for Macintosh: "$VIM:vimfiles:view"
7865 for VMS: "sys$login:vimfiles/view"
7866 for RiscOS: "Choices:vimfiles/view")
7867 global
7868 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007869 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 feature}
7871 Name of the directory where to store files for |:mkview|.
7872 This option cannot be set from a |modeline| or in the |sandbox|, for
7873 security reasons.
7874
7875 *'viewoptions'* *'vop'*
7876'viewoptions' 'vop' string (default: "folds,options,cursor")
7877 global
7878 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007879 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 feature}
7881 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007882 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 word save and restore ~
7884 cursor cursor position in file and in window
7885 folds manually created folds, opened/closed folds and local
7886 fold options
7887 options options and mappings local to a window or buffer (not
7888 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007889 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007890 slash backslashes in file names replaced with forward
7891 slashes
7892 unix with Unix end-of-line format (single <NL>), even when
7893 on Windows or DOS
7894
7895 "slash" and "unix" are useful on Windows when sharing view files
7896 with Unix. The Unix version of Vim cannot source dos format scripts,
7897 but the Windows version of Vim can source unix format scripts.
7898
7899 *'viminfo'* *'vi'* *E526* *E527* *E528*
7900'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007901 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7902 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7903 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 global
7905 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007906 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 feature}
7908 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007909 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 separated list of parameters, each consisting of a single character
7911 identifying the particular parameter, followed by a number or string
7912 which specifies the value of that parameter. If a particular
7913 character is left out, then the default value is used for that
7914 parameter. The following is a list of the identifying characters and
7915 the effect of their value.
7916 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007917 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 ! When included, save and restore global variables that start
7919 with an uppercase letter, and don't contain a lowercase
7920 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007921 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007922 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007923 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 " Maximum number of lines saved for each register. Old name of
7925 the '<' item, with the disadvantage that you need to put a
7926 backslash before the ", otherwise it will be recognized as the
7927 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007928 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 % When included, save and restore the buffer list. If Vim is
7930 started with a file name argument, the buffer list is not
7931 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007932 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 without a file name and buffers for help files are not written
7934 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007935 When followed by a number, the number specifies the maximum
7936 number of buffers that are stored. Without a number all
7937 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007938 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 ' Maximum number of previously edited files for which the marks
7940 are remembered. This parameter must always be included when
7941 'viminfo' is non-empty.
7942 Including this item also means that the |jumplist| and the
7943 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007944 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007945 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007946 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 patterns are also saved. When not included, the value of
7948 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007949 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007951 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007952 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 < Maximum number of lines saved for each register. If zero then
7954 registers are not saved. When not included, all lines are
7955 saved. '"' is the old name for this item.
7956 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007957 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007958 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007959 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007960 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 c When included, convert the text in the viminfo file from the
7962 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007963 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007964 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 f Whether file marks need to be stored. If zero, file marks ('0
7966 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007967 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007969 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 h Disable the effect of 'hlsearch' when loading the viminfo
7971 file. When not included, it depends on whether ":nohlsearch"
7972 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007973 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 n Name of the viminfo file. The name must immediately follow
7975 the 'n'. Must be the last one! If the "-i" argument was
7976 given when starting Vim, that file name overrides the one
7977 given here with 'viminfo'. Environment variables are expanded
7978 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007979 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980 r Removable media. The argument is a string (up to the next
7981 ','). This parameter can be given several times. Each
7982 specifies the start of a path for which no marks will be
7983 stored. This is to avoid removable media. For MS-DOS you
7984 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7985 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7986 ignored. Maximum length of each 'r' argument is 50
7987 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007988 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007989 s Maximum size of an item in Kbyte. If zero then registers are
7990 not saved. Currently only applies to registers. The default
7991 "s10" will exclude registers with more than 10 Kbyte of text.
7992 Also see the '<' item above: line count limit.
7993
7994 Example: >
7995 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7996<
7997 '50 Marks will be remembered for the last 50 files you
7998 edited.
7999 <1000 Contents of registers (up to 1000 lines each) will be
8000 remembered.
8001 s100 Registers with more than 100 Kbyte text are skipped.
8002 :0 Command-line history will not be saved.
8003 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8004 no / Since '/' is not specified, the default will be used,
8005 that is, save all of the search history, and also the
8006 previous search and substitute patterns.
8007 no % The buffer list will not be saved nor read back.
8008 no h 'hlsearch' highlighting will be restored.
8009
8010 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8011 load the contents of the file, this is not done automatically.
8012
8013 This option cannot be set from a |modeline| or in the |sandbox|, for
8014 security reasons.
8015
8016 *'virtualedit'* *'ve'*
8017'virtualedit' 've' string (default "")
8018 global
8019 {not in Vi}
8020 {not available when compiled without the
8021 |+virtualedit| feature}
8022 A comma separated list of these words:
8023 block Allow virtual editing in Visual block mode.
8024 insert Allow virtual editing in Insert mode.
8025 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008026 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008027
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008029 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008030 of the line. Useful for selecting a rectangle in Visual mode and
8031 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008032 "onemore" is not the same, it will only allow moving the cursor just
8033 after the last character of the line. This makes some commands more
8034 consistent. Previously the cursor was always past the end of the line
8035 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008036 break some plugins or Vim scripts. For example because |l| can move
8037 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008038 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008039 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008040 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008041 It doesn't make sense to combine "all" with "onemore", but you will
8042 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008043
8044 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8045'visualbell' 'vb' boolean (default off)
8046 global
8047 {not in Vi}
8048 Use visual bell instead of beeping. The terminal code to display the
8049 visual bell is given with 't_vb'. When no beep or flash is wanted,
8050 use ":set vb t_vb=".
8051 Note: When the GUI starts, 't_vb' is reset to its default value. You
8052 might want to set it again in your |gvimrc|.
8053 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8054 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8055 where 40 is the time in msec.
8056 Does not work on the Amiga, you always get a screen flash.
8057 Also see 'errorbells'.
8058
8059 *'warn'* *'nowarn'*
8060'warn' boolean (default on)
8061 global
8062 Give a warning message when a shell command is used while the buffer
8063 has been changed.
8064
8065 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8066'weirdinvert' 'wiv' boolean (default off)
8067 global
8068 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008069 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 It is provided for backwards compatibility with version 4.x.
8071 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8072 vice versa. Has no effect when the GUI is running.
8073
8074 *'whichwrap'* *'ww'*
8075'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8076 global
8077 {not in Vi}
8078 Allow specified keys that move the cursor left/right to move to the
8079 previous/next line when the cursor is on the first/last character in
8080 the line. Concatenate characters to allow this for these keys:
8081 char key mode ~
8082 b <BS> Normal and Visual
8083 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008084 h "h" Normal and Visual (not recommended)
8085 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 < <Left> Normal and Visual
8087 > <Right> Normal and Visual
8088 ~ "~" Normal
8089 [ <Left> Insert and Replace
8090 ] <Right> Insert and Replace
8091 For example: >
8092 :set ww=<,>,[,]
8093< allows wrap only when cursor keys are used.
8094 When the movement keys are used in combination with a delete or change
8095 operator, the <EOL> also counts for a character. This makes "3h"
8096 different from "3dh" when the cursor crosses the end of a line. This
8097 is also true for "x" and "X", because they do the same as "dl" and
8098 "dh". If you use this, you may also want to use the mapping
8099 ":map <BS> X" to make backspace delete the character in front of the
8100 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008101 When 'l' is included and it is used after an operator at the end of a
8102 line then it will not move to the next line. This makes "dl", "cl",
8103 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 NOTE: This option is set to the Vi default value when 'compatible' is
8105 set and to the Vim default value when 'compatible' is reset.
8106
8107 *'wildchar'* *'wc'*
8108'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8109 global
8110 {not in Vi}
8111 Character you have to type to start wildcard expansion in the
8112 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008113 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 The character is not recognized when used inside a macro. See
8115 'wildcharm' for that.
8116 Although 'wc' is a number option, you can set it to a special key: >
8117 :set wc=<Esc>
8118< NOTE: This option is set to the Vi default value when 'compatible' is
8119 set and to the Vim default value when 'compatible' is reset.
8120
8121 *'wildcharm'* *'wcm'*
8122'wildcharm' 'wcm' number (default: none (0))
8123 global
8124 {not in Vi}
8125 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008126 recognized when used inside a macro. You can find "spare" command-line
8127 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 you'll never actually type 'wildcharm', just use it in mappings that
8129 automatically invoke completion mode, e.g.: >
8130 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008131 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132< Then after typing :ss you can use CTRL-P & CTRL-N.
8133
8134 *'wildignore'* *'wig'*
8135'wildignore' 'wig' string (default "")
8136 global
8137 {not in Vi}
8138 {not available when compiled without the |+wildignore|
8139 feature}
8140 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008141 patterns is ignored when expanding |wildcards|, completing file or
8142 directory names, and influences the result of |expand()|, |glob()| and
8143 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008144 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8145 Also see 'suffixes'.
8146 Example: >
8147 :set wildignore=*.o,*.obj
8148< The use of |:set+=| and |:set-=| is preferred when adding or removing
8149 a pattern from the list. This avoids problems when a future version
8150 uses another default.
8151
Bram Moolenaar94950a92010-12-02 16:01:29 +01008152
Bram Moolenaar81af9252010-12-10 20:35:50 +01008153 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008154'wildignorecase' 'wic' boolean (default off)
8155 global
8156 {not in Vi}
8157 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008158 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008159 Does not apply when the shell is used to expand wildcards, which
8160 happens when there are special characters.
8161
8162
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8164'wildmenu' 'wmnu' boolean (default off)
8165 global
8166 {not in Vi}
8167 {not available if compiled without the |+wildmenu|
8168 feature}
8169 When 'wildmenu' is on, command-line completion operates in an enhanced
8170 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8171 the possible matches are shown just above the command line, with the
8172 first match highlighted (overwriting the status line, if there is
8173 one). Keys that show the previous/next match, such as <Tab> or
8174 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8175 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8176 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008177 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 If there are more matches than can fit in the line, a ">" is shown on
8179 the right and/or a "<" is shown on the left. The status line scrolls
8180 as needed.
8181 The "wildmenu" mode is abandoned when a key is hit that is not used
8182 for selecting a completion.
8183 While the "wildmenu" is active the following keys have special
8184 meanings:
8185
8186 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8187 <Down> - in filename/menu name completion: move into a
8188 subdirectory or submenu.
8189 <CR> - in menu completion, when the cursor is just after a
8190 dot: move into a submenu.
8191 <Up> - in filename/menu name completion: move up into
8192 parent directory or parent menu.
8193
8194 This makes the menus accessible from the console |console-menus|.
8195
8196 If you prefer the <Left> and <Right> keys to move the cursor instead
8197 of selecting a different match, use this: >
8198 :cnoremap <Left> <Space><BS><Left>
8199 :cnoremap <Right> <Space><BS><Right>
8200<
8201 The "WildMenu" highlighting is used for displaying the current match
8202 |hl-WildMenu|.
8203
8204 *'wildmode'* *'wim'*
8205'wildmode' 'wim' string (Vim default: "full")
8206 global
8207 {not in Vi}
8208 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008209 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008210 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008211 first part specifies the behavior for the first use of 'wildchar',
8212 The second part for the second use, etc.
8213 These are the possible values for each part:
8214 "" Complete only the first match.
8215 "full" Complete the next full match. After the last match,
8216 the original string is used and then the first match
8217 again.
8218 "longest" Complete till longest common string. If this doesn't
8219 result in a longer string, use the next part.
8220 "longest:full" Like "longest", but also start 'wildmenu' if it is
8221 enabled.
8222 "list" When more than one match, list all matches.
8223 "list:full" When more than one match, list all matches and
8224 complete first match.
8225 "list:longest" When more than one match, list all matches and
8226 complete till longest common string.
8227 When there is only a single match, it is fully completed in all cases.
8228
8229 Examples: >
8230 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008231< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008232 :set wildmode=longest,full
8233< Complete longest common string, then each full match >
8234 :set wildmode=list:full
8235< List all matches and complete each full match >
8236 :set wildmode=list,full
8237< List all matches without completing, then each full match >
8238 :set wildmode=longest,list
8239< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008240 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008241
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008242 *'wildoptions'* *'wop'*
8243'wildoptions' 'wop' string (default "")
8244 global
8245 {not in Vi}
8246 {not available when compiled without the |+wildignore|
8247 feature}
8248 A list of words that change how command line completion is done.
8249 Currently only one word is allowed:
8250 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008251 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008252 is displayed per line. Often used tag kinds are:
8253 d #define
8254 f function
8255 Also see |cmdline-completion|.
8256
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 *'winaltkeys'* *'wak'*
8258'winaltkeys' 'wak' string (default "menu")
8259 global
8260 {not in Vi}
8261 {only used in Win32, Motif, GTK and Photon GUI}
8262 Some GUI versions allow the access to menu entries by using the ALT
8263 key in combination with a character that appears underlined in the
8264 menu. This conflicts with the use of the ALT key for mappings and
8265 entering special characters. This option tells what to do:
8266 no Don't use ALT keys for menus. ALT key combinations can be
8267 mapped, but there is no automatic handling. This can then be
8268 done with the |:simalt| command.
8269 yes ALT key handling is done by the windowing system. ALT key
8270 combinations cannot be mapped.
8271 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008272 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 keys can be mapped.
8274 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8275 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008276 This option is not used for <F10>; on Win32 and with GTK <F10> will
8277 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008279 *'window'* *'wi'*
8280'window' 'wi' number (default screen height - 1)
8281 global
8282 Window height. Do not confuse this with the height of the Vim window,
8283 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008284 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8285 value is smaller than 'lines' minus one. The screen will scroll
8286 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008287 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8288 in a much smarter way, taking care of wrapping lines.
8289 When resizing the Vim window, the value is smaller than 1 or more than
8290 or equal to 'lines' it will be set to 'lines' minus 1.
8291 {Vi also uses the option to specify the number of displayed lines}
8292
Bram Moolenaar071d4272004-06-13 20:20:40 +00008293 *'winheight'* *'wh'* *E591*
8294'winheight' 'wh' number (default 1)
8295 global
8296 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008297 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008298 feature}
8299 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008300 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008301 focus goes to a window that is smaller, its size is increased, at the
8302 cost of the height of other windows.
8303 Set 'winheight' to a small number for normal editing.
8304 Set it to 999 to make the current window fill most of the screen.
8305 Other windows will be only 'winminheight' high. This has the drawback
8306 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8307 to create only two windows, set the option after startup is done,
8308 using the |VimEnter| event: >
8309 au VimEnter * set winheight=999
8310< Minimum value is 1.
8311 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 height of the current window.
8313 'winheight' applies to the current window. Use 'winminheight' to set
8314 the minimal height for other windows.
8315
8316 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8317'winfixheight' 'wfh' boolean (default off)
8318 local to window
8319 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008320 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 feature}
8322 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008323 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8324 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 The height may be changed anyway when running out of room.
8326
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008327 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8328'winfixwidth' 'wfw' boolean (default off)
8329 local to window
8330 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008331 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008332 feature}
8333 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008334 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008335 The width may be changed anyway when running out of room.
8336
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 *'winminheight'* *'wmh'*
8338'winminheight' 'wmh' number (default 1)
8339 global
8340 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008341 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342 feature}
8343 The minimal height of a window, when it's not the current window.
8344 This is a hard minimum, windows will never become smaller.
8345 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8346 status bar) if necessary. They will return to at least one line when
8347 they become active (since the cursor has to have somewhere to go.)
8348 Use 'winheight' to set the minimal height of the current window.
8349 This option is only checked when making a window smaller. Don't use a
8350 large number, it will cause errors when opening more than a few
8351 windows. A value of 0 to 3 is reasonable.
8352
8353 *'winminwidth'* *'wmw'*
8354'winminwidth' 'wmw' number (default 1)
8355 global
8356 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008357 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 feature}
8359 The minimal width of a window, when it's not the current window.
8360 This is a hard minimum, windows will never become smaller.
8361 When set to zero, windows may be "squashed" to zero columns (i.e. just
8362 a vertical separator) if necessary. They will return to at least one
8363 line when they become active (since the cursor has to have somewhere
8364 to go.)
8365 Use 'winwidth' to set the minimal width of the current window.
8366 This option is only checked when making a window smaller. Don't use a
8367 large number, it will cause errors when opening more than a few
8368 windows. A value of 0 to 12 is reasonable.
8369
8370 *'winwidth'* *'wiw'* *E592*
8371'winwidth' 'wiw' number (default 20)
8372 global
8373 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008374 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 feature}
8376 Minimal number of columns for the current window. This is not a hard
8377 minimum, Vim will use fewer columns if there is not enough room. If
8378 the current window is smaller, its size is increased, at the cost of
8379 the width of other windows. Set it to 999 to make the current window
8380 always fill the screen. Set it to a small number for normal editing.
8381 The width is not adjusted after one of the commands to change the
8382 width of the current window.
8383 'winwidth' applies to the current window. Use 'winminwidth' to set
8384 the minimal width for other windows.
8385
8386 *'wrap'* *'nowrap'*
8387'wrap' boolean (default on)
8388 local to window
8389 {not in Vi}
8390 This option changes how text is displayed. It doesn't change the text
8391 in the buffer, see 'textwidth' for that.
8392 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008393 displaying continues on the next line. When off lines will not wrap
8394 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 moved to a part that is not shown, the screen will scroll
8396 horizontally.
8397 The line will be broken in the middle of a word if necessary. See
8398 'linebreak' to get the break at a word boundary.
8399 To make scrolling horizontally a bit more useful, try this: >
8400 :set sidescroll=5
8401 :set listchars+=precedes:<,extends:>
8402< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008403 This option can't be set from a |modeline| when the 'diff' option is
8404 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008405
8406 *'wrapmargin'* *'wm'*
8407'wrapmargin' 'wm' number (default 0)
8408 local to buffer
8409 Number of characters from the right window border where wrapping
8410 starts. When typing text beyond this limit, an <EOL> will be inserted
8411 and inserting continues on the next line.
8412 Options that add a margin, such as 'number' and 'foldcolumn', cause
8413 the text width to be further reduced. This is Vi compatible.
8414 When 'textwidth' is non-zero, this option is not used.
8415 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8416 and less usefully}
8417
8418 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8419'wrapscan' 'ws' boolean (default on) *E384* *E385*
8420 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008421 Searches wrap around the end of the file. Also applies to |]s| and
8422 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423
8424 *'write'* *'nowrite'*
8425'write' boolean (default on)
8426 global
8427 {not in Vi}
8428 Allows writing files. When not set, writing a file is not allowed.
8429 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008430 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 argument. Filtering text is still possible, even though this requires
8432 writing a temporary file.
8433
8434 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8435'writeany' 'wa' boolean (default off)
8436 global
8437 Allows writing to any file with no need for "!" override.
8438
8439 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8440'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8441 otherwise)
8442 global
8443 {not in Vi}
8444 Make a backup before overwriting a file. The backup is removed after
8445 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008446 also on.
8447 WARNING: Switching this option off means that when Vim fails to write
8448 your buffer correctly and then, for whatever reason, Vim exits, you
8449 lose both the original file and what you were writing. Only reset
8450 this option if your file system is almost full and it makes the write
8451 fail (and make sure not to exit Vim until the write was successful).
8452 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008453 When the 'backupskip' pattern matches, a backup is not made anyway.
8454 NOTE: This option is set to the default value when 'compatible' is
8455 set.
8456
8457 *'writedelay'* *'wd'*
8458'writedelay' 'wd' number (default 0)
8459 global
8460 {not in Vi}
8461 The number of microseconds to wait for each character sent to the
8462 screen. When non-zero, characters are sent to the terminal one by
8463 one. For MS-DOS pcterm this does not work. For debugging purposes.
8464
8465 vim:tw=78:ts=8:ft=help:norl: