blob: 39c3270fd2341cf15ec95626227a33ce3d1f4314 [file] [log] [blame]
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001*options.txt* For Vim version 7.4. Last change: 2015 Feb 17
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
Bram Moolenaar18400e62015-01-27 15:58:40 +010062 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000063 The old value can be inserted by typing 'wildchar' (by
64 default this is a <Tab> or CTRL-E if 'compatible' is
65 set). See |cmdline-completion|.
66 White space between {option} and '=' is allowed and
67 will be ignored. White space between '=' and {value}
68 is not allowed.
69 See |option-backslash| for using white space and
70 backslashes in {value}.
71
72:se[t] {option}+={value} *:set+=*
73 Add the {value} to a number option, or append the
74 {value} to a string option. When the option is a
75 comma separated list, a comma is added, unless the
76 value was empty.
77 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000078 are removed. When adding a flag that was already
79 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000080 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000081 {not in Vi}
82
83:se[t] {option}^={value} *:set^=*
84 Multiply the {value} to a number option, or prepend
85 the {value} to a string option. When the option is a
86 comma separated list, a comma is added, unless the
87 value was empty.
88 Also see |:set-args| above.
89 {not in Vi}
90
91:se[t] {option}-={value} *:set-=*
92 Subtract the {value} from a number option, or remove
93 the {value} from a string option, if it is there.
94 If the {value} is not found in a string option, there
95 is no error or warning. When the option is a comma
96 separated list, a comma is deleted, unless the option
97 becomes empty.
98 When the option is a list of flags, {value} must be
99 exactly as they appear in the option. Remove flags
100 one by one to avoid problems.
101 Also see |:set-args| above.
102 {not in Vi}
103
104The {option} arguments to ":set" may be repeated. For example: >
105 :set ai nosi sw=3 ts=3
106If you make an error in one of the arguments, an error message will be given
107and the following arguments will be ignored.
108
109 *:set-verbose*
110When 'verbose' is non-zero, displaying an option value will also tell where it
111was last set. Example: >
112 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000113< shiftwidth=4 ~
114 Last set from modeline ~
115 cindent ~
116 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
117This is only done when specific option values are requested, not for ":verbose
118set all" or ":verbose set" without an argument.
119When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000120When the option was set while executing a function, user command or
121autocommand, the script in which it was defined is reported.
122Note that an option may also have been set as a side effect of setting
123'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000124A few special texts:
125 Last set from modeline ~
126 Option was set in a |modeline|.
127 Last set from --cmd argument ~
128 Option was set with command line argument |--cmd| or +.
129 Last set from -c argument ~
130 Option was set with command line argument |-c|, +, |-S| or
131 |-q|.
132 Last set from environment variable ~
133 Option was set from an environment variable, $VIMINIT,
134 $GVIMINIT or $EXINIT.
135 Last set from error handler ~
136 Option was cleared when evaluating it resulted in an error.
137
Bram Moolenaardb84e452010-08-15 13:50:43 +0200138{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000139
140 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000141For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142override the value from the termcap. You can then use it in a mapping. If
143the "xx" part contains special characters, use the <t_xx> form: >
144 :set <t_#4>=^[Ot
145This can also be used to translate a special code for a normal key. For
146example, if Alt-b produces <Esc>b, use this: >
147 :set <M-b>=^[b
148(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
149The advantage over a mapping is that it works in all situations.
150
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100151You can define any key codes, e.g.: >
152 :set t_xy=^[foo;
153There is no warning for using a name that isn't recognized. You can map these
154codes as you like: >
155 :map <t_xy> something
156< *E846*
157When a key code is not set, it's like it does not exist. Trying to get its
158value will result in an error: >
159 :set t_kb=
160 :set t_kb
161 E846: Key code not set: t_kb
162
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000163The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
164security reasons.
165
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000167at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168"set all" probably does not fit on the screen, causing Vim to give the
169|more-prompt|.
170
171 *option-backslash*
172To include white space in a string option value it has to be preceded with a
173backslash. To include a backslash you have to use two. Effectively this
174means that the number of backslashes in an option value is halved (rounded
175down).
176A few examples: >
177 :set tags=tags\ /usr/tags results in "tags /usr/tags"
178 :set tags=tags\\,file results in "tags\,file"
179 :set tags=tags\\\ file results in "tags\ file"
180
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181The "|" character separates a ":set" command from a following command. To
182include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183'titlestring' option to "hi|there": >
184 :set titlestring=hi\|there
185This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
186 :set titlestring=hi|set iconstring=there
187
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000188Similarly, the double quote character starts a comment. To include the '"' in
189the option value, use '\"' instead. This example sets the 'titlestring'
190option to 'hi "there"': >
191 :set titlestring=hi\ \"there\"
192
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000193For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194precise: For options that expect a file name (those where environment
195variables are expanded) a backslash before a normal file name character is not
196removed. But a backslash before a special character (space, backslash, comma,
197etc.) is used like explained above.
198There is one special situation, when the value starts with "\\": >
199 :set dir=\\machine\path results in "\\machine\path"
200 :set dir=\\\\machine\\path results in "\\machine\path"
201 :set dir=\\path\\file results in "\\path\file" (wrong!)
202For the first one the start is kept, but for the second one the backslashes
203are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000204halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000205result which is probably not what you want. Avoid it.
206
207 *add-option-flags* *remove-option-flags*
208 *E539* *E550* *E551* *E552*
209Some options are a list of flags. When you want to add a flag to such an
210option, without changing the existing ones, you can do it like this: >
211 :set guioptions+=a
212Remove a flag from an option like this: >
213 :set guioptions-=a
214This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000215Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
217doesn't appear.
218
219 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000220Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000221environment variable exists the '$' and the following environment variable
222name is replaced with its value. If it does not exist the '$' and the name
223are not modified. Any non-id character (not a letter, digit or '_') may
224follow the environment variable name. That character and what follows is
225appended to the value of the environment variable. Examples: >
226 :set term=$TERM.new
227 :set path=/usr/$INCLUDE,$HOME/include,.
228When adding or removing a string from an option with ":set opt-=val" or ":set
229opt+=val" the expansion is done before the adding or removing.
230
231
232Handling of local options *local-options*
233
234Some of the options only apply to a window or buffer. Each window or buffer
235has its own copy of this option, thus can each have their own value. This
236allows you to set 'list' in one window but not in another. And set
237'shiftwidth' to 3 in one buffer and 4 in another.
238
239The following explains what happens to these local options in specific
240situations. You don't really need to know all of this, since Vim mostly uses
241the option values you would expect. Unfortunately, doing what the user
242expects is a bit complicated...
243
244When splitting a window, the local options are copied to the new window. Thus
245right after the split the contents of the two windows look the same.
246
247When editing a new buffer, its local option values must be initialized. Since
248the local options of the current buffer might be specifically for that buffer,
249these are not used. Instead, for each buffer-local option there also is a
250global value, which is used for new buffers. With ":set" both the local and
251global value is changed. With "setlocal" only the local value is changed,
252thus this value is not used when editing a new buffer.
253
254When editing a buffer that has been edited before, the last used window
255options are used again. If this buffer has been edited in this window, the
256values from back then are used. Otherwise the values from the window where
257the buffer was edited last are used.
258
259It's possible to set a local window option specifically for a type of buffer.
260When you edit another buffer in the same window, you don't want to keep
261using these local window options. Therefore Vim keeps a global value of the
262local window options, which is used when editing another buffer. Each window
263has its own copy of these values. Thus these are local to the window, but
264global to all buffers in the window. With this you can do: >
265 :e one
266 :set list
267 :e two
268Now the 'list' option will also be set in "two", since with the ":set list"
269command you have also set the global value. >
270 :set nolist
271 :e one
272 :setlocal list
273 :e two
274Now the 'list' option is not set, because ":set nolist" resets the global
275value, ":setlocal list" only changes the local value and ":e two" gets the
276global value. Note that if you do this next: >
277 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200278You will get back the 'list' value as it was the last time you edited "one".
279The options local to a window are remembered for each buffer. This also
280happens when the buffer is not loaded, but they are lost when the buffer is
281wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100304:se[t] {option}< For |global-local| options: Remove the local value of
305 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {not in Vi}
307
308 *:setg* *:setglobal*
309:setg[lobal] ... Like ":set" but set only the global value for a local
310 option without changing the local value.
311 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200312 With the "all" argument: display global values for all
313 local options.
314 Without argument: display global values for all local
315 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318For buffer-local and window-local options:
319 Command global value local value ~
320 :set option=value set set
321 :setlocal option=value - set
322:setglobal option=value set -
323 :set option? - display
324 :setlocal option? - display
325:setglobal option? display -
326
327
328Global options with a local value *global-local*
329
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000330Options are global when you mostly use one value for all buffers and windows.
331For some global options it's useful to sometimes have a different local value.
332You can set the local value with ":setlocal". That buffer or window will then
333use the local value, while other buffers and windows continue using the global
334value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336For example, you have two windows, both on C source code. They use the global
337'makeprg' option. If you do this in one of the two windows: >
338 :set makeprg=gmake
339then the other window will switch to the same value. There is no need to set
340the 'makeprg' option in the other C source window too.
341However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000342another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000343files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 :setlocal makeprg=perlmake
345You can switch back to using the global value by making the local value empty: >
346 :setlocal makeprg=
347This only works for a string option. For a boolean option you need to use the
348"<" flag, like this: >
349 :setlocal autoread<
350Note that for non-boolean options using "<" copies the global value to the
351local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000352when the global value changes later). You can also use: >
353 :set path<
354This will make the local value of 'path' empty, so that the global value is
355used. Thus it does the same as: >
356 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357Note: In the future more global options can be made global-local. Using
358":setlocal" on a global option might work differently then.
359
360
361Setting the filetype
362
363:setf[iletype] {filetype} *:setf* *:setfiletype*
364 Set the 'filetype' option to {filetype}, but only if
365 not done yet in a sequence of (nested) autocommands.
366 This is short for: >
367 :if !did_filetype()
368 : setlocal filetype={filetype}
369 :endif
370< This command is used in a filetype.vim file to avoid
371 setting the 'filetype' option twice, causing different
372 settings and syntax files to be loaded.
373 {not in Vi}
374
Bram Moolenaard58e9292011-02-09 17:07:58 +0100375 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
377:opt[ions] Open a window for viewing and setting all options.
378 Options are grouped by function.
379 Offers short help for each option. Hit <CR> on the
380 short help to open a help window with more help for
381 the option.
382 Modify the value of the option and hit <CR> on the
383 "set" line to set the new value. For window and
384 buffer specific options, the last accessed window is
385 used to set the option value in, unless this is a help
386 window, in which case the window below help window is
387 used (skipping the option-window).
388 {not available when compiled without the |+eval| or
389 |+autocmd| features}
390
391 *$HOME*
392Using "~" is like using "$HOME", but it is only recognized at the start of an
393option and after a space or comma.
394
395On Unix systems "~user" can be used too. It is replaced by the home directory
396of user "user". Example: >
397 :set path=~mool/include,/usr/include,.
398
399On Unix systems the form "${HOME}" can be used too. The name between {} can
400contain non-id characters then. Note that if you want to use this for the
401"gf" command, you need to add the '{' and '}' characters to 'isfname'.
402
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100403On MS-Windows, if $HOME is not defined as an environment variable, then
404at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406NOTE: expanding environment variables and "~/" is only done with the ":set"
407command, not when assigning a value to an option with ":let".
408
409
410Note the maximum length of an expanded option is limited. How much depends on
411the system, mostly it is something like 256 or 1024 characters.
412
413 *:fix* *:fixdel*
414:fix[del] Set the value of 't_kD':
415 't_kb' is 't_kD' becomes ~
416 CTRL-? CTRL-H
417 not CTRL-? CTRL-?
418
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
420
421 If your delete key terminal code is wrong, but the
422 code for backspace is alright, you can put this in
423 your .vimrc: >
424 :fixdel
425< This works no matter what the actual code for
426 backspace is.
427
428 If the backspace key terminal code is wrong you can
429 use this: >
430 :if &term == "termname"
431 : set t_kb=^V<BS>
432 : fixdel
433 :endif
434< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000435 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 with your terminal name.
437
438 If your <Delete> key sends a strange key sequence (not
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
440 :if &term == "termname"
441 : set t_kD=^V<Delete>
442 :endif
443< Where "^V" is CTRL-V and "<Delete>" is the delete key
444 (don't type eight characters!). Replace "termname"
445 with your terminal name.
446
447 *Linux-backspace*
448 Note about Linux: By default the backspace key
449 produces CTRL-?, which is wrong. You can fix it by
450 putting this line in your rc.local: >
451 echo "keycode 14 = BackSpace" | loadkeys
452<
453 *NetBSD-backspace*
454 Note about NetBSD: If your backspace doesn't produce
455 the right code, try this: >
456 xmodmap -e "keycode 22 = BackSpace"
457< If this works, add this in your .Xmodmap file: >
458 keysym 22 = BackSpace
459< You need to restart for this to take effect.
460
461==============================================================================
4622. Automatically setting options *auto-setting*
463
464Besides changing options with the ":set" command, there are three alternatives
465to set options automatically for one or more files:
466
4671. When starting Vim initializations are read from various places. See
468 |initialization|. Most of them are performed for all editing sessions,
469 and some of them depend on the directory where Vim is started.
470 You can create an initialization file with |:mkvimrc|, |:mkview| and
471 |:mksession|.
4722. If you start editing a new file, the automatic commands are executed.
473 This can be used to set options for files matching a particular pattern and
474 many other things. See |autocommand|.
4753. If you start editing a new file, and the 'modeline' option is on, a
476 number of lines at the beginning and end of the file are checked for
477 modelines. This is explained here.
478
479 *modeline* *vim:* *vi:* *ex:* *E520*
480There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200481 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000482
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200486[white] optional white space
487{options} a list of option settings, separated with white space
488 or ':', where each part between ':' is the argument
489 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200493 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000494
495The second form (this is compatible with some versions of Vi):
496
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200497 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200499[text] any text or empty
500{white} at least one blank character (<Space> or <Tab>)
501{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
502[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503se[t] the string "set " or "se " (note the space); When
504 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200505{options} a list of options, separated with white space, which
506 is the argument for a ":set" command
507: a colon
508[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000511 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200514The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
515chance that a normal word like "lex:" is caught. There is one exception:
516"vi:" and "vim:" can also be at the start of the line (for compatibility with
517version 3.0). Using "ex:" at the start of the line will be ignored (this
518could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
520 *modeline-local*
521The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000522buffer and window that contain the file. Although it's possible to set global
523options from a modeline, this is unusual. If you have two windows open and
524the files in it set the same global option to a different value, the result
525depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000527When editing a file that was already loaded, only the window-local options
528from the modeline are used. Thus if you manually changed a buffer-local
529option after opening the file, it won't be changed if you edit the same buffer
530in another window. But window-local options will be set.
531
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532 *modeline-version*
533If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200534number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535 vim{vers}: version {vers} or later
536 vim<{vers}: version before {vers}
537 vim={vers}: version {vers}
538 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100539{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
540For example, to use a modeline only for Vim 7.0:
541 /* vim700: set foldmethod=marker */ ~
542To use a modeline for Vim after version 7.2:
543 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544There can be no blanks between "vim" and the ":".
545
546
547The number of lines that are checked can be set with the 'modelines' option.
548If 'modeline' is off or 'modelines' is 0 no lines are checked.
549
550Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000551like:
552 /* vi:ts=4: */ ~
553will give an error message for the trailing "*/". This line is OK:
554 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555
556If an error is detected the rest of the line is skipped.
557
558If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000559backslash in front of the ':' will be removed. Example:
560 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561This sets the 'dir' option to "c:\tmp". Only a single backslash before the
562':' is removed. Thus to include "\:" you have to specify "\\:".
563
564No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565might create a Trojan horse text file with modelines). And not all options
566can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000567|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000568causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
569are wrapped unexpectedly. So disable modelines before editing untrusted text.
570The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571
572Hint: If you would like to do something else than setting an option, you could
573define an autocommand that checks the file for a specific string. For
574example: >
575 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
576And define a function SetVar() that does something with the line containing
577"VAR".
578
579==============================================================================
5803. Options summary *option-summary*
581
582In the list below all the options are mentioned with their full name and with
583an abbreviation if there is one. Both forms may be used.
584
585In this document when a boolean option is "set" that means that ":set option"
586is entered. When an option is "reset", ":set nooption" is used.
587
588For some options there are two default values: The "Vim default", which is
589used when 'compatible' is not set, and the "Vi default", which is used when
590'compatible' is set.
591
592Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594different value in each window. For example the 'list' option can be set in
595one window and reset in another for the same text, giving both types of view
596at the same time. There are a few options that are specific to a certain
597file. These can have a different value for each file or buffer. For example
598the 'textwidth' option can be 78 for a normal text file and 0 for a C
599program.
600
601 global one option for all buffers and windows
602 local to window each window has its own copy of this option
603 local to buffer each buffer has its own copy of this option
604
605When creating a new window the option values from the currently active window
606are used as a default value for the window-specific options. For the
607buffer-specific options this depends on the 's' and 'S' flags in the
608'cpoptions' option. If 's' is included (which is the default) the values for
609buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000610first entered. If 'S' is present the options are copied each time the buffer
611is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612present, the options are copied from the currently active buffer when the
613buffer is created.
614
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000615Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000617Not all options are supported in all versions. This depends on the supported
618features and sometimes on the system. A remark about this is in curly braces
619below. When an option is not supported it may still be set without getting an
620error, this is called a hidden option. You can't get the value of a hidden
621option though, it is not stored.
622
623To test if option "foo" can be used with ":set" use something like this: >
624 if exists('&foo')
625This also returns true for a hidden option. To test if option "foo" is really
626supported use something like this: >
627 if exists('+foo')
628<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000629 *E355*
630A jump table for the options with a short description can be found at |Q_op|.
631
632 *'aleph'* *'al'* *aleph* *Aleph*
633'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
634 global
635 {not in Vi}
636 {only available when compiled with the |+rightleft|
637 feature}
638 The ASCII code for the first letter of the Hebrew alphabet. The
639 routine that maps the keyboard in Hebrew mode, both in Insert mode
640 (when hkmap is set) and on the command-line (when hitting CTRL-_)
641 outputs the Hebrew characters in the range [aleph..aleph+26].
642 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
643 See |rileft.txt|.
644
645 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
646'allowrevins' 'ari' boolean (default off)
647 global
648 {not in Vi}
649 {only available when compiled with the |+rightleft|
650 feature}
651 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
652 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
653 into reverse Insert mode, and don't know how to get out. See
654 'revins'.
655 NOTE: This option is reset when 'compatible' is set.
656
657 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
658'altkeymap' 'akm' boolean (default off)
659 global
660 {not in Vi}
661 {only available when compiled with the |+farsi|
662 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 the keyboard map between Farsi and English, when 'allowrevins' set.
665
Bram Moolenaar582fd852005-03-28 20:58:01 +0000666 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 is useful to start the Vim in native mode i.e. English (left-to-right
668 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000669 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670
671 *'ambiwidth'* *'ambw'*
672'ambiwidth' 'ambw' string (default: "single")
673 global
674 {not in Vi}
675 {only available when compiled with the |+multi_byte|
676 feature}
677 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
678 Tells Vim what to do with characters with East Asian Width Class
679 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
680 letters, Cyrillic letters).
681
682 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000683 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 expected by most users.
685 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200686 *E834* *E835*
687 The value "double" cannot be used if 'listchars' or 'fillchars'
688 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000689
690 There are a number of CJK fonts for which the width of glyphs for
691 those characters are solely based on how many octets they take in
692 legacy/traditional CJK encodings. In those encodings, Euro,
693 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000696 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000697 Vim is running inside a terminal (emulators) that uses a CJK font
698 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
699 this option should be set to "double" to match the width perceived
700 by Vim with the width of glyphs in the font. Perhaps it also has
701 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
702 when the system locale is set to one of CJK locales. See Unicode
703 Standard Annex #11 (http://www.unicode.org/reports/tr11).
704
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100705 Vim may set this option automatically at startup time when Vim is
706 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200707 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100708
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
710'antialias' 'anti' boolean (default: off)
711 global
712 {not in Vi}
713 {only available when compiled with GUI enabled
714 on Mac OS X}
715 This option only has an effect in the GUI version of Vim on Mac OS X
716 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
717 which can be easier to read at certain sizes on certain displays.
718 Setting this option can sometimes cause problems if 'guifont' is set
719 to its default (empty string).
720
721 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
722'autochdir' 'acd' boolean (default off)
723 global
724 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200725 {only available when compiled with it, use
726 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000727 When on, Vim will change the current working directory whenever you
728 open a file, switch buffers, delete a buffer or open/close a window.
729 It will change to the directory containing the file which was opened
730 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000731 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
734'arabic' 'arab' boolean (default off)
735 local to window
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 This option can be set to start editing Arabic text.
740 Setting this option will:
741 - Set the 'rightleft' option, unless 'termbidi' is set.
742 - Set the 'arabicshape' option, unless 'termbidi' is set.
743 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
744 between typing English and Arabic key mapping.
745 - Set the 'delcombine' option
746 Note that 'encoding' must be "utf-8" for working with Arabic text.
747
748 Resetting this option will:
749 - Reset the 'rightleft' option.
750 - Disable the use of 'keymap' (without changing its value).
751 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200752 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 Also see |arabic.txt|.
754
755 *'arabicshape'* *'arshape'*
756 *'noarabicshape'* *'noarshape'*
757'arabicshape' 'arshape' boolean (default on)
758 global
759 {not in Vi}
760 {only available when compiled with the |+arabic|
761 feature}
762 When on and 'termbidi' is off, the required visual character
763 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200764 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765 one which encompasses:
766 a) the changing/morphing of characters based on their location
767 within a word (initial, medial, final and stand-alone).
768 b) the enabling of the ability to compose characters
769 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100770 When disabled the display shows each character's true stand-alone
771 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 Arabic is a complex language which requires other settings, for
773 further details see |arabic.txt|.
774
775 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
776'autoindent' 'ai' boolean (default off)
777 local to buffer
778 Copy indent from current line when starting a new line (typing <CR>
779 in Insert mode or when using the "o" or "O" command). If you do not
780 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000781 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
782 to another line has the same effect, unless the 'I' flag is included
783 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000784 When autoindent is on, formatting (with the "gq" command or when you
785 reach 'textwidth' in Insert mode) uses the indentation of the first
786 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000787 When 'smartindent' or 'cindent' is on the indent is changed in
788 a different way.
789 The 'autoindent' option is reset when the 'paste' option is set.
790 {small difference from Vi: After the indent is deleted when typing
791 <Esc> or <CR>, the cursor position when moving up or down is after the
792 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
793
794 *'autoread'* *'ar'* *'noautoread'* *'noar'*
795'autoread' 'ar' boolean (default off)
796 global or local to buffer |global-local|
797 {not in Vi}
798 When a file has been detected to have been changed outside of Vim and
799 it has not been changed inside of Vim, automatically read it again.
800 When the file has been deleted this is not done. |timestamp|
801 If this option has a local value, use this command to switch back to
802 using the global value: >
803 :set autoread<
804<
805 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
806'autowrite' 'aw' boolean (default off)
807 global
808 Write the contents of the file, if it has been modified, on each
809 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000810 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
812 Note that for some commands the 'autowrite' option is not used, see
813 'autowriteall' for that.
814
815 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
816'autowriteall' 'awa' boolean (default off)
817 global
818 {not in Vi}
819 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
820 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
821 Setting this option also implies that Vim behaves like 'autowrite' has
822 been set.
823
824 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200825'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826 global
827 {not in Vi}
828 When set to "dark", Vim will try to use colors that look good on a
829 dark background. When set to "light", Vim will try to use colors that
830 look good on a light background. Any other value is illegal.
831 Vim tries to set the default value according to the terminal used.
832 This will not always be correct.
833 Setting this option does not change the background color, it tells Vim
834 what the background color looks like. For changing the background
835 color, see |:hi-normal|.
836
837 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000838 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000839 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100840 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000841 setting 'background' will cause the color scheme to be reloaded. If
842 the color scheme adjusts to the value of 'background' this will work.
843 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100844 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845
846 When setting 'background' to the default value with: >
847 :set background&
848< Vim will guess the value. In the GUI this should work correctly,
849 in other cases Vim might not be able to guess the right value.
850
851 When starting the GUI, the default value for 'background' will be
852 "light". When the value is not set in the .gvimrc, and Vim detects
853 that the background is actually quite dark, 'background' is set to
854 "dark". But this happens only AFTER the .gvimrc file has been read
855 (because the window needs to be opened to find the actual background
856 color). To get around this, force the GUI window to be opened by
857 putting a ":gui" command in the .gvimrc file, before where the value
858 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200859
860 For MS-DOS, Windows and OS/2 the default is "dark".
861 For other systems "dark" is used when 'term' is "linux",
862 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
863 background. Otherwise the default is "light".
864
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 Normally this option would be set in the .vimrc file. Possibly
866 depending on the terminal name. Example: >
867 :if &term == "pcterm"
868 : set background=dark
869 :endif
870< When this option is set, the default settings for the highlight groups
871 will change. To use other settings, place ":highlight" commands AFTER
872 the setting of the 'background' option.
873 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
874 to select the colors for syntax highlighting. After changing this
875 option, you must load syntax.vim again to see the result. This can be
876 done with ":syntax on".
877
878 *'backspace'* *'bs'*
879'backspace' 'bs' string (default "")
880 global
881 {not in Vi}
882 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
883 mode. This is a list of items, separated by commas. Each item allows
884 a way to backspace over something:
885 value effect ~
886 indent allow backspacing over autoindent
887 eol allow backspacing over line breaks (join lines)
888 start allow backspacing over the start of insert; CTRL-W and CTRL-U
889 stop once at the start of insert.
890
891 When the value is empty, Vi compatible backspacing is used.
892
893 For backwards compatibility with version 5.4 and earlier:
894 value effect ~
895 0 same as ":set backspace=" (Vi compatible)
896 1 same as ":set backspace=indent,eol"
897 2 same as ":set backspace=indent,eol,start"
898
899 See |:fixdel| if your <BS> or <Del> key does not do what you want.
900 NOTE: This option is set to "" when 'compatible' is set.
901
902 *'backup'* *'bk'* *'nobackup'* *'nobk'*
903'backup' 'bk' boolean (default off)
904 global
905 {not in Vi}
906 Make a backup before overwriting a file. Leave it around after the
907 file has been successfully written. If you do not want to keep the
908 backup file, but you do want a backup while the file is being
909 written, reset this option and set the 'writebackup' option (this is
910 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000911 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000912 |backup-table| for more explanations.
913 When the 'backupskip' pattern matches, a backup is not made anyway.
914 When 'patchmode' is set, the backup may be renamed to become the
915 oldest version of a file.
916 NOTE: This option is reset when 'compatible' is set.
917
918 *'backupcopy'* *'bkc'*
919'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200920 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000921 {not in Vi}
922 When writing a file and a backup is made, this option tells how it's
923 done. This is a comma separated list of words.
924
925 The main values are:
926 "yes" make a copy of the file and overwrite the original one
927 "no" rename the file and write a new one
928 "auto" one of the previous, what works best
929
930 Extra values that can be combined with the ones above are:
931 "breaksymlink" always break symlinks when writing
932 "breakhardlink" always break hardlinks when writing
933
934 Making a copy and overwriting the original file:
935 - Takes extra time to copy the file.
936 + When the file has special attributes, is a (hard/symbolic) link or
937 has a resource fork, all this is preserved.
938 - When the file is a link the backup will have the name of the link,
939 not of the real file.
940
941 Renaming the file and writing a new one:
942 + It's fast.
943 - Sometimes not all attributes of the file can be copied to the new
944 file.
945 - When the file is a link the new file will not be a link.
946
947 The "auto" value is the middle way: When Vim sees that renaming file
948 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000949 the file is not a link) that is used. When problems are expected, a
950 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951
952 The "breaksymlink" and "breakhardlink" values can be used in
953 combination with any of "yes", "no" and "auto". When included, they
954 force Vim to always break either symbolic or hard links by doing
955 exactly what the "no" option does, renaming the original file to
956 become the backup and writing a new file in its place. This can be
957 useful for example in source trees where all the files are symbolic or
958 hard links and any changes should stay in the local source tree, not
959 be propagated back to the original source.
960 *crontab*
961 One situation where "no" and "auto" will cause problems: A program
962 that opens a file, invokes Vim to edit that file, and then tests if
963 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000964 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 example.
966
967 When a copy is made, the original file is truncated and then filled
968 with the new text. This means that protection bits, owner and
969 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000970 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 group of the backup is set to the group of the original file. If this
972 fails, the protection bits for the group are made the same as for
973 others.
974
975 When the file is renamed this is the other way around: The backup has
976 the same attributes of the original file, and the newly written file
977 is owned by the current user. When the file was a (hard/symbolic)
978 link, the new file will not! That's why the "auto" value doesn't
979 rename when the file is a link. The owner and group of the newly
980 written file will be set to the same ones as the original file, but
981 the system may refuse to do this. In that case the "auto" value will
982 again not rename the file.
983
984 *'backupdir'* *'bdir'*
985'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100986 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987 for Unix: ".,~/tmp,~/")
988 global
989 {not in Vi}
990 List of directories for the backup file, separated with commas.
991 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100992 where this is possible. The directory must exist, Vim will not
993 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100994 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 impossible!). Writing may fail because of this.
996 - A directory "." means to put the backup file in the same directory
997 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000998 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 put the backup file relative to where the edited file is. The
1000 leading "." is replaced with the path name of the edited file.
1001 ("." inside a directory name has no special meaning).
1002 - Spaces after the comma are ignored, other spaces are considered part
1003 of the directory name. To have a space at the start of a directory
1004 name, precede it with a backslash.
1005 - To include a comma in a directory name precede it with a backslash.
1006 - A directory name may end in an '/'.
1007 - Environment variables are expanded |:set_env|.
1008 - Careful with '\' characters, type one before a space, type two to
1009 get one in the option (see |option-backslash|), for example: >
1010 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1011< - For backwards compatibility with Vim version 3.0 a '>' at the start
1012 of the option is removed.
1013 See also 'backup' and 'writebackup' options.
1014 If you want to hide your backup files on Unix, consider this value: >
1015 :set backupdir=./.backup,~/.backup,.,/tmp
1016< You must create a ".backup" directory in each directory and in your
1017 home directory for this to work properly.
1018 The use of |:set+=| and |:set-=| is preferred when adding or removing
1019 directories from the list. This avoids problems when a future version
1020 uses another default.
1021 This option cannot be set from a |modeline| or in the |sandbox|, for
1022 security reasons.
1023
1024 *'backupext'* *'bex'* *E589*
1025'backupext' 'bex' string (default "~", for VMS: "_")
1026 global
1027 {not in Vi}
1028 String which is appended to a file name to make the name of the
1029 backup file. The default is quite unusual, because this avoids
1030 accidentally overwriting existing files with a backup file. You might
1031 prefer using ".bak", but make sure that you don't have files with
1032 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001033 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001035 If you like to keep a lot of backups, you could use a BufWritePre
1036 autocommand to change 'backupext' just before writing the file to
1037 include a timestamp. >
1038 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1039< Use 'backupdir' to put the backup in a different directory.
1040
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 *'backupskip'* *'bsk'*
1042'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1043 global
1044 {not in Vi}
1045 {not available when compiled without the |+wildignore|
1046 feature}
1047 A list of file patterns. When one of the patterns matches with the
1048 name of the file which is written, no backup file is created. Both
1049 the specified file name and the full path name of the file are used.
1050 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1051 Watch out for special characters, see |option-backslash|.
1052 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001053 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001054
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001055 WARNING: Not having a backup file means that when Vim fails to write
1056 your buffer correctly and then, for whatever reason, Vim exits, you
1057 lose both the original file and what you were writing. Only disable
1058 backups if you don't care about losing the file.
1059
Bram Moolenaar02467872007-05-06 13:22:01 +00001060 Note that environment variables are not expanded. If you want to use
1061 $HOME you must expand it explicitly, e.g.: >
1062 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1063
1064< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001065 backup would be made by renaming the original file crontab won't see
1066 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067
1068 *'balloondelay'* *'bdlay'*
1069'balloondelay' 'bdlay' number (default: 600)
1070 global
1071 {not in Vi}
1072 {only available when compiled with the |+balloon_eval|
1073 feature}
1074 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1075
1076 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1077'ballooneval' 'beval' boolean (default off)
1078 global
1079 {not in Vi}
1080 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001081 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 Switch on the |balloon-eval| functionality.
1083
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001084 *'balloonexpr'* *'bexpr'*
1085'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001086 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001087 {not in Vi}
1088 {only available when compiled with the |+balloon_eval|
1089 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001090 Expression for text to show in evaluation balloon. It is only used
1091 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001092
1093 v:beval_bufnr number of the buffer in which balloon is going to show
1094 v:beval_winnr number of the window
1095 v:beval_lnum line number
1096 v:beval_col column number (byte index)
1097 v:beval_text word under or after the mouse pointer
1098
1099 The evaluation of the expression must not have side effects!
1100 Example: >
1101 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001102 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001103 \', column ' . v:beval_col .
1104 \ ' of file ' . bufname(v:beval_bufnr) .
1105 \ ' on word "' . v:beval_text . '"'
1106 endfunction
1107 set bexpr=MyBalloonExpr()
1108 set ballooneval
1109<
1110 NOTE: The balloon is displayed only if the cursor is on a text
1111 character. If the result of evaluating 'balloonexpr' is not empty,
1112 Vim does not try to send a message to an external debugger (Netbeans
1113 or Sun Workshop).
1114
Bram Moolenaar30b65812012-07-12 22:01:11 +02001115 The expression will be evaluated in the |sandbox| when set from a
1116 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001117
1118 It is not allowed to change text or jump to another window while
1119 evaluating 'balloonexpr' |textlock|.
1120
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001121 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001122 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001123< When they are supported "\n" characters will start a new line. If the
1124 expression evaluates to a |List| this is equal to using each List item
1125 as a string and putting "\n" in between them.
1126
Bram 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 Moolenaar96d2c5b2006-03-11 21:27:59 +00001822
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001823 *'concealcursor'* *'cocu'*
1824'concealcursor' 'cocu' string (default: "")
1825 local to window
1826 {not in Vi}
1827 {not available when compiled without the |+conceal|
1828 feature}
1829 Sets the modes in which text in the cursor line can also be concealed.
1830 When the current mode is listed then concealing happens just like in
1831 other lines.
1832 n Normal mode
1833 v Visual mode
1834 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001835 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001836
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001837 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001838 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001839 are moving around text is concealed, but when starting to insert text
1840 or selecting a Visual area the concealed text is displayed, so that
1841 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001842 Keep in mind that the cursor position is not always where it's
1843 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001844
1845
1846'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001847 number (default 0)
1848 local to window
1849 {not in Vi}
1850 {not available when compiled without the |+conceal|
1851 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001852 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1853 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001854
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001855 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001856 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001857 1 Each block of concealed text is replaced with one
1858 character. If the syntax item does not have a custom
1859 replacement character defined (see |:syn-cchar|) the
1860 character defined in 'listchars' is used (default is a
1861 space).
1862 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001863 2 Concealed text is completely hidden unless it has a
1864 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001865 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001866 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001867
Bram Moolenaara7781e02010-07-19 20:13:22 +02001868 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001869 edit and copy the text. This can be changed with the 'concealcursor'
1870 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001871
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1873'confirm' 'cf' boolean (default off)
1874 global
1875 {not in Vi}
1876 When 'confirm' is on, certain operations that would normally
1877 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1878 instead raise a |dialog| asking if you wish to save the current
1879 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1880 If 'confirm' is off you can still activate confirmation for one
1881 command only (this is most useful in mappings) with the |:confirm|
1882 command.
1883 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1884
1885 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1886'conskey' 'consk' boolean (default off)
1887 global
1888 {not in Vi} {only for MS-DOS}
1889 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001890 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 three methods of console input are available:
1892 'conskey' 'bioskey' action ~
1893 on on or off direct console input
1894 off on BIOS
1895 off off STDIN
1896
1897 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1898'copyindent' 'ci' boolean (default off)
1899 local to buffer
1900 {not in Vi}
1901 Copy the structure of the existing lines indent when autoindenting a
1902 new line. Normally the new indent is reconstructed by a series of
1903 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1904 in which case only spaces are used). Enabling this option makes the
1905 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001906 existing line. 'expandtab' has no effect on these characters, a Tab
1907 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 line, the remaining space is filled in the normal manner.
1909 NOTE: 'copyindent' is reset when 'compatible' is set.
1910 Also see 'preserveindent'.
1911
1912 *'cpoptions'* *'cpo'*
1913'cpoptions' 'cpo' string (Vim default: "aABceFs",
1914 Vi default: all flags)
1915 global
1916 {not in Vi}
1917 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001918 this indicates Vi-compatible behavior. This is used for things where
1919 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 'cpoptions' stands for "compatible-options".
1921 Commas can be added for readability.
1922 To avoid problems with flags that are added in the future, use the
1923 "+=" and "-=" feature of ":set" |add-option-flags|.
1924 NOTE: This option is set to the Vi default value when 'compatible' is
1925 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001926 NOTE: This option is set to the POSIX default value at startup when
1927 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001928 variable exists |posix|. This means Vim tries to behave like the
1929 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930
1931 contains behavior ~
1932 *cpo-a*
1933 a When included, a ":read" command with a file name
1934 argument will set the alternate file name for the
1935 current window.
1936 *cpo-A*
1937 A When included, a ":write" command with a file name
1938 argument will set the alternate file name for the
1939 current window.
1940 *cpo-b*
1941 b "\|" in a ":map" command is recognized as the end of
1942 the map command. The '\' is included in the mapping,
1943 the text after the '|' is interpreted as the next
1944 command. Use a CTRL-V instead of a backslash to
1945 include the '|' in the mapping. Applies to all
1946 mapping, abbreviation, menu and autocmd commands.
1947 See also |map_bar|.
1948 *cpo-B*
1949 B A backslash has no special meaning in mappings,
1950 abbreviations and the "to" part of the menu commands.
1951 Remove this flag to be able to use a backslash like a
1952 CTRL-V. For example, the command ":map X \<Esc>"
1953 results in X being mapped to:
1954 'B' included: "\^[" (^[ is a real <Esc>)
1955 'B' excluded: "<Esc>" (5 characters)
1956 ('<' excluded in both cases)
1957 *cpo-c*
1958 c Searching continues at the end of any match at the
1959 cursor position, but not further than the start of the
1960 next line. When not present searching continues
1961 one character from the cursor position. With 'c'
1962 "abababababab" only gets three matches when repeating
1963 "/abab", without 'c' there are five matches.
1964 *cpo-C*
1965 C Do not concatenate sourced lines that start with a
1966 backslash. See |line-continuation|.
1967 *cpo-d*
1968 d Using "./" in the 'tags' option doesn't mean to use
1969 the tags file relative to the current file, but the
1970 tags file in the current directory.
1971 *cpo-D*
1972 D Can't use CTRL-K to enter a digraph after Normal mode
1973 commands with a character argument, like |r|, |f| and
1974 |t|.
1975 *cpo-e*
1976 e When executing a register with ":@r", always add a
1977 <CR> to the last line, also when the register is not
1978 linewise. If this flag is not present, the register
1979 is not linewise and the last line does not end in a
1980 <CR>, then the last line is put on the command-line
1981 and can be edited before hitting <CR>.
1982 *cpo-E*
1983 E It is an error when using "y", "d", "c", "g~", "gu" or
1984 "gU" on an Empty region. The operators only work when
1985 at least one character is to be operate on. Example:
1986 This makes "y0" fail in the first column.
1987 *cpo-f*
1988 f When included, a ":read" command with a file name
1989 argument will set the file name for the current buffer,
1990 if the current buffer doesn't have a file name yet.
1991 *cpo-F*
1992 F When included, a ":write" command with a file name
1993 argument will set the file name for the current
1994 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001995 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 *cpo-g*
1997 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001998 *cpo-H*
1999 H When using "I" on a line with only blanks, insert
2000 before the last blank. Without this flag insert after
2001 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 *cpo-i*
2003 i When included, interrupting the reading of a file will
2004 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002005 *cpo-I*
2006 I When moving the cursor up or down just after inserting
2007 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 *cpo-j*
2009 j When joining lines, only add two spaces after a '.',
2010 not after '!' or '?'. Also see 'joinspaces'.
2011 *cpo-J*
2012 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002013 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 white space.
2015 *cpo-k*
2016 k Disable the recognition of raw key codes in
2017 mappings, abbreviations, and the "to" part of menu
2018 commands. For example, if <Key> sends ^[OA (where ^[
2019 is <Esc>), the command ":map X ^[OA" results in X
2020 being mapped to:
2021 'k' included: "^[OA" (3 characters)
2022 'k' excluded: "<Key>" (one key code)
2023 Also see the '<' flag below.
2024 *cpo-K*
2025 K Don't wait for a key code to complete when it is
2026 halfway a mapping. This breaks mapping <F1><F1> when
2027 only part of the second <F1> has been read. It
2028 enables cancelling the mapping by typing <F1><Esc>.
2029 *cpo-l*
2030 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002031 literally, only "\]", "\^", "\-" and "\\" are special.
2032 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2034 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002035 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036 *cpo-L*
2037 L When the 'list' option is set, 'wrapmargin',
2038 'textwidth', 'softtabstop' and Virtual Replace mode
2039 (see |gR|) count a <Tab> as two characters, instead of
2040 the normal behavior of a <Tab>.
2041 *cpo-m*
2042 m When included, a showmatch will always wait half a
2043 second. When not included, a showmatch will wait half
2044 a second or until a character is typed. |'showmatch'|
2045 *cpo-M*
2046 M When excluded, "%" matching will take backslashes into
2047 account. Thus in "( \( )" and "\( ( \)" the outer
2048 parenthesis match. When included "%" ignores
2049 backslashes, which is Vi compatible.
2050 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002051 n When included, the column used for 'number' and
2052 'relativenumber' will also be used for text of wrapped
2053 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 *cpo-o*
2055 o Line offset to search command is not remembered for
2056 next search.
2057 *cpo-O*
2058 O Don't complain if a file is being overwritten, even
2059 when it didn't exist when editing it. This is a
2060 protection against a file unexpectedly created by
2061 someone else. Vi didn't complain about this.
2062 *cpo-p*
2063 p Vi compatible Lisp indenting. When not present, a
2064 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002065 *cpo-P*
2066 P When included, a ":write" command that appends to a
2067 file will set the file name for the current buffer, if
2068 the current buffer doesn't have a file name yet and
2069 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002070 *cpo-q*
2071 q When joining multiple lines leave the cursor at the
2072 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 *cpo-r*
2074 r Redo ("." command) uses "/" to repeat a search
2075 command, instead of the actually used search string.
2076 *cpo-R*
2077 R Remove marks from filtered lines. Without this flag
2078 marks are kept like |:keepmarks| was used.
2079 *cpo-s*
2080 s Set buffer options when entering the buffer for the
2081 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002082 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 set when the buffer is created.
2084 *cpo-S*
2085 S Set buffer options always when entering a buffer
2086 (except 'readonly', 'fileformat', 'filetype' and
2087 'syntax'). This is the (most) Vi compatible setting.
2088 The options are set to the values in the current
2089 buffer. When you change an option and go to another
2090 buffer, the value is copied. Effectively makes the
2091 buffer options global to all buffers.
2092
2093 's' 'S' copy buffer options
2094 no no when buffer created
2095 yes no when buffer first entered (default)
2096 X yes each time when buffer entered (vi comp.)
2097 *cpo-t*
2098 t Search pattern for the tag command is remembered for
2099 "n" command. Otherwise Vim only puts the pattern in
2100 the history for search pattern, but doesn't change the
2101 last used search pattern.
2102 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002103 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 *cpo-v*
2105 v Backspaced characters remain visible on the screen in
2106 Insert mode. Without this flag the characters are
2107 erased from the screen right away. With this flag the
2108 screen newly typed text overwrites backspaced
2109 characters.
2110 *cpo-w*
2111 w When using "cw" on a blank character, only change one
2112 character and not all blanks until the start of the
2113 next word.
2114 *cpo-W*
2115 W Don't overwrite a readonly file. When omitted, ":w!"
2116 overwrites a readonly file, if possible.
2117 *cpo-x*
2118 x <Esc> on the command-line executes the command-line.
2119 The default in Vim is to abandon the command-line,
2120 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002121 *cpo-X*
2122 X When using a count with "R" the replaced text is
2123 deleted only once. Also when repeating "R" with "."
2124 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 *cpo-y*
2126 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002127 *cpo-Z*
2128 Z When using "w!" while the 'readonly' option is set,
2129 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 *cpo-!*
2131 ! When redoing a filter command, use the last used
2132 external command, whatever it was. Otherwise the last
2133 used -filter- command is used.
2134 *cpo-$*
2135 $ When making a change to one line, don't redisplay the
2136 line, but put a '$' at the end of the changed text.
2137 The changed text will be overwritten when you type the
2138 new text. The line is redisplayed if you type any
2139 command that moves the cursor from the insertion
2140 point.
2141 *cpo-%*
2142 % Vi-compatible matching is done for the "%" command.
2143 Does not recognize "#if", "#endif", etc.
2144 Does not recognize "/*" and "*/".
2145 Parens inside single and double quotes are also
2146 counted, causing a string that contains a paren to
2147 disturb the matching. For example, in a line like
2148 "if (strcmp("foo(", s))" the first paren does not
2149 match the last one. When this flag is not included,
2150 parens inside single and double quotes are treated
2151 specially. When matching a paren outside of quotes,
2152 everything inside quotes is ignored. When matching a
2153 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002154 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002155 This flag is also used for other features, such as
2156 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002157 *cpo--*
2158 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002159 it would go above the first line or below the last
2160 line. Without it the cursor moves to the first or
2161 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002162 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002163 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002164 *cpo-+*
2165 + When included, a ":write file" command will reset the
2166 'modified' flag of the buffer, even though the buffer
2167 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002168 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 * Use ":*" in the same way as ":@". When not included,
2170 ":*" is an alias for ":'<,'>", select the Visual area.
2171 *cpo-<*
2172 < Disable the recognition of special key codes in |<>|
2173 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002174 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175 ":map X <Tab>" results in X being mapped to:
2176 '<' included: "<Tab>" (5 characters)
2177 '<' excluded: "^I" (^I is a real <Tab>)
2178 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002179 *cpo->*
2180 > When appending to a register, put a line break before
2181 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002182 *cpo-;*
2183 ; When using |,| or |;| to repeat the last |t| search
2184 and the cursor is right in front of the searched
2185 character, the cursor won't move. When not included,
2186 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002187 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002188
2189 POSIX flags. These are not included in the Vi default value, except
2190 when $VIM_POSIX was set on startup. |posix|
2191
2192 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002193 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002194 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002195 *cpo-&*
2196 & When ":preserve" was used keep the swap file when
2197 exiting normally while this buffer is still loaded.
2198 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002199 *cpo-\*
2200 \ Backslash in a [] range in a search pattern is taken
2201 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002202 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2203 '\' excluded: "/[ \-]" finds <Space> and '-'
2204 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002205 *cpo-/*
2206 / When "%" is used as the replacement string in a |:s|
2207 command, use the previous replacement string. |:s%|
2208 *cpo-{*
2209 { The |{| and |}| commands also stop at a "{" character
2210 at the start of a line.
2211 *cpo-.*
2212 . The ":chdir" and ":cd" commands fail if the current
2213 buffer is modified, unless ! is used. Vim doesn't
2214 need this, since it remembers the full path of an
2215 opened file.
2216 *cpo-bar*
2217 | The value of the $LINES and $COLUMNS environment
2218 variables overrule the terminal size values obtained
2219 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002220
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002222 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002223'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002224 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002225 {not in Vi}
2226 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002227 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002228 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002229 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002230 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002231 blowfish Blowfish method. Medium strong encryption but it has
2232 an implementation flaw. Requires Vim 7.3 or later,
2233 files can NOT be read by Vim 7.2 and older. This adds
2234 a "seed" to the file, every time you write the file
2235 the encrypted bytes will be different.
2236 *blowfish2*
2237 blowfish2 Blowfish method. Medium strong encryption. Requires
2238 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2239 and older. This adds a "seed" to the file, every time
2240 you write the file the encrypted bytes will be
2241 different. The whole undo file is encrypted, not just
2242 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002243
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002244 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002245 to the detected method of the file being read. Thus if you write it
2246 without changing 'cryptmethod' the same method will be used.
2247 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002248 explicitly write it, you don't get a warning unless there are other
2249 modifications. Also see |:X|.
2250
2251 When setting the global value to an empty string, it will end up with
2252 the value "zip". When setting the local value to an empty string the
2253 buffer will use the global value.
2254
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002255 When a new encryption method is added in a later version of Vim, and
2256 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002257 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002258
2259
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 *'cscopepathcomp'* *'cspc'*
2261'cscopepathcomp' 'cspc' number (default 0)
2262 global
2263 {not available when compiled without the |+cscope|
2264 feature}
2265 {not in Vi}
2266 Determines how many components of the path to show in a list of tags.
2267 See |cscopepathcomp|.
2268
2269 *'cscopeprg'* *'csprg'*
2270'cscopeprg' 'csprg' string (default "cscope")
2271 global
2272 {not available when compiled without the |+cscope|
2273 feature}
2274 {not in Vi}
2275 Specifies the command to execute cscope. See |cscopeprg|.
2276 This option cannot be set from a |modeline| or in the |sandbox|, for
2277 security reasons.
2278
2279 *'cscopequickfix'* *'csqf'*
2280'cscopequickfix' 'csqf' string (default "")
2281 global
2282 {not available when compiled without the |+cscope|
2283 or |+quickfix| features}
2284 {not in Vi}
2285 Specifies whether to use quickfix window to show cscope results.
2286 See |cscopequickfix|.
2287
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002288 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002289'cscoperelative' 'csre' boolean (default off)
2290 global
2291 {not available when compiled without the |+cscope|
2292 feature}
2293 {not in Vi}
2294 In the absence of a prefix (-P) for cscope. setting this option enables
2295 to use the basename of cscope.out path as the prefix.
2296 See |cscoperelative|.
2297
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2299'cscopetag' 'cst' boolean (default off)
2300 global
2301 {not available when compiled without the |+cscope|
2302 feature}
2303 {not in Vi}
2304 Use cscope for tag commands. See |cscope-options|.
2305 NOTE: This option is reset when 'compatible' is set.
2306
2307 *'cscopetagorder'* *'csto'*
2308'cscopetagorder' 'csto' number (default 0)
2309 global
2310 {not available when compiled without the |+cscope|
2311 feature}
2312 {not in Vi}
2313 Determines the order in which ":cstag" performs a search. See
2314 |cscopetagorder|.
2315 NOTE: This option is set to 0 when 'compatible' is set.
2316
2317 *'cscopeverbose'* *'csverb'*
2318 *'nocscopeverbose'* *'nocsverb'*
2319'cscopeverbose' 'csverb' boolean (default off)
2320 global
2321 {not available when compiled without the |+cscope|
2322 feature}
2323 {not in Vi}
2324 Give messages when adding a cscope database. See |cscopeverbose|.
2325 NOTE: This option is reset when 'compatible' is set.
2326
Bram Moolenaar860cae12010-06-05 23:22:07 +02002327 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2328'cursorbind' 'crb' boolean (default off)
2329 local to window
2330 {not in Vi}
2331 {not available when compiled without the |+cursorbind|
2332 feature}
2333 When this option is set, as the cursor in the current
2334 window moves other cursorbound windows (windows that also have
2335 this option set) move their cursors to the corresponding line and
2336 column. This option is useful for viewing the
2337 differences between two versions of a file (see 'diff'); in diff mode,
2338 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002339 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002340
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002341
2342 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2343'cursorcolumn' 'cuc' boolean (default off)
2344 local to window
2345 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002346 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002347 feature}
2348 Highlight the screen column of the cursor with CursorColumn
2349 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2350 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002351 If you only want the highlighting in the current window you can use
2352 these autocommands: >
2353 au WinLeave * set nocursorline nocursorcolumn
2354 au WinEnter * set cursorline cursorcolumn
2355<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002356
2357 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2358'cursorline' 'cul' boolean (default off)
2359 local to window
2360 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002361 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002362 feature}
2363 Highlight the screen line of the cursor with CursorLine
2364 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2365 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002366 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002367 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002368
2369
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 *'debug'*
2371'debug' string (default "")
2372 global
2373 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002374 These values can be used:
2375 msg Error messages that would otherwise be omitted will be given
2376 anyway.
2377 throw Error messages that would otherwise be omitted will be given
2378 anyway and also throw an exception and set |v:errmsg|.
2379 beep A message will be given when otherwise only a beep would be
2380 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002381 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002382 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2383 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384
2385 *'define'* *'def'*
2386'define' 'def' string (default "^\s*#\s*define")
2387 global or local to buffer |global-local|
2388 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002389 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 pattern, just like for the "/" command. This option is used for the
2391 commands like "[i" and "[d" |include-search|. The 'isident' option is
2392 used to recognize the defined name after the match:
2393 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2394 See |option-backslash| about inserting backslashes to include a space
2395 or backslash.
2396 The default value is for C programs. For C++ this value would be
2397 useful, to include const type declarations: >
2398 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2399< When using the ":set" command, you need to double the backslashes!
2400
2401 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2402'delcombine' 'deco' boolean (default off)
2403 global
2404 {not in Vi}
2405 {only available when compiled with the |+multi_byte|
2406 feature}
2407 If editing Unicode and this option is set, backspace and Normal mode
2408 "x" delete each combining character on its own. When it is off (the
2409 default) the character along with its combining characters are
2410 deleted.
2411 Note: When 'delcombine' is set "xx" may work different from "2x"!
2412
2413 This is useful for Arabic, Hebrew and many other languages where one
2414 may have combining characters overtop of base characters, and want
2415 to remove only the combining ones.
2416
2417 *'dictionary'* *'dict'*
2418'dictionary' 'dict' string (default "")
2419 global or local to buffer |global-local|
2420 {not in Vi}
2421 List of file names, separated by commas, that are used to lookup words
2422 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2423 contain a list of words. This can be one word per line, or several
2424 words per line, separated by non-keyword characters (white space is
2425 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002426 When this option is empty, or an entry "spell" is present, spell
2427 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 after a comma are ignored, otherwise spaces are included in the file
2430 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002431 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 Where to find a list of words?
2433 - On FreeBSD, there is the file "/usr/share/dict/words".
2434 - In the Simtel archive, look in the "msdos/linguist" directory.
2435 - In "miscfiles" of the GNU collection.
2436 The use of |:set+=| and |:set-=| is preferred when adding or removing
2437 directories from the list. This avoids problems when a future version
2438 uses another default.
2439 Backticks cannot be used in this option for security reasons.
2440
2441 *'diff'* *'nodiff'*
2442'diff' boolean (default off)
2443 local to window
2444 {not in Vi}
2445 {not available when compiled without the |+diff|
2446 feature}
2447 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002448 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449
2450 *'dex'* *'diffexpr'*
2451'diffexpr' 'dex' string (default "")
2452 global
2453 {not in Vi}
2454 {not available when compiled without the |+diff|
2455 feature}
2456 Expression which is evaluated to obtain an ed-style diff file from two
2457 versions of a file. See |diff-diffexpr|.
2458 This option cannot be set from a |modeline| or in the |sandbox|, for
2459 security reasons.
2460
2461 *'dip'* *'diffopt'*
2462'diffopt' 'dip' string (default "filler")
2463 global
2464 {not in Vi}
2465 {not available when compiled without the |+diff|
2466 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002467 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 All are optional. Items must be separated by a comma.
2469
2470 filler Show filler lines, to keep the text
2471 synchronized with a window that has inserted
2472 lines at the same position. Mostly useful
2473 when windows are side-by-side and 'scrollbind'
2474 is set.
2475
2476 context:{n} Use a context of {n} lines between a change
2477 and a fold that contains unchanged lines.
2478 When omitted a context of six lines is used.
2479 See |fold-diff|.
2480
2481 icase Ignore changes in case of text. "a" and "A"
2482 are considered the same. Adds the "-i" flag
2483 to the "diff" command if 'diffexpr' is empty.
2484
2485 iwhite Ignore changes in amount of white space. Adds
2486 the "-b" flag to the "diff" command if
2487 'diffexpr' is empty. Check the documentation
2488 of the "diff" command for what this does
2489 exactly. It should ignore adding trailing
2490 white space, but not leading white space.
2491
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002492 horizontal Start diff mode with horizontal splits (unless
2493 explicitly specified otherwise).
2494
2495 vertical Start diff mode with vertical splits (unless
2496 explicitly specified otherwise).
2497
2498 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2499 starting diff mode. Without this 2 is used.
2500
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 Examples: >
2502
2503 :set diffopt=filler,context:4
2504 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002505 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506<
2507 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2508'digraph' 'dg' boolean (default off)
2509 global
2510 {not in Vi}
2511 {not available when compiled without the |+digraphs|
2512 feature}
2513 Enable the entering of digraphs in Insert mode with {char1} <BS>
2514 {char2}. See |digraphs|.
2515 NOTE: This option is reset when 'compatible' is set.
2516
2517 *'directory'* *'dir'*
2518'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002519 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 for Unix: ".,~/tmp,/var/tmp,/tmp")
2521 global
2522 List of directory names for the swap file, separated with commas.
2523 - The swap file will be created in the first directory where this is
2524 possible.
2525 - Empty means that no swap file will be used (recovery is
2526 impossible!).
2527 - A directory "." means to put the swap file in the same directory as
2528 the edited file. On Unix, a dot is prepended to the file name, so
2529 it doesn't show in a directory listing. On MS-Windows the "hidden"
2530 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002531 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 put the swap file relative to where the edited file is. The leading
2533 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002534 - For Unix and Win32, if a directory ends in two path separators "//"
2535 or "\\", the swap file name will be built from the complete path to
2536 the file with all path separators substituted to percent '%' signs.
2537 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002538 On Win32, when a separating comma is following, you must use "//",
2539 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 - Spaces after the comma are ignored, other spaces are considered part
2541 of the directory name. To have a space at the start of a directory
2542 name, precede it with a backslash.
2543 - To include a comma in a directory name precede it with a backslash.
2544 - A directory name may end in an ':' or '/'.
2545 - Environment variables are expanded |:set_env|.
2546 - Careful with '\' characters, type one before a space, type two to
2547 get one in the option (see |option-backslash|), for example: >
2548 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2549< - For backwards compatibility with Vim version 3.0 a '>' at the start
2550 of the option is removed.
2551 Using "." first in the list is recommended. This means that editing
2552 the same file twice will result in a warning. Using "/tmp" on Unix is
2553 discouraged: When the system crashes you lose the swap file.
2554 "/var/tmp" is often not cleared when rebooting, thus is a better
2555 choice than "/tmp". But it can contain a lot of files, your swap
2556 files get lost in the crowd. That is why a "tmp" directory in your
2557 home directory is tried first.
2558 The use of |:set+=| and |:set-=| is preferred when adding or removing
2559 directories from the list. This avoids problems when a future version
2560 uses another default.
2561 This option cannot be set from a |modeline| or in the |sandbox|, for
2562 security reasons.
2563 {Vi: directory to put temp file in, defaults to "/tmp"}
2564
2565 *'display'* *'dy'*
2566'display' 'dy' string (default "")
2567 global
2568 {not in Vi}
2569 Change the way text is displayed. This is comma separated list of
2570 flags:
2571 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002572 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 last line that doesn't fit is replaced with "@" lines.
2574 uhex Show unprintable characters hexadecimal as <xx>
2575 instead of using ^C and ~C.
2576
2577 *'eadirection'* *'ead'*
2578'eadirection' 'ead' string (default "both")
2579 global
2580 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002581 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 feature}
2583 Tells when the 'equalalways' option applies:
2584 ver vertically, width of windows is not affected
2585 hor horizontally, height of windows is not affected
2586 both width and height of windows is affected
2587
2588 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2589'edcompatible' 'ed' boolean (default off)
2590 global
2591 Makes the 'g' and 'c' flags of the ":substitute" command to be
2592 toggled each time the flag is given. See |complex-change|. See
2593 also 'gdefault' option.
2594 Switching this option on is discouraged!
2595
2596 *'encoding'* *'enc'* *E543*
2597'encoding' 'enc' string (default: "latin1" or value from $LANG)
2598 global
2599 {only available when compiled with the |+multi_byte|
2600 feature}
2601 {not in Vi}
2602 Sets the character encoding used inside Vim. It applies to text in
2603 the buffers, registers, Strings in expressions, text stored in the
2604 viminfo file, etc. It sets the kind of characters which Vim can work
2605 with. See |encoding-names| for the possible values.
2606
2607 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002608 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002610 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611
Bram Moolenaar865242e2010-07-14 21:12:05 +02002612 This option cannot be set from a |modeline|. It would most likely
2613 corrupt the text.
2614
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2616 "utf-8". Although care has been taken to allow different values of
2617 'encoding', "utf-8" is the natural choice for the environment and
2618 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002619 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 versions, and to avoid changing the encoding of newly created files
2621 without your knowledge (in case 'fileencodings' is empty).
2622
2623 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 iconv() or as specified with 'charconvert'.
2626
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002627 If you need to know whether 'encoding' is a multi-byte encoding, you
2628 can use: >
2629 if has("multi_byte_encoding")
2630<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 Normally 'encoding' will be equal to your current locale. This will
2632 be the default if Vim recognizes your environment settings. If
2633 'encoding' is not set to the current locale, 'termencoding' must be
2634 set to convert typed and displayed text. See |encoding-table|.
2635
2636 When you set this option, it fires the |EncodingChanged| autocommand
2637 event so that you can set up fonts if necessary.
2638
2639 When the option is set, the value is converted to lowercase. Thus
2640 you can set it with uppercase values too. Underscores are translated
2641 to '-' signs.
2642 When the encoding is recognized, it is changed to the standard name.
2643 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2644 "iso-8859-2" and "utf8" becomes "utf-8".
2645
2646 Note: "latin1" is also used when the encoding could not be detected.
2647 This only works when editing files in the same encoding! When the
2648 actual character set is not latin1, make sure 'fileencoding' and
2649 'fileencodings' are empty. When conversion is needed, switch to using
2650 utf-8.
2651
2652 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2653 You don't notice this while editing, but it does matter for the
2654 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2655 setting 'encoding' to one of these values instead of utf-8 only has
2656 effect for encoding used for files when 'fileencoding' is empty.
2657
Bram Moolenaar661b1822005-07-28 22:36:45 +00002658 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2659 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660
2661 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2662'endofline' 'eol' boolean (default on)
2663 local to buffer
2664 {not in Vi}
2665 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002666 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 option is automatically set when starting to edit a new file, unless
2668 the file does not have an <EOL> for the last line in the file, in
2669 which case it is reset. Normally you don't have to set or reset this
2670 option. When 'binary' is off the value is not used when writing the
2671 file. When 'binary' is on it is used to remember the presence of a
2672 <EOL> for the last line in the file, so that when you write the file
2673 the situation from the original file can be kept. But you can change
2674 it if you want to.
2675
2676 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2677'equalalways' 'ea' boolean (default on)
2678 global
2679 {not in Vi}
2680 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002681 splitting or closing a window. This also happens the moment the
2682 option is switched on. When off, splitting a window will reduce the
2683 size of the current window and leave the other windows the same. When
2684 closing a window the extra lines are given to the window next to it
2685 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 When mixing vertically and horizontally split windows, a minimal size
2687 is computed and some windows may be larger if there is room. The
2688 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002689 Changing the height and width of a window can be avoided by setting
2690 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002691 If a window size is specified when creating a new window sizes are
2692 currently not equalized (it's complicated, but may be implemented in
2693 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'equalprg'* *'ep'*
2696'equalprg' 'ep' string (default "")
2697 global or local to buffer |global-local|
2698 {not in Vi}
2699 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002700 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002701 or 'indentexpr'. When Vim was compiled without internal formatting,
2702 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002703 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 about including spaces and backslashes.
2705 This option cannot be set from a |modeline| or in the |sandbox|, for
2706 security reasons.
2707
2708 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2709'errorbells' 'eb' boolean (default off)
2710 global
2711 Ring the bell (beep or screen flash) for error messages. This only
2712 makes a difference for error messages, the bell will be used always
2713 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002714 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 screen flash or do nothing.
2716
2717 *'errorfile'* *'ef'*
2718'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2719 others: "errors.err")
2720 global
2721 {not in Vi}
2722 {not available when compiled without the |+quickfix|
2723 feature}
2724 Name of the errorfile for the QuickFix mode (see |:cf|).
2725 When the "-q" command-line argument is used, 'errorfile' is set to the
2726 following argument. See |-q|.
2727 NOT used for the ":make" command. See 'makeef' for that.
2728 Environment variables are expanded |:set_env|.
2729 See |option-backslash| about including spaces and backslashes.
2730 This option cannot be set from a |modeline| or in the |sandbox|, for
2731 security reasons.
2732
2733 *'errorformat'* *'efm'*
2734'errorformat' 'efm' string (default is very long)
2735 global or local to buffer |global-local|
2736 {not in Vi}
2737 {not available when compiled without the |+quickfix|
2738 feature}
2739 Scanf-like description of the format for the lines in the error file
2740 (see |errorformat|).
2741
2742 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2743'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2744 global
2745 {not in Vi}
2746 Function keys that start with an <Esc> are recognized in Insert
2747 mode. When this option is off, the cursor and function keys cannot be
2748 used in Insert mode if they start with an <Esc>. The advantage of
2749 this is that the single <Esc> is recognized immediately, instead of
2750 after one second. Instead of resetting this option, you might want to
2751 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2752 when 'esckeys' is off, you can still map anything, but the cursor keys
2753 won't work by default.
2754 NOTE: This option is set to the Vi default value when 'compatible' is
2755 set and to the Vim default value when 'compatible' is reset.
2756
2757 *'eventignore'* *'ei'*
2758'eventignore' 'ei' string (default "")
2759 global
2760 {not in Vi}
2761 {not available when compiled without the |+autocmd|
2762 feature}
2763 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002764 When set to "all" or when "all" is one of the items, all autocommand
2765 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 Otherwise this is a comma separated list of event names. Example: >
2767 :set ei=WinEnter,WinLeave
2768<
2769 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2770'expandtab' 'et' boolean (default off)
2771 local to buffer
2772 {not in Vi}
2773 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2776 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2777 NOTE: This option is reset when 'compatible' is set.
2778
2779 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2780'exrc' 'ex' boolean (default off)
2781 global
2782 {not in Vi}
2783 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2784 directory. If you switch this option on you should also consider
2785 setting the 'secure' option (see |initialization|). Using a local
2786 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2787 also see |.vimrc| and |gui-init|.
2788 This option cannot be set from a |modeline| or in the |sandbox|, for
2789 security reasons.
2790
2791 *'fileencoding'* *'fenc'* *E213*
2792'fileencoding' 'fenc' string (default: "")
2793 local to buffer
2794 {only available when compiled with the |+multi_byte|
2795 feature}
2796 {not in Vi}
2797 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002798
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002800 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 When 'fileencoding' is empty, the same value as 'encoding' will be
2802 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002803 Conversion will also be done when 'encoding' and 'fileencoding' are
2804 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2805 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002807 'encoding' is "utf-8" or another Unicode encoding, conversion
2808 is most likely done in a way that the reverse conversion
2809 results in the same text. When 'encoding' is not "utf-8" some
2810 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002811
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 See 'encoding' for the possible values. Additionally, values may be
2813 specified that can be handled by the converter, see
2814 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002815
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 When reading a file 'fileencoding' will be set from 'fileencodings'.
2817 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002818 'fileencoding', use the |++enc| argument. One exception: when
2819 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002820 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002821
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2823 When the option is set, the value is converted to lowercase. Thus
2824 you can set it with uppercase values too. '_' characters are
2825 replaced with '-'. If a name is recognized from the list for
2826 'encoding', it is replaced by the standard name. For example
2827 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002828
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 When this option is set, after starting to edit a file, the 'modified'
2830 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002831
2832 Keep in mind that changing 'fenc' from a modeline happens
2833 AFTER the text has been read, thus it applies to when the file will be
2834 written. If you do set 'fenc' in a modeline, you might want to set
2835 'nomodified' to avoid not being able to ":q".
2836
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 This option can not be changed when 'modifiable' is off.
2838
2839 *'fe'*
2840 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002841 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 old short name was 'fe', which is no longer used.
2843
2844 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002845'fileencodings' 'fencs' string (default: "ucs-bom",
2846 "ucs-bom,utf-8,default,latin1" when
2847 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 global
2849 {only available when compiled with the |+multi_byte|
2850 feature}
2851 {not in Vi}
2852 This is a list of character encodings considered when starting to edit
2853 an existing file. When a file is read, Vim tries to use the first
2854 mentioned character encoding. If an error is detected, the next one
2855 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002856 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 an empty string, which means the value of 'encoding' is used.
2858 WARNING: Conversion can cause loss of information! When
2859 'encoding' is "utf-8" (or one of the other Unicode variants)
2860 conversion is most likely done in a way that the reverse
2861 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002862 "utf-8" some non-ASCII characters may be lost! You can use
2863 the |++bad| argument to specify what is done with characters
2864 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 For an empty file or a file with only ASCII characters most encodings
2866 will work and the first entry of 'fileencodings' will be used (except
2867 "ucs-bom", which requires the BOM to be present). If you prefer
2868 another encoding use an BufReadPost autocommand event to test if your
2869 preferred encoding is to be used. Example: >
2870 au BufReadPost * if search('\S', 'w') == 0 |
2871 \ set fenc=iso-2022-jp | endif
2872< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2873 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002874 When the |++enc| argument is used then the value of 'fileencodings' is
2875 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002876 Note that 'fileencodings' is not used for a new file, the global value
2877 of 'fileencoding' is used instead. You can set it with: >
2878 :setglobal fenc=iso-8859-2
2879< This means that a non-existing file may get a different encoding than
2880 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 The special value "ucs-bom" can be used to check for a Unicode BOM
2882 (Byte Order Mark) at the start of the file. It must not be preceded
2883 by "utf-8" or another Unicode encoding for this to work properly.
2884 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2885 because Vim cannot detect an error, thus the encoding is always
2886 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002887 The special value "default" can be used for the encoding from the
2888 environment. This is the default value for 'encoding'. It is useful
2889 when 'encoding' is set to "utf-8" and your environment uses a
2890 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002891 When 'encoding' is "utf-8" and a file contains an illegal byte
2892 sequence it won't be recognized as UTF-8. You can use the |8g8|
2893 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 WRONG VALUES: WHAT'S WRONG:
2895 latin1,utf-8 "latin1" will always be used
2896 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2897 file
2898 cp1250,latin1 "cp1250" will always be used
2899 If 'fileencodings' is empty, 'fileencoding' is not modified.
2900 See 'fileencoding' for the possible values.
2901 Setting this option does not have an effect until the next time a file
2902 is read.
2903
2904 *'fileformat'* *'ff'*
2905'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2906 Unix default: "unix",
2907 Macintosh default: "mac")
2908 local to buffer
2909 {not in Vi}
2910 This gives the <EOL> of the current buffer, which is used for
2911 reading/writing the buffer from/to a file:
2912 dos <CR> <NL>
2913 unix <NL>
2914 mac <CR>
2915 When "dos" is used, CTRL-Z at the end of a file is ignored.
2916 See |file-formats| and |file-read|.
2917 For the character encoding of the file see 'fileencoding'.
2918 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002919 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002920 This option is set automatically when starting to edit a file and
2921 'fileformats' is not empty and 'binary' is off.
2922 When this option is set, after starting to edit a file, the 'modified'
2923 option is set, because the file would be different when written.
2924 This option can not be changed when 'modifiable' is off.
2925 For backwards compatibility: When this option is set to "dos",
2926 'textmode' is set, otherwise 'textmode' is reset.
2927
2928 *'fileformats'* *'ffs'*
2929'fileformats' 'ffs' string (default:
2930 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2931 Vim Unix: "unix,dos",
2932 Vim Mac: "mac,unix,dos",
2933 Vi Cygwin: "unix,dos",
2934 Vi others: "")
2935 global
2936 {not in Vi}
2937 This gives the end-of-line (<EOL>) formats that will be tried when
2938 starting to edit a new buffer and when reading a file into an existing
2939 buffer:
2940 - When empty, the format defined with 'fileformat' will be used
2941 always. It is not set automatically.
2942 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002943 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944 'fileformats' name will be used when a file is read into an existing
2945 buffer, no matter what 'fileformat' for that buffer is set to.
2946 - When more than one name is present, separated by commas, automatic
2947 <EOL> detection will be done when reading a file. When starting to
2948 edit a file, a check is done for the <EOL>:
2949 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2950 'fileformat' is set to "dos".
2951 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002952 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01002954 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
2955 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02002956 This means that "mac" is only chosen when:
2957 "unix" is not present or no <NL> is found in the file, and
2958 "dos" is not present or no <CR><NL> is found in the file.
2959 Except: if "unix" was chosen, but there is a <CR> before
2960 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002961 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 4. If 'fileformat' is still not set, the first name from
2963 'fileformats' is used.
2964 When reading a file into an existing buffer, the same is done, but
2965 this happens like 'fileformat' has been set appropriately for that
2966 file only, the option is not changed.
2967 When 'binary' is set, the value of 'fileformats' is not used.
2968
Bram Moolenaar81af9252010-12-10 20:35:50 +01002969 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002970 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002971
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2973 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2974 done:
2975 - When 'fileformats' is empty, there is no automatic detection. Dos
2976 format will be used.
2977 - When 'fileformats' is set to one or more names, automatic detection
2978 is done. This is based on the first <NL> in the file: If there is a
2979 <CR> in front of it, Dos format is used, otherwise Unix format is
2980 used.
2981 Also see |file-formats|.
2982 For backwards compatibility: When this option is set to an empty
2983 string or one format (no comma is included), 'textauto' is reset,
2984 otherwise 'textauto' is set.
2985 NOTE: This option is set to the Vi default value when 'compatible' is
2986 set and to the Vim default value when 'compatible' is reset.
2987
Bram Moolenaarbf884932013-04-05 22:26:15 +02002988 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2989'fileignorecase' 'fic' boolean (default on for systems where case in file
2990 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002991 global
2992 {not in Vi}
2993 When set case is ignored when using file names and directories.
2994 See 'wildignorecase' for only ignoring case when doing completion.
2995
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 *'filetype'* *'ft'*
2997'filetype' 'ft' string (default: "")
2998 local to buffer
2999 {not in Vi}
3000 {not available when compiled without the |+autocmd|
3001 feature}
3002 When this option is set, the FileType autocommand event is triggered.
3003 All autocommands that match with the value of this option will be
3004 executed. Thus the value of 'filetype' is used in place of the file
3005 name.
3006 Otherwise this option does not always reflect the current file type.
3007 This option is normally set when the file type is detected. To enable
3008 this use the ":filetype on" command. |:filetype|
3009 Setting this option to a different value is most useful in a modeline,
3010 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003011 Example, for in an IDL file:
3012 /* vim: set filetype=idl : */ ~
3013 |FileType| |filetypes|
3014 When a dot appears in the value then this separates two filetype
3015 names. Example:
3016 /* vim: set filetype=c.doxygen : */ ~
3017 This will use the "c" filetype first, then the "doxygen" filetype.
3018 This works both for filetype plugins and for syntax files. More than
3019 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 This option is not copied to another buffer, independent of the 's' or
3021 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003022 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023
3024 *'fillchars'* *'fcs'*
3025'fillchars' 'fcs' string (default "vert:|,fold:-")
3026 global
3027 {not in Vi}
3028 {not available when compiled without the |+windows|
3029 and |+folding| features}
3030 Characters to fill the statuslines and vertical separators.
3031 It is a comma separated list of items:
3032
3033 item default Used for ~
3034 stl:c ' ' or '^' statusline of the current window
3035 stlnc:c ' ' or '-' statusline of the non-current windows
3036 vert:c '|' vertical separators |:vsplit|
3037 fold:c '-' filling 'foldtext'
3038 diff:c '-' deleted lines of the 'diff' option
3039
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 "stlnc" the space will be used when there is highlighting, '^' or '-'
3042 otherwise.
3043
3044 Example: >
3045 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3046< This is similar to the default, except that these characters will also
3047 be used when there is highlighting.
3048
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003049 for "stl" and "stlnc" only single-byte values are supported.
3050
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 The highlighting used for these items:
3052 item highlight group ~
3053 stl:c StatusLine |hl-StatusLine|
3054 stlnc:c StatusLineNC |hl-StatusLineNC|
3055 vert:c VertSplit |hl-VertSplit|
3056 fold:c Folded |hl-Folded|
3057 diff:c DiffDelete |hl-DiffDelete|
3058
3059 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3060'fkmap' 'fk' boolean (default off) *E198*
3061 global
3062 {not in Vi}
3063 {only available when compiled with the |+rightleft|
3064 feature}
3065 When on, the keyboard is mapped for the Farsi character set.
3066 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003067 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068
3069 *'foldclose'* *'fcl'*
3070'foldclose' 'fcl' string (default "")
3071 global
3072 {not in Vi}
3073 {not available when compiled without the |+folding|
3074 feature}
3075 When set to "all", a fold is closed when the cursor isn't in it and
3076 its level is higher than 'foldlevel'. Useful if you want folds to
3077 automatically close when moving out of them.
3078
3079 *'foldcolumn'* *'fdc'*
3080'foldcolumn' 'fdc' number (default 0)
3081 local to window
3082 {not in Vi}
3083 {not available when compiled without the |+folding|
3084 feature}
3085 When non-zero, a column with the specified width is shown at the side
3086 of the window which indicates open and closed folds. The maximum
3087 value is 12.
3088 See |folding|.
3089
3090 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3091'foldenable' 'fen' boolean (default on)
3092 local to window
3093 {not in Vi}
3094 {not available when compiled without the |+folding|
3095 feature}
3096 When off, all folds are open. This option can be used to quickly
3097 switch between showing all text unfolded and viewing the text with
3098 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003099 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 'foldenable' is off.
3101 This option is set by commands that create a new fold or close a fold.
3102 See |folding|.
3103
3104 *'foldexpr'* *'fde'*
3105'foldexpr' 'fde' string (default: "0")
3106 local to window
3107 {not in Vi}
3108 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003109 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003111 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003112
Bram Moolenaar30b65812012-07-12 22:01:11 +02003113 The expression will be evaluated in the |sandbox| if set from a
3114 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003115 This option can't be set from a |modeline| when the 'diff' option is
3116 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003117
3118 It is not allowed to change text or jump to another window while
3119 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120
3121 *'foldignore'* *'fdi'*
3122'foldignore' 'fdi' string (default: "#")
3123 local to window
3124 {not in Vi}
3125 {not available when compiled without the |+folding|
3126 feature}
3127 Used only when 'foldmethod' is "indent". Lines starting with
3128 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003129 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 The default "#" works well for C programs. See |fold-indent|.
3131
3132 *'foldlevel'* *'fdl'*
3133'foldlevel' 'fdl' number (default: 0)
3134 local to window
3135 {not in Vi}
3136 {not available when compiled without the |+folding|
3137 feature}
3138 Sets the fold level: Folds with a higher level will be closed.
3139 Setting this option to zero will close all folds. Higher numbers will
3140 close fewer folds.
3141 This option is set by commands like |zm|, |zM| and |zR|.
3142 See |fold-foldlevel|.
3143
3144 *'foldlevelstart'* *'fdls'*
3145'foldlevelstart' 'fdls' number (default: -1)
3146 global
3147 {not in Vi}
3148 {not available when compiled without the |+folding|
3149 feature}
3150 Sets 'foldlevel' when starting to edit another buffer in a window.
3151 Useful to always start editing with all folds closed (value zero),
3152 some folds closed (one) or no folds closed (99).
3153 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003154 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003155 ignores this option and closes all folds.
3156 It is also done before BufReadPre autocommands, to allow an autocmd to
3157 overrule the 'foldlevel' value for specific files.
3158 When the value is negative, it is not used.
3159
3160 *'foldmarker'* *'fmr'* *E536*
3161'foldmarker' 'fmr' string (default: "{{{,}}}")
3162 local to window
3163 {not in Vi}
3164 {not available when compiled without the |+folding|
3165 feature}
3166 The start and end marker used when 'foldmethod' is "marker". There
3167 must be one comma, which separates the start and end marker. The
3168 marker is a literal string (a regular expression would be too slow).
3169 See |fold-marker|.
3170
3171 *'foldmethod'* *'fdm'*
3172'foldmethod' 'fdm' string (default: "manual")
3173 local to window
3174 {not in Vi}
3175 {not available when compiled without the |+folding|
3176 feature}
3177 The kind of folding used for the current window. Possible values:
3178 |fold-manual| manual Folds are created manually.
3179 |fold-indent| indent Lines with equal indent form a fold.
3180 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3181 |fold-marker| marker Markers are used to specify folds.
3182 |fold-syntax| syntax Syntax highlighting items specify folds.
3183 |fold-diff| diff Fold text that is not changed.
3184
3185 *'foldminlines'* *'fml'*
3186'foldminlines' 'fml' number (default: 1)
3187 local to window
3188 {not in Vi}
3189 {not available when compiled without the |+folding|
3190 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003191 Sets the number of screen lines above which a fold can be displayed
3192 closed. Also for manually closed folds. With the default value of
3193 one a fold can only be closed if it takes up two or more screen lines.
3194 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003195 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 "zc" to close a fold, which is displayed open because it's smaller
3197 than 'foldminlines', a following "zc" may close a containing fold.
3198
3199 *'foldnestmax'* *'fdn'*
3200'foldnestmax' 'fdn' number (default: 20)
3201 local to window
3202 {not in Vi}
3203 {not available when compiled without the |+folding|
3204 feature}
3205 Sets the maximum nesting of folds for the "indent" and "syntax"
3206 methods. This avoids that too many folds will be created. Using more
3207 than 20 doesn't work, because the internal limit is 20.
3208
3209 *'foldopen'* *'fdo'*
3210'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3211 search,tag,undo")
3212 global
3213 {not in Vi}
3214 {not available when compiled without the |+folding|
3215 feature}
3216 Specifies for which type of commands folds will be opened, if the
3217 command moves the cursor into a closed fold. It is a comma separated
3218 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003219 NOTE: When the command is part of a mapping this option is not used.
3220 Add the |zv| command to the mapping to get the same effect.
3221 (rationale: the mapping may want to control opening folds itself)
3222
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 item commands ~
3224 all any
3225 block "(", "{", "[[", "[{", etc.
3226 hor horizontal movements: "l", "w", "fx", etc.
3227 insert any command in Insert mode
3228 jump far jumps: "G", "gg", etc.
3229 mark jumping to a mark: "'m", CTRL-O, etc.
3230 percent "%"
3231 quickfix ":cn", ":crew", ":make", etc.
3232 search search for a pattern: "/", "n", "*", "gd", etc.
3233 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003234 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 tag jumping to a tag: ":ta", CTRL-T, etc.
3236 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 When a movement command is used for an operator (e.g., "dl" or "y%")
3238 this option is not used. This means the operator will include the
3239 whole closed fold.
3240 Note that vertical movements are not here, because it would make it
3241 very difficult to move onto a closed fold.
3242 In insert mode the folds containing the cursor will always be open
3243 when text is inserted.
3244 To close folds you can re-apply 'foldlevel' with the |zx| command or
3245 set the 'foldclose' option to "all".
3246
3247 *'foldtext'* *'fdt'*
3248'foldtext' 'fdt' string (default: "foldtext()")
3249 local to window
3250 {not in Vi}
3251 {not available when compiled without the |+folding|
3252 feature}
3253 An expression which is used to specify the text displayed for a closed
3254 fold. See |fold-foldtext|.
3255
Bram Moolenaar30b65812012-07-12 22:01:11 +02003256 The expression will be evaluated in the |sandbox| if set from a
3257 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003258
3259 It is not allowed to change text or jump to another window while
3260 evaluating 'foldtext' |textlock|.
3261
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 *'formatoptions'* *'fo'*
3263'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3264 local to buffer
3265 {not in Vi}
3266 This is a sequence of letters which describes how automatic
3267 formatting is to be done. See |fo-table|. When the 'paste' option is
3268 on, no formatting is done (like 'formatoptions' is empty). Commas can
3269 be inserted for readability.
3270 To avoid problems with flags that are added in the future, use the
3271 "+=" and "-=" feature of ":set" |add-option-flags|.
3272 NOTE: This option is set to the Vi default value when 'compatible' is
3273 set and to the Vim default value when 'compatible' is reset.
3274
Bram Moolenaar86b68352004-12-27 21:59:20 +00003275 *'formatlistpat'* *'flp'*
3276'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3277 local to buffer
3278 {not in Vi}
3279 A pattern that is used to recognize a list header. This is used for
3280 the "n" flag in 'formatoptions'.
3281 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003282 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003283 while still checking more characters. There must be a character
3284 following the pattern, when it matches the whole line it is handled
3285 like there is no match.
3286 The default recognizes a number, followed by an optional punctuation
3287 character and white space.
3288
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 *'formatprg'* *'fp'*
3290'formatprg' 'fp' string (default "")
3291 global
3292 {not in Vi}
3293 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003294 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003296 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003297 If the 'formatexpr' option is not empty it will be used instead.
3298 Otherwise, if 'formatprg' option is an empty string, the internal
3299 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003300 Environment variables are expanded |:set_env|. See |option-backslash|
3301 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003302 This option cannot be set from a |modeline| or in the |sandbox|, for
3303 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003305 *'formatexpr'* *'fex'*
3306'formatexpr' 'fex' string (default "")
3307 local to buffer
3308 {not in Vi}
3309 {not available when compiled without the |+eval|
3310 feature}
3311 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003312 operator or automatic formatting (see 'formatoptions'). When this
3313 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003314
3315 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003316 The |v:count| variable holds the number of lines to be formatted.
3317 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003318 inserted if the expression is being evaluated due to
3319 automatic formatting. This can be empty. Don't insert
3320 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003321
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003322 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003323 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003324< This will invoke the mylang#Format() function in the
3325 autoload/mylang.vim file in 'runtimepath'. |autoload|
3326
3327 The expression is also evaluated when 'textwidth' is set and adding
3328 text beyond that limit. This happens under the same conditions as
3329 when internal formatting is used. Make sure the cursor is kept in the
3330 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003331 return "i" or "R" in this situation.
3332
3333 When the expression evaluates to non-zero Vim will fall back to using
3334 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003335
Bram Moolenaar30b65812012-07-12 22:01:11 +02003336 The expression will be evaluated in the |sandbox| when set from a
3337 modeline, see |sandbox-option|. That stops the option from working,
3338 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003339
3340 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003341'fsync' 'fs' boolean (default on)
3342 global
3343 {not in Vi}
3344 When on, the library function fsync() will be called after writing a
3345 file. This will flush a file to disk, ensuring that it is safely
3346 written even on filesystems which do metadata-only journaling. This
3347 will force the harddrive to spin up on Linux systems running in laptop
3348 mode, so it may be undesirable in some situations. Be warned that
3349 turning this off increases the chances of data loss after a crash. On
3350 systems without an fsync() implementation, this variable is always
3351 off.
3352 Also see 'swapsync' for controlling fsync() on swap files.
3353
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3355'gdefault' 'gd' boolean (default off)
3356 global
3357 {not in Vi}
3358 When on, the ":substitute" flag 'g' is default on. This means that
3359 all matches in a line are substituted instead of one. When a 'g' flag
3360 is given to a ":substitute" command, this will toggle the substitution
3361 of all or one match. See |complex-change|.
3362
3363 command 'gdefault' on 'gdefault' off ~
3364 :s/// subst. all subst. one
3365 :s///g subst. one subst. all
3366 :s///gg subst. all subst. one
3367
3368 NOTE: This option is reset when 'compatible' is set.
3369
3370 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003371'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 global
3373 {not in Vi}
3374 Format to recognize for the ":grep" command output.
3375 This is a scanf-like string that uses the same format as the
3376 'errorformat' option: see |errorformat|.
3377
3378 *'grepprg'* *'gp'*
3379'grepprg' 'gp' string (default "grep -n ",
3380 Unix: "grep -n $* /dev/null",
3381 Win32: "findstr /n" or "grep -n",
3382 VMS: "SEARCH/NUMBERS ")
3383 global or local to buffer |global-local|
3384 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003385 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 and '#' characters, which are expanded like when used in a command-
3387 line. The placeholder "$*" is allowed to specify where the arguments
3388 will be included. Environment variables are expanded |:set_env|. See
3389 |option-backslash| about including spaces and backslashes.
3390 When your "grep" accepts the "-H" argument, use this to make ":grep"
3391 also work well with a single file: >
3392 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003393< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003394 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3395 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003396 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 apply equally to 'grepprg'.
3398 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3399 otherwise it's "grep -n".
3400 This option cannot be set from a |modeline| or in the |sandbox|, for
3401 security reasons.
3402
3403 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3404'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3405 ve:ver35-Cursor,
3406 o:hor50-Cursor,
3407 i-ci:ver25-Cursor/lCursor,
3408 r-cr:hor20-Cursor/lCursor,
3409 sm:block-Cursor
3410 -blinkwait175-blinkoff150-blinkon175",
3411 for MS-DOS and Win32 console:
3412 "n-v-c:block,o:hor50,i-ci:hor15,
3413 r-cr:hor30,sm:block")
3414 global
3415 {not in Vi}
3416 {only available when compiled with GUI enabled, and
3417 for MS-DOS and Win32 console}
3418 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003419 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 the height of the cursor can be changed. This can be done by
3421 specifying a block cursor, or a percentage for a vertical or
3422 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003423 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003425 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 mode-list and an argument-list:
3427 mode-list:argument-list,mode-list:argument-list,..
3428 The mode-list is a dash separated list of these modes:
3429 n Normal mode
3430 v Visual mode
3431 ve Visual mode with 'selection' "exclusive" (same as 'v',
3432 if not specified)
3433 o Operator-pending mode
3434 i Insert mode
3435 r Replace mode
3436 c Command-line Normal (append) mode
3437 ci Command-line Insert mode
3438 cr Command-line Replace mode
3439 sm showmatch in Insert mode
3440 a all modes
3441 The argument-list is a dash separated list of these arguments:
3442 hor{N} horizontal bar, {N} percent of the character height
3443 ver{N} vertical bar, {N} percent of the character width
3444 block block cursor, fills the whole character
3445 [only one of the above three should be present]
3446 blinkwait{N} *cursor-blinking*
3447 blinkon{N}
3448 blinkoff{N}
3449 blink times for cursor: blinkwait is the delay before
3450 the cursor starts blinking, blinkon is the time that
3451 the cursor is shown and blinkoff is the time that the
3452 cursor is not shown. The times are in msec. When one
3453 of the numbers is zero, there is no blinking. The
3454 default is: "blinkwait700-blinkon400-blinkoff250".
3455 These numbers are used for a missing entry. This
3456 means that blinking is enabled by default. To switch
3457 blinking off you can use "blinkon0". The cursor only
3458 blinks when Vim is waiting for input, not while
3459 executing a command.
3460 To make the cursor blink in an xterm, see
3461 |xterm-blink|.
3462 {group-name}
3463 a highlight group name, that sets the color and font
3464 for the cursor
3465 {group-name}/{group-name}
3466 Two highlight group names, the first is used when
3467 no language mappings are used, the other when they
3468 are. |language-mapping|
3469
3470 Examples of parts:
3471 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3472 block cursor with colors from the "nCursor"
3473 highlight group
3474 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3475 In Insert and Command-line Insert mode, use a
3476 30% vertical bar cursor with colors from the
3477 "iCursor" highlight group. Blink a bit
3478 faster.
3479
3480 The 'a' mode is different. It will set the given argument-list for
3481 all modes. It does not reset anything to defaults. This can be used
3482 to do a common setting for all modes. For example, to switch off
3483 blinking: "a:blinkon0"
3484
3485 Examples of cursor highlighting: >
3486 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3487 :highlight Cursor gui=NONE guifg=bg guibg=fg
3488<
3489 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003490 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491'guifont' 'gfn' string (default "")
3492 global
3493 {not in Vi}
3494 {only available when compiled with GUI enabled}
3495 This is a list of fonts which will be used for the GUI version of Vim.
3496 In its simplest form the value is just one font name. When
3497 the font cannot be found you will get an error message. To try other
3498 font names a list can be specified, font names separated with commas.
3499 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003500
Bram Moolenaar05159a02005-02-26 23:04:13 +00003501 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3502 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003503
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 Spaces after a comma are ignored. To include a comma in a font name
3505 precede it with a backslash. Setting an option requires an extra
3506 backslash before a space and a backslash. See also
3507 |option-backslash|. For example: >
3508 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003509< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003511
3512 If none of the fonts can be loaded, Vim will keep the current setting.
3513 If an empty font list is given, Vim will try using other resource
3514 settings (for X, it will use the Vim.font resource), and finally it
3515 will try some builtin default which should always be there ("7x13" in
3516 the case of X). The font names given should be "normal" fonts. Vim
3517 will try to find the related bold and italic fonts.
3518
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003519 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003520 :set guifont=*
3521< will bring up a font requester, where you can pick the font you want.
3522
3523 The font name depends on the GUI used. See |setting-guifont| for a
3524 way to set 'guifont' for various systems.
3525
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 For the GTK+ 2 GUI the font name looks like this: >
3527 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003528< That's all. XLFDs are not used. For Chinese this is reported to work
3529 well: >
3530 if has("gui_gtk2")
3531 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3532 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3533 endif
3534<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003535 For Mac OSX you can use something like this: >
3536 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003537< Also see 'macatsui', it can help fix display problems.
3538 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003540 width). An exception is GTK 2: all fonts are accepted, but
3541 mono-spaced fonts look best.
3542
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 To preview a font on X11, you might be able to use the "xfontsel"
3544 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 For the Win32 GUI *E244* *E245*
3547 - takes these options in the font name:
3548 hXX - height is XX (points, can be floating-point)
3549 wXX - width is XX (points, can be floating-point)
3550 b - bold
3551 i - italic
3552 u - underline
3553 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003554 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3556 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3557 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003558 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559
3560 Use a ':' to separate the options.
3561 - A '_' can be used in the place of a space, so you don't need to use
3562 backslashes to escape the spaces.
3563 - Examples: >
3564 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3565 :set guifont=Andale_Mono:h7.5:w4.5
3566< See also |font-sizes|.
3567
3568 *'guifontset'* *'gfs'*
3569 *E250* *E252* *E234* *E597* *E598*
3570'guifontset' 'gfs' string (default "")
3571 global
3572 {not in Vi}
3573 {only available when compiled with GUI enabled and
3574 with the |+xfontset| feature}
3575 {not available in the GTK+ 2 GUI}
3576 When not empty, specifies two (or more) fonts to be used. The first
3577 one for normal English, the second one for your special language. See
3578 |xfontset|.
3579 Setting this option also means that all font names will be handled as
3580 a fontset name. Also the ones used for the "font" argument of the
3581 |:highlight| command.
3582 The fonts must match with the current locale. If fonts for the
3583 character sets that the current locale uses are not included, setting
3584 'guifontset' will fail.
3585 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3586 the comma-separated names are alternative names, one of which will be
3587 used. In 'guifontset' the whole string is one fontset name,
3588 including the commas. It is not possible to specify alternative
3589 fontset names.
3590 This example works on many X11 systems: >
3591 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3592<
3593 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3594'guifontwide' 'gfw' string (default "")
3595 global
3596 {not in Vi}
3597 {only available when compiled with GUI enabled}
3598 When not empty, specifies a comma-separated list of fonts to be used
3599 for double-width characters. The first font that can be loaded is
3600 used.
3601 Note: The size of these fonts must be exactly twice as wide as the one
3602 specified with 'guifont' and the same height.
3603
3604 All GUI versions but GTK+ 2:
3605
3606 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3607 'guifontset' is empty or invalid.
3608 When 'guifont' is set and a valid font is found in it and
3609 'guifontwide' is empty Vim will attempt to find a matching
3610 double-width font and set 'guifontwide' to it.
3611
3612 GTK+ 2 GUI only: *guifontwide_gtk2*
3613
3614 If set and valid, 'guifontwide' is always used for double width
3615 characters, even if 'encoding' is not set to "utf-8".
3616 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003617 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 font for characters not available in 'guifont'. Thus you do not need
3619 to set 'guifontwide' at all unless you want to override the choice
3620 made by Pango/Xft.
3621
Bram Moolenaar0f272122013-01-23 18:37:40 +01003622 Windows +multibyte only: *guifontwide_win_mbyte*
3623
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003624 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003625
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 *'guiheadroom'* *'ghr'*
3627'guiheadroom' 'ghr' number (default 50)
3628 global
3629 {not in Vi} {only for GTK and X11 GUI}
3630 The number of pixels subtracted from the screen height when fitting
3631 the GUI window on the screen. Set this before the GUI is started,
3632 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003633 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 lines will be left for window decorations and other items on the
3635 screen. Set it to a negative value to allow windows taller than the
3636 screen.
3637
3638 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003639'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3640 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 global
3642 {not in Vi}
3643 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003644 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 sequence of letters which describes what components and options of the
3646 GUI should be used.
3647 To avoid problems with flags that are added in the future, use the
3648 "+=" and "-=" feature of ":set" |add-option-flags|.
3649
3650 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003651 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 'a' Autoselect: If present, then whenever VISUAL mode is started,
3653 or the Visual area extended, Vim tries to become the owner of
3654 the windowing system's global selection. This means that the
3655 Visually highlighted text is available for pasting into other
3656 applications as well as into Vim itself. When the Visual mode
3657 ends, possibly due to an operation on the text, or when an
3658 application wants to paste the selection, the highlighted text
3659 is automatically yanked into the "* selection register.
3660 Thus the selection is still available for pasting into other
3661 applications after the VISUAL mode has ended.
3662 If not present, then Vim won't become the owner of the
3663 windowing system's global selection unless explicitly told to
3664 by a yank or delete operation for the "* register.
3665 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003666 *'go-P'*
3667 'P' Like autoselect but using the "+ register instead of the "*
3668 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003669 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003670 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 applies to the modeless selection.
3672
3673 'guioptions' autoselect Visual autoselect modeless ~
3674 "" - -
3675 "a" yes yes
3676 "A" - yes
3677 "aA" yes yes
3678
Bram Moolenaar02467872007-05-06 13:22:01 +00003679 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 'c' Use console dialogs instead of popup dialogs for simple
3681 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003682 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003683 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003684 'guitablabel' can be used to change the text in the labels.
3685 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003686 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003687 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003688 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 'f' Foreground: Don't use fork() to detach the GUI from the shell
3690 where it was started. Use this for programs that wait for the
3691 editor to finish (e.g., an e-mail program). Alternatively you
3692 can use "gvim -f" or ":gui -f" to start the GUI in the
3693 foreground. |gui-fork|
3694 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003695 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003696 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3698 corner of the window. It's black&white on non-GTK, because of
3699 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003700 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003702 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003703 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003705 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 file is sourced the system menu has already been loaded; the
3707 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003708 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 'g' Grey menu items: Make menu items that are not active grey. If
3710 'g' is not included inactive menu items are not shown at all.
3711 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003712 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 't' Include tearoff menu items. Currently only works for Win32,
3714 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003715 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003716 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003717 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003718 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003720 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 'R' Right-hand scrollbar is present when there is a vertically
3722 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003723 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003725 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 'L' Left-hand scrollbar is present when there is a vertically
3727 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003728 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3730 the longest visible line, or on the cursor line if the 'h'
3731 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003732 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'h' Limit horizontal scrollbar size to the length of the cursor
3734 line. Reduces computations. |gui-horiz-scroll|
3735
3736 And yes, you may even have scrollbars on the left AND the right if
3737 you really want to :-). See |gui-scrollbars| for more information.
3738
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003739 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 'v' Use a vertical button layout for dialogs. When not included,
3741 a horizontal layout is preferred, but when it doesn't fit a
3742 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003743 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 'p' Use Pointer callbacks for X11 GUI. This is required for some
3745 window managers. If the cursor is not blinking or hollow at
3746 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003747 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003749 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003750 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751
Bram Moolenaar02467872007-05-06 13:22:01 +00003752
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 *'guipty'* *'noguipty'*
3754'guipty' boolean (default on)
3755 global
3756 {not in Vi}
3757 {only available when compiled with GUI enabled}
3758 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3759 I/O to/from shell commands. See |gui-pty|.
3760
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003761 *'guitablabel'* *'gtl'*
3762'guitablabel' 'gtl' string (default empty)
3763 global
3764 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003765 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003766 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003767 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003768 pages line. When empty and when the result is empty Vim will use a
3769 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003770
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003771 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003772 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003773
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003774 Only used when the GUI tab pages line is displayed. 'e' must be
3775 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3776 used.
3777
Bram Moolenaar57657d82006-04-21 22:12:41 +00003778 *'guitabtooltip'* *'gtt'*
3779'guitabtooltip' 'gtt' string (default empty)
3780 global
3781 {not in Vi}
3782 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003783 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003784 When nonempty describes the text to use in a tooltip for the GUI tab
3785 pages line. When empty Vim will use a default tooltip.
3786 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003787 You can include a line break. Simplest method is to use |:let|: >
3788 :let &guitabtooltip = "line one\nline two"
3789<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003790
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 *'helpfile'* *'hf'*
3792'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3793 (others) "$VIMRUNTIME/doc/help.txt")
3794 global
3795 {not in Vi}
3796 Name of the main help file. All distributed help files should be
3797 placed together in one directory. Additionally, all "doc" directories
3798 in 'runtimepath' will be used.
3799 Environment variables are expanded |:set_env|. For example:
3800 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003801 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 spaces and backslashes.
3803 This option cannot be set from a |modeline| or in the |sandbox|, for
3804 security reasons.
3805
3806 *'helpheight'* *'hh'*
3807'helpheight' 'hh' number (default 20)
3808 global
3809 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003810 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 feature}
3812 Minimal initial height of the help window when it is opened with the
3813 ":help" command. The initial height of the help window is half of the
3814 current window, or (when the 'ea' option is on) the same as other
3815 windows. When the height is less than 'helpheight', the height is
3816 set to 'helpheight'. Set to zero to disable.
3817
3818 *'helplang'* *'hlg'*
3819'helplang' 'hlg' string (default: messages language or empty)
3820 global
3821 {only available when compiled with the |+multi_lang|
3822 feature}
3823 {not in Vi}
3824 Comma separated list of languages. Vim will use the first language
3825 for which the desired help can be found. The English help will always
3826 be used as a last resort. You can add "en" to prefer English over
3827 another language, but that will only find tags that exist in that
3828 language and not in the English help.
3829 Example: >
3830 :set helplang=de,it
3831< This will first search German, then Italian and finally English help
3832 files.
3833 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3834 try to find the tag in the current language before using this option.
3835 See |help-translated|.
3836
3837 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3838'hidden' 'hid' boolean (default off)
3839 global
3840 {not in Vi}
3841 When off a buffer is unloaded when it is |abandon|ed. When on a
3842 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3843 displayed in another window, it does not become hidden, of course.
3844 The commands that move through the buffer list sometimes make a buffer
3845 hidden although the 'hidden' option is off: When the buffer is
3846 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003847 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003848 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 This option is set for one command with ":hide {command}" |:hide|.
3850 WARNING: It's easy to forget that you have changes in hidden buffers.
3851 Think twice when using ":q!" or ":qa!".
3852
3853 *'highlight'* *'hl'*
3854'highlight' 'hl' string (default (as a single string):
3855 "8:SpecialKey,@:NonText,d:Directory,
3856 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003857 M:ModeMsg,n:LineNr,N:CursorLineNr,
3858 r:Question,s:StatusLine,S:StatusLineNC,
3859 c:VertSplit, t:Title,v:Visual,
3860 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 f:Folded,F:FoldColumn,A:DiffAdd,
3862 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003863 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003864 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003865 +:Pmenu,=:PmenuSel,
3866 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 global
3868 {not in Vi}
3869 This option can be used to set highlighting mode for various
3870 occasions. It is a comma separated list of character pairs. The
3871 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003872 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3874 |hl-NonText| @ '~' and '@' at the end of the window and
3875 characters from 'showbreak'
3876 |hl-Directory| d directories in CTRL-D listing and other special
3877 things in listings
3878 |hl-ErrorMsg| e error messages
3879 h (obsolete, ignored)
3880 |hl-IncSearch| i 'incsearch' highlighting
3881 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3882 |hl-MoreMsg| m |more-prompt|
3883 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003884 |hl-LineNr| n line number for ":number" and ":#" commands, and
3885 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003886 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3887 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 |hl-Question| r |hit-enter| prompt and yes/no questions
3889 |hl-StatusLine| s status line of current window |status-line|
3890 |hl-StatusLineNC| S status lines of not-current windows
3891 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3892 |hl-VertSplit| c column used to separate vertically split windows
3893 |hl-Visual| v Visual mode
3894 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3895 Selection" Only X11 Gui's |gui-x11| and
3896 |xterm-clipboard|.
3897 |hl-WarningMsg| w warning messages
3898 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3899 |hl-Folded| f line used for closed folds
3900 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003901 |hl-DiffAdd| A added line in diff mode
3902 |hl-DiffChange| C changed line in diff mode
3903 |hl-DiffDelete| D deleted line in diff mode
3904 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003906 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003907 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003908 |hl-SpellRare| R rare word |spell|
3909 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003910 |hl-Conceal| - the placeholders used for concealed characters
3911 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003912 |hl-Pmenu| + popup menu normal line
3913 |hl-PmenuSel| = popup menu normal line
3914 |hl-PmenuSbar| x popup menu scrollbar
3915 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916
3917 The display modes are:
3918 r reverse (termcap entry "mr" and "me")
3919 i italic (termcap entry "ZH" and "ZR")
3920 b bold (termcap entry "md" and "me")
3921 s standout (termcap entry "so" and "se")
3922 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003923 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 n no highlighting
3925 - no highlighting
3926 : use a highlight group
3927 The default is used for occasions that are not included.
3928 If you want to change what the display modes do, see |dos-colors|
3929 for an example.
3930 When using the ':' display mode, this must be followed by the name of
3931 a highlight group. A highlight group can be used to define any type
3932 of highlighting, including using color. See |:highlight| on how to
3933 define one. The default uses a different group for each occasion.
3934 See |highlight-default| for the default highlight groups.
3935
3936 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3937'hlsearch' 'hls' boolean (default off)
3938 global
3939 {not in Vi}
3940 {not available when compiled without the
3941 |+extra_search| feature}
3942 When there is a previous search pattern, highlight all its matches.
3943 The type of highlighting used can be set with the 'l' occasion in the
3944 'highlight' option. This uses the "Search" highlight group by
3945 default. Note that only the matching text is highlighted, any offsets
3946 are not applied.
3947 See also: 'incsearch' and |:match|.
3948 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003949 off with |:nohlsearch|. This does not change the option value, as
3950 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003951 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 When the search pattern can match an end-of-line, Vim will try to
3953 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003954 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003956 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003957 You can specify whether the highlight status is restored on startup
3958 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 NOTE: This option is reset when 'compatible' is set.
3960
3961 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003962'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 global
3964 {not in Vi}
3965 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003966 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003968 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003969 NOTE: This option is set to the Vi default value when 'compatible' is
3970 set and to the Vim default value when 'compatible' is reset.
3971
3972 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3973'hkmap' 'hk' boolean (default off)
3974 global
3975 {not in Vi}
3976 {only available when compiled with the |+rightleft|
3977 feature}
3978 When on, the keyboard is mapped for the Hebrew character set.
3979 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3980 toggle this option. See |rileft.txt|.
3981 NOTE: This option is reset when 'compatible' is set.
3982
3983 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3984'hkmapp' 'hkp' boolean (default off)
3985 global
3986 {not in Vi}
3987 {only available when compiled with the |+rightleft|
3988 feature}
3989 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3990 This is useful if you have a non-Hebrew keyboard.
3991 See |rileft.txt|.
3992 NOTE: This option is reset when 'compatible' is set.
3993
3994 *'icon'* *'noicon'*
3995'icon' boolean (default off, on when title can be restored)
3996 global
3997 {not in Vi}
3998 {not available when compiled without the |+title|
3999 feature}
4000 When on, the icon text of the window will be set to the value of
4001 'iconstring' (if it is not empty), or to the name of the file
4002 currently being edited. Only the last part of the name is used.
4003 Overridden by the 'iconstring' option.
4004 Only works if the terminal supports setting window icons (currently
4005 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4006 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4007 builtin termcap).
4008 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004009 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004011 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012
4013 *'iconstring'*
4014'iconstring' string (default "")
4015 global
4016 {not in Vi}
4017 {not available when compiled without the |+title|
4018 feature}
4019 When this option is not empty, it will be used for the icon text of
4020 the window. This happens only when the 'icon' option is on.
4021 Only works if the terminal supports setting window icon text
4022 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4023 Does not work for MS Windows.
4024 When Vim was compiled with HAVE_X11 defined, the original icon will be
4025 restored if possible |X11|.
4026 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004027 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 'titlestring' for example settings.
4029 {not available when compiled without the |+statusline| feature}
4030
4031 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4032'ignorecase' 'ic' boolean (default off)
4033 global
4034 Ignore case in search patterns. Also used when searching in the tags
4035 file.
4036 Also see 'smartcase'.
4037 Can be overruled by using "\c" or "\C" in the pattern, see
4038 |/ignorecase|.
4039
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004040 *'imactivatefunc'* *'imaf'*
4041'imactivatefunc' 'imaf' string (default "")
4042 global
4043 {not in Vi}
4044 {only available when compiled with |+xim| and
4045 |+GUI_GTK|}
4046 This option specifies a function that will be called to
4047 activate/inactivate Input Method.
4048
4049 Example: >
4050 function ImActivateFunc(active)
4051 if a:active
4052 ... do something
4053 else
4054 ... do something
4055 endif
4056 " return value is not used
4057 endfunction
4058 set imactivatefunc=ImActivateFunc
4059<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 *'imactivatekey'* *'imak'*
4061'imactivatekey' 'imak' string (default "")
4062 global
4063 {not in Vi}
4064 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004065 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 Specifies the key that your Input Method in X-Windows uses for
4067 activation. When this is specified correctly, vim can fully control
4068 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4069 You can't use this option to change the activation key, the option
4070 tells Vim what the key is.
4071 Format:
4072 [MODIFIER_FLAG-]KEY_STRING
4073
4074 These characters can be used for MODIFIER_FLAG (case is ignored):
4075 S Shift key
4076 L Lock key
4077 C Control key
4078 1 Mod1 key
4079 2 Mod2 key
4080 3 Mod3 key
4081 4 Mod4 key
4082 5 Mod5 key
4083 Combinations are allowed, for example "S-C-space" or "SC-space" are
4084 both shift+ctrl+space.
4085 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4086
4087 Example: >
4088 :set imactivatekey=S-space
4089< "S-space" means shift+space. This is the activation key for kinput2 +
4090 canna (Japanese), and ami (Korean).
4091
4092 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4093'imcmdline' 'imc' boolean (default off)
4094 global
4095 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004096 {only available when compiled with the |+xim|,
4097 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 When set the Input Method is always on when starting to edit a command
4099 line, unless entering a search pattern (see 'imsearch' for that).
4100 Setting this option is useful when your input method allows entering
4101 English characters directly, e.g., when it's used to type accented
4102 characters with dead keys.
4103
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004104 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4106 global
4107 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004108 {only available when compiled with the |+xim|,
4109 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 When set the Input Method is never used. This is useful to disable
4111 the IM when it doesn't work properly.
4112 Currently this option is on by default for SGI/IRIX machines. This
4113 may change in later releases.
4114
4115 *'iminsert'* *'imi'*
4116'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4117 local to buffer
4118 {not in Vi}
4119 Specifies whether :lmap or an Input Method (IM) is to be used in
4120 Insert mode. Valid values:
4121 0 :lmap is off and IM is off
4122 1 :lmap is ON and IM is off
4123 2 :lmap is off and IM is ON
4124 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4125 or |global-ime|.
4126 To always reset the option to zero when leaving Insert mode with <Esc>
4127 this can be used: >
4128 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4129< This makes :lmap and IM turn off automatically when leaving Insert
4130 mode.
4131 Note that this option changes when using CTRL-^ in Insert mode
4132 |i_CTRL-^|.
4133 The value is set to 1 when setting 'keymap' to a valid keymap name.
4134 It is also used for the argument of commands like "r" and "f".
4135 The value 0 may not work correctly with Athena and Motif with some XIM
4136 methods. Use 'imdisable' to disable XIM then.
4137
4138 *'imsearch'* *'ims'*
4139'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4140 local to buffer
4141 {not in Vi}
4142 Specifies whether :lmap or an Input Method (IM) is to be used when
4143 entering a search pattern. Valid values:
4144 -1 the value of 'iminsert' is used, makes it look like
4145 'iminsert' is also used when typing a search pattern
4146 0 :lmap is off and IM is off
4147 1 :lmap is ON and IM is off
4148 2 :lmap is off and IM is ON
4149 Note that this option changes when using CTRL-^ in Command-line mode
4150 |c_CTRL-^|.
4151 The value is set to 1 when it is not -1 and setting the 'keymap'
4152 option to a valid keymap name.
4153 The value 0 may not work correctly with Athena and Motif with some XIM
4154 methods. Use 'imdisable' to disable XIM then.
4155
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004156 *'imstatusfunc'* *'imsf'*
4157'imstatusfunc' 'imsf' string (default "")
4158 global
4159 {not in Vi}
4160 {only available when compiled with |+xim| and
4161 |+GUI_GTK|}
4162 This option specifies a function that is called to obtain the status
4163 of Input Method. It must return a positive number when IME is active.
4164
4165 Example: >
4166 function ImStatusFunc()
4167 let is_active = ...do something
4168 return is_active ? 1 : 0
4169 endfunction
4170 set imstatusfunc=ImStatusFunc
4171<
4172 NOTE: This function is invoked very often. Keep it fast.
4173
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 *'include'* *'inc'*
4175'include' 'inc' string (default "^\s*#\s*include")
4176 global or local to buffer |global-local|
4177 {not in Vi}
4178 {not available when compiled without the
4179 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004180 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 pattern, just like for the "/" command (See |pattern|). The default
4182 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004183 "]I", "[d", etc.
4184 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004185 comes after the matched pattern. But if "\zs" appears in the pattern
4186 then the text matched from "\zs" to the end, or until "\ze" if it
4187 appears, is used as the file name. Use this to include characters
4188 that are not in 'isfname', such as a space. You can then use
4189 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004190 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
4192 *'includeexpr'* *'inex'*
4193'includeexpr' 'inex' string (default "")
4194 local to buffer
4195 {not in Vi}
4196 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004197 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004199 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 :set includeexpr=substitute(v:fname,'\\.','/','g')
4201< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004202
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004204 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 Also used for |<cfile>|.
4206
Bram Moolenaar30b65812012-07-12 22:01:11 +02004207 The expression will be evaluated in the |sandbox| when set from a
4208 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004209
4210 It is not allowed to change text or jump to another window while
4211 evaluating 'includeexpr' |textlock|.
4212
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4214'incsearch' 'is' boolean (default off)
4215 global
4216 {not in Vi}
4217 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004218 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004219 While typing a search command, show where the pattern, as it was typed
4220 so far, matches. The matched string is highlighted. If the pattern
4221 is invalid or not found, nothing is shown. The screen will be updated
4222 often, this is only useful on fast terminals.
4223 Note that the match will be shown, but the cursor will return to its
4224 original position when no match is found and when pressing <Esc>. You
4225 still need to finish the search command with <Enter> to move the
4226 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004227 When compiled with the |+reltime| feature Vim only searches for about
4228 half a second. With a complicated pattern and/or a lot of text the
4229 match may not be found. This is to avoid that Vim hangs while you
4230 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004231 The highlighting can be set with the 'i' flag in 'highlight'.
4232 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004233 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004234 to the command line. If 'ignorecase' and 'smartcase' are set and the
4235 command line has no uppercase characters, the added character is
4236 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004237 CTRL-R CTRL-W can be used to add the word at the end of the current
4238 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 NOTE: This option is reset when 'compatible' is set.
4240
4241 *'indentexpr'* *'inde'*
4242'indentexpr' 'inde' string (default "")
4243 local to buffer
4244 {not in Vi}
4245 {not available when compiled without the |+cindent|
4246 or |+eval| features}
4247 Expression which is evaluated to obtain the proper indent for a line.
4248 It is used when a new line is created, for the |=| operator and
4249 in Insert mode as specified with the 'indentkeys' option.
4250 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004251 'smartindent' indenting. When 'lisp' is set, this option is
4252 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 When 'paste' is set this option is not used for indenting.
4254 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004255 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 when the expression is evaluated (but it may be moved around).
4257 The expression must return the number of spaces worth of indent. It
4258 can return "-1" to keep the current indent (this means 'autoindent' is
4259 used for the indent).
4260 Functions useful for computing the indent are |indent()|, |cindent()|
4261 and |lispindent()|.
4262 The evaluation of the expression must not have side effects! It must
4263 not change the text, jump to another window, etc. Afterwards the
4264 cursor position is always restored, thus the cursor may be moved.
4265 Normally this option would be set to call a function: >
4266 :set indentexpr=GetMyIndent()
4267< Error messages will be suppressed, unless the 'debug' option contains
4268 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004269 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 NOTE: This option is made empty when 'compatible' is set.
4271
Bram Moolenaar30b65812012-07-12 22:01:11 +02004272 The expression will be evaluated in the |sandbox| when set from a
4273 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004274
4275 It is not allowed to change text or jump to another window while
4276 evaluating 'indentexpr' |textlock|.
4277
4278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 *'indentkeys'* *'indk'*
4280'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4281 local to buffer
4282 {not in Vi}
4283 {not available when compiled without the |+cindent|
4284 feature}
4285 A list of keys that, when typed in Insert mode, cause reindenting of
4286 the current line. Only happens if 'indentexpr' isn't empty.
4287 The format is identical to 'cinkeys', see |indentkeys-format|.
4288 See |C-indenting| and |indent-expression|.
4289
4290 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4291'infercase' 'inf' boolean (default off)
4292 local to buffer
4293 {not in Vi}
4294 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004295 'ignorecase' is also on, the case of the match is adjusted depending
4296 on the typed text. If the typed text contains a lowercase letter
4297 where the match has an upper case letter, the completed part is made
4298 lowercase. If the typed text has no lowercase letters and the match
4299 has a lowercase letter where the typed text has an uppercase letter,
4300 and there is a letter before it, the completed part is made uppercase.
4301 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302
4303 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4304'insertmode' 'im' boolean (default off)
4305 global
4306 {not in Vi}
4307 Makes Vim work in a way that Insert mode is the default mode. Useful
4308 if you want to use Vim as a modeless editor. Used for |evim|.
4309 These Insert mode commands will be useful:
4310 - Use the cursor keys to move around.
4311 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4312 this is a mapping, it is executed as if 'insertmode' was off.
4313 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004315 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4316 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004317
4318 These items change when 'insertmode' is set:
4319 - when starting to edit of a file, Vim goes to Insert mode.
4320 - <Esc> in Insert mode is a no-op and beeps.
4321 - <Esc> in Normal mode makes Vim go to Insert mode.
4322 - CTRL-L in Insert mode is a command, it is not inserted.
4323 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4324 However, when <Esc> is used inside a mapping, it behaves like
4325 'insertmode' was not set. This was done to be able to use the same
4326 mappings with 'insertmode' set or not set.
4327 When executing commands with |:normal| 'insertmode' is not used.
4328
4329 NOTE: This option is reset when 'compatible' is set.
4330
4331 *'isfname'* *'isf'*
4332'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4333 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4334 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4335 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4336 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4337 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4338 global
4339 {not in Vi}
4340 The characters specified by this option are included in file names and
4341 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004342 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 Multi-byte characters 256 and above are always included, only the
4344 characters up to 255 are specified with this option.
4345 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004346 Think twice before adding white space to this option. Although a
4347 space may appear inside a file name, the effect will be that Vim
4348 doesn't know where a file name starts or ends when doing completion.
4349 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350
4351 Note that on systems using a backslash as path separator, Vim tries to
4352 do its best to make it work as you would expect. That is a bit
4353 tricky, since Vi originally used the backslash to escape special
4354 characters. Vim will not remove a backslash in front of a normal file
4355 name character on these systems, but it will on Unix and alikes. The
4356 '&' and '^' are not included by default, because these are special for
4357 cmd.exe.
4358
4359 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004360 Each part can be a single character number or a range. A range is two
4361 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 decimal number between 0 and 255 or the ASCII character itself (does
4363 not work for digits). Example:
4364 "_,-,128-140,#-43" (include '_' and '-' and the range
4365 128 to 140 and '#' to 43)
4366 If a part starts with '^', the following character number or range
4367 will be excluded from the option. The option is interpreted from left
4368 to right. Put the excluded character after the range where it is
4369 included. To include '^' itself use it as the last character of the
4370 option or the end of a range. Example:
4371 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4372 If the character is '@', all characters where isalpha() returns TRUE
4373 are included. Normally these are the characters a to z and A to Z,
4374 plus accented characters. To include '@' itself use "@-@". Examples:
4375 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004376 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 "a-z,A-Z,@-@" All letters plus the '@' character.
4378 A comma can be included by using it where a character number is
4379 expected. Example:
4380 "48-57,,,_" Digits, comma and underscore.
4381 A comma can be excluded by prepending a '^'. Example:
4382 " -~,^,,9" All characters from space to '~', excluding
4383 comma, plus <Tab>.
4384 See |option-backslash| about including spaces and backslashes.
4385
4386 *'isident'* *'isi'*
4387'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4388 "@,48-57,_,128-167,224-235"
4389 otherwise: "@,48-57,_,192-255")
4390 global
4391 {not in Vi}
4392 The characters given by this option are included in identifiers.
4393 Identifiers are used in recognizing environment variables and after a
4394 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004395 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 option.
4397 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004398 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4400
4401 *'iskeyword'* *'isk'*
4402'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4403 "@,48-57,_,128-167,224-235"
4404 otherwise: "@,48-57,_,192-255"
4405 Vi default: "@,48-57,_")
4406 local to buffer
4407 {not in Vi}
4408 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 'isfname' for a description of the format of this option. For C
4411 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4412 For a help file it is set to all non-blank printable characters except
4413 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4414 command).
4415 When the 'lisp' option is on the '-' character is always included.
4416 NOTE: This option is set to the Vi default value when 'compatible' is
4417 set and to the Vim default value when 'compatible' is reset.
4418
4419 *'isprint'* *'isp'*
4420'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4421 "@,~-255"; otherwise: "@,161-255")
4422 global
4423 {not in Vi}
4424 The characters given by this option are displayed directly on the
4425 screen. It is also used for "\p" in a |pattern|. The characters from
4426 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4427 even when they are not included in 'isprint' or excluded. See
4428 'isfname' for a description of the format of this option.
4429
4430 Non-printable characters are displayed with two characters:
4431 0 - 31 "^@" - "^_"
4432 32 - 126 always single characters
4433 127 "^?"
4434 128 - 159 "~@" - "~_"
4435 160 - 254 "| " - "|~"
4436 255 "~?"
4437 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4438 displayed as <xx>, with the hexadecimal value of the byte.
4439 When 'display' contains "uhex" all unprintable characters are
4440 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004441 The SpecialKey highlighting will be used for unprintable characters.
4442 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
4444 Multi-byte characters 256 and above are always included, only the
4445 characters up to 255 are specified with this option. When a character
4446 is printable but it is not available in the current font, a
4447 replacement character will be shown.
4448 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4449 There is no option to specify these characters.
4450
4451 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4452'joinspaces' 'js' boolean (default on)
4453 global
4454 {not in Vi}
4455 Insert two spaces after a '.', '?' and '!' with a join command.
4456 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4457 Otherwise only one space is inserted.
4458 NOTE: This option is set when 'compatible' is set.
4459
4460 *'key'*
4461'key' string (default "")
4462 local to buffer
4463 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004464 {only available when compiled with the |+cryptv|
4465 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004467 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 Careful: Do not set the key value by hand, someone might see the typed
4469 key. Use the |:X| command. But you can make 'key' empty: >
4470 :set key=
4471< It is not possible to get the value of this option with ":set key" or
4472 "echo &key". This is to avoid showing it to someone who shouldn't
4473 know. It also means you cannot see it yourself once you have set it,
4474 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004475 You can use "&key" in an expression to detect whether encryption is
4476 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477
4478 *'keymap'* *'kmp'* *E544*
4479'keymap' 'kmp' string (default "")
4480 local to buffer
4481 {not in Vi}
4482 {only available when compiled with the |+keymap|
4483 feature}
4484 Name of a keyboard mapping. See |mbyte-keymap|.
4485 Setting this option to a valid keymap name has the side effect of
4486 setting 'iminsert' to one, so that the keymap becomes effective.
4487 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004488 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 *'keymodel'* *'km'*
4491'keymodel' 'km' string (default "")
4492 global
4493 {not in Vi}
4494 List of comma separated words, which enable special things that keys
4495 can do. These values can be used:
4496 startsel Using a shifted special key starts selection (either
4497 Select mode or Visual mode, depending on "key" being
4498 present in 'selectmode').
4499 stopsel Using a not-shifted special key stops selection.
4500 Special keys in this context are the cursor keys, <End>, <Home>,
4501 <PageUp> and <PageDown>.
4502 The 'keymodel' option is set by the |:behave| command.
4503
4504 *'keywordprg'* *'kp'*
4505'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4506 OS/2: "view /", VMS: "help")
4507 global or local to buffer |global-local|
4508 {not in Vi}
4509 Program to use for the |K| command. Environment variables are
4510 expanded |:set_env|. ":help" may be used to access the Vim internal
4511 help. (Note that previously setting the global option to the empty
4512 value did this, which is now deprecated.)
4513 When "man" is used, Vim will automatically translate a count for the
4514 "K" command to a section number. Also for "man -s", in which case the
4515 "-s" is removed when there is no count.
4516 See |option-backslash| about including spaces and backslashes.
4517 Example: >
4518 :set keywordprg=man\ -s
4519< This option cannot be set from a |modeline| or in the |sandbox|, for
4520 security reasons.
4521
4522 *'langmap'* *'lmap'* *E357* *E358*
4523'langmap' 'lmap' string (default "")
4524 global
4525 {not in Vi}
4526 {only available when compiled with the |+langmap|
4527 feature}
4528 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004529 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 inserted directly. When in command mode the 'langmap' option takes
4531 care of translating these special characters to the original meaning
4532 of the key. This means you don't have to change the keyboard mode to
4533 be able to execute Normal mode commands.
4534 This is the opposite of the 'keymap' option, where characters are
4535 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004536 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4537 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004538 This option cannot be set from a |modeline| or in the |sandbox|, for
4539 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004541 Example (for Greek, in UTF-8): *greek* >
4542 :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 +00004543< Example (exchanges meaning of z and y for commands): >
4544 :set langmap=zy,yz,ZY,YZ
4545<
4546 The 'langmap' option is a list of parts, separated with commas. Each
4547 part can be in one of two forms:
4548 1. A list of pairs. Each pair is a "from" character immediately
4549 followed by the "to" character. Examples: "aA", "aAbBcC".
4550 2. A list of "from" characters, a semi-colon and a list of "to"
4551 characters. Example: "abc;ABC"
4552 Example: "aA,fgh;FGH,cCdDeE"
4553 Special characters need to be preceded with a backslash. These are
4554 ";", ',' and backslash itself.
4555
4556 This will allow you to activate vim actions without having to switch
4557 back and forth between the languages. Your language characters will
4558 be understood as normal vim English characters (according to the
4559 langmap mappings) in the following cases:
4560 o Normal/Visual mode (commands, buffer/register names, user mappings)
4561 o Insert/Replace Mode: Register names after CTRL-R
4562 o Insert/Replace Mode: Mappings
4563 Characters entered in Command-line mode will NOT be affected by
4564 this option. Note that this option can be changed at any time
4565 allowing to switch between mappings for different languages/encodings.
4566 Use a mapping to avoid having to type it each time!
4567
4568 *'langmenu'* *'lm'*
4569'langmenu' 'lm' string (default "")
4570 global
4571 {not in Vi}
4572 {only available when compiled with the |+menu| and
4573 |+multi_lang| features}
4574 Language to use for menu translation. Tells which file is loaded
4575 from the "lang" directory in 'runtimepath': >
4576 "lang/menu_" . &langmenu . ".vim"
4577< (without the spaces). For example, to always use the Dutch menus, no
4578 matter what $LANG is set to: >
4579 :set langmenu=nl_NL.ISO_8859-1
4580< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004581 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 If your $LANG is set to a non-English language but you do want to use
4583 the English menus: >
4584 :set langmenu=none
4585< This option must be set before loading menus, switching on filetype
4586 detection or syntax highlighting. Once the menus are defined setting
4587 this option has no effect. But you could do this: >
4588 :source $VIMRUNTIME/delmenu.vim
4589 :set langmenu=de_DE.ISO_8859-1
4590 :source $VIMRUNTIME/menu.vim
4591< Warning: This deletes all menus that you defined yourself!
4592
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004593 *'langnoremap'* *'lnr'*
4594'langnoremap' 'lnr' boolean (default off)
4595 global
4596 {not in Vi}
4597 {only available when compiled with the |+langmap|
4598 feature}
4599 When on, setting 'langmap' does not apply to characters resulting from
4600 a mapping. This basically means, if you noticed that setting
4601 'langmap' disables some of your mappings, try setting this option.
4602 This option defaults to off for backwards compatibility. Set it on if
4603 that works for you to avoid mappings to break.
4604
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 *'laststatus'* *'ls'*
4606'laststatus' 'ls' number (default 1)
4607 global
4608 {not in Vi}
4609 The value of this option influences when the last window will have a
4610 status line:
4611 0: never
4612 1: only if there are at least two windows
4613 2: always
4614 The screen looks nicer with a status line if you have several
4615 windows, but it takes another screen line. |status-line|
4616
4617 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4618'lazyredraw' 'lz' boolean (default off)
4619 global
4620 {not in Vi}
4621 When this option is set, the screen will not be redrawn while
4622 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004623 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 update use |:redraw|.
4625
4626 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4627'linebreak' 'lbr' boolean (default off)
4628 local to window
4629 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004630 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004632 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 than at the last character that fits on the screen. Unlike
4634 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004635 it only affects the way the file is displayed, not its contents.
4636 If 'breakindent' is set, line is visually indented. Then, the value
4637 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004638 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 Note that <Tab> characters after an <EOL> are mostly not displayed
4640 with the right amount of white space.
4641
4642 *'lines'* *E593*
4643'lines' number (default 24 or terminal height)
4644 global
4645 Number of lines of the Vim window.
4646 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004647 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 When Vim is running in the GUI or in a resizable window, setting this
4649 option will cause the window size to be changed. When you only want
4650 to use the size for the GUI, put the command in your |gvimrc| file.
4651 Vim limits the number of lines to what fits on the screen. You can
4652 use this command to get the tallest window possible: >
4653 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004654< Minimum value is 2, maximum value is 1000.
4655 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 When you set this option and Vim is unable to change the physical
4657 number of lines of the display, the display may be messed up.
4658
4659 *'linespace'* *'lsp'*
4660'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4661 global
4662 {not in Vi}
4663 {only in the GUI}
4664 Number of pixel lines inserted between characters. Useful if the font
4665 uses the full character cell height, making lines touch each other.
4666 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004667 With some fonts there can be too much room between lines (to have
4668 space for ascents and descents). Then it makes sense to set
4669 'linespace' to a negative value. This may cause display problems
4670 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671
4672 *'lisp'* *'nolisp'*
4673'lisp' boolean (default off)
4674 local to buffer
4675 {not available when compiled without the |+lispindent|
4676 feature}
4677 Lisp mode: When <Enter> is typed in insert mode set the indent for
4678 the next line to Lisp standards (well, sort of). Also happens with
4679 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4680 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4681 better. Also see 'lispwords'.
4682 The '-' character is included in keyword characters. Redefines the
4683 "=" operator to use this same indentation algorithm rather than
4684 calling an external program if 'equalprg' is empty.
4685 This option is not used when 'paste' is set.
4686 {Vi: Does it a little bit differently}
4687
4688 *'lispwords'* *'lw'*
4689'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004690 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 {not in Vi}
4692 {not available when compiled without the |+lispindent|
4693 feature}
4694 Comma separated list of words that influence the Lisp indenting.
4695 |'lisp'|
4696
4697 *'list'* *'nolist'*
4698'list' boolean (default off)
4699 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004700 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4701 line. Useful to see the difference between tabs and spaces and for
4702 trailing blanks. Further changed by the 'listchars' option.
4703
4704 The cursor is displayed at the start of the space a Tab character
4705 occupies, not at the end as usual in Normal mode. To get this cursor
4706 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004707 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004708<
4709 Note that list mode will also affect formatting (set with 'textwidth'
4710 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 changing the way tabs are displayed.
4712
4713 *'listchars'* *'lcs'*
4714'listchars' 'lcs' string (default "eol:$")
4715 global
4716 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004717 Strings to use in 'list' mode and for the |:list| command. It is a
4718 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004719 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 eol:c Character to show at the end of each line. When
4721 omitted, there is no extra character at the end of the
4722 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004723 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004724 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004726 fill the space that the tab normally occupies.
4727 "tab:>-" will show a tab that takes four spaces as
4728 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004729 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004730 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004732 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 extends:c Character to show in the last column, when 'wrap' is
4734 off and the line continues beyond the right of the
4735 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004736 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 precedes:c Character to show in the first column, when 'wrap'
4738 is off and there is text preceding the character
4739 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004740 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004741 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004742 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004743 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004744 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004745 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004746
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004747 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004749 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750
4751 Examples: >
4752 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004753 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 :set lcs=extends:>,precedes:<
4755< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004756 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004757 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758
4759 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4760'loadplugins' 'lpl' boolean (default on)
4761 global
4762 {not in Vi}
4763 When on the plugin scripts are loaded when starting up |load-plugins|.
4764 This option can be reset in your |vimrc| file to disable the loading
4765 of plugins.
4766 Note that using the "-u NONE" and "--noplugin" command line arguments
4767 reset this option. |-u| |--noplugin|
4768
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004769 *'macatsui'* *'nomacatsui'*
4770'macatsui' boolean (default on)
4771 global
4772 {only available in Mac GUI version}
4773 This is a workaround for when drawing doesn't work properly. When set
4774 and compiled with multi-byte support ATSUI text drawing is used. When
4775 not set ATSUI text drawing is not used. Switch this option off when
4776 you experience drawing problems. In a future version the problems may
4777 be solved and this option becomes obsolete. Therefore use this method
4778 to unset it: >
4779 if exists('&macatsui')
4780 set nomacatsui
4781 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004782< Another option to check if you have drawing problems is
4783 'termencoding'.
4784
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785 *'magic'* *'nomagic'*
4786'magic' boolean (default on)
4787 global
4788 Changes the special characters that can be used in search patterns.
4789 See |pattern|.
4790 NOTE: To avoid portability problems with using patterns, always keep
4791 this option at the default "on". Only switch it off when working with
4792 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004793 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794
4795 *'makeef'* *'mef'*
4796'makeef' 'mef' string (default: "")
4797 global
4798 {not in Vi}
4799 {not available when compiled without the |+quickfix|
4800 feature}
4801 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4802 and the |:grep| command.
4803 When it is empty, an internally generated temp file will be used.
4804 When "##" is included, it is replaced by a number to make the name
4805 unique. This makes sure that the ":make" command doesn't overwrite an
4806 existing file.
4807 NOT used for the ":cf" command. See 'errorfile' for that.
4808 Environment variables are expanded |:set_env|.
4809 See |option-backslash| about including spaces and backslashes.
4810 This option cannot be set from a |modeline| or in the |sandbox|, for
4811 security reasons.
4812
4813 *'makeprg'* *'mp'*
4814'makeprg' 'mp' string (default "make", VMS: "MMS")
4815 global or local to buffer |global-local|
4816 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004817 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004818 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4819 which are expanded to the current and alternate file name. Use |::S|
4820 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004821 Environment variables are expanded |:set_env|. See |option-backslash|
4822 about including spaces and backslashes.
4823 Note that a '|' must be escaped twice: once for ":set" and once for
4824 the interpretation of a command. When you use a filter called
4825 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 :set makeprg=gmake\ \\\|\ myfilter
4827< The placeholder "$*" can be given (even multiple times) to specify
4828 where the arguments will be included, for example: >
4829 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4830< This option cannot be set from a |modeline| or in the |sandbox|, for
4831 security reasons.
4832
4833 *'matchpairs'* *'mps'*
4834'matchpairs' 'mps' string (default "(:),{:},[:]")
4835 local to buffer
4836 {not in Vi}
4837 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004838 other.
4839 Only character pairs are allowed that are different, thus you cannot
4840 jump between two double quotes.
4841 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004842 The pairs must be separated by a comma. Example for including '<' and
4843 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844 :set mps+=<:>
4845
4846< A more exotic example, to jump between the '=' and ';' in an
4847 assignment, useful for languages like C and Java: >
4848 :au FileType c,cpp,java set mps+==:;
4849
4850< For a more advanced way of using "%", see the matchit.vim plugin in
4851 the $VIMRUNTIME/macros directory. |add-local-help|
4852
4853 *'matchtime'* *'mat'*
4854'matchtime' 'mat' number (default 5)
4855 global
4856 {not in Vi}{in Nvi}
4857 Tenths of a second to show the matching paren, when 'showmatch' is
4858 set. Note that this is not in milliseconds, like other options that
4859 set a time. This is to be compatible with Nvi.
4860
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004861 *'maxcombine'* *'mco'*
4862'maxcombine' 'mco' number (default 2)
4863 global
4864 {not in Vi}
4865 {only available when compiled with the |+multi_byte|
4866 feature}
4867 The maximum number of combining characters supported for displaying.
4868 Only used when 'encoding' is "utf-8".
4869 The default is OK for most languages. Hebrew may require 4.
4870 Maximum value is 6.
4871 Even when this option is set to 2 you can still edit text with more
4872 combining characters, you just can't see them. Use |g8| or |ga|.
4873 See |mbyte-combining|.
4874
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 *'maxfuncdepth'* *'mfd'*
4876'maxfuncdepth' 'mfd' number (default 100)
4877 global
4878 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004879 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004880 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 Maximum depth of function calls for user functions. This normally
4882 catches endless recursion. When using a recursive function with
4883 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4884 more memory, there is the danger of failing when memory is exhausted.
4885 See also |:function|.
4886
4887 *'maxmapdepth'* *'mmd'* *E223*
4888'maxmapdepth' 'mmd' number (default 1000)
4889 global
4890 {not in Vi}
4891 Maximum number of times a mapping is done without resulting in a
4892 character to be used. This normally catches endless mappings, like
4893 ":map x y" with ":map y x". It still does not catch ":map g wg",
4894 because the 'w' is used before the next mapping is done. See also
4895 |key-mapping|.
4896
4897 *'maxmem'* *'mm'*
4898'maxmem' 'mm' number (default between 256 to 5120 (system
4899 dependent) or half the amount of memory
4900 available)
4901 global
4902 {not in Vi}
4903 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4904 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004905 other memory to be freed. The maximum usable value is about 2000000.
4906 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004908 *'maxmempattern'* *'mmp'*
4909'maxmempattern' 'mmp' number (default 1000)
4910 global
4911 {not in Vi}
4912 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004913 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004914 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004915 When Vim runs into the limit it gives an error message and mostly
4916 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004917 Running into the limit often means that the pattern is very
4918 inefficient or too complex. This may already happen with the pattern
4919 "\(.\)*" on a very long line. ".*" works much better.
4920 Vim may run out of memory before hitting the 'maxmempattern' limit.
4921
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 *'maxmemtot'* *'mmt'*
4923'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4924 dependent) or half the amount of memory
4925 available)
4926 global
4927 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004928 Maximum amount of memory in Kbyte to use for all buffers together.
4929 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4930 without a limit. On 64 bit machines higher values might work. But
4931 hey, do you really need more than 2 Gbyte for text editing?
4932 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
4934 *'menuitems'* *'mis'*
4935'menuitems' 'mis' number (default 25)
4936 global
4937 {not in Vi}
4938 {not available when compiled without the |+menu|
4939 feature}
4940 Maximum number of items to use in a menu. Used for menus that are
4941 generated from a list of items, e.g., the Buffers menu. Changing this
4942 option has no direct effect, the menu must be refreshed first.
4943
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004944 *'mkspellmem'* *'msm'*
4945'mkspellmem' 'msm' string (default "460000,2000,500")
4946 global
4947 {not in Vi}
4948 {not available when compiled without the |+syntax|
4949 feature}
4950 Parameters for |:mkspell|. This tunes when to start compressing the
4951 word tree. Compression can be slow when there are many words, but
4952 it's needed to avoid running out of memory. The amount of memory used
4953 per word depends very much on how similar the words are, that's why
4954 this tuning is complicated.
4955
4956 There are three numbers, separated by commas:
4957 {start},{inc},{added}
4958
4959 For most languages the uncompressed word tree fits in memory. {start}
4960 gives the amount of memory in Kbyte that can be used before any
4961 compression is done. It should be a bit smaller than the amount of
4962 memory that is available to Vim.
4963
4964 When going over the {start} limit the {inc} number specifies the
4965 amount of memory in Kbyte that can be allocated before another
4966 compression is done. A low number means compression is done after
4967 less words are added, which is slow. A high number means more memory
4968 will be allocated.
4969
4970 After doing compression, {added} times 1024 words can be added before
4971 the {inc} limit is ignored and compression is done when any extra
4972 amount of memory is needed. A low number means there is a smaller
4973 chance of hitting the {inc} limit, less memory is used but it's
4974 slower.
4975
4976 The languages for which these numbers are important are Italian and
4977 Hungarian. The default works for when you have about 512 Mbyte. If
4978 you have 1 Gbyte you could use: >
4979 :set mkspellmem=900000,3000,800
4980< If you have less than 512 Mbyte |:mkspell| may fail for some
4981 languages, no matter what you set 'mkspellmem' to.
4982
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004984'modeline' 'ml' boolean (Vim default: on (off for root),
4985 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 local to buffer
4987 *'modelines'* *'mls'*
4988'modelines' 'mls' number (default 5)
4989 global
4990 {not in Vi}
4991 If 'modeline' is on 'modelines' gives the number of lines that is
4992 checked for set commands. If 'modeline' is off or 'modelines' is zero
4993 no lines are checked. See |modeline|.
4994 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4995 set and to the Vim default value when 'compatible' is reset.
4996
4997 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4998'modifiable' 'ma' boolean (default on)
4999 local to buffer
5000 {not in Vi} *E21*
5001 When off the buffer contents cannot be changed. The 'fileformat' and
5002 'fileencoding' options also can't be changed.
5003 Can be reset with the |-M| command line argument.
5004
5005 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5006'modified' 'mod' boolean (default off)
5007 local to buffer
5008 {not in Vi}
5009 When on, the buffer is considered to be modified. This option is set
5010 when:
5011 1. A change was made to the text since it was last written. Using the
5012 |undo| command to go back to the original text will reset the
5013 option. But undoing changes that were made before writing the
5014 buffer will set the option again, since the text is different from
5015 when it was written.
5016 2. 'fileformat' or 'fileencoding' is different from its original
5017 value. The original value is set when the buffer is read or
5018 written. A ":set nomodified" command also resets the original
5019 values to the current values and the 'modified' option will be
5020 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005021 This option is not set when a change is made to the buffer as the
5022 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5023 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5024 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005025 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5026 will be ignored.
5027
5028 *'more'* *'nomore'*
5029'more' boolean (Vim default: on, Vi default: off)
5030 global
5031 {not in Vi}
5032 When on, listings pause when the whole screen is filled. You will get
5033 the |more-prompt|. When this option is off there are no pauses, the
5034 listing continues until finished.
5035 NOTE: This option is set to the Vi default value when 'compatible' is
5036 set and to the Vim default value when 'compatible' is reset.
5037
5038 *'mouse'* *E538*
5039'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5040 global
5041 {not in Vi}
5042 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005043 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5044 sysmouse and Linux console with gpm). For using the mouse in the
5045 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 The mouse can be enabled for different modes:
5047 n Normal mode
5048 v Visual mode
5049 i Insert mode
5050 c Command-line mode
5051 h all previous modes when editing a help file
5052 a all previous modes
5053 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 Normally you would enable the mouse in all four modes with: >
5055 :set mouse=a
5056< When the mouse is not enabled, the GUI will still use the mouse for
5057 modeless selection. This doesn't move the text cursor.
5058
5059 See |mouse-using|. Also see |'clipboard'|.
5060
5061 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005062 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 the mouse buttons can still be used by keeping the shift key pressed.
5064 Also see the 'clipboard' option.
5065
5066 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5067'mousefocus' 'mousef' boolean (default off)
5068 global
5069 {not in Vi}
5070 {only works in the GUI}
5071 The window that the mouse pointer is on is automatically activated.
5072 When changing the window layout or window focus in another way, the
5073 mouse pointer is moved to the window with keyboard focus. Off is the
5074 default because it makes using the pull down menus a little goofy, as
5075 a pointer transit may activate a window unintentionally.
5076
5077 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5078'mousehide' 'mh' boolean (default on)
5079 global
5080 {not in Vi}
5081 {only works in the GUI}
5082 When on, the mouse pointer is hidden when characters are typed.
5083 The mouse pointer is restored when the mouse is moved.
5084
5085 *'mousemodel'* *'mousem'*
5086'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5087 global
5088 {not in Vi}
5089 Sets the model to use for the mouse. The name mostly specifies what
5090 the right mouse button is used for:
5091 extend Right mouse button extends a selection. This works
5092 like in an xterm.
5093 popup Right mouse button pops up a menu. The shifted left
5094 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005095 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 popup_setpos Like "popup", but the cursor will be moved to the
5097 position where the mouse was clicked, and thus the
5098 selected operation will act upon the clicked object.
5099 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005100 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 course, that right clicking outside a selection will
5102 end Visual mode.
5103 Overview of what button does what for each model:
5104 mouse extend popup(_setpos) ~
5105 left click place cursor place cursor
5106 left drag start selection start selection
5107 shift-left search word extend selection
5108 right click extend selection popup menu (place cursor)
5109 right drag extend selection -
5110 middle click paste paste
5111
5112 In the "popup" model the right mouse button produces a pop-up menu.
5113 You need to define this first, see |popup-menu|.
5114
5115 Note that you can further refine the meaning of buttons with mappings.
5116 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5117 selection (because that's handled in the GUI code directly).
5118
5119 The 'mousemodel' option is set by the |:behave| command.
5120
5121 *'mouseshape'* *'mouses'* *E547*
5122'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005123 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 global
5125 {not in Vi}
5126 {only available when compiled with the |+mouseshape|
5127 feature}
5128 This option tells Vim what the mouse pointer should look like in
5129 different modes. The option is a comma separated list of parts, much
5130 like used for 'guicursor'. Each part consist of a mode/location-list
5131 and an argument-list:
5132 mode-list:shape,mode-list:shape,..
5133 The mode-list is a dash separated list of these modes/locations:
5134 In a normal window: ~
5135 n Normal mode
5136 v Visual mode
5137 ve Visual mode with 'selection' "exclusive" (same as 'v',
5138 if not specified)
5139 o Operator-pending mode
5140 i Insert mode
5141 r Replace mode
5142
5143 Others: ~
5144 c appending to the command-line
5145 ci inserting in the command-line
5146 cr replacing in the command-line
5147 m at the 'Hit ENTER' or 'More' prompts
5148 ml idem, but cursor in the last line
5149 e any mode, pointer below last window
5150 s any mode, pointer on a status line
5151 sd any mode, while dragging a status line
5152 vs any mode, pointer on a vertical separator line
5153 vd any mode, while dragging a vertical separator line
5154 a everywhere
5155
5156 The shape is one of the following:
5157 avail name looks like ~
5158 w x arrow Normal mouse pointer
5159 w x blank no pointer at all (use with care!)
5160 w x beam I-beam
5161 w x updown up-down sizing arrows
5162 w x leftright left-right sizing arrows
5163 w x busy The system's usual busy pointer
5164 w x no The system's usual 'no input' pointer
5165 x udsizing indicates up-down resizing
5166 x lrsizing indicates left-right resizing
5167 x crosshair like a big thin +
5168 x hand1 black hand
5169 x hand2 white hand
5170 x pencil what you write with
5171 x question big ?
5172 x rightup-arrow arrow pointing right-up
5173 w x up-arrow arrow pointing up
5174 x <number> any X11 pointer number (see X11/cursorfont.h)
5175
5176 The "avail" column contains a 'w' if the shape is available for Win32,
5177 x for X11.
5178 Any modes not specified or shapes not available use the normal mouse
5179 pointer.
5180
5181 Example: >
5182 :set mouseshape=s:udsizing,m:no
5183< will make the mouse turn to a sizing arrow over the status lines and
5184 indicate no input when the hit-enter prompt is displayed (since
5185 clicking the mouse has no effect in this state.)
5186
5187 *'mousetime'* *'mouset'*
5188'mousetime' 'mouset' number (default 500)
5189 global
5190 {not in Vi}
5191 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5192 time in msec between two mouse clicks for the second click to be
5193 recognized as a multi click.
5194
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005195 *'mzquantum'* *'mzq'*
5196'mzquantum' 'mzq' number (default 100)
5197 global
5198 {not in Vi}
5199 {not available when compiled without the |+mzscheme|
5200 feature}
5201 The number of milliseconds between polls for MzScheme threads.
5202 Negative or zero value means no thread scheduling.
5203
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 *'nrformats'* *'nf'*
5205'nrformats' 'nf' string (default "octal,hex")
5206 local to buffer
5207 {not in Vi}
5208 This defines what bases Vim will consider for numbers when using the
5209 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5210 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005211 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005213 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005214 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005216 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 considered to be hexadecimal. Example: Using CTRL-X on
5218 "0x100" results in "0x0ff".
5219 Numbers which simply begin with a digit in the range 1-9 are always
5220 considered decimal. This also happens for numbers that are not
5221 recognized as octal or hex.
5222
5223 *'number'* *'nu'* *'nonumber'* *'nonu'*
5224'number' 'nu' boolean (default off)
5225 local to window
5226 Print the line number in front of each line. When the 'n' option is
5227 excluded from 'cpoptions' a wrapped line will not use the column of
5228 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005229 The 'numberwidth' option can be used to set the room used for the line
5230 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 When a long, wrapped line doesn't start with the first character, '-'
5232 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005233 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5234 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005235 *number_relativenumber*
5236 The 'relativenumber' option changes the displayed number to be
5237 relative to the cursor. Together with 'number' there are these
5238 four combinations (cursor in line 3):
5239
5240 'nonu' 'nu' 'nonu' 'nu'
5241 'nornu' 'nornu' 'rnu' 'rnu'
5242
5243 |apple | 1 apple | 2 apple | 2 apple
5244 |pear | 2 pear | 1 pear | 1 pear
5245 |nobody | 3 nobody | 0 nobody |3 nobody
5246 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005248 *'numberwidth'* *'nuw'*
5249'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5250 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005251 {not in Vi}
5252 {only available when compiled with the |+linebreak|
5253 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005254 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005255 when the 'number' or 'relativenumber' option is set or printing lines
5256 with a line number. Since one space is always between the number and
5257 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005258 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005259 fit the highest line number in the buffer respectively the number of
5260 rows in the window, depending on whether 'number' or 'relativenumber'
5261 is set. Thus with the Vim default of 4 there is room for a line number
5262 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005263 The minimum value is 1, the maximum value is 10.
5264 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5265
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005266 *'omnifunc'* *'ofu'*
5267'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005268 local to buffer
5269 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005270 {not available when compiled without the |+eval|
5271 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005272 This option specifies a function to be used for Insert mode omni
5273 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005274 See |complete-functions| for an explanation of how the function is
5275 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005276 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005277 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005278 This option cannot be set from a |modeline| or in the |sandbox|, for
5279 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005280
5281
Bram Moolenaar02467872007-05-06 13:22:01 +00005282 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005283'opendevice' 'odev' boolean (default off)
5284 global
5285 {not in Vi}
5286 {only for MS-DOS, MS-Windows and OS/2}
5287 Enable reading and writing from devices. This may get Vim stuck on a
5288 device that can be opened but doesn't actually do the I/O. Therefore
5289 it is off by default.
5290 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5291 result in editing a device.
5292
5293
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005294 *'operatorfunc'* *'opfunc'*
5295'operatorfunc' 'opfunc' string (default: empty)
5296 global
5297 {not in Vi}
5298 This option specifies a function to be called by the |g@| operator.
5299 See |:map-operator| for more info and an example.
5300
5301 This option cannot be set from a |modeline| or in the |sandbox|, for
5302 security reasons.
5303
5304
Bram Moolenaar251e1912011-06-19 05:09:16 +02005305 *'osfiletype'* *'oft'*
5306'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 local to buffer
5308 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005309 This option was supported on RISC OS, which has been removed.
5310
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311
5312 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005313'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 global
5315 Specifies the nroff macros that separate paragraphs. These are pairs
5316 of two letters (see |object-motions|).
5317
5318 *'paste'* *'nopaste'*
5319'paste' boolean (default off)
5320 global
5321 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005322 Put Vim in Paste mode. This is useful if you want to cut or copy
5323 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 unexpected effects.
5325 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005326 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327 knows about pasting and will mostly do the right thing without 'paste'
5328 being set. The same is true for a terminal where Vim handles the
5329 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005330 This option is reset when starting the GUI. Thus if you set it in
5331 your .vimrc it will work in a terminal, but not in the GUI. Setting
5332 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5333 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334 When the 'paste' option is switched on (also when it was already on):
5335 - mapping in Insert mode and Command-line mode is disabled
5336 - abbreviations are disabled
5337 - 'textwidth' is set to 0
5338 - 'wrapmargin' is set to 0
5339 - 'autoindent' is reset
5340 - 'smartindent' is reset
5341 - 'softtabstop' is set to 0
5342 - 'revins' is reset
5343 - 'ruler' is reset
5344 - 'showmatch' is reset
5345 - 'formatoptions' is used like it is empty
5346 These options keep their value, but their effect is disabled:
5347 - 'lisp'
5348 - 'indentexpr'
5349 - 'cindent'
5350 NOTE: When you start editing another file while the 'paste' option is
5351 on, settings from the modelines or autocommands may change the
5352 settings again, causing trouble when pasting text. You might want to
5353 set the 'paste' option again.
5354 When the 'paste' option is reset the mentioned options are restored to
5355 the value before the moment 'paste' was switched from off to on.
5356 Resetting 'paste' before ever setting it does not have any effect.
5357 Since mapping doesn't work while 'paste' is active, you need to use
5358 the 'pastetoggle' option to toggle the 'paste' option with some key.
5359
5360 *'pastetoggle'* *'pt'*
5361'pastetoggle' 'pt' string (default "")
5362 global
5363 {not in Vi}
5364 When non-empty, specifies the key sequence that toggles the 'paste'
5365 option. This is like specifying a mapping: >
5366 :map {keys} :set invpaste<CR>
5367< Where {keys} is the value of 'pastetoggle'.
5368 The difference is that it will work even when 'paste' is set.
5369 'pastetoggle' works in Insert mode and Normal mode, but not in
5370 Command-line mode.
5371 Mappings are checked first, thus overrule 'pastetoggle'. However,
5372 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5373 this: >
5374 :map <F10> :set paste<CR>
5375 :map <F11> :set nopaste<CR>
5376 :imap <F10> <C-O>:set paste<CR>
5377 :imap <F11> <nop>
5378 :set pastetoggle=<F11>
5379< This will make <F10> start paste mode and <F11> stop paste mode.
5380 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5381 mode everything is inserted literally, except the 'pastetoggle' key
5382 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005383 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384
5385 *'pex'* *'patchexpr'*
5386'patchexpr' 'pex' string (default "")
5387 global
5388 {not in Vi}
5389 {not available when compiled without the |+diff|
5390 feature}
5391 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005392 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
Bram Moolenaardbc28022014-07-26 13:40:44 +02005394 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395'patchmode' 'pm' string (default "")
5396 global
5397 {not in Vi}
5398 When non-empty the oldest version of a file is kept. This can be used
5399 to keep the original version of a file if you are changing files in a
5400 source distribution. Only the first time that a file is written a
5401 copy of the original file will be kept. The name of the copy is the
5402 name of the original file with the string in the 'patchmode' option
5403 appended. This option should start with a dot. Use a string like
5404 ".org". 'backupdir' must not be empty for this to work (Detail: The
5405 backup file is renamed to the patchmode file after the new file has
5406 been successfully written, that's why it must be possible to write a
5407 backup file). If there was no file to be backed up, an empty file is
5408 created.
5409 When the 'backupskip' pattern matches, a patchmode file is not made.
5410 Using 'patchmode' for compressed files appends the extension at the
5411 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5412 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005413 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005415 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416'path' 'pa' string (default on Unix: ".,/usr/include,,"
5417 on OS/2: ".,/emx/include,,"
5418 other systems: ".,,")
5419 global or local to buffer |global-local|
5420 {not in Vi}
5421 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005422 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5423 provided that the file being searched for has a relative path (not
5424 starting with "/", "./" or "../"). The directories in the 'path'
5425 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426 - Use commas to separate directory names: >
5427 :set path=.,/usr/local/include,/usr/include
5428< - Spaces can also be used to separate directory names (for backwards
5429 compatibility with version 3.0). To have a space in a directory
5430 name, precede it with an extra backslash, and escape the space: >
5431 :set path=.,/dir/with\\\ space
5432< - To include a comma in a directory name precede it with an extra
5433 backslash: >
5434 :set path=.,/dir/with\\,comma
5435< - To search relative to the directory of the current file, use: >
5436 :set path=.
5437< - To search in the current directory use an empty string between two
5438 commas: >
5439 :set path=,,
5440< - A directory name may end in a ':' or '/'.
5441 - Environment variables are expanded |:set_env|.
5442 - When using |netrw.vim| URLs can be used. For example, adding
5443 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005444 - Search upwards and downwards in a directory tree using "*", "**" and
5445 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 {not available when compiled without the |+path_extra| feature}
5447 - Careful with '\' characters, type two to get one in the option: >
5448 :set path=.,c:\\include
5449< Or just use '/' instead: >
5450 :set path=.,c:/include
5451< Don't forget "." or files won't even be found in the same directory as
5452 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005453 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454 it is something like 256 or 1024 characters.
5455 You can check if all the include files are found, using the value of
5456 'path', see |:checkpath|.
5457 The use of |:set+=| and |:set-=| is preferred when adding or removing
5458 directories from the list. This avoids problems when a future version
5459 uses another default. To remove the current directory use: >
5460 :set path-=
5461< To add the current directory use: >
5462 :set path+=
5463< To use an environment variable, you probably need to replace the
5464 separator. Here is an example to append $INCL, in which directory
5465 names are separated with a semi-colon: >
5466 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5467< Replace the ';' with a ':' or whatever separator is used. Note that
5468 this doesn't work when $INCL contains a comma or white space.
5469
5470 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5471'preserveindent' 'pi' boolean (default off)
5472 local to buffer
5473 {not in Vi}
5474 When changing the indent of the current line, preserve as much of the
5475 indent structure as possible. Normally the indent is replaced by a
5476 series of tabs followed by spaces as required (unless |'expandtab'| is
5477 enabled, in which case only spaces are used). Enabling this option
5478 means the indent will preserve as many existing characters as possible
5479 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005480 'expandtab' does not apply to the preserved white space, a Tab remains
5481 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 NOTE: When using ">>" multiple times the resulting indent is a mix of
5483 tabs and spaces. You might not like this.
5484 NOTE: 'preserveindent' is reset when 'compatible' is set.
5485 Also see 'copyindent'.
5486 Use |:retab| to clean up white space.
5487
5488 *'previewheight'* *'pvh'*
5489'previewheight' 'pvh' number (default 12)
5490 global
5491 {not in Vi}
5492 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005493 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 Default height for a preview window. Used for |:ptag| and associated
5495 commands. Used for |CTRL-W_}| when no count is given.
5496
5497 *'previewwindow'* *'nopreviewwindow'*
5498 *'pvw'* *'nopvw'* *E590*
5499'previewwindow' 'pvw' boolean (default off)
5500 local to window
5501 {not in Vi}
5502 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005503 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005504 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 set. It's normally not set directly, but by using one of the commands
5506 |:ptag|, |:pedit|, etc.
5507
5508 *'printdevice'* *'pdev'*
5509'printdevice' 'pdev' string (default empty)
5510 global
5511 {not in Vi}
5512 {only available when compiled with the |+printer|
5513 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005514 The name of the printer to be used for |:hardcopy|.
5515 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005516 This option cannot be set from a |modeline| or in the |sandbox|, for
5517 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518
Bram Moolenaar8299df92004-07-10 09:47:34 +00005519 *'printencoding'* *'penc'*
5520'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 global
5522 {not in Vi}
5523 {only available when compiled with the |+printer|
5524 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005525 Sets the character encoding used when printing.
5526 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527
5528 *'printexpr'* *'pexpr'*
5529'printexpr' 'pexpr' String (default: see below)
5530 global
5531 {not in Vi}
5532 {only available when compiled with the |+printer|
5533 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005534 Expression used to print the PostScript produced with |:hardcopy|.
5535 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005536
Bram Moolenaar8299df92004-07-10 09:47:34 +00005537 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538'printfont' 'pfn' string (default "courier")
5539 global
5540 {not in Vi}
5541 {only available when compiled with the |+printer|
5542 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005543 The name of the font that will be used for |:hardcopy|.
5544 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545
5546 *'printheader'* *'pheader'*
5547'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5548 global
5549 {not in Vi}
5550 {only available when compiled with the |+printer|
5551 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005552 The format of the header produced in |:hardcopy| output.
5553 See |pheader-option|.
5554
5555 *'printmbcharset'* *'pmbcs'*
5556'printmbcharset' 'pmbcs' string (default "")
5557 global
5558 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005559 {only available when compiled with the |+printer|,
5560 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005561 The CJK character set to be used for CJK output from |:hardcopy|.
5562 See |pmbcs-option|.
5563
5564 *'printmbfont'* *'pmbfn'*
5565'printmbfont' 'pmbfn' string (default "")
5566 global
5567 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005568 {only available when compiled with the |+printer|,
5569 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005570 List of font names to be used for CJK output from |:hardcopy|.
5571 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
5573 *'printoptions'* *'popt'*
5574'printoptions' 'popt' string (default "")
5575 global
5576 {not in Vi}
5577 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005578 List of items that control the format of the output of |:hardcopy|.
5579 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005581 *'prompt'* *'noprompt'*
5582'prompt' boolean (default on)
5583 global
5584 When on a ":" prompt is used in Ex mode.
5585
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005586 *'pumheight'* *'ph'*
5587'pumheight' 'ph' number (default 0)
5588 global
5589 {not available when compiled without the
5590 |+insert_expand| feature}
5591 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005592 Determines the maximum number of items to show in the popup menu for
5593 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005594 |ins-completion-menu|.
5595
5596
Bram Moolenaar677ee682005-01-27 14:41:15 +00005597 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005598'quoteescape' 'qe' string (default "\")
5599 local to buffer
5600 {not in Vi}
5601 The characters that are used to escape quotes in a string. Used for
5602 objects like a', a" and a` |a'|.
5603 When one of the characters in this option is found inside a string,
5604 the following character will be skipped. The default value makes the
5605 text "foo\"bar\\" considered to be one string.
5606
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5608'readonly' 'ro' boolean (default off)
5609 local to buffer
5610 If on, writes fail unless you use a '!'. Protects you from
5611 accidentally overwriting a file. Default on when Vim is started
5612 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005613 When using ":w!" the 'readonly' option is reset for the current
5614 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005616 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005618 *'redrawtime'* *'rdt'*
5619'redrawtime' 'rdt' number (default 2000)
5620 global
5621 {not in Vi}
5622 {only available when compiled with the |+reltime|
5623 feature}
5624 The time in milliseconds for redrawing the display. This applies to
5625 searching for patterns for 'hlsearch' and |:match| highlighting.
5626 When redrawing takes more than this many milliseconds no further
5627 matches will be highlighted. This is used to avoid that Vim hangs
5628 when using a very complicated pattern.
5629
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005630 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005631'regexpengine' 're' number (default 0)
5632 global
5633 {not in Vi}
5634 This selects the default regexp engine. |two-engines|
5635 The possible values are:
5636 0 automatic selection
5637 1 old engine
5638 2 NFA engine
5639 Note that when using the NFA engine and the pattern contains something
5640 that is not supported the pattern will not match. This is only useful
5641 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005642 Using automatic selection enables Vim to switch the engine, if the
5643 default engine becomes too costly. E.g., when the NFA engine uses too
5644 many states. This should prevent Vim from hanging on a combination of
5645 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005646
Bram Moolenaar64486672010-05-16 15:46:46 +02005647 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5648'relativenumber' 'rnu' boolean (default off)
5649 local to window
5650 {not in Vi}
5651 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005652 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005653 precede some vertical motion commands (e.g. j k + -) with, without
5654 having to calculate it yourself. Especially useful in combination with
5655 other commands (e.g. y d c < > gq gw =).
5656 When the 'n' option is excluded from 'cpoptions' a wrapped
5657 line will not use the column of line numbers (this is the default when
5658 'compatible' isn't set).
5659 The 'numberwidth' option can be used to set the room used for the line
5660 number.
5661 When a long, wrapped line doesn't start with the first character, '-'
5662 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005663 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5664 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005665
5666 The number in front of the cursor line also depends on the value of
5667 'number', see |number_relativenumber| for all combinations of the two
5668 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005669
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 *'remap'* *'noremap'*
5671'remap' boolean (default on)
5672 global
5673 Allows for mappings to work recursively. If you do not want this for
5674 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005675 NOTE: To avoid portability problems with Vim scripts, always keep
5676 this option at the default "on". Only switch it off when working with
5677 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005679 *'renderoptions'* *'rop'*
5680'renderoptions' 'rop' string (default: empty)
5681 global
5682 {not in Vi}
5683 {only available when compiled with GUI and DIRECTX on
5684 MS-Windows}
5685 Select a text renderer and set its options. The options depend on the
5686 renderer.
5687
5688 Syntax: >
5689 set rop=type:{renderer}(,{name}:{value})*
5690<
5691 Currently, only one optional renderer is available.
5692
5693 render behavior ~
5694 directx Vim will draw text using DirectX (DirectWrite). It makes
5695 drawn glyphs more beautiful than default GDI.
5696 It requires 'encoding' is "utf-8", and only works on
5697 MS-Windows Vista or newer version.
5698
5699 Options:
5700 name meaning type value ~
5701 gamma gamma float 1.0 - 2.2 (maybe)
5702 contrast enhancedContrast float (unknown)
5703 level clearTypeLevel float (unknown)
5704 geom pixelGeometry int 0 - 2 (see below)
5705 renmode renderingMode int 0 - 6 (see below)
5706 taamode textAntialiasMode int 0 - 3 (see below)
5707
5708 See this URL for detail:
5709 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5710
5711 For geom: structure of a device pixel.
5712 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5713 1 - DWRITE_PIXEL_GEOMETRY_RGB
5714 2 - DWRITE_PIXEL_GEOMETRY_BGR
5715
5716 See this URL for detail:
5717 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5718
5719 For renmode: method of rendering glyphs.
5720 0 - DWRITE_RENDERING_MODE_DEFAULT
5721 1 - DWRITE_RENDERING_MODE_ALIASED
5722 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5723 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5724 4 - DWRITE_RENDERING_MODE_NATURAL
5725 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5726 6 - DWRITE_RENDERING_MODE_OUTLINE
5727
5728 See this URL for detail:
5729 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5730
5731 For taamode: antialiasing mode used for drawing text.
5732 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5733 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5734 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5735 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5736
5737 See this URL for detail:
5738 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5739
5740 Example: >
5741 set encoding=utf-8
5742 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5743 set rop=type:directx
5744<
5745 If select a raster font (Courier, Terminal or FixedSys) to
5746 'guifont', it fallbacks to be drawn by GDI automatically.
5747
5748 Other render types are currently not supported.
5749
Bram Moolenaar071d4272004-06-13 20:20:40 +00005750 *'report'*
5751'report' number (default 2)
5752 global
5753 Threshold for reporting number of lines changed. When the number of
5754 changed lines is more than 'report' a message will be given for most
5755 ":" commands. If you want it always, set 'report' to 0.
5756 For the ":substitute" command the number of substitutions is used
5757 instead of the number of lines.
5758
5759 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5760'restorescreen' 'rs' boolean (default on)
5761 global
5762 {not in Vi} {only in Windows 95/NT console version}
5763 When set, the screen contents is restored when exiting Vim. This also
5764 happens when executing external commands.
5765
5766 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5767 options in your .vimrc. To disable restoring:
5768 set t_ti= t_te=
5769 To enable restoring (for an xterm):
5770 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5771 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5772
5773 *'revins'* *'ri'* *'norevins'* *'nori'*
5774'revins' 'ri' boolean (default off)
5775 global
5776 {not in Vi}
5777 {only available when compiled with the |+rightleft|
5778 feature}
5779 Inserting characters in Insert mode will work backwards. See "typing
5780 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5781 command in Insert mode, when 'allowrevins' is set.
5782 NOTE: This option is reset when 'compatible' or 'paste' is set.
5783
5784 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5785'rightleft' 'rl' boolean (default off)
5786 local to window
5787 {not in Vi}
5788 {only available when compiled with the |+rightleft|
5789 feature}
5790 When on, display orientation becomes right-to-left, i.e., characters
5791 that are stored in the file appear from the right to the left.
5792 Using this option, it is possible to edit files for languages that
5793 are written from the right to the left such as Hebrew and Arabic.
5794 This option is per window, so it is possible to edit mixed files
5795 simultaneously, or to view the same file in both ways (this is
5796 useful whenever you have a mixed text file with both right-to-left
5797 and left-to-right strings so that both sets are displayed properly
5798 in different windows). Also see |rileft.txt|.
5799
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005800 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801'rightleftcmd' 'rlc' string (default "search")
5802 local to window
5803 {not in Vi}
5804 {only available when compiled with the |+rightleft|
5805 feature}
5806 Each word in this option enables the command line editing to work in
5807 right-to-left mode for a group of commands:
5808
5809 search "/" and "?" commands
5810
5811 This is useful for languages such as Hebrew, Arabic and Farsi.
5812 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5813
5814 *'ruler'* *'ru'* *'noruler'* *'noru'*
5815'ruler' 'ru' boolean (default off)
5816 global
5817 {not in Vi}
5818 {not available when compiled without the
5819 |+cmdline_info| feature}
5820 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005821 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 text in the file is shown on the far right:
5823 Top first line is visible
5824 Bot last line is visible
5825 All first and last line are visible
5826 45% relative position in the file
5827 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005828 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005830 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 this option takes precedence over 'ruler' and 'rulerformat'
5832 If the number of characters displayed is different from the number of
5833 bytes in the text (e.g., for a TAB or a multi-byte character), both
5834 the text column (byte number) and the screen column are shown,
5835 separated with a dash.
5836 For an empty line "0-1" is shown.
5837 For an empty buffer the line number will also be zero: "0,0-1".
5838 This option is reset when the 'paste' option is set.
5839 If you don't want to see the ruler all the time but want to know where
5840 you are, use "g CTRL-G" |g_CTRL-G|.
5841 NOTE: This option is reset when 'compatible' is set.
5842
5843 *'rulerformat'* *'ruf'*
5844'rulerformat' 'ruf' string (default empty)
5845 global
5846 {not in Vi}
5847 {not available when compiled without the |+statusline|
5848 feature}
5849 When this option is not empty, it determines the content of the ruler
5850 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005851 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005852 The default ruler width is 17 characters. To make the ruler 15
5853 characters wide, put "%15(" at the start and "%)" at the end.
5854 Example: >
5855 :set rulerformat=%15(%c%V\ %p%%%)
5856<
5857 *'runtimepath'* *'rtp'* *vimfiles*
5858'runtimepath' 'rtp' string (default:
5859 Unix: "$HOME/.vim,
5860 $VIM/vimfiles,
5861 $VIMRUNTIME,
5862 $VIM/vimfiles/after,
5863 $HOME/.vim/after"
5864 Amiga: "home:vimfiles,
5865 $VIM/vimfiles,
5866 $VIMRUNTIME,
5867 $VIM/vimfiles/after,
5868 home:vimfiles/after"
5869 PC, OS/2: "$HOME/vimfiles,
5870 $VIM/vimfiles,
5871 $VIMRUNTIME,
5872 $VIM/vimfiles/after,
5873 $HOME/vimfiles/after"
5874 Macintosh: "$VIM:vimfiles,
5875 $VIMRUNTIME,
5876 $VIM:vimfiles:after"
5877 RISC-OS: "Choices:vimfiles,
5878 $VIMRUNTIME,
5879 Choices:vimfiles/after"
5880 VMS: "sys$login:vimfiles,
5881 $VIM/vimfiles,
5882 $VIMRUNTIME,
5883 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005884 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 global
5886 {not in Vi}
5887 This is a list of directories which will be searched for runtime
5888 files:
5889 filetype.vim filetypes by file name |new-filetype|
5890 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005891 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005892 colors/ color scheme files |:colorscheme|
5893 compiler/ compiler files |:compiler|
5894 doc/ documentation |write-local-help|
5895 ftplugin/ filetype plugins |write-filetype-plugin|
5896 indent/ indent scripts |indent-expression|
5897 keymap/ key mapping files |mbyte-keymap|
5898 lang/ menu translations |:menutrans|
5899 menu.vim GUI menus |menu.vim|
5900 plugin/ plugin scripts |write-plugin|
5901 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005902 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005903 syntax/ syntax files |mysyntaxfile|
5904 tutor/ files for vimtutor |tutor|
5905
5906 And any other file searched for with the |:runtime| command.
5907
5908 The defaults for most systems are setup to search five locations:
5909 1. In your home directory, for your personal preferences.
5910 2. In a system-wide Vim directory, for preferences from the system
5911 administrator.
5912 3. In $VIMRUNTIME, for files distributed with Vim.
5913 *after-directory*
5914 4. In the "after" directory in the system-wide Vim directory. This is
5915 for the system administrator to overrule or add to the distributed
5916 defaults (rarely needed)
5917 5. In the "after" directory in your home directory. This is for
5918 personal preferences to overrule or add to the distributed defaults
5919 or system-wide settings (rarely needed).
5920
5921 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5922 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005923 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 wildcards.
5925 See |:runtime|.
5926 Example: >
5927 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5928< This will use the directory "~/vimruntime" first (containing your
5929 personal Vim runtime files), then "/mygroup/vim" (shared between a
5930 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5931 files).
5932 You probably should always include $VIMRUNTIME somewhere, to use the
5933 distributed runtime files. You can put a directory before $VIMRUNTIME
5934 to find files which replace a distributed runtime files. You can put
5935 a directory after $VIMRUNTIME to find files which add to distributed
5936 runtime files.
5937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
5940 *'scroll'* *'scr'*
5941'scroll' 'scr' number (default: half the window height)
5942 local to window
5943 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5944 set to half the number of lines in the window when the window size
5945 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005946 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5948 the number of screen lines instead of file lines, makes a difference
5949 when lines wrap}
5950
5951 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5952'scrollbind' 'scb' boolean (default off)
5953 local to window
5954 {not in Vi}
5955 {not available when compiled without the |+scrollbind|
5956 feature}
5957 See also |scroll-binding|. When this option is set, the current
5958 window scrolls as other scrollbind windows (windows that also have
5959 this option set) scroll. This option is useful for viewing the
5960 differences between two versions of a file, see 'diff'.
5961 See |'scrollopt'| for options that determine how this option should be
5962 interpreted.
5963 This option is mostly reset when splitting a window to edit another
5964 file. This means that ":split | edit file" results in two windows
5965 with scroll-binding, but ":split file" does not.
5966
5967 *'scrolljump'* *'sj'*
5968'scrolljump' 'sj' number (default 1)
5969 global
5970 {not in Vi}
5971 Minimal number of lines to scroll when the cursor gets off the
5972 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5973 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005974 When set to a negative number from -1 to -100 this is used as the
5975 percentage of the window height. Thus -50 scrolls half the window
5976 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005977 NOTE: This option is set to 1 when 'compatible' is set.
5978
5979 *'scrolloff'* *'so'*
5980'scrolloff' 'so' number (default 0)
5981 global
5982 {not in Vi}
5983 Minimal number of screen lines to keep above and below the cursor.
5984 This will make some context visible around where you are working. If
5985 you set it to a very large value (999) the cursor line will always be
5986 in the middle of the window (except at the start or end of the file or
5987 when long lines wrap).
5988 For scrolling horizontally see 'sidescrolloff'.
5989 NOTE: This option is set to 0 when 'compatible' is set.
5990
5991 *'scrollopt'* *'sbo'*
5992'scrollopt' 'sbo' string (default "ver,jump")
5993 global
5994 {not available when compiled without the |+scrollbind|
5995 feature}
5996 {not in Vi}
5997 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005998 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5999 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006000 The following words are available:
6001 ver Bind vertical scrolling for 'scrollbind' windows
6002 hor Bind horizontal scrolling for 'scrollbind' windows
6003 jump Applies to the offset between two windows for vertical
6004 scrolling. This offset is the difference in the first
6005 displayed line of the bound windows. When moving
6006 around in a window, another 'scrollbind' window may
6007 reach a position before the start or after the end of
6008 the buffer. The offset is not changed though, when
6009 moving back the 'scrollbind' window will try to scroll
6010 to the desired position when possible.
6011 When now making that window the current one, two
6012 things can be done with the relative offset:
6013 1. When "jump" is not included, the relative offset is
6014 adjusted for the scroll position in the new current
6015 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006016 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 2. When "jump" is included, the other windows are
6018 scrolled to keep the same relative offset. When
6019 going back to the other window, it still uses the
6020 same relative offset.
6021 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006022 When 'diff' mode is active there always is vertical scroll binding,
6023 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024
6025 *'sections'* *'sect'*
6026'sections' 'sect' string (default "SHNHH HUnhsh")
6027 global
6028 Specifies the nroff macros that separate sections. These are pairs of
6029 two letters (See |object-motions|). The default makes a section start
6030 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6031
6032 *'secure'* *'nosecure'* *E523*
6033'secure' boolean (default off)
6034 global
6035 {not in Vi}
6036 When on, ":autocmd", shell and write commands are not allowed in
6037 ".vimrc" and ".exrc" in the current directory and map commands are
6038 displayed. Switch it off only if you know that you will not run into
6039 problems, or when the 'exrc' option is off. On Unix this option is
6040 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006041 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 'secure' at the end of your ~/.vimrc then.
6043 This option cannot be set from a |modeline| or in the |sandbox|, for
6044 security reasons.
6045
6046 *'selection'* *'sel'*
6047'selection' 'sel' string (default "inclusive")
6048 global
6049 {not in Vi}
6050 This option defines the behavior of the selection. It is only used
6051 in Visual and Select mode.
6052 Possible values:
6053 value past line inclusive ~
6054 old no yes
6055 inclusive yes yes
6056 exclusive yes no
6057 "past line" means that the cursor is allowed to be positioned one
6058 character past the line.
6059 "inclusive" means that the last character of the selection is included
6060 in an operation. For example, when "x" is used to delete the
6061 selection.
6062 Note that when "exclusive" is used and selecting from the end
6063 backwards, you cannot include the last character of a line, when
6064 starting in Normal mode and 'virtualedit' empty.
6065
6066 The 'selection' option is set by the |:behave| command.
6067
6068 *'selectmode'* *'slm'*
6069'selectmode' 'slm' string (default "")
6070 global
6071 {not in Vi}
6072 This is a comma separated list of words, which specifies when to start
6073 Select mode instead of Visual mode, when a selection is started.
6074 Possible values:
6075 mouse when using the mouse
6076 key when using shifted special keys
6077 cmd when using "v", "V" or CTRL-V
6078 See |Select-mode|.
6079 The 'selectmode' option is set by the |:behave| command.
6080
6081 *'sessionoptions'* *'ssop'*
6082'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006083 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 global
6085 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006086 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 feature}
6088 Changes the effect of the |:mksession| command. It is a comma
6089 separated list of words. Each word enables saving and restoring
6090 something:
6091 word save and restore ~
6092 blank empty windows
6093 buffers hidden and unloaded buffers, not just those in windows
6094 curdir the current directory
6095 folds manually created folds, opened/closed folds and local
6096 fold options
6097 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006098 and contain at least one lowercase letter. Only
6099 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 help the help window
6101 localoptions options and mappings local to a window or buffer (not
6102 global values for local options)
6103 options all options and mappings (also global values for local
6104 options)
6105 resize size of the Vim window: 'lines' and 'columns'
6106 sesdir the directory in which the session file is located
6107 will become the current directory (useful with
6108 projects accessed over a network from different
6109 systems)
6110 slash backslashes in file names replaced with forward
6111 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006112 tabpages all tab pages; without this only the current tab page
6113 is restored, so that you can make a session for each
6114 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 unix with Unix end-of-line format (single <NL>), even when
6116 on Windows or DOS
6117 winpos position of the whole Vim window
6118 winsize window sizes
6119
6120 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006121 When neither "curdir" nor "sesdir" is included, file names are stored
6122 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 "slash" and "unix" are useful on Windows when sharing session files
6124 with Unix. The Unix version of Vim cannot source dos format scripts,
6125 but the Windows version of Vim can source unix format scripts.
6126
6127 *'shell'* *'sh'* *E91*
6128'shell' 'sh' string (default $SHELL or "sh",
6129 MS-DOS and Win32: "command.com" or
6130 "cmd.exe", OS/2: "cmd")
6131 global
6132 Name of the shell to use for ! and :! commands. When changing the
6133 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6134 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006135 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006136 See |option-backslash| about including spaces and backslashes.
6137 Environment variables are expanded |:set_env|.
6138 If the name of the shell contains a space, you might need to enclose
6139 it in quotes. Example: >
6140 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6141< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006142 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 "-f" is not inside the quotes, because it is not part of the command
6144 name. And Vim automagically recognizes the backslashes that are path
6145 separators.
6146 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6147 variable to change the way external commands are executed. See the
6148 libc.inf file of DJGPP.
6149 Under MS-Windows, when the executable ends in ".com" it must be
6150 included. Thus setting the shell to "command.com" or "4dos.com"
6151 works, but "command" and "4dos" do not work for all commands (e.g.,
6152 filtering).
6153 For unknown reasons, when using "4dos.com" the current directory is
6154 changed to "C:\". To avoid this set 'shell' like this: >
6155 :set shell=command.com\ /c\ 4dos
6156< This option cannot be set from a |modeline| or in the |sandbox|, for
6157 security reasons.
6158
6159 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006160'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006161 MS-DOS and Win32, when 'shell' does not
6162 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 global
6164 {not in Vi}
6165 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6166 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6167 systems, the default is set according to the value of 'shell', to
6168 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006169 OS/2 (EMX figures this out itself).
6170 On Unix it can have more than one flag. Each white space separated
6171 part is passed as an argument to the shell command.
6172 See |option-backslash| about including spaces and backslashes.
6173 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 This option cannot be set from a |modeline| or in the |sandbox|, for
6175 security reasons.
6176
6177 *'shellpipe'* *'sp'*
6178'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6179 global
6180 {not in Vi}
6181 {not available when compiled without the |+quickfix|
6182 feature}
6183 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006184 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006185 including spaces and backslashes.
6186 The name of the temporary file can be represented by "%s" if necessary
6187 (the file name is appended automatically if no %s appears in the value
6188 of this option).
6189 For the Amiga and MS-DOS the default is ">". The output is directly
6190 saved in a file and not echoed to the screen.
6191 For Unix the default it "| tee". The stdout of the compiler is saved
6192 in a file and echoed to the screen. If the 'shell' option is "csh" or
6193 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006194 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6195 default becomes "2>&1| tee". This means that stderr is also included.
6196 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6197 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006198 The initialization of this option is done after reading the ".vimrc"
6199 and the other initializations, so that when the 'shell' option is set
6200 there, the 'shellpipe' option changes automatically, unless it was
6201 explicitly set before.
6202 When 'shellpipe' is set to an empty string, no redirection of the
6203 ":make" output will be done. This is useful if you use a 'makeprg'
6204 that writes to 'makeef' by itself. If you want no piping, but do
6205 want to include the 'makeef', set 'shellpipe' to a single space.
6206 Don't forget to precede the space with a backslash: ":set sp=\ ".
6207 In the future pipes may be used for filtering and this option will
6208 become obsolete (at least for Unix).
6209 This option cannot be set from a |modeline| or in the |sandbox|, for
6210 security reasons.
6211
6212 *'shellquote'* *'shq'*
6213'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6214 contains "sh" somewhere: "\"")
6215 global
6216 {not in Vi}
6217 Quoting character(s), put around the command passed to the shell, for
6218 the "!" and ":!" commands. The redirection is kept outside of the
6219 quoting. See 'shellxquote' to include the redirection. It's
6220 probably not useful to set both options.
6221 This is an empty string by default. Only known to be useful for
6222 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6223 or bash, where it should be "\"". The default is adjusted according
6224 the value of 'shell', to reduce the need to set this option by the
6225 user. See |dos-shell|.
6226 This option cannot be set from a |modeline| or in the |sandbox|, for
6227 security reasons.
6228
6229 *'shellredir'* *'srr'*
6230'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6231 global
6232 {not in Vi}
6233 String to be used to put the output of a filter command in a temporary
6234 file. See also |:!|. See |option-backslash| about including spaces
6235 and backslashes.
6236 The name of the temporary file can be represented by "%s" if necessary
6237 (the file name is appended automatically if no %s appears in the value
6238 of this option).
6239 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6240 or "zsh" during initializations, the default becomes ">&". If the
6241 'shell' option is "sh", "ksh" or "bash" the default becomes
6242 ">%s 2>&1". This means that stderr is also included.
6243 For Win32, the Unix checks are done and additionally "cmd" is checked
6244 for, which makes the default ">%s 2>&1". Also, the same names with
6245 ".exe" appended are checked for.
6246 The initialization of this option is done after reading the ".vimrc"
6247 and the other initializations, so that when the 'shell' option is set
6248 there, the 'shellredir' option changes automatically unless it was
6249 explicitly set before.
6250 In the future pipes may be used for filtering and this option will
6251 become obsolete (at least for Unix).
6252 This option cannot be set from a |modeline| or in the |sandbox|, for
6253 security reasons.
6254
6255 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6256'shellslash' 'ssl' boolean (default off)
6257 global
6258 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6259 When set, a forward slash is used when expanding file names. This is
6260 useful when a Unix-like shell is used instead of command.com or
6261 cmd.exe. Backward slashes can still be typed, but they are changed to
6262 forward slashes by Vim.
6263 Note that setting or resetting this option has no effect for some
6264 existing file names, thus this option needs to be set before opening
6265 any file for best results. This might change in the future.
6266 'shellslash' only works when a backslash can be used as a path
6267 separator. To test if this is so use: >
6268 if exists('+shellslash')
6269<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006270 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6271'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6272 global
6273 {not in Vi}
6274 When on, use temp files for shell commands. When off use a pipe.
6275 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006276 Currently a pipe is only supported on Unix and MS-Windows 2K and
6277 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006278 :if has("filterpipe")
6279< The advantage of using a pipe is that nobody can read the temp file
6280 and the 'shell' command does not need to support redirection.
6281 The advantage of using a temp file is that the file type and encoding
6282 can be detected.
6283 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6284 |FilterWritePost| autocommands event are not triggered when
6285 'shelltemp' is off.
6286
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 *'shelltype'* *'st'*
6288'shelltype' 'st' number (default 0)
6289 global
6290 {not in Vi} {only for the Amiga}
6291 On the Amiga this option influences the way how the commands work
6292 which use a shell.
6293 0 and 1: always use the shell
6294 2 and 3: use the shell only to filter lines
6295 4 and 5: use shell only for ':sh' command
6296 When not using the shell, the command is executed directly.
6297
6298 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6299 1 and 3: use "shell cmd" to start external commands
6300
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006301 *'shellxescape'* *'sxe'*
6302'shellxescape' 'sxe' string (default: "";
6303 for MS-DOS and MS-Windows: "\"&|<>()@^")
6304 global
6305 {not in Vi}
6306 When 'shellxquote' is set to "(" then the characters listed in this
6307 option will be escaped with a '^' character. This makes it possible
6308 to execute most external commands with cmd.exe.
6309
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 *'shellxquote'* *'sxq'*
6311'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006312 for Win32, when 'shell' is cmd.exe: "("
6313 for Win32, when 'shell' contains "sh"
6314 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 for Unix, when using system(): "\"")
6316 global
6317 {not in Vi}
6318 Quoting character(s), put around the command passed to the shell, for
6319 the "!" and ":!" commands. Includes the redirection. See
6320 'shellquote' to exclude the redirection. It's probably not useful
6321 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006322 When the value is '(' then ')' is appended. When the value is '"('
6323 then ')"' is appended.
6324 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006325 This is an empty string by default on most systems, but is known to be
6326 useful for on Win32 version, either for cmd.exe which automatically
6327 strips off the first and last quote on a command, or 3rd-party shells
6328 such as the MKS Korn Shell or bash, where it should be "\"". The
6329 default is adjusted according the value of 'shell', to reduce the need
6330 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 This option cannot be set from a |modeline| or in the |sandbox|, for
6332 security reasons.
6333
6334 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6335'shiftround' 'sr' boolean (default off)
6336 global
6337 {not in Vi}
6338 Round indent to multiple of 'shiftwidth'. Applies to > and <
6339 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6340 a multiple of 'shiftwidth' (this is Vi compatible).
6341 NOTE: This option is reset when 'compatible' is set.
6342
6343 *'shiftwidth'* *'sw'*
6344'shiftwidth' 'sw' number (default 8)
6345 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006346 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006348 When zero the 'ts' value will be used. Use the |shiftwidth()|
6349 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350
6351 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006352'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6353 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 global
6355 {not in Vi}
6356 This option helps to avoid all the |hit-enter| prompts caused by file
6357 messages, for example with CTRL-G, and to avoid some other messages.
6358 It is a list of flags:
6359 flag meaning when present ~
6360 f use "(3 of 5)" instead of "(file 3 of 5)"
6361 i use "[noeol]" instead of "[Incomplete last line]"
6362 l use "999L, 888C" instead of "999 lines, 888 characters"
6363 m use "[+]" instead of "[Modified]"
6364 n use "[New]" instead of "[New File]"
6365 r use "[RO]" instead of "[readonly]"
6366 w use "[w]" instead of "written" for file write message
6367 and "[a]" instead of "appended" for ':w >> file' command
6368 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6369 "[unix format]" and "[mac]" instead of "[mac format]".
6370 a all of the above abbreviations
6371
6372 o overwrite message for writing a file with subsequent message
6373 for reading a file (useful for ":wn" or when 'autowrite' on)
6374 O message for reading a file overwrites any previous message.
6375 Also for quickfix message (e.g., ":cn").
6376 s don't give "search hit BOTTOM, continuing at TOP" or "search
6377 hit TOP, continuing at BOTTOM" messages
6378 t truncate file message at the start if it is too long to fit
6379 on the command-line, "<" will appear in the left most column.
6380 Ignored in Ex mode.
6381 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006382 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 Ignored in Ex mode.
6384 W don't give "written" or "[w]" when writing a file
6385 A don't give the "ATTENTION" message when an existing swap file
6386 is found.
6387 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006388 c don't give |ins-completion-menu| messages. For example,
6389 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6390 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006391
6392 This gives you the opportunity to avoid that a change between buffers
6393 requires you to hit <Enter>, but still gives as useful a message as
6394 possible for the space available. To get the whole message that you
6395 would have got with 'shm' empty, use ":file!"
6396 Useful values:
6397 shm= No abbreviation of message.
6398 shm=a Abbreviation, but no loss of information.
6399 shm=at Abbreviation, and truncate message when necessary.
6400
6401 NOTE: This option is set to the Vi default value when 'compatible' is
6402 set and to the Vim default value when 'compatible' is reset.
6403
6404 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6405'shortname' 'sn' boolean (default off)
6406 local to buffer
6407 {not in Vi, not in MS-DOS versions}
6408 Filenames are assumed to be 8 characters plus one extension of 3
6409 characters. Multiple dots in file names are not allowed. When this
6410 option is on, dots in file names are replaced with underscores when
6411 adding an extension (".~" or ".swp"). This option is not available
6412 for MS-DOS, because then it would always be on. This option is useful
6413 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6414 or crossdos. When running the Win32 GUI version under Win32s, this
6415 option is always on by default.
6416
6417 *'showbreak'* *'sbr'* *E595*
6418'showbreak' 'sbr' string (default "")
6419 global
6420 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006421 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 feature}
6423 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006424 values are "> " or "+++ ": >
6425 :set showbreak=>\
6426< Note the backslash to escape the trailing space. It's easier like
6427 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006428 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006429< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 comma (in a future version the comma might be used to separate the
6431 part that is shown at the end and at the start of a line).
6432 The characters are highlighted according to the '@' flag in
6433 'highlight'.
6434 Note that tabs after the showbreak will be displayed differently.
6435 If you want the 'showbreak' to appear in between line numbers, add the
6436 "n" flag to 'cpoptions'.
6437
6438 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6439'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6440 off)
6441 global
6442 {not in Vi}
6443 {not available when compiled without the
6444 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006445 Show (partial) command in the last line of the screen. Set this
6446 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 In Visual mode the size of the selected area is shown:
6448 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006449 If the number of bytes is different it is also displayed: "2-6"
6450 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006452 - When selecting a block, the size in screen characters:
6453 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 NOTE: This option is set to the Vi default value when 'compatible' is
6455 set and to the Vim default value when 'compatible' is reset.
6456
6457 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6458'showfulltag' 'sft' boolean (default off)
6459 global
6460 {not in Vi}
6461 When completing a word in insert mode (see |ins-completion|) from the
6462 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006463 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006464 matched a C function, you can see a template for what arguments are
6465 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006466 Note that this doesn't work well together with having "longest" in
6467 'completeopt', because the completion from the search pattern may not
6468 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469
6470 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6471'showmatch' 'sm' boolean (default off)
6472 global
6473 When a bracket is inserted, briefly jump to the matching one. The
6474 jump is only done if the match can be seen on the screen. The time to
6475 show the match can be set with 'matchtime'.
6476 A Beep is given if there is no match (no matter if the match can be
6477 seen or not). This option is reset when the 'paste' option is set.
6478 When the 'm' flag is not included in 'cpoptions', typing a character
6479 will immediately move the cursor back to where it belongs.
6480 See the "sm" field in 'guicursor' for setting the cursor shape and
6481 blinking when showing the match.
6482 The 'matchpairs' option can be used to specify the characters to show
6483 matches for. 'rightleft' and 'revins' are used to look for opposite
6484 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006485 Also see the matchparen plugin for highlighting the match when moving
6486 around |pi_paren.txt|.
6487 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488
6489 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6490'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6491 global
6492 If in Insert, Replace or Visual mode put a message on the last line.
6493 Use the 'M' flag in 'highlight' to set the type of highlighting for
6494 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006495 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006496 doesn't mean XIM is really active, especially when 'imactivatekey' is
6497 not set.
6498 NOTE: This option is set to the Vi default value when 'compatible' is
6499 set and to the Vim default value when 'compatible' is reset.
6500
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006501 *'showtabline'* *'stal'*
6502'showtabline' 'stal' number (default 1)
6503 global
6504 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006505 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006506 feature}
6507 The value of this option specifies when the line with tab page labels
6508 will be displayed:
6509 0: never
6510 1: only if there are at least two tab pages
6511 2: always
6512 This is both for the GUI and non-GUI implementation of the tab pages
6513 line.
6514 See |tab-page| for more information about tab pages.
6515
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 *'sidescroll'* *'ss'*
6517'sidescroll' 'ss' number (default 0)
6518 global
6519 {not in Vi}
6520 The minimal number of columns to scroll horizontally. Used only when
6521 the 'wrap' option is off and the cursor is moved off of the screen.
6522 When it is zero the cursor will be put in the middle of the screen.
6523 When using a slow terminal set it to a large number or 0. When using
6524 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6525 commands.
6526
6527 *'sidescrolloff'* *'siso'*
6528'sidescrolloff' 'siso' number (default 0)
6529 global
6530 {not in Vi}
6531 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006532 right of the cursor if 'nowrap' is set. Setting this option to a
6533 value greater than 0 while having |'sidescroll'| also at a non-zero
6534 value makes some context visible in the line you are scrolling in
6535 horizontally (except at beginning of the line). Setting this option
6536 to a large value (like 999) has the effect of keeping the cursor
6537 horizontally centered in the window, as long as one does not come too
6538 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006539 NOTE: This option is set to 0 when 'compatible' is set.
6540
6541 Example: Try this together with 'sidescroll' and 'listchars' as
6542 in the following example to never allow the cursor to move
6543 onto the "extends" character:
6544
6545 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6546 :set sidescrolloff=1
6547
6548
6549 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6550'smartcase' 'scs' boolean (default off)
6551 global
6552 {not in Vi}
6553 Override the 'ignorecase' option if the search pattern contains upper
6554 case characters. Only used when the search pattern is typed and
6555 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006556 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6558 recalling the search pattern from history and hitting <Enter>.
6559 NOTE: This option is reset when 'compatible' is set.
6560
6561 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6562'smartindent' 'si' boolean (default off)
6563 local to buffer
6564 {not in Vi}
6565 {not available when compiled without the
6566 |+smartindent| feature}
6567 Do smart autoindenting when starting a new line. Works for C-like
6568 programs, but can also be used for other languages. 'cindent' does
6569 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006570 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006571 setting 'si' has no effect. 'indentexpr' is a more advanced
6572 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 Normally 'autoindent' should also be on when using 'smartindent'.
6574 An indent is automatically inserted:
6575 - After a line ending in '{'.
6576 - After a line starting with a keyword from 'cinwords'.
6577 - Before a line starting with '}' (only with the "O" command).
6578 When typing '}' as the first character in a new line, that line is
6579 given the same indent as the matching '{'.
6580 When typing '#' as the first character in a new line, the indent for
6581 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006582 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6584 When using the ">>" command, lines starting with '#' are not shifted
6585 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006586 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 is set smart indenting is disabled.
6588
6589 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6590'smarttab' 'sta' boolean (default off)
6591 global
6592 {not in Vi}
6593 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006594 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6595 <BS> will delete a 'shiftwidth' worth of space at the start of the
6596 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006597 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006598 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6599 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006600 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006602 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 NOTE: This option is reset when 'compatible' is set.
6604
6605 *'softtabstop'* *'sts'*
6606'softtabstop' 'sts' number (default 0)
6607 local to buffer
6608 {not in Vi}
6609 Number of spaces that a <Tab> counts for while performing editing
6610 operations, like inserting a <Tab> or using <BS>. It "feels" like
6611 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6612 used. This is useful to keep the 'ts' setting at its standard value
6613 of 8, while being able to edit like it is set to 'sts'. However,
6614 commands like "x" still work on the actual characters.
6615 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006616 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 'softtabstop' is set to 0 when the 'paste' option is set.
6618 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6619 spaces is minimized by using <Tab>s.
6620 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6621 set.
6622 NOTE: This option is set to 0 when 'compatible' is set.
6623
Bram Moolenaar217ad922005-03-20 22:37:15 +00006624 *'spell'* *'nospell'*
6625'spell' boolean (default off)
6626 local to window
6627 {not in Vi}
6628 {not available when compiled without the |+syntax|
6629 feature}
6630 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006631 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006632
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006633 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006634'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006635 local to buffer
6636 {not in Vi}
6637 {not available when compiled without the |+syntax|
6638 feature}
6639 Pattern to locate the end of a sentence. The following word will be
6640 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006641 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006642 When this check is not wanted make this option empty.
6643 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006644 Be careful with special characters, see |option-backslash| about
6645 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006646 To set this option automatically depending on the language, see
6647 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006648
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006649 *'spellfile'* *'spf'*
6650'spellfile' 'spf' string (default empty)
6651 local to buffer
6652 {not in Vi}
6653 {not available when compiled without the |+syntax|
6654 feature}
6655 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006656 commands. It must end in ".{encoding}.add". You need to include the
6657 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006658 *E765*
6659 It may also be a comma separated list of names. A count before the
6660 |zg| and |zw| commands can be used to access each. This allows using
6661 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006662 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006663 you: Using the first directory in 'runtimepath' that is writable. If
6664 there is no "spell" directory yet it will be created. For the file
6665 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006666 ignoring the region.
6667 The resulting ".spl" file will be used for spell checking, it does not
6668 have to appear in 'spelllang'.
6669 Normally one file is used for all regions, but you can add the region
6670 name if you want to. However, it will then only be used when
6671 'spellfile' is set to it, for entries in 'spelllang' only files
6672 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006673 This option cannot be set from a |modeline| or in the |sandbox|, for
6674 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006675
Bram Moolenaar217ad922005-03-20 22:37:15 +00006676 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006677'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006678 local to buffer
6679 {not in Vi}
6680 {not available when compiled without the |+syntax|
6681 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006682 A comma separated list of word list names. When the 'spell' option is
6683 on spellchecking will be done for these languages. Example: >
6684 set spelllang=en_us,nl,medical
6685< This means US English, Dutch and medical words are recognized. Words
6686 that are not recognized will be highlighted.
6687 The word list name must not include a comma or dot. Using a dash is
6688 recommended to separate the two letter language name from a
6689 specification. Thus "en-rare" is used for rare English words.
6690 A region name must come last and have the form "_xx", where "xx" is
6691 the two-letter, lower case region name. You can use more than one
6692 region by listing them: "en_us,en_ca" supports both US and Canadian
6693 English, but not words specific for Australia, New Zealand or Great
6694 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006695 If the name "cjk" is included East Asian characters are excluded from
6696 spell checking. This is useful when editing text that also has Asian
6697 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006698 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006699 As a special case the name of a .spl file can be given as-is. The
6700 first "_xx" in the name is removed and used as the region name
6701 (_xx is an underscore, two letters and followed by a non-letter).
6702 This is mainly for testing purposes. You must make sure the correct
6703 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006704 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006705 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6706 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006707 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006708
Bram Moolenaar98692072006-02-04 00:57:42 +00006709 If the |spellfile.vim| plugin is active and you use a language name
6710 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6711 will ask you if you want to download the file.
6712
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006713 After this option has been set successfully, Vim will source the files
6714 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006715 up to the first comma, dot or underscore.
6716 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006717
6718
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006719 *'spellsuggest'* *'sps'*
6720'spellsuggest' 'sps' string (default "best")
6721 global
6722 {not in Vi}
6723 {not available when compiled without the |+syntax|
6724 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006725 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006726 the |spellsuggest()| function. This is a comma-separated list of
6727 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006728
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006729 best Internal method that works best for English. Finds
6730 changes like "fast" and uses a bit of sound-a-like
6731 scoring to improve the ordering.
6732
6733 double Internal method that uses two methods and mixes the
6734 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006735 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006736 word. That only works when the language specifies
6737 sound folding. Can be slow and doesn't always give
6738 better results.
6739
6740 fast Internal method that only checks for simple changes:
6741 character inserts/deletes/swaps. Works well for
6742 simple typing mistakes.
6743
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006744 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006745 Not used for |spellsuggest()|. The number of
6746 suggestions is never more than the value of 'lines'
6747 minus two.
6748
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006749 file:{filename} Read file {filename}, which must have two columns,
6750 separated by a slash. The first column contains the
6751 bad word, the second column the suggested good word.
6752 Example:
6753 theribal/terrible ~
6754 Use this for common mistakes that do not appear at the
6755 top of the suggestion list with the internal methods.
6756 Lines without a slash are ignored, use this for
6757 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006758 The word in the second column must be correct,
6759 otherwise it will not be used. Add the word to an
6760 ".add" file if it is currently flagged as a spelling
6761 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006762 The file is used for all languages.
6763
6764 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6765 trouble with spaces. |v:val| holds the badly spelled
6766 word. The expression must evaluate to a List of
6767 Lists, each with a suggestion and a score.
6768 Example:
6769 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006770 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006771 internal methods use. A lower score is better.
6772 This may invoke |spellsuggest()| if you temporarily
6773 set 'spellsuggest' to exclude the "expr:" part.
6774 Errors are silently ignored, unless you set the
6775 'verbose' option to a non-zero value.
6776
6777 Only one of "best", "double" or "fast" may be used. The others may
6778 appear several times in any order. Example: >
6779 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6780<
6781 This option cannot be set from a |modeline| or in the |sandbox|, for
6782 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006783
6784
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6786'splitbelow' 'sb' boolean (default off)
6787 global
6788 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006789 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006790 feature}
6791 When on, splitting a window will put the new window below the current
6792 one. |:split|
6793
6794 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6795'splitright' 'spr' boolean (default off)
6796 global
6797 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006798 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 feature}
6800 When on, splitting a window will put the new window right of the
6801 current one. |:vsplit|
6802
6803 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6804'startofline' 'sol' boolean (default on)
6805 global
6806 {not in Vi}
6807 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006808 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006809 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006810 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 with a linewise operator, with "%" with a count and to buffer changing
6812 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6813 only has a line number, e.g., ":25" or ":+".
6814 In case of buffer changing commands the cursor is placed at the column
6815 where it was the last time the buffer was edited.
6816 NOTE: This option is set when 'compatible' is set.
6817
Bram Moolenaar00654022011-02-25 14:42:19 +01006818 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006820 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 {not in Vi}
6822 {not available when compiled without the |+statusline|
6823 feature}
6824 When nonempty, this option determines the content of the status line.
6825 Also see |status-line|.
6826
6827 The option consists of printf style '%' items interspersed with
6828 normal text. Each status line item is of the form:
6829 %-0{minwid}.{maxwid}{item}
6830 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006831 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832
Bram Moolenaar238a5642006-02-21 22:12:05 +00006833 When the option starts with "%!" then it is used as an expression,
6834 evaluated and the result is used as the option value. Example: >
6835 :set statusline=%!MyStatusLine()
6836< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006837 Note that the "%!" expression is evaluated in the context of the
6838 current window and buffer, while %{} items are evaluated in the
6839 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006840
6841 When there is error while evaluating the option then it will be made
6842 empty to avoid further errors. Otherwise screen updating would loop.
6843
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 Note that the only effect of 'ruler' when this option is set (and
6845 'laststatus' is 2) is controlling the output of |CTRL-G|.
6846
6847 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006848 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006850 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 minwid Minimum width of the item, padding as set by '-' & '0'.
6852 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006853 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006854 on the left for text items. Numeric items will be
6855 shifted down to maxwid-2 digits followed by '>'number
6856 where number is the amount of missing digits, much like
6857 an exponential notation.
6858 item A one letter code as described below.
6859
6860 Following is a description of the possible statusline items. The
6861 second character in "item" is the type:
6862 N for number
6863 S for string
6864 F for flags as described below
6865 - not applicable
6866
6867 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006868 f S Path to the file in the buffer, as typed or relative to current
6869 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006870 F S Full path to the file in the buffer.
6871 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006872 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006874 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006876 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006878 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006880 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006881 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6882 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006883 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6885 being used: "<keymap>"
6886 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006887 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 B N As above, in hexadecimal.
6889 o N Byte number in file of byte under cursor, first byte is 1.
6890 Mnemonic: Offset from start of file (with one added)
6891 {not available when compiled without |+byte_offset| feature}
6892 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006893 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006894 l N Line number.
6895 L N Number of lines in buffer.
6896 c N Column number.
6897 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006898 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 p N Percentage through file in lines as in |CTRL-G|.
6900 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006901 percentage described for 'ruler'. Always 3 in length, unless
6902 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006903 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006905 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006906 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 ( - Start of item group. Can be used for setting the width and
6908 alignment of a section. Must be followed by %) somewhere.
6909 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006910 T N For 'tabline': start of tab page N label. Use %T after the last
6911 label. This information is used for mouse clicks.
6912 X N For 'tabline': start of close tab N label. Use %X after the
6913 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6914 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 < - Where to truncate line if too long. Default is at the start.
6916 No width fields allowed.
6917 = - Separation point between left and right aligned items.
6918 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006919 # - Set highlight group. The name must follow and then a # again.
6920 Thus use %#HLname# for highlight group HLname. The same
6921 highlighting is used, also for the statusline of non-current
6922 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006924 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 The difference between User{N} and StatusLine will be applied
6926 to StatusLineNC for the statusline of non-current windows.
6927 The number N must be between 1 and 9. See |hl-User1..9|
6928
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006929 When displaying a flag, Vim removes the leading comma, if any, when
6930 that flag comes right after plaintext. This will make a nice display
6931 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932
Bram Moolenaar582fd852005-03-28 20:58:01 +00006933 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 not set) and a minwid is not set for the group, the whole group will
6935 become empty. This will make a group like the following disappear
6936 completely from the statusline when none of the flags are set. >
6937 :set statusline=...%(\ [%M%R%H]%)...
6938<
6939 Beware that an expression is evaluated each and every time the status
6940 line is displayed. The current buffer and current window will be set
6941 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006942 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006944 real current buffer.
6945
Bram Moolenaar30b65812012-07-12 22:01:11 +02006946 The 'statusline' option will be evaluated in the |sandbox| if set from
6947 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006948
6949 It is not allowed to change text or jump to another window while
6950 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951
6952 If the statusline is not updated when you want it (e.g., after setting
6953 a variable that's used in an expression), you can force an update by
6954 setting an option without changing its value. Example: >
6955 :let &ro = &ro
6956
6957< A result of all digits is regarded a number for display purposes.
6958 Otherwise the result is taken as flag text and applied to the rules
6959 described above.
6960
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006961 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6963 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6964
6965 Examples:
6966 Emulate standard status line with 'ruler' set >
6967 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6968< Similar, but add ASCII value of char under the cursor (like "ga") >
6969 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6970< Display byte count and byte value, modified flag in red. >
6971 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6972 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6973< Display a ,GZ flag if a compressed file is loaded >
6974 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6975< In the |:autocmd|'s: >
6976 :let b:gzflag = 1
6977< And: >
6978 :unlet b:gzflag
6979< And define this function: >
6980 :function VarExists(var, val)
6981 : if exists(a:var) | return a:val | else | return '' | endif
6982 :endfunction
6983<
6984 *'suffixes'* *'su'*
6985'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6986 global
6987 {not in Vi}
6988 Files with these suffixes get a lower priority when multiple files
6989 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006990 suffixes. Spaces after the comma are ignored. A dot is also seen as
6991 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006992 separator, precede it with a backslash (see |option-backslash| about
6993 including spaces and backslashes).
6994 See 'wildignore' for completely ignoring files.
6995 The use of |:set+=| and |:set-=| is preferred when adding or removing
6996 suffixes from the list. This avoids problems when a future version
6997 uses another default.
6998
6999 *'suffixesadd'* *'sua'*
7000'suffixesadd' 'sua' string (default "")
7001 local to buffer
7002 {not in Vi}
7003 {not available when compiled without the
7004 |+file_in_path| feature}
7005 Comma separated list of suffixes, which are used when searching for a
7006 file for the "gf", "[I", etc. commands. Example: >
7007 :set suffixesadd=.java
7008<
7009 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7010'swapfile' 'swf' boolean (default on)
7011 local to buffer
7012 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007013 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 swapfile is not wanted for a specific buffer. For example, with
7015 confidential information that even root must not be able to access.
7016 Careful: All text will be in memory:
7017 - Don't use this for big files.
7018 - Recovery will be impossible!
7019 A swapfile will only be present when |'updatecount'| is non-zero and
7020 'swapfile' is set.
7021 When 'swapfile' is reset, the swap file for the current buffer is
7022 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7023 non-zero, a swap file is immediately created.
7024 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007025 If you want to open a new buffer without creating a swap file for it,
7026 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027
7028 This option is used together with 'bufhidden' and 'buftype' to
7029 specify special kinds of buffers. See |special-buffers|.
7030
7031 *'swapsync'* *'sws'*
7032'swapsync' 'sws' string (default "fsync")
7033 global
7034 {not in Vi}
7035 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007036 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 When this option is empty parts of the swap file may be in memory and
7038 not written to disk. When the system crashes you may lose more work.
7039 On Unix the system does a sync now and then without Vim asking for it,
7040 so the disadvantage of setting this option off is small. On some
7041 systems the swap file will not be written at all. For a unix system
7042 setting it to "sync" will use the sync() call instead of the default
7043 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007044 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045
7046 *'switchbuf'* *'swb'*
7047'switchbuf' 'swb' string (default "")
7048 global
7049 {not in Vi}
7050 This option controls the behavior when switching between buffers.
7051 Possible values (comma separated list):
7052 useopen If included, jump to the first open window that
7053 contains the specified buffer (if there is one).
7054 Otherwise: Do not examine other windows.
7055 This setting is checked with |quickfix| commands, when
7056 jumping to errors (":cc", ":cn", "cp", etc.). It is
7057 also used in all buffer related split commands, for
7058 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007059 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007060 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007061 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007062 a buffer for a |quickfix| command that display errors.
7063 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007064 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007065 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007067 *'synmaxcol'* *'smc'*
7068'synmaxcol' 'smc' number (default 3000)
7069 local to buffer
7070 {not in Vi}
7071 {not available when compiled without the |+syntax|
7072 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007073 Maximum column in which to search for syntax items. In long lines the
7074 text after this column is not highlighted and following lines may not
7075 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007076 This helps to avoid very slow redrawing for an XML file that is one
7077 long line.
7078 Set to zero to remove the limit.
7079
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 *'syntax'* *'syn'*
7081'syntax' 'syn' string (default empty)
7082 local to buffer
7083 {not in Vi}
7084 {not available when compiled without the |+syntax|
7085 feature}
7086 When this option is set, the syntax with this name is loaded, unless
7087 syntax highlighting has been switched off with ":syntax off".
7088 Otherwise this option does not always reflect the current syntax (the
7089 b:current_syntax variable does).
7090 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007091 not automatically recognized. Example, in an IDL file:
7092 /* vim: set syntax=idl : */ ~
7093 When a dot appears in the value then this separates two filetype
7094 names. Example:
7095 /* vim: set syntax=c.doxygen : */ ~
7096 This will use the "c" syntax first, then the "doxygen" syntax.
7097 Note that the second one must be prepared to be loaded as an addition,
7098 otherwise it will be skipped. More than one dot may appear.
7099 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 :set syntax=OFF
7101< To switch syntax highlighting on according to the current value of the
7102 'filetype' option: >
7103 :set syntax=ON
7104< What actually happens when setting the 'syntax' option is that the
7105 Syntax autocommand event is triggered with the value as argument.
7106 This option is not copied to another buffer, independent of the 's' or
7107 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007108 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007110 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007111'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007112 global
7113 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007114 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007115 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007116 When nonempty, this option determines the content of the tab pages
7117 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007118 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007119
7120 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007121 option and only when there is no GUI tab line. When 'e' is in
7122 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007123 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007124
7125 The value is evaluated like with 'statusline'. You can use
7126 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007127 the text to be displayed. Use "%1T" for the first label, "%2T" for
7128 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007129
7130 Keep in mind that only one of the tab pages is the current one, others
7131 are invisible and you can't jump to their windows.
7132
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007133
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007134 *'tabpagemax'* *'tpm'*
7135'tabpagemax' 'tpm' number (default 10)
7136 global
7137 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007138 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007139 feature}
7140 Maximum number of tab pages to be opened by the |-p| command line
7141 argument or the ":tab all" command. |tabpage|
7142
7143
7144 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145'tabstop' 'ts' number (default 8)
7146 local to buffer
7147 Number of spaces that a <Tab> in the file counts for. Also see
7148 |:retab| command, and 'softtabstop' option.
7149
7150 Note: Setting 'tabstop' to any other value than 8 can make your file
7151 appear wrong in many places (e.g., when printing it).
7152
7153 There are four main ways to use tabs in Vim:
7154 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7155 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007156 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 behave like a tab appears every 4 (or 3) characters.
7158 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7159 'expandtab'. This way you will always insert spaces. The
7160 formatting will never be messed up when 'tabstop' is changed.
7161 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007162 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 works when using Vim to edit the file.
7164 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7165 'noexpandtab'. This should then work (for initial indents only)
7166 for any tabstop setting that people use. It might be nice to have
7167 tabs after the first non-blank inserted as spaces if you do this
7168 though. Otherwise aligned comments will be wrong when 'tabstop' is
7169 changed.
7170
7171 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7172'tagbsearch' 'tbs' boolean (default on)
7173 global
7174 {not in Vi}
7175 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007176 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 searching makes searching for a tag a LOT faster, but a linear search
7178 will find more tags if the tags file wasn't properly sorted.
7179 Vim normally assumes that your tags files are sorted, or indicate that
7180 they are not sorted. Only when this is not the case does the
7181 'tagbsearch' option need to be switched off.
7182
7183 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007184 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 certain files, or retry all files with a linear search. When
7186 'tagbsearch' is off, only a linear search is done.
7187
7188 Linear searching is done anyway, for one file, when Vim finds a line
7189 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007190 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007191< [The whitespace before and after the '0' must be a single <Tab>]
7192
7193 When a binary search was done and no match was found in any of the
7194 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7195 instead of a normal tag name, a retry is done with a linear search.
7196 Tags in unsorted tags files, and matches with different case will only
7197 be found in the retry.
7198
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007199 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 linear search can be avoided for the 'ignorecase' case. Use a value
7201 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7202 case-fold sorted with the -f switch to "sort" in most unices, as in
7203 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007204 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7205 for this as well. Note that case must be folded to uppercase for this
7206 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207
7208 When 'tagbsearch' is off, tags searching is slower when a full match
7209 exists, but faster when no full match exists. Tags in unsorted tags
7210 files may only be found with 'tagbsearch' off.
7211 When the tags file is not sorted, or sorted in a wrong way (not on
7212 ASCII byte value), 'tagbsearch' should be off, or the line given above
7213 must be included in the tags file.
7214 This option doesn't affect commands that find all matching tags (e.g.,
7215 command-line completion and ":help").
7216 {Vi: always uses binary search in some versions}
7217
7218 *'taglength'* *'tl'*
7219'taglength' 'tl' number (default 0)
7220 global
7221 If non-zero, tags are significant up to this number of characters.
7222
7223 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7224'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7225 global
7226 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007227 If on and using a tags file in another directory, file names in that
7228 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007229 NOTE: This option is set to the Vi default value when 'compatible' is
7230 set and to the Vim default value when 'compatible' is reset.
7231
7232 *'tags'* *'tag'* *E433*
7233'tags' 'tag' string (default "./tags,tags", when compiled with
7234 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7235 global or local to buffer |global-local|
7236 Filenames for the tag command, separated by spaces or commas. To
7237 include a space or comma in a file name, precede it with a backslash
7238 (see |option-backslash| about including spaces and backslashes).
7239 When a file name starts with "./", the '.' is replaced with the path
7240 of the current file. But only when the 'd' flag is not included in
7241 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7242 |tags-option|.
7243 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007244 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7245 find all files named "tags" below "/lib". The filename itself cannot
7246 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7247 files called "tags?". {not available when compiled without the
7248 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007249 The |tagfiles()| function can be used to get a list of the file names
7250 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007251 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7252 files are also supported. They are automatically recognized. The
7253 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7254 differences are ignored (MS-Windows). |emacs-tags|
7255 The use of |:set+=| and |:set-=| is preferred when adding or removing
7256 file names from the list. This avoids problems when a future version
7257 uses another default.
7258 {Vi: default is "tags /usr/lib/tags"}
7259
7260 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7261'tagstack' 'tgst' boolean (default on)
7262 global
7263 {not in all versions of Vi}
7264 When on, the |tagstack| is used normally. When off, a ":tag" or
7265 ":tselect" command with an argument will not push the tag onto the
7266 tagstack. A following ":tag" without an argument, a ":pop" command or
7267 any other command that uses the tagstack will use the unmodified
7268 tagstack, but does change the pointer to the active entry.
7269 Resetting this option is useful when using a ":tag" command in a
7270 mapping which should not change the tagstack.
7271
7272 *'term'* *E529* *E530* *E531*
7273'term' string (default is $TERM, if that fails:
7274 in the GUI: "builtin_gui"
7275 on Amiga: "amiga"
7276 on BeOS: "beos-ansi"
7277 on Mac: "mac-ansi"
7278 on MiNT: "vt52"
7279 on MS-DOS: "pcterm"
7280 on OS/2: "os2ansi"
7281 on Unix: "ansi"
7282 on VMS: "ansi"
7283 on Win 32: "win32")
7284 global
7285 Name of the terminal. Used for choosing the terminal control
7286 characters. Environment variables are expanded |:set_env|.
7287 For example: >
7288 :set term=$TERM
7289< See |termcap|.
7290
7291 *'termbidi'* *'tbidi'*
7292 *'notermbidi'* *'notbidi'*
7293'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7294 global
7295 {not in Vi}
7296 {only available when compiled with the |+arabic|
7297 feature}
7298 The terminal is in charge of Bi-directionality of text (as specified
7299 by Unicode). The terminal is also expected to do the required shaping
7300 that some languages (such as Arabic) require.
7301 Setting this option implies that 'rightleft' will not be set when
7302 'arabic' is set and the value of 'arabicshape' will be ignored.
7303 Note that setting 'termbidi' has the immediate effect that
7304 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7305 This option is reset when the GUI is started.
7306 For further details see |arabic.txt|.
7307
7308 *'termencoding'* *'tenc'*
7309'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7310 Macintosh GUI: "macroman")
7311 global
7312 {only available when compiled with the |+multi_byte|
7313 feature}
7314 {not in Vi}
7315 Encoding used for the terminal. This specifies what character
7316 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007317 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007318 display). Except for the Mac when 'macatsui' is off, then
7319 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 In the Win32 console version the default value is the console codepage
7321 when it differs from the ANSI codepage.
7322 *E617*
7323 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7324 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7325 Any attempts to set a different value will be rejected, and an error
7326 message is shown.
7327 For the Win32 GUI 'termencoding' is not used for typed characters,
7328 because the Win32 system always passes Unicode characters.
7329 When empty, the same encoding is used as for the 'encoding' option.
7330 This is the normal value.
7331 Not all combinations for 'termencoding' and 'encoding' are valid. See
7332 |encoding-table|.
7333 The value for this option must be supported by internal conversions or
7334 iconv(). When this is not possible no conversion will be done and you
7335 will probably experience problems with non-ASCII characters.
7336 Example: You are working with the locale set to euc-jp (Japanese) and
7337 want to edit a UTF-8 file: >
7338 :let &termencoding = &encoding
7339 :set encoding=utf-8
7340< You need to do this when your system has no locale support for UTF-8.
7341
7342 *'terse'* *'noterse'*
7343'terse' boolean (default off)
7344 global
7345 When set: Add 's' flag to 'shortmess' option (this makes the message
7346 for a search that hits the start or end of the file not being
7347 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7348 shortens a lot of messages}
7349
7350 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7351'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7352 global
7353 {not in Vi}
7354 This option is obsolete. Use 'fileformats'.
7355 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7356 set to the default value for the current system. When 'textauto' is
7357 reset, 'fileformats' is made empty.
7358 NOTE: This option is set to the Vi default value when 'compatible' is
7359 set and to the Vim default value when 'compatible' is reset.
7360
7361 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7362'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7363 others: default off)
7364 local to buffer
7365 {not in Vi}
7366 This option is obsolete. Use 'fileformat'.
7367 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7368 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7369 "unix".
7370
7371 *'textwidth'* *'tw'*
7372'textwidth' 'tw' number (default 0)
7373 local to buffer
7374 {not in Vi}
7375 Maximum width of text that is being inserted. A longer line will be
7376 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007377 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7378 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007380 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 NOTE: This option is set to 0 when 'compatible' is set.
7382
7383 *'thesaurus'* *'tsr'*
7384'thesaurus' 'tsr' string (default "")
7385 global or local to buffer |global-local|
7386 {not in Vi}
7387 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007388 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 the file should contain words with similar meaning, separated by
7390 non-keyword characters (white space is preferred). Maximum line
7391 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007392 To obtain a file to be used here, check out this ftp site:
7393 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007394 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 after a comma are ignored, otherwise spaces are included in the file
7396 name. See |option-backslash| about using backslashes.
7397 The use of |:set+=| and |:set-=| is preferred when adding or removing
7398 directories from the list. This avoids problems when a future version
7399 uses another default.
7400 Backticks cannot be used in this option for security reasons.
7401
7402 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7403'tildeop' 'top' boolean (default off)
7404 global
7405 {not in Vi}
7406 When on: The tilde command "~" behaves like an operator.
7407 NOTE: This option is reset when 'compatible' is set.
7408
7409 *'timeout'* *'to'* *'notimeout'* *'noto'*
7410'timeout' 'to' boolean (default on)
7411 global
7412 *'ttimeout'* *'nottimeout'*
7413'ttimeout' boolean (default off)
7414 global
7415 {not in Vi}
7416 These two options together determine the behavior when part of a
7417 mapped key sequence or keyboard code has been received:
7418
7419 'timeout' 'ttimeout' action ~
7420 off off do not time out
7421 on on or off time out on :mappings and key codes
7422 off on time out on key codes
7423
7424 If both options are off, Vim will wait until either the complete
7425 mapping or key sequence has been received, or it is clear that there
7426 is no mapping or key sequence for the received characters. For
7427 example: if you have mapped "vl" and Vim has received 'v', the next
7428 character is needed to see if the 'v' is followed by an 'l'.
7429 When one of the options is on, Vim will wait for about 1 second for
7430 the next character to arrive. After that the already received
7431 characters are interpreted as single characters. The waiting time can
7432 be changed with the 'timeoutlen' option.
7433 On slow terminals or very busy systems timing out may cause
7434 malfunctioning cursor keys. If both options are off, Vim waits
7435 forever after an entered <Esc> if there are key codes that start
7436 with <Esc>. You will have to type <Esc> twice. If you do not have
7437 problems with key codes, but would like to have :mapped key
7438 sequences not timing out in 1 second, set the 'ttimeout' option and
7439 reset the 'timeout' option.
7440
7441 NOTE: 'ttimeout' is reset when 'compatible' is set.
7442
7443 *'timeoutlen'* *'tm'*
7444'timeoutlen' 'tm' number (default 1000)
7445 global
7446 {not in all versions of Vi}
7447 *'ttimeoutlen'* *'ttm'*
7448'ttimeoutlen' 'ttm' number (default -1)
7449 global
7450 {not in Vi}
7451 The time in milliseconds that is waited for a key code or mapped key
7452 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7453 when part of a command has been typed.
7454 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7455 different timeout value for key codes is desired set 'ttimeoutlen' to
7456 a non-negative number.
7457
7458 ttimeoutlen mapping delay key code delay ~
7459 < 0 'timeoutlen' 'timeoutlen'
7460 >= 0 'timeoutlen' 'ttimeoutlen'
7461
7462 The timeout only happens when the 'timeout' and 'ttimeout' options
7463 tell so. A useful setting would be >
7464 :set timeout timeoutlen=3000 ttimeoutlen=100
7465< (time out on mapping after three seconds, time out on key codes after
7466 a tenth of a second).
7467
7468 *'title'* *'notitle'*
7469'title' boolean (default off, on when title can be restored)
7470 global
7471 {not in Vi}
7472 {not available when compiled without the |+title|
7473 feature}
7474 When on, the title of the window will be set to the value of
7475 'titlestring' (if it is not empty), or to:
7476 filename [+=-] (path) - VIM
7477 Where:
7478 filename the name of the file being edited
7479 - indicates the file cannot be modified, 'ma' off
7480 + indicates the file was modified
7481 = indicates the file is read-only
7482 =+ indicates the file is read-only and modified
7483 (path) is the path of the file being edited
7484 - VIM the server name |v:servername| or "VIM"
7485 Only works if the terminal supports setting window titles
7486 (currently Amiga console, Win32 console, all GUI versions and
7487 terminals with a non- empty 't_ts' option - these are Unix xterm and
7488 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7489 *X11*
7490 When Vim was compiled with HAVE_X11 defined, the original title will
7491 be restored if possible. The output of ":version" will include "+X11"
7492 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7493 works for the icon name |'icon'|.
7494 But: When Vim was started with the |-X| argument, restoring the title
7495 will not work (except in the GUI).
7496 If the title cannot be restored, it is set to the value of 'titleold'.
7497 You might want to restore the title outside of Vim then.
7498 When using an xterm from a remote machine you can use this command:
7499 rsh machine_name xterm -display $DISPLAY &
7500 then the WINDOWID environment variable should be inherited and the
7501 title of the window should change back to what it should be after
7502 exiting Vim.
7503
7504 *'titlelen'*
7505'titlelen' number (default 85)
7506 global
7507 {not in Vi}
7508 {not available when compiled without the |+title|
7509 feature}
7510 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007511 title. When the title is longer, only the end of the path name is
7512 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007513 Using a percentage makes this adapt to the width of the window. But
7514 it won't work perfectly, because the actual number of characters
7515 available also depends on the font used and other things in the title
7516 bar. When 'titlelen' is zero the full path is used. Otherwise,
7517 values from 1 to 30000 percent can be used.
7518 'titlelen' is also used for the 'titlestring' option.
7519
7520 *'titleold'*
7521'titleold' string (default "Thanks for flying Vim")
7522 global
7523 {not in Vi}
7524 {only available when compiled with the |+title|
7525 feature}
7526 This option will be used for the window title when exiting Vim if the
7527 original title cannot be restored. Only happens if 'title' is on or
7528 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007529 This option cannot be set from a |modeline| or in the |sandbox|, for
7530 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007531 *'titlestring'*
7532'titlestring' string (default "")
7533 global
7534 {not in Vi}
7535 {not available when compiled without the |+title|
7536 feature}
7537 When this option is not empty, it will be used for the title of the
7538 window. This happens only when the 'title' option is on.
7539 Only works if the terminal supports setting window titles (currently
7540 Amiga console, Win32 console, all GUI versions and terminals with a
7541 non-empty 't_ts' option).
7542 When Vim was compiled with HAVE_X11 defined, the original title will
7543 be restored if possible |X11|.
7544 When this option contains printf-style '%' items, they will be
7545 expanded according to the rules used for 'statusline'.
7546 Example: >
7547 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7548 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7549< The value of 'titlelen' is used to align items in the middle or right
7550 of the available space.
7551 Some people prefer to have the file name first: >
7552 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7553< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007554 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007555 separating space only when needed.
7556 NOTE: Use of special characters in 'titlestring' may cause the display
7557 to be garbled (e.g., when it contains a CR or NL character).
7558 {not available when compiled without the |+statusline| feature}
7559
7560 *'toolbar'* *'tb'*
7561'toolbar' 'tb' string (default "icons,tooltips")
7562 global
7563 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7564 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007565 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 possible values are:
7567 icons Toolbar buttons are shown with icons.
7568 text Toolbar buttons shown with text.
7569 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007570 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 tooltips Tooltips are active for toolbar buttons.
7572 Tooltips refer to the popup help text which appears after the mouse
7573 cursor is placed over a toolbar button for a brief moment.
7574
7575 If you want the toolbar to be shown with icons as well as text, do the
7576 following: >
7577 :set tb=icons,text
7578< Motif and Athena cannot display icons and text at the same time. They
7579 will show icons if both are requested.
7580
7581 If none of the strings specified in 'toolbar' are valid or if
7582 'toolbar' is empty, this option is ignored. If you want to disable
7583 the toolbar, you need to set the 'guioptions' option. For example: >
7584 :set guioptions-=T
7585< Also see |gui-toolbar|.
7586
7587 *'toolbariconsize'* *'tbis'*
7588'toolbariconsize' 'tbis' string (default "small")
7589 global
7590 {not in Vi}
7591 {only in the GTK+ 2 GUI}
7592 Controls the size of toolbar icons. The possible values are:
7593 tiny Use tiny toolbar icons.
7594 small Use small toolbar icons (default).
7595 medium Use medium-sized toolbar icons.
7596 large Use large toolbar icons.
7597 The exact dimensions in pixels of the various icon sizes depend on
7598 the current theme. Common dimensions are large=32x32, medium=24x24,
7599 small=20x20 and tiny=16x16.
7600
7601 If 'toolbariconsize' is empty, the global default size as determined
7602 by user preferences or the current theme is used.
7603
7604 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7605'ttybuiltin' 'tbi' boolean (default on)
7606 global
7607 {not in Vi}
7608 When on, the builtin termcaps are searched before the external ones.
7609 When off the builtin termcaps are searched after the external ones.
7610 When this option is changed, you should set the 'term' option next for
7611 the change to take effect, for example: >
7612 :set notbi term=$TERM
7613< See also |termcap|.
7614 Rationale: The default for this option is "on", because the builtin
7615 termcap entries are generally better (many systems contain faulty
7616 xterm entries...).
7617
7618 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7619'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7620 sun-cmd, screen, rxvt, dtterm or
7621 iris-ansi; also on when running Vim in
7622 a DOS console)
7623 global
7624 {not in Vi}
7625 Indicates a fast terminal connection. More characters will be sent to
7626 the screen for redrawing, instead of using insert/delete line
7627 commands. Improves smoothness of redrawing when there are multiple
7628 windows and the terminal does not support a scrolling region.
7629 Also enables the extra writing of characters at the end of each screen
7630 line for lines that wrap. This helps when using copy/paste with the
7631 mouse in an xterm and other terminals.
7632
7633 *'ttymouse'* *'ttym'*
7634'ttymouse' 'ttym' string (default depends on 'term')
7635 global
7636 {not in Vi}
7637 {only in Unix and VMS, doesn't work in the GUI; not
7638 available when compiled without |+mouse|}
7639 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007640 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 *xterm-mouse*
7642 xterm xterm-like mouse handling. The mouse generates
7643 "<Esc>[Mscr", where "scr" is three bytes:
7644 "s" = button state
7645 "c" = column plus 33
7646 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007647 This only works up to 223 columns! See "dec",
7648 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 xterm2 Works like "xterm", but with the xterm reporting the
7650 mouse position while the mouse is dragged. This works
7651 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007652 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 work. See below for how Vim detects this
7654 automatically.
7655 *netterm-mouse*
7656 netterm NetTerm mouse handling. The mouse generates
7657 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7658 for the row and column.
7659 *dec-mouse*
7660 dec DEC terminal mouse handling. The mouse generates a
7661 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007662 This is also available for an Xterm, if it was
7663 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 *jsbterm-mouse*
7665 jsbterm JSB term mouse handling.
7666 *pterm-mouse*
7667 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007668 *urxvt-mouse*
7669 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007670 The mouse works only if the terminal supports this
7671 encoding style, but it does not have 223 columns limit
7672 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007673 *sgr-mouse*
7674 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007675 mouse reporting. The mouse works even in columns
7676 beyond 223. This option is backward compatible with
7677 "xterm2" because it can also decode "xterm2" style
7678 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679
7680 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007681 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7682 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007683 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7684 recognized, if enabled at compile time. DEC terminal mouse codes
7685 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007686 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7687 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007689 set to a name that starts with "xterm", "mlterm", or "screen", and
7690 'ttymouse' is not set already.
7691 Additionally, if vim is compiled with the |+termresponse| feature and
7692 |t_RV| is set to the escape sequence to request the xterm version
7693 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007694 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007695 from 95 to 276. The "sgr" value will be set if the xterm version is
7696 277 or highter.
7697 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7698 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007699 :set t_RV=
7700<
7701 *'ttyscroll'* *'tsl'*
7702'ttyscroll' 'tsl' number (default 999)
7703 global
7704 Maximum number of lines to scroll the screen. If there are more lines
7705 to scroll the window is redrawn. For terminals where scrolling is
7706 very slow and redrawing is not slow this can be set to a small number,
7707 e.g., 3, to speed up displaying.
7708
7709 *'ttytype'* *'tty'*
7710'ttytype' 'tty' string (default from $TERM)
7711 global
7712 Alias for 'term', see above.
7713
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007714 *'undodir'* *'udir'*
7715'undodir' 'udir' string (default ".")
7716 global
7717 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007718 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007719 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007720 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007721 "." means using the directory of the file. The undo file name for
7722 "file.txt" is ".file.txt.un~".
7723 For other directories the file name is the full path of the edited
7724 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007725 When writing: The first directory that exists is used. "." always
7726 works, no directories after "." will be used for writing.
7727 When reading all entries are tried to find an undo file. The first
7728 undo file that exists is used. When it cannot be read an error is
7729 given, no further entry is used.
7730 See |undo-persistence|.
7731
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007732 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007733'undofile' 'udf' boolean (default off)
7734 local to buffer
7735 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007736 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007737 When on, Vim automatically saves undo history to an undo file when
7738 writing a buffer to a file, and restores undo history from the same
7739 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007740 The directory where the undo file is stored is specified by 'undodir'.
7741 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007742 The undo file is not read when 'undoreload' causes the buffer from
7743 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007744 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007745
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 *'undolevels'* *'ul'*
7747'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7748 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007749 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 {not in Vi}
7751 Maximum number of changes that can be undone. Since undo information
7752 is kept in memory, higher numbers will cause more memory to be used
7753 (nevertheless, a single change can use an unlimited amount of memory).
7754 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7755 itself: >
7756 set ul=0
7757< But you can also get Vi compatibility by including the 'u' flag in
7758 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007759 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007760 Set to -1 for no undo at all. You might want to do this only for the
7761 current buffer: >
7762 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007764
7765 The local value is set to -123456 when the global value is to be used.
7766
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007767 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007769 *'undoreload'* *'ur'*
7770'undoreload' 'ur' number (default 10000)
7771 global
7772 {not in Vi}
7773 Save the whole buffer for undo when reloading it. This applies to the
7774 ":e!" command and reloading for when the buffer changed outside of
7775 Vim. |FileChangedShell|
7776 The save only happens when this options is negative or when the number
7777 of lines is smaller than the value of this option.
7778 Set this option to zero to disable undo for a reload.
7779
7780 When saving undo for a reload, any undo file is not read.
7781
7782 Note that this causes the whole buffer to be stored in memory. Set
7783 this option to a lower value if you run out of memory.
7784
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 *'updatecount'* *'uc'*
7786'updatecount' 'uc' number (default: 200)
7787 global
7788 {not in Vi}
7789 After typing this many characters the swap file will be written to
7790 disk. When zero, no swap file will be created at all (see chapter on
7791 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7792 Vim with the "-n" option, see |startup|. When editing in readonly
7793 mode this option will be initialized to 10000.
7794 The swapfile can be disabled per buffer with |'swapfile'|.
7795 When 'updatecount' is set from zero to non-zero, swap files are
7796 created for all buffers that have 'swapfile' set. When 'updatecount'
7797 is set to zero, existing swap files are not deleted.
7798 Also see |'swapsync'|.
7799 This option has no meaning in buffers where |'buftype'| is "nofile"
7800 or "nowrite".
7801
7802 *'updatetime'* *'ut'*
7803'updatetime' 'ut' number (default 4000)
7804 global
7805 {not in Vi}
7806 If this many milliseconds nothing is typed the swap file will be
7807 written to disk (see |crash-recovery|). Also used for the
7808 |CursorHold| autocommand event.
7809
7810 *'verbose'* *'vbs'*
7811'verbose' 'vbs' number (default 0)
7812 global
7813 {not in Vi, although some versions have a boolean
7814 verbose option}
7815 When bigger than zero, Vim will give messages about what it is doing.
7816 Currently, these messages are given:
7817 >= 1 When the viminfo file is read or written.
7818 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007819 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 >= 8 Files for which a group of autocommands is executed.
7821 >= 9 Every executed autocommand.
7822 >= 12 Every executed function.
7823 >= 13 When an exception is thrown, caught, finished, or discarded.
7824 >= 14 Anything pending in a ":finally" clause.
7825 >= 15 Every executed Ex command (truncated at 200 characters).
7826
7827 This option can also be set with the "-V" argument. See |-V|.
7828 This option is also set by the |:verbose| command.
7829
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007830 When the 'verbosefile' option is set then the verbose messages are not
7831 displayed.
7832
7833 *'verbosefile'* *'vfile'*
7834'verbosefile' 'vfile' string (default empty)
7835 global
7836 {not in Vi}
7837 When not empty all messages are written in a file with this name.
7838 When the file exists messages are appended.
7839 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007840 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007841 Setting 'verbosefile' to a new value is like making it empty first.
7842 The difference with |:redir| is that verbose messages are not
7843 displayed when 'verbosefile' is set.
7844
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 *'viewdir'* *'vdir'*
7846'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7847 "$VIM/vimfiles/view",
7848 for Unix: "~/.vim/view",
7849 for Macintosh: "$VIM:vimfiles:view"
7850 for VMS: "sys$login:vimfiles/view"
7851 for RiscOS: "Choices:vimfiles/view")
7852 global
7853 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007854 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 feature}
7856 Name of the directory where to store files for |:mkview|.
7857 This option cannot be set from a |modeline| or in the |sandbox|, for
7858 security reasons.
7859
7860 *'viewoptions'* *'vop'*
7861'viewoptions' 'vop' string (default: "folds,options,cursor")
7862 global
7863 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007864 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007865 feature}
7866 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007867 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 word save and restore ~
7869 cursor cursor position in file and in window
7870 folds manually created folds, opened/closed folds and local
7871 fold options
7872 options options and mappings local to a window or buffer (not
7873 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007874 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 slash backslashes in file names replaced with forward
7876 slashes
7877 unix with Unix end-of-line format (single <NL>), even when
7878 on Windows or DOS
7879
7880 "slash" and "unix" are useful on Windows when sharing view files
7881 with Unix. The Unix version of Vim cannot source dos format scripts,
7882 but the Windows version of Vim can source unix format scripts.
7883
7884 *'viminfo'* *'vi'* *E526* *E527* *E528*
7885'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007886 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7887 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7888 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 global
7890 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007891 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007892 feature}
7893 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007894 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007895 separated list of parameters, each consisting of a single character
7896 identifying the particular parameter, followed by a number or string
7897 which specifies the value of that parameter. If a particular
7898 character is left out, then the default value is used for that
7899 parameter. The following is a list of the identifying characters and
7900 the effect of their value.
7901 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007902 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 ! When included, save and restore global variables that start
7904 with an uppercase letter, and don't contain a lowercase
7905 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007906 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007907 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007908 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007909 " Maximum number of lines saved for each register. Old name of
7910 the '<' item, with the disadvantage that you need to put a
7911 backslash before the ", otherwise it will be recognized as the
7912 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007913 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 % When included, save and restore the buffer list. If Vim is
7915 started with a file name argument, the buffer list is not
7916 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007917 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 without a file name and buffers for help files are not written
7919 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007920 When followed by a number, the number specifies the maximum
7921 number of buffers that are stored. Without a number all
7922 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007923 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 ' Maximum number of previously edited files for which the marks
7925 are remembered. This parameter must always be included when
7926 'viminfo' is non-empty.
7927 Including this item also means that the |jumplist| and the
7928 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007929 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007931 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007932 patterns are also saved. When not included, the value of
7933 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007934 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007935 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007936 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007937 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 < Maximum number of lines saved for each register. If zero then
7939 registers are not saved. When not included, all lines are
7940 saved. '"' is the old name for this item.
7941 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007942 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007944 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007945 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 c When included, convert the text in the viminfo file from the
7947 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007948 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007949 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007950 f Whether file marks need to be stored. If zero, file marks ('0
7951 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007952 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007954 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955 h Disable the effect of 'hlsearch' when loading the viminfo
7956 file. When not included, it depends on whether ":nohlsearch"
7957 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007958 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 n Name of the viminfo file. The name must immediately follow
7960 the 'n'. Must be the last one! If the "-i" argument was
7961 given when starting Vim, that file name overrides the one
7962 given here with 'viminfo'. Environment variables are expanded
7963 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007964 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007965 r Removable media. The argument is a string (up to the next
7966 ','). This parameter can be given several times. Each
7967 specifies the start of a path for which no marks will be
7968 stored. This is to avoid removable media. For MS-DOS you
7969 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7970 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7971 ignored. Maximum length of each 'r' argument is 50
7972 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007973 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 s Maximum size of an item in Kbyte. If zero then registers are
7975 not saved. Currently only applies to registers. The default
7976 "s10" will exclude registers with more than 10 Kbyte of text.
7977 Also see the '<' item above: line count limit.
7978
7979 Example: >
7980 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7981<
7982 '50 Marks will be remembered for the last 50 files you
7983 edited.
7984 <1000 Contents of registers (up to 1000 lines each) will be
7985 remembered.
7986 s100 Registers with more than 100 Kbyte text are skipped.
7987 :0 Command-line history will not be saved.
7988 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7989 no / Since '/' is not specified, the default will be used,
7990 that is, save all of the search history, and also the
7991 previous search and substitute patterns.
7992 no % The buffer list will not be saved nor read back.
7993 no h 'hlsearch' highlighting will be restored.
7994
7995 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7996 load the contents of the file, this is not done automatically.
7997
7998 This option cannot be set from a |modeline| or in the |sandbox|, for
7999 security reasons.
8000
8001 *'virtualedit'* *'ve'*
8002'virtualedit' 've' string (default "")
8003 global
8004 {not in Vi}
8005 {not available when compiled without the
8006 |+virtualedit| feature}
8007 A comma separated list of these words:
8008 block Allow virtual editing in Visual block mode.
8009 insert Allow virtual editing in Insert mode.
8010 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008011 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008012
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008014 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 of the line. Useful for selecting a rectangle in Visual mode and
8016 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008017 "onemore" is not the same, it will only allow moving the cursor just
8018 after the last character of the line. This makes some commands more
8019 consistent. Previously the cursor was always past the end of the line
8020 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008021 break some plugins or Vim scripts. For example because |l| can move
8022 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008023 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008024 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008025 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008026 It doesn't make sense to combine "all" with "onemore", but you will
8027 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028
8029 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8030'visualbell' 'vb' boolean (default off)
8031 global
8032 {not in Vi}
8033 Use visual bell instead of beeping. The terminal code to display the
8034 visual bell is given with 't_vb'. When no beep or flash is wanted,
8035 use ":set vb t_vb=".
8036 Note: When the GUI starts, 't_vb' is reset to its default value. You
8037 might want to set it again in your |gvimrc|.
8038 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8039 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8040 where 40 is the time in msec.
8041 Does not work on the Amiga, you always get a screen flash.
8042 Also see 'errorbells'.
8043
8044 *'warn'* *'nowarn'*
8045'warn' boolean (default on)
8046 global
8047 Give a warning message when a shell command is used while the buffer
8048 has been changed.
8049
8050 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8051'weirdinvert' 'wiv' boolean (default off)
8052 global
8053 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008054 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 It is provided for backwards compatibility with version 4.x.
8056 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8057 vice versa. Has no effect when the GUI is running.
8058
8059 *'whichwrap'* *'ww'*
8060'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8061 global
8062 {not in Vi}
8063 Allow specified keys that move the cursor left/right to move to the
8064 previous/next line when the cursor is on the first/last character in
8065 the line. Concatenate characters to allow this for these keys:
8066 char key mode ~
8067 b <BS> Normal and Visual
8068 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008069 h "h" Normal and Visual (not recommended)
8070 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008071 < <Left> Normal and Visual
8072 > <Right> Normal and Visual
8073 ~ "~" Normal
8074 [ <Left> Insert and Replace
8075 ] <Right> Insert and Replace
8076 For example: >
8077 :set ww=<,>,[,]
8078< allows wrap only when cursor keys are used.
8079 When the movement keys are used in combination with a delete or change
8080 operator, the <EOL> also counts for a character. This makes "3h"
8081 different from "3dh" when the cursor crosses the end of a line. This
8082 is also true for "x" and "X", because they do the same as "dl" and
8083 "dh". If you use this, you may also want to use the mapping
8084 ":map <BS> X" to make backspace delete the character in front of the
8085 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008086 When 'l' is included and it is used after an operator at the end of a
8087 line then it will not move to the next line. This makes "dl", "cl",
8088 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 NOTE: This option is set to the Vi default value when 'compatible' is
8090 set and to the Vim default value when 'compatible' is reset.
8091
8092 *'wildchar'* *'wc'*
8093'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8094 global
8095 {not in Vi}
8096 Character you have to type to start wildcard expansion in the
8097 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008098 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008099 The character is not recognized when used inside a macro. See
8100 'wildcharm' for that.
8101 Although 'wc' is a number option, you can set it to a special key: >
8102 :set wc=<Esc>
8103< NOTE: This option is set to the Vi default value when 'compatible' is
8104 set and to the Vim default value when 'compatible' is reset.
8105
8106 *'wildcharm'* *'wcm'*
8107'wildcharm' 'wcm' number (default: none (0))
8108 global
8109 {not in Vi}
8110 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008111 recognized when used inside a macro. You can find "spare" command-line
8112 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 you'll never actually type 'wildcharm', just use it in mappings that
8114 automatically invoke completion mode, e.g.: >
8115 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008116 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008117< Then after typing :ss you can use CTRL-P & CTRL-N.
8118
8119 *'wildignore'* *'wig'*
8120'wildignore' 'wig' string (default "")
8121 global
8122 {not in Vi}
8123 {not available when compiled without the |+wildignore|
8124 feature}
8125 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008126 patterns is ignored when expanding |wildcards|, completing file or
8127 directory names, and influences the result of |expand()|, |glob()| and
8128 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008129 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8130 Also see 'suffixes'.
8131 Example: >
8132 :set wildignore=*.o,*.obj
8133< The use of |:set+=| and |:set-=| is preferred when adding or removing
8134 a pattern from the list. This avoids problems when a future version
8135 uses another default.
8136
Bram Moolenaar94950a92010-12-02 16:01:29 +01008137
Bram Moolenaar81af9252010-12-10 20:35:50 +01008138 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008139'wildignorecase' 'wic' boolean (default off)
8140 global
8141 {not in Vi}
8142 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008143 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008144 Does not apply when the shell is used to expand wildcards, which
8145 happens when there are special characters.
8146
8147
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8149'wildmenu' 'wmnu' boolean (default off)
8150 global
8151 {not in Vi}
8152 {not available if compiled without the |+wildmenu|
8153 feature}
8154 When 'wildmenu' is on, command-line completion operates in an enhanced
8155 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8156 the possible matches are shown just above the command line, with the
8157 first match highlighted (overwriting the status line, if there is
8158 one). Keys that show the previous/next match, such as <Tab> or
8159 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8160 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8161 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008162 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 If there are more matches than can fit in the line, a ">" is shown on
8164 the right and/or a "<" is shown on the left. The status line scrolls
8165 as needed.
8166 The "wildmenu" mode is abandoned when a key is hit that is not used
8167 for selecting a completion.
8168 While the "wildmenu" is active the following keys have special
8169 meanings:
8170
8171 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8172 <Down> - in filename/menu name completion: move into a
8173 subdirectory or submenu.
8174 <CR> - in menu completion, when the cursor is just after a
8175 dot: move into a submenu.
8176 <Up> - in filename/menu name completion: move up into
8177 parent directory or parent menu.
8178
8179 This makes the menus accessible from the console |console-menus|.
8180
8181 If you prefer the <Left> and <Right> keys to move the cursor instead
8182 of selecting a different match, use this: >
8183 :cnoremap <Left> <Space><BS><Left>
8184 :cnoremap <Right> <Space><BS><Right>
8185<
8186 The "WildMenu" highlighting is used for displaying the current match
8187 |hl-WildMenu|.
8188
8189 *'wildmode'* *'wim'*
8190'wildmode' 'wim' string (Vim default: "full")
8191 global
8192 {not in Vi}
8193 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008194 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008195 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 first part specifies the behavior for the first use of 'wildchar',
8197 The second part for the second use, etc.
8198 These are the possible values for each part:
8199 "" Complete only the first match.
8200 "full" Complete the next full match. After the last match,
8201 the original string is used and then the first match
8202 again.
8203 "longest" Complete till longest common string. If this doesn't
8204 result in a longer string, use the next part.
8205 "longest:full" Like "longest", but also start 'wildmenu' if it is
8206 enabled.
8207 "list" When more than one match, list all matches.
8208 "list:full" When more than one match, list all matches and
8209 complete first match.
8210 "list:longest" When more than one match, list all matches and
8211 complete till longest common string.
8212 When there is only a single match, it is fully completed in all cases.
8213
8214 Examples: >
8215 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008216< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 :set wildmode=longest,full
8218< Complete longest common string, then each full match >
8219 :set wildmode=list:full
8220< List all matches and complete each full match >
8221 :set wildmode=list,full
8222< List all matches without completing, then each full match >
8223 :set wildmode=longest,list
8224< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008225 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008226
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008227 *'wildoptions'* *'wop'*
8228'wildoptions' 'wop' string (default "")
8229 global
8230 {not in Vi}
8231 {not available when compiled without the |+wildignore|
8232 feature}
8233 A list of words that change how command line completion is done.
8234 Currently only one word is allowed:
8235 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008236 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008237 is displayed per line. Often used tag kinds are:
8238 d #define
8239 f function
8240 Also see |cmdline-completion|.
8241
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 *'winaltkeys'* *'wak'*
8243'winaltkeys' 'wak' string (default "menu")
8244 global
8245 {not in Vi}
8246 {only used in Win32, Motif, GTK and Photon GUI}
8247 Some GUI versions allow the access to menu entries by using the ALT
8248 key in combination with a character that appears underlined in the
8249 menu. This conflicts with the use of the ALT key for mappings and
8250 entering special characters. This option tells what to do:
8251 no Don't use ALT keys for menus. ALT key combinations can be
8252 mapped, but there is no automatic handling. This can then be
8253 done with the |:simalt| command.
8254 yes ALT key handling is done by the windowing system. ALT key
8255 combinations cannot be mapped.
8256 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008257 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008258 keys can be mapped.
8259 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8260 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008261 This option is not used for <F10>; on Win32 and with GTK <F10> will
8262 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008263
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008264 *'window'* *'wi'*
8265'window' 'wi' number (default screen height - 1)
8266 global
8267 Window height. Do not confuse this with the height of the Vim window,
8268 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008269 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8270 value is smaller than 'lines' minus one. The screen will scroll
8271 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008272 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8273 in a much smarter way, taking care of wrapping lines.
8274 When resizing the Vim window, the value is smaller than 1 or more than
8275 or equal to 'lines' it will be set to 'lines' minus 1.
8276 {Vi also uses the option to specify the number of displayed lines}
8277
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 *'winheight'* *'wh'* *E591*
8279'winheight' 'wh' number (default 1)
8280 global
8281 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008282 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 feature}
8284 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008285 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008286 focus goes to a window that is smaller, its size is increased, at the
8287 cost of the height of other windows.
8288 Set 'winheight' to a small number for normal editing.
8289 Set it to 999 to make the current window fill most of the screen.
8290 Other windows will be only 'winminheight' high. This has the drawback
8291 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8292 to create only two windows, set the option after startup is done,
8293 using the |VimEnter| event: >
8294 au VimEnter * set winheight=999
8295< Minimum value is 1.
8296 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008297 height of the current window.
8298 'winheight' applies to the current window. Use 'winminheight' to set
8299 the minimal height for other windows.
8300
8301 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8302'winfixheight' 'wfh' boolean (default off)
8303 local to window
8304 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008305 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008306 feature}
8307 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008308 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8309 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008310 The height may be changed anyway when running out of room.
8311
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008312 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8313'winfixwidth' 'wfw' boolean (default off)
8314 local to window
8315 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008316 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008317 feature}
8318 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008319 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008320 The width may be changed anyway when running out of room.
8321
Bram Moolenaar071d4272004-06-13 20:20:40 +00008322 *'winminheight'* *'wmh'*
8323'winminheight' 'wmh' number (default 1)
8324 global
8325 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008326 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008327 feature}
8328 The minimal height of a window, when it's not the current window.
8329 This is a hard minimum, windows will never become smaller.
8330 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8331 status bar) if necessary. They will return to at least one line when
8332 they become active (since the cursor has to have somewhere to go.)
8333 Use 'winheight' to set the minimal height of the current window.
8334 This option is only checked when making a window smaller. Don't use a
8335 large number, it will cause errors when opening more than a few
8336 windows. A value of 0 to 3 is reasonable.
8337
8338 *'winminwidth'* *'wmw'*
8339'winminwidth' 'wmw' number (default 1)
8340 global
8341 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008342 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008343 feature}
8344 The minimal width of a window, when it's not the current window.
8345 This is a hard minimum, windows will never become smaller.
8346 When set to zero, windows may be "squashed" to zero columns (i.e. just
8347 a vertical separator) if necessary. They will return to at least one
8348 line when they become active (since the cursor has to have somewhere
8349 to go.)
8350 Use 'winwidth' to set the minimal width of the current window.
8351 This option is only checked when making a window smaller. Don't use a
8352 large number, it will cause errors when opening more than a few
8353 windows. A value of 0 to 12 is reasonable.
8354
8355 *'winwidth'* *'wiw'* *E592*
8356'winwidth' 'wiw' number (default 20)
8357 global
8358 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008359 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 feature}
8361 Minimal number of columns for the current window. This is not a hard
8362 minimum, Vim will use fewer columns if there is not enough room. If
8363 the current window is smaller, its size is increased, at the cost of
8364 the width of other windows. Set it to 999 to make the current window
8365 always fill the screen. Set it to a small number for normal editing.
8366 The width is not adjusted after one of the commands to change the
8367 width of the current window.
8368 'winwidth' applies to the current window. Use 'winminwidth' to set
8369 the minimal width for other windows.
8370
8371 *'wrap'* *'nowrap'*
8372'wrap' boolean (default on)
8373 local to window
8374 {not in Vi}
8375 This option changes how text is displayed. It doesn't change the text
8376 in the buffer, see 'textwidth' for that.
8377 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008378 displaying continues on the next line. When off lines will not wrap
8379 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 moved to a part that is not shown, the screen will scroll
8381 horizontally.
8382 The line will be broken in the middle of a word if necessary. See
8383 'linebreak' to get the break at a word boundary.
8384 To make scrolling horizontally a bit more useful, try this: >
8385 :set sidescroll=5
8386 :set listchars+=precedes:<,extends:>
8387< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008388 This option can't be set from a |modeline| when the 'diff' option is
8389 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390
8391 *'wrapmargin'* *'wm'*
8392'wrapmargin' 'wm' number (default 0)
8393 local to buffer
8394 Number of characters from the right window border where wrapping
8395 starts. When typing text beyond this limit, an <EOL> will be inserted
8396 and inserting continues on the next line.
8397 Options that add a margin, such as 'number' and 'foldcolumn', cause
8398 the text width to be further reduced. This is Vi compatible.
8399 When 'textwidth' is non-zero, this option is not used.
8400 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8401 and less usefully}
8402
8403 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8404'wrapscan' 'ws' boolean (default on) *E384* *E385*
8405 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008406 Searches wrap around the end of the file. Also applies to |]s| and
8407 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408
8409 *'write'* *'nowrite'*
8410'write' boolean (default on)
8411 global
8412 {not in Vi}
8413 Allows writing files. When not set, writing a file is not allowed.
8414 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008415 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 argument. Filtering text is still possible, even though this requires
8417 writing a temporary file.
8418
8419 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8420'writeany' 'wa' boolean (default off)
8421 global
8422 Allows writing to any file with no need for "!" override.
8423
8424 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8425'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8426 otherwise)
8427 global
8428 {not in Vi}
8429 Make a backup before overwriting a file. The backup is removed after
8430 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008431 also on.
8432 WARNING: Switching this option off means that when Vim fails to write
8433 your buffer correctly and then, for whatever reason, Vim exits, you
8434 lose both the original file and what you were writing. Only reset
8435 this option if your file system is almost full and it makes the write
8436 fail (and make sure not to exit Vim until the write was successful).
8437 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 When the 'backupskip' pattern matches, a backup is not made anyway.
8439 NOTE: This option is set to the default value when 'compatible' is
8440 set.
8441
8442 *'writedelay'* *'wd'*
8443'writedelay' 'wd' number (default 0)
8444 global
8445 {not in Vi}
8446 The number of microseconds to wait for each character sent to the
8447 screen. When non-zero, characters are sent to the terminal one by
8448 one. For MS-DOS pcterm this does not work. For debugging purposes.
8449
8450 vim:tw=78:ts=8:ft=help:norl: