blob: 23ac10a61f5b43c6f32ba6782ba4133eb88c4bd0 [file] [log] [blame]
Bram Moolenaardb7207e2012-02-22 17:30:19 +01001*options.txt* For Vim version 7.3. Last change: 2012 Feb 22
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
280You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000281"one". The options local to a window are not remembered for each buffer.
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:
481 [text]{white}{vi:|vim:|ex:}[white]{options}
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487{options} a list of option settings, separated with white space or ':',
488 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000489 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000491Example:
492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493
494The second form (this is compatible with some versions of Vi):
495
496 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
497
498[text] any text or empty
499{white} at least one blank character (<Space> or <Tab>)
500{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
501[white] optional white space
502se[t] the string "set " or "se " (note the space)
503{options} a list of options, separated with white space, which is the
504 argument for a ":set" command
505: a colon
506[text] any text or empty
507
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000508Example:
509 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511The white space before {vi:|vim:|ex:} is required. This minimizes the chance
512that a normal word like "lex:" is caught. There is one exception: "vi:" and
513"vim:" can also be at the start of the line (for compatibility with version
5143.0). Using "ex:" at the start of the line will be ignored (this could be
515short for "example:").
516
517 *modeline-local*
518The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000519buffer and window that contain the file. Although it's possible to set global
520options from a modeline, this is unusual. If you have two windows open and
521the files in it set the same global option to a different value, the result
522depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000524When editing a file that was already loaded, only the window-local options
525from the modeline are used. Thus if you manually changed a buffer-local
526option after opening the file, it won't be changed if you edit the same buffer
527in another window. But window-local options will be set.
528
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 *modeline-version*
530If the modeline is only to be used for some versions of Vim, the version
531number can be specified where "vim:" is used:
532 vim{vers}: version {vers} or later
533 vim<{vers}: version before {vers}
534 vim={vers}: version {vers}
535 vim>{vers}: version after {vers}
536{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000537For example, to use a modeline only for Vim 6.0 and later:
538 /* vim600: set foldmethod=marker: */ ~
539To use a modeline for Vim before version 5.7:
540 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541There can be no blanks between "vim" and the ":".
542
543
544The number of lines that are checked can be set with the 'modelines' option.
545If 'modeline' is off or 'modelines' is 0 no lines are checked.
546
547Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000548like:
549 /* vi:ts=4: */ ~
550will give an error message for the trailing "*/". This line is OK:
551 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553If an error is detected the rest of the line is skipped.
554
555If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000556backslash in front of the ':' will be removed. Example:
557 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558This sets the 'dir' option to "c:\tmp". Only a single backslash before the
559':' is removed. Thus to include "\:" you have to specify "\\:".
560
561No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000562might create a Trojan horse text file with modelines). And not all options
563can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000564|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
566are wrapped unexpectedly. So disable modelines before editing untrusted text.
567The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568
569Hint: If you would like to do something else than setting an option, you could
570define an autocommand that checks the file for a specific string. For
571example: >
572 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
573And define a function SetVar() that does something with the line containing
574"VAR".
575
576==============================================================================
5773. Options summary *option-summary*
578
579In the list below all the options are mentioned with their full name and with
580an abbreviation if there is one. Both forms may be used.
581
582In this document when a boolean option is "set" that means that ":set option"
583is entered. When an option is "reset", ":set nooption" is used.
584
585For some options there are two default values: The "Vim default", which is
586used when 'compatible' is not set, and the "Vi default", which is used when
587'compatible' is set.
588
589Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000590are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591different value in each window. For example the 'list' option can be set in
592one window and reset in another for the same text, giving both types of view
593at the same time. There are a few options that are specific to a certain
594file. These can have a different value for each file or buffer. For example
595the 'textwidth' option can be 78 for a normal text file and 0 for a C
596program.
597
598 global one option for all buffers and windows
599 local to window each window has its own copy of this option
600 local to buffer each buffer has its own copy of this option
601
602When creating a new window the option values from the currently active window
603are used as a default value for the window-specific options. For the
604buffer-specific options this depends on the 's' and 'S' flags in the
605'cpoptions' option. If 's' is included (which is the default) the values for
606buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000607first entered. If 'S' is present the options are copied each time the buffer
608is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609present, the options are copied from the currently active buffer when the
610buffer is created.
611
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000612Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000614Not all options are supported in all versions. This depends on the supported
615features and sometimes on the system. A remark about this is in curly braces
616below. When an option is not supported it may still be set without getting an
617error, this is called a hidden option. You can't get the value of a hidden
618option though, it is not stored.
619
620To test if option "foo" can be used with ":set" use something like this: >
621 if exists('&foo')
622This also returns true for a hidden option. To test if option "foo" is really
623supported use something like this: >
624 if exists('+foo')
625<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 *E355*
627A jump table for the options with a short description can be found at |Q_op|.
628
629 *'aleph'* *'al'* *aleph* *Aleph*
630'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
631 global
632 {not in Vi}
633 {only available when compiled with the |+rightleft|
634 feature}
635 The ASCII code for the first letter of the Hebrew alphabet. The
636 routine that maps the keyboard in Hebrew mode, both in Insert mode
637 (when hkmap is set) and on the command-line (when hitting CTRL-_)
638 outputs the Hebrew characters in the range [aleph..aleph+26].
639 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
640 See |rileft.txt|.
641
642 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
643'allowrevins' 'ari' boolean (default off)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
649 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
650 into reverse Insert mode, and don't know how to get out. See
651 'revins'.
652 NOTE: This option is reset when 'compatible' is set.
653
654 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
655'altkeymap' 'akm' boolean (default off)
656 global
657 {not in Vi}
658 {only available when compiled with the |+farsi|
659 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000660 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 the keyboard map between Farsi and English, when 'allowrevins' set.
662
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 is useful to start the Vim in native mode i.e. English (left-to-right
665 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000666 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
668 *'ambiwidth'* *'ambw'*
669'ambiwidth' 'ambw' string (default: "single")
670 global
671 {not in Vi}
672 {only available when compiled with the |+multi_byte|
673 feature}
674 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
675 Tells Vim what to do with characters with East Asian Width Class
676 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
677 letters, Cyrillic letters).
678
679 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000680 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 expected by most users.
682 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200683 *E834* *E835*
684 The value "double" cannot be used if 'listchars' or 'fillchars'
685 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686
687 There are a number of CJK fonts for which the width of glyphs for
688 those characters are solely based on how many octets they take in
689 legacy/traditional CJK encodings. In those encodings, Euro,
690 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 Vim is running inside a terminal (emulators) that uses a CJK font
695 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
696 this option should be set to "double" to match the width perceived
697 by Vim with the width of glyphs in the font. Perhaps it also has
698 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
699 when the system locale is set to one of CJK locales. See Unicode
700 Standard Annex #11 (http://www.unicode.org/reports/tr11).
701
702 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
703'antialias' 'anti' boolean (default: off)
704 global
705 {not in Vi}
706 {only available when compiled with GUI enabled
707 on Mac OS X}
708 This option only has an effect in the GUI version of Vim on Mac OS X
709 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
710 which can be easier to read at certain sizes on certain displays.
711 Setting this option can sometimes cause problems if 'guifont' is set
712 to its default (empty string).
713
714 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
715'autochdir' 'acd' boolean (default off)
716 global
717 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200718 {only available when compiled with it, use
719 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000720 When on, Vim will change the current working directory whenever you
721 open a file, switch buffers, delete a buffer or open/close a window.
722 It will change to the directory containing the file which was opened
723 or selected.
724 This option is provided for backward compatibility with the Vim
725 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000726 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
729'arabic' 'arab' boolean (default off)
730 local to window
731 {not in Vi}
732 {only available when compiled with the |+arabic|
733 feature}
734 This option can be set to start editing Arabic text.
735 Setting this option will:
736 - Set the 'rightleft' option, unless 'termbidi' is set.
737 - Set the 'arabicshape' option, unless 'termbidi' is set.
738 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
739 between typing English and Arabic key mapping.
740 - Set the 'delcombine' option
741 Note that 'encoding' must be "utf-8" for working with Arabic text.
742
743 Resetting this option will:
744 - Reset the 'rightleft' option.
745 - Disable the use of 'keymap' (without changing its value).
746 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
747 option.
748 Also see |arabic.txt|.
749
750 *'arabicshape'* *'arshape'*
751 *'noarabicshape'* *'noarshape'*
752'arabicshape' 'arshape' boolean (default on)
753 global
754 {not in Vi}
755 {only available when compiled with the |+arabic|
756 feature}
757 When on and 'termbidi' is off, the required visual character
758 corrections that need to take place for displaying the Arabic language
759 take affect. Shaping, in essence, gets enabled; the term is a broad
760 one which encompasses:
761 a) the changing/morphing of characters based on their location
762 within a word (initial, medial, final and stand-alone).
763 b) the enabling of the ability to compose characters
764 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100765 When disabled the display shows each character's true stand-alone
766 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 Arabic is a complex language which requires other settings, for
768 further details see |arabic.txt|.
769
770 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
771'autoindent' 'ai' boolean (default off)
772 local to buffer
773 Copy indent from current line when starting a new line (typing <CR>
774 in Insert mode or when using the "o" or "O" command). If you do not
775 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000776 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
777 to another line has the same effect, unless the 'I' flag is included
778 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000779 When autoindent is on, formatting (with the "gq" command or when you
780 reach 'textwidth' in Insert mode) uses the indentation of the first
781 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 When 'smartindent' or 'cindent' is on the indent is changed in
783 a different way.
784 The 'autoindent' option is reset when the 'paste' option is set.
785 {small difference from Vi: After the indent is deleted when typing
786 <Esc> or <CR>, the cursor position when moving up or down is after the
787 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
788
789 *'autoread'* *'ar'* *'noautoread'* *'noar'*
790'autoread' 'ar' boolean (default off)
791 global or local to buffer |global-local|
792 {not in Vi}
793 When a file has been detected to have been changed outside of Vim and
794 it has not been changed inside of Vim, automatically read it again.
795 When the file has been deleted this is not done. |timestamp|
796 If this option has a local value, use this command to switch back to
797 using the global value: >
798 :set autoread<
799<
800 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
801'autowrite' 'aw' boolean (default off)
802 global
803 Write the contents of the file, if it has been modified, on each
804 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000805 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
807 Note that for some commands the 'autowrite' option is not used, see
808 'autowriteall' for that.
809
810 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
811'autowriteall' 'awa' boolean (default off)
812 global
813 {not in Vi}
814 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
815 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
816 Setting this option also implies that Vim behaves like 'autowrite' has
817 been set.
818
819 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200820'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 global
822 {not in Vi}
823 When set to "dark", Vim will try to use colors that look good on a
824 dark background. When set to "light", Vim will try to use colors that
825 look good on a light background. Any other value is illegal.
826 Vim tries to set the default value according to the terminal used.
827 This will not always be correct.
828 Setting this option does not change the background color, it tells Vim
829 what the background color looks like. For changing the background
830 color, see |:hi-normal|.
831
832 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000833 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000834 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100835 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 setting 'background' will cause the color scheme to be reloaded. If
837 the color scheme adjusts to the value of 'background' this will work.
838 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100839 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841 When setting 'background' to the default value with: >
842 :set background&
843< Vim will guess the value. In the GUI this should work correctly,
844 in other cases Vim might not be able to guess the right value.
845
846 When starting the GUI, the default value for 'background' will be
847 "light". When the value is not set in the .gvimrc, and Vim detects
848 that the background is actually quite dark, 'background' is set to
849 "dark". But this happens only AFTER the .gvimrc file has been read
850 (because the window needs to be opened to find the actual background
851 color). To get around this, force the GUI window to be opened by
852 putting a ":gui" command in the .gvimrc file, before where the value
853 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200854
855 For MS-DOS, Windows and OS/2 the default is "dark".
856 For other systems "dark" is used when 'term' is "linux",
857 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
858 background. Otherwise the default is "light".
859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 Normally this option would be set in the .vimrc file. Possibly
861 depending on the terminal name. Example: >
862 :if &term == "pcterm"
863 : set background=dark
864 :endif
865< When this option is set, the default settings for the highlight groups
866 will change. To use other settings, place ":highlight" commands AFTER
867 the setting of the 'background' option.
868 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
869 to select the colors for syntax highlighting. After changing this
870 option, you must load syntax.vim again to see the result. This can be
871 done with ":syntax on".
872
873 *'backspace'* *'bs'*
874'backspace' 'bs' string (default "")
875 global
876 {not in Vi}
877 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
878 mode. This is a list of items, separated by commas. Each item allows
879 a way to backspace over something:
880 value effect ~
881 indent allow backspacing over autoindent
882 eol allow backspacing over line breaks (join lines)
883 start allow backspacing over the start of insert; CTRL-W and CTRL-U
884 stop once at the start of insert.
885
886 When the value is empty, Vi compatible backspacing is used.
887
888 For backwards compatibility with version 5.4 and earlier:
889 value effect ~
890 0 same as ":set backspace=" (Vi compatible)
891 1 same as ":set backspace=indent,eol"
892 2 same as ":set backspace=indent,eol,start"
893
894 See |:fixdel| if your <BS> or <Del> key does not do what you want.
895 NOTE: This option is set to "" when 'compatible' is set.
896
897 *'backup'* *'bk'* *'nobackup'* *'nobk'*
898'backup' 'bk' boolean (default off)
899 global
900 {not in Vi}
901 Make a backup before overwriting a file. Leave it around after the
902 file has been successfully written. If you do not want to keep the
903 backup file, but you do want a backup while the file is being
904 written, reset this option and set the 'writebackup' option (this is
905 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 |backup-table| for more explanations.
908 When the 'backupskip' pattern matches, a backup is not made anyway.
909 When 'patchmode' is set, the backup may be renamed to become the
910 oldest version of a file.
911 NOTE: This option is reset when 'compatible' is set.
912
913 *'backupcopy'* *'bkc'*
914'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
915 global
916 {not in Vi}
917 When writing a file and a backup is made, this option tells how it's
918 done. This is a comma separated list of words.
919
920 The main values are:
921 "yes" make a copy of the file and overwrite the original one
922 "no" rename the file and write a new one
923 "auto" one of the previous, what works best
924
925 Extra values that can be combined with the ones above are:
926 "breaksymlink" always break symlinks when writing
927 "breakhardlink" always break hardlinks when writing
928
929 Making a copy and overwriting the original file:
930 - Takes extra time to copy the file.
931 + When the file has special attributes, is a (hard/symbolic) link or
932 has a resource fork, all this is preserved.
933 - When the file is a link the backup will have the name of the link,
934 not of the real file.
935
936 Renaming the file and writing a new one:
937 + It's fast.
938 - Sometimes not all attributes of the file can be copied to the new
939 file.
940 - When the file is a link the new file will not be a link.
941
942 The "auto" value is the middle way: When Vim sees that renaming file
943 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000944 the file is not a link) that is used. When problems are expected, a
945 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947 The "breaksymlink" and "breakhardlink" values can be used in
948 combination with any of "yes", "no" and "auto". When included, they
949 force Vim to always break either symbolic or hard links by doing
950 exactly what the "no" option does, renaming the original file to
951 become the backup and writing a new file in its place. This can be
952 useful for example in source trees where all the files are symbolic or
953 hard links and any changes should stay in the local source tree, not
954 be propagated back to the original source.
955 *crontab*
956 One situation where "no" and "auto" will cause problems: A program
957 that opens a file, invokes Vim to edit that file, and then tests if
958 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000959 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960 example.
961
962 When a copy is made, the original file is truncated and then filled
963 with the new text. This means that protection bits, owner and
964 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000965 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 group of the backup is set to the group of the original file. If this
967 fails, the protection bits for the group are made the same as for
968 others.
969
970 When the file is renamed this is the other way around: The backup has
971 the same attributes of the original file, and the newly written file
972 is owned by the current user. When the file was a (hard/symbolic)
973 link, the new file will not! That's why the "auto" value doesn't
974 rename when the file is a link. The owner and group of the newly
975 written file will be set to the same ones as the original file, but
976 the system may refuse to do this. In that case the "auto" value will
977 again not rename the file.
978
979 *'backupdir'* *'bdir'*
980'backupdir' 'bdir' string (default for Amiga: ".,t:",
981 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
982 for Unix: ".,~/tmp,~/")
983 global
984 {not in Vi}
985 List of directories for the backup file, separated with commas.
986 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100987 where this is possible. The directory must exist, Vim will not
988 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 - Empty means that no backup file will be created ('patchmode' is
990 impossible!). Writing may fail because of this.
991 - A directory "." means to put the backup file in the same directory
992 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000993 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 put the backup file relative to where the edited file is. The
995 leading "." is replaced with the path name of the edited file.
996 ("." inside a directory name has no special meaning).
997 - Spaces after the comma are ignored, other spaces are considered part
998 of the directory name. To have a space at the start of a directory
999 name, precede it with a backslash.
1000 - To include a comma in a directory name precede it with a backslash.
1001 - A directory name may end in an '/'.
1002 - Environment variables are expanded |:set_env|.
1003 - Careful with '\' characters, type one before a space, type two to
1004 get one in the option (see |option-backslash|), for example: >
1005 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1006< - For backwards compatibility with Vim version 3.0 a '>' at the start
1007 of the option is removed.
1008 See also 'backup' and 'writebackup' options.
1009 If you want to hide your backup files on Unix, consider this value: >
1010 :set backupdir=./.backup,~/.backup,.,/tmp
1011< You must create a ".backup" directory in each directory and in your
1012 home directory for this to work properly.
1013 The use of |:set+=| and |:set-=| is preferred when adding or removing
1014 directories from the list. This avoids problems when a future version
1015 uses another default.
1016 This option cannot be set from a |modeline| or in the |sandbox|, for
1017 security reasons.
1018
1019 *'backupext'* *'bex'* *E589*
1020'backupext' 'bex' string (default "~", for VMS: "_")
1021 global
1022 {not in Vi}
1023 String which is appended to a file name to make the name of the
1024 backup file. The default is quite unusual, because this avoids
1025 accidentally overwriting existing files with a backup file. You might
1026 prefer using ".bak", but make sure that you don't have files with
1027 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001028 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001030 If you like to keep a lot of backups, you could use a BufWritePre
1031 autocommand to change 'backupext' just before writing the file to
1032 include a timestamp. >
1033 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1034< Use 'backupdir' to put the backup in a different directory.
1035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 *'backupskip'* *'bsk'*
1037'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1038 global
1039 {not in Vi}
1040 {not available when compiled without the |+wildignore|
1041 feature}
1042 A list of file patterns. When one of the patterns matches with the
1043 name of the file which is written, no backup file is created. Both
1044 the specified file name and the full path name of the file are used.
1045 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1046 Watch out for special characters, see |option-backslash|.
1047 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001048 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001049
1050 Note that environment variables are not expanded. If you want to use
1051 $HOME you must expand it explicitly, e.g.: >
1052 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1053
1054< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001055 backup would be made by renaming the original file crontab won't see
1056 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057
1058 *'balloondelay'* *'bdlay'*
1059'balloondelay' 'bdlay' number (default: 600)
1060 global
1061 {not in Vi}
1062 {only available when compiled with the |+balloon_eval|
1063 feature}
1064 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1065
1066 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1067'ballooneval' 'beval' boolean (default off)
1068 global
1069 {not in Vi}
1070 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001071 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 Switch on the |balloon-eval| functionality.
1073
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001074 *'balloonexpr'* *'bexpr'*
1075'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001076 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001077 {not in Vi}
1078 {only available when compiled with the |+balloon_eval|
1079 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001080 Expression for text to show in evaluation balloon. It is only used
1081 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001082
1083 v:beval_bufnr number of the buffer in which balloon is going to show
1084 v:beval_winnr number of the window
1085 v:beval_lnum line number
1086 v:beval_col column number (byte index)
1087 v:beval_text word under or after the mouse pointer
1088
1089 The evaluation of the expression must not have side effects!
1090 Example: >
1091 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001092 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001093 \', column ' . v:beval_col .
1094 \ ' of file ' . bufname(v:beval_bufnr) .
1095 \ ' on word "' . v:beval_text . '"'
1096 endfunction
1097 set bexpr=MyBalloonExpr()
1098 set ballooneval
1099<
1100 NOTE: The balloon is displayed only if the cursor is on a text
1101 character. If the result of evaluating 'balloonexpr' is not empty,
1102 Vim does not try to send a message to an external debugger (Netbeans
1103 or Sun Workshop).
1104
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001105 The expression may be evaluated in the |sandbox|, see
1106 |sandbox-option|.
1107
1108 It is not allowed to change text or jump to another window while
1109 evaluating 'balloonexpr' |textlock|.
1110
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001111 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001112 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001113< When they are supported "\n" characters will start a new line. If the
1114 expression evaluates to a |List| this is equal to using each List item
1115 as a string and putting "\n" in between them.
1116
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1118'binary' 'bin' boolean (default off)
1119 local to buffer
1120 {not in Vi}
1121 This option should be set before editing a binary file. You can also
1122 use the |-b| Vim argument. When this option is switched on a few
1123 options will be changed (also when it already was on):
1124 'textwidth' will be set to 0
1125 'wrapmargin' will be set to 0
1126 'modeline' will be off
1127 'expandtab' will be off
1128 Also, 'fileformat' and 'fileformats' options will not be used, the
1129 file is read and written like 'fileformat' was "unix" (a single <NL>
1130 separates lines).
1131 The 'fileencoding' and 'fileencodings' options will not be used, the
1132 file is read without conversion.
1133 NOTE: When you start editing a(nother) file while the 'bin' option is
1134 on, settings from autocommands may change the settings again (e.g.,
1135 'textwidth'), causing trouble when editing. You might want to set
1136 'bin' again when the file has been loaded.
1137 The previous values of these options are remembered and restored when
1138 'bin' is switched from on to off. Each buffer has its own set of
1139 saved option values.
1140 To edit a file with 'binary' set you can use the |++bin| argument.
1141 This avoids you have to do ":set bin", which would have effect for all
1142 files you edit.
1143 When writing a file the <EOL> for the last line is only written if
1144 there was one in the original file (normally Vim appends an <EOL> to
1145 the last line if there is none; this would make the file longer). See
1146 the 'endofline' option.
1147
1148 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1149'bioskey' 'biosk' boolean (default on)
1150 global
1151 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001152 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 better to detect CTRL-C, but only works for the console. When using a
1154 terminal over a serial port reset this option.
1155 Also see |'conskey'|.
1156
1157 *'bomb'* *'nobomb'*
1158'bomb' boolean (default off)
1159 local to buffer
1160 {not in Vi}
1161 {only available when compiled with the |+multi_byte|
1162 feature}
1163 When writing a file and the following conditions are met, a BOM (Byte
1164 Order Mark) is prepended to the file:
1165 - this option is on
1166 - the 'binary' option is off
1167 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1168 endian variants.
1169 Some applications use the BOM to recognize the encoding of the file.
1170 Often used for UCS-2 files on MS-Windows. For other applications it
1171 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001172 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1174 check for the presence of the BOM is done and 'bomb' set accordingly.
1175 Unless 'binary' is set, it is removed from the first line, so that you
1176 don't see it when editing. When you don't change the options, the BOM
1177 will be restored when writing the file.
1178
1179 *'breakat'* *'brk'*
1180'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1181 global
1182 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001183 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 feature}
1185 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001186 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1187 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001188
1189 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001190'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001191 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001192 {not in Vi} {only for Motif, Athena, GTK, Mac and
1193 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001195 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001196 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197 buffer Use the directory of the related buffer.
1198 current Use the current directory.
1199 {path} Use the specified directory
1200
1201 *'bufhidden'* *'bh'*
1202'bufhidden' 'bh' string (default: "")
1203 local to buffer
1204 {not in Vi}
1205 {not available when compiled without the |+quickfix|
1206 feature}
1207 This option specifies what happens when a buffer is no longer
1208 displayed in a window:
1209 <empty> follow the global 'hidden' option
1210 hide hide the buffer (don't unload it), also when 'hidden'
1211 is not set
1212 unload unload the buffer, also when 'hidden' is set or using
1213 |:hide|
1214 delete delete the buffer from the buffer list, also when
1215 'hidden' is set or using |:hide|, like using
1216 |:bdelete|
1217 wipe wipe out the buffer from the buffer list, also when
1218 'hidden' is set or using |:hide|, like using
1219 |:bwipeout|
1220
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001221 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001222 are lost without a warning. Also, these values may break autocommands
1223 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001224 This option is used together with 'buftype' and 'swapfile' to specify
1225 special kinds of buffers. See |special-buffers|.
1226
1227 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1228'buflisted' 'bl' boolean (default: on)
1229 local to buffer
1230 {not in Vi}
1231 When this option is set, the buffer shows up in the buffer list. If
1232 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1233 This option is reset by Vim for buffers that are only used to remember
1234 a file name or marks. Vim sets it when starting to edit a buffer.
1235 But not when moving to a buffer with ":buffer".
1236
1237 *'buftype'* *'bt'* *E382*
1238'buftype' 'bt' string (default: "")
1239 local to buffer
1240 {not in Vi}
1241 {not available when compiled without the |+quickfix|
1242 feature}
1243 The value of this option specifies the type of a buffer:
1244 <empty> normal buffer
1245 nofile buffer which is not related to a file and will not be
1246 written
1247 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001248 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001249 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001250 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001252 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 help help buffer (you are not supposed to set this
1254 manually)
1255
1256 This option is used together with 'bufhidden' and 'swapfile' to
1257 specify special kinds of buffers. See |special-buffers|.
1258
1259 Be careful with changing this option, it can have many side effects!
1260
Bram Moolenaar280f1262006-01-30 00:14:18 +00001261 A "quickfix" buffer is only used for the error list and the location
1262 list. This value is set by the |:cwindow| and |:lwindow| commands and
1263 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264
1265 "nofile" and "nowrite" buffers are similar:
1266 both: The buffer is not to be written to disk, ":w" doesn't
1267 work (":w filename" does work though).
1268 both: The buffer is never considered to be |'modified'|.
1269 There is no warning when the changes will be lost, for
1270 example when you quit Vim.
1271 both: A swap file is only created when using too much memory
1272 (when 'swapfile' has been reset there is never a swap
1273 file).
1274 nofile only: The buffer name is fixed, it is not handled like a
1275 file name. It is not modified in response to a |:cd|
1276 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001277 *E676*
1278 "acwrite" implies that the buffer name is not related to a file, like
1279 "nofile", but it will be written. Thus, in contrast to "nofile" and
1280 "nowrite", ":w" does work and a modified buffer can't be abandoned
1281 without saving. For writing there must be matching |BufWriteCmd|,
1282 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283
1284 *'casemap'* *'cmp'*
1285'casemap' 'cmp' string (default: "internal,keepascii")
1286 global
1287 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001288 {only available when compiled with the |+multi_byte|
1289 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 Specifies details about changing the case of letters. It may contain
1291 these words, separated by a comma:
1292 internal Use internal case mapping functions, the current
1293 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001294 matters when 'encoding' is a Unicode encoding,
1295 "latin1" or "iso-8859-15". When "internal" is
1296 omitted, the towupper() and towlower() system library
1297 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1299 case mapping, the current locale is not effective.
1300 This probably only matters for Turkish.
1301
1302 *'cdpath'* *'cd'* *E344* *E346*
1303'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1304 global
1305 {not in Vi}
1306 {not available when compiled without the
1307 |+file_in_path| feature}
1308 This is a list of directories which will be searched when using the
1309 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001310 for has a relative path, not an absolute part starting with "/", "./"
1311 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 The 'cdpath' option's value has the same form and semantics as
1313 |'path'|. Also see |file-searching|.
1314 The default value is taken from $CDPATH, with a "," prepended to look
1315 in the current directory first.
1316 If the default value taken from $CDPATH is not what you want, include
1317 a modified version of the following command in your vimrc file to
1318 override it: >
1319 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1320< This option cannot be set from a |modeline| or in the |sandbox|, for
1321 security reasons.
1322 (parts of 'cdpath' can be passed to the shell to expand file names).
1323
1324 *'cedit'*
1325'cedit' string (Vi default: "", Vim default: CTRL-F)
1326 global
1327 {not in Vi}
1328 {not available when compiled without the |+vertsplit|
1329 feature}
1330 The key used in Command-line Mode to open the command-line window.
1331 The default is CTRL-F when 'compatible' is off.
1332 Only non-printable keys are allowed.
1333 The key can be specified as a single character, but it is difficult to
1334 type. The preferred way is to use the <> notation. Examples: >
1335 :set cedit=<C-Y>
1336 :set cedit=<Esc>
1337< |Nvi| also has this option, but it only uses the first character.
1338 See |cmdwin|.
1339
1340 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1341'charconvert' 'ccv' string (default "")
1342 global
1343 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001344 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 {not in Vi}
1346 An expression that is used for character encoding conversion. It is
1347 evaluated when a file that is to be read or has been written has a
1348 different encoding from what is desired.
1349 'charconvert' is not used when the internal iconv() function is
1350 supported and is able to do the conversion. Using iconv() is
1351 preferred, because it is much faster.
1352 'charconvert' is not used when reading stdin |--|, because there is no
1353 file to convert from. You will have to save the text in a file first.
1354 The expression must return zero or an empty string for success,
1355 non-zero for failure.
1356 The possible encoding names encountered are in 'encoding'.
1357 Additionally, names given in 'fileencodings' and 'fileencoding' are
1358 used.
1359 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1360 is done internally by Vim, 'charconvert' is not used for this.
1361 'charconvert' is also used to convert the viminfo file, if the 'c'
1362 flag is present in 'viminfo'. Also used for Unicode conversion.
1363 Example: >
1364 set charconvert=CharConvert()
1365 fun CharConvert()
1366 system("recode "
1367 \ . v:charconvert_from . ".." . v:charconvert_to
1368 \ . " <" . v:fname_in . " >" v:fname_out)
1369 return v:shell_error
1370 endfun
1371< The related Vim variables are:
1372 v:charconvert_from name of the current encoding
1373 v:charconvert_to name of the desired encoding
1374 v:fname_in name of the input file
1375 v:fname_out name of the output file
1376 Note that v:fname_in and v:fname_out will never be the same.
1377 Note that v:charconvert_from and v:charconvert_to may be different
1378 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1379 Encryption is not done by Vim when using 'charconvert'. If you want
1380 to encrypt the file after conversion, 'charconvert' should take care
1381 of this.
1382 This option cannot be set from a |modeline| or in the |sandbox|, for
1383 security reasons.
1384
1385 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1386'cindent' 'cin' boolean (default off)
1387 local to buffer
1388 {not in Vi}
1389 {not available when compiled without the |+cindent|
1390 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001391 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 that trigger reindenting in insert mode and 'cinoptions' to set your
1393 preferred indent style.
1394 If 'indentexpr' is not empty, it overrules 'cindent'.
1395 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1396 the "=" operator indents using this algorithm rather than calling an
1397 external program.
1398 See |C-indenting|.
1399 When you don't like the way 'cindent' works, try the 'smartindent'
1400 option or 'indentexpr'.
1401 This option is not used when 'paste' is set.
1402 NOTE: This option is reset when 'compatible' is set.
1403
1404 *'cinkeys'* *'cink'*
1405'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1406 local to buffer
1407 {not in Vi}
1408 {not available when compiled without the |+cindent|
1409 feature}
1410 A list of keys that, when typed in Insert mode, cause reindenting of
1411 the current line. Only used if 'cindent' is on and 'indentexpr' is
1412 empty.
1413 For the format of this option see |cinkeys-format|.
1414 See |C-indenting|.
1415
1416 *'cinoptions'* *'cino'*
1417'cinoptions' 'cino' string (default "")
1418 local to buffer
1419 {not in Vi}
1420 {not available when compiled without the |+cindent|
1421 feature}
1422 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1423 program. See |cinoptions-values| for the values of this option, and
1424 |C-indenting| for info on C indenting in general.
1425
1426
1427 *'cinwords'* *'cinw'*
1428'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1429 local to buffer
1430 {not in Vi}
1431 {not available when compiled without both the
1432 |+cindent| and the |+smartindent| features}
1433 These keywords start an extra indent in the next line when
1434 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1435 an appropriate place (inside {}).
1436 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1437 matter, include the keyword both the uppercase and lowercase:
1438 "if,If,IF".
1439
1440 *'clipboard'* *'cb'*
1441'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1442 for X-windows, "" otherwise)
1443 global
1444 {not in Vi}
1445 {only in GUI versions or when the |+xterm_clipboard|
1446 feature is included}
1447 This option is a list of comma separated names.
1448 These names are recognized:
1449
1450 unnamed When included, Vim will use the clipboard register '*'
1451 for all yank, delete, change and put operations which
1452 would normally go to the unnamed register. When a
1453 register is explicitly specified, it will always be
1454 used regardless of whether "unnamed" is in 'clipboard'
1455 or not. The clipboard register can always be
1456 explicitly accessed using the "* notation. Also see
1457 |gui-clipboard|.
1458
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001459 unnamedplus A variant of "unnamed" flag which uses the clipboard
1460 register '+' (|quoteplus|) instead of register '*' for
1461 all operations except yank. Yank shall copy the text
1462 into register '+' and also into '*' when "unnamed" is
1463 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001464 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001465 Availability can be checked with: >
1466 if has('unnamedplus')
1467<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 autoselect Works like the 'a' flag in 'guioptions': If present,
1469 then whenever Visual mode is started, or the Visual
1470 area extended, Vim tries to become the owner of the
1471 windowing system's global selection or put the
1472 selected text on the clipboard used by the selection
1473 register "*. See |guioptions_a| and |quotestar| for
1474 details. When the GUI is active, the 'a' flag in
1475 'guioptions' is used, when the GUI is not active, this
1476 "autoselect" flag is used.
1477 Also applies to the modeless selection.
1478
1479 autoselectml Like "autoselect", but for the modeless selection
1480 only. Compare to the 'A' flag in 'guioptions'.
1481
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001482 html When the clipboard contains HTML, use this when
1483 pasting. When putting text on the clipboard, mark it
1484 as HTML. This works to copy rendered HTML from
1485 Firefox, paste it as raw HTML in Vim, select the HTML
1486 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001487 You probably want to add this only temporarily,
1488 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001489 Only supported for GTK version 2 and later.
1490 Only available with the |+multi_byte| feature.
1491
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 exclude:{pattern}
1493 Defines a pattern that is matched against the name of
1494 the terminal 'term'. If there is a match, no
1495 connection will be made to the X server. This is
1496 useful in this situation:
1497 - Running Vim in a console.
1498 - $DISPLAY is set to start applications on another
1499 display.
1500 - You do not want to connect to the X server in the
1501 console, but do want this in a terminal emulator.
1502 To never connect to the X server use: >
1503 exclude:.*
1504< This has the same effect as using the |-X| argument.
1505 Note that when there is no connection to the X server
1506 the window title won't be restored and the clipboard
1507 cannot be accessed.
1508 The value of 'magic' is ignored, {pattern} is
1509 interpreted as if 'magic' was on.
1510 The rest of the option value will be used for
1511 {pattern}, this must be the last entry.
1512
1513 *'cmdheight'* *'ch'*
1514'cmdheight' 'ch' number (default 1)
1515 global
1516 {not in Vi}
1517 Number of screen lines to use for the command-line. Helps avoiding
1518 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001519 The value of this option is stored with the tab page, so that each tab
1520 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521
1522 *'cmdwinheight'* *'cwh'*
1523'cmdwinheight' 'cwh' number (default 7)
1524 global
1525 {not in Vi}
1526 {not available when compiled without the |+vertsplit|
1527 feature}
1528 Number of screen lines to use for the command-line window. |cmdwin|
1529
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001530 *'colorcolumn'* *'cc'*
1531'colorcolumn' 'cc' string (default "")
1532 local to window
1533 {not in Vi}
1534 {not available when compiled without the |+syntax|
1535 feature}
1536 'colorcolumn' is a comma separated list of screen columns that are
1537 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1538 text. Will make screen redrawing slower.
1539 The screen column can be an absolute number, or a number preceded with
1540 '+' or '-', which is added to or subtracted from 'textwidth'. >
1541
1542 :set cc=+1 " highlight column after 'textwidth'
1543 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1544 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1545<
1546 When 'textwidth' is zero then the items with '-' and '+' are not used.
1547 A maximum of 256 columns are highlighted.
1548
Bram Moolenaar071d4272004-06-13 20:20:40 +00001549 *'columns'* *'co'* *E594*
1550'columns' 'co' number (default 80 or terminal width)
1551 global
1552 {not in Vi}
1553 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001554 initialization and does not have to be set by hand. Also see
1555 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 When Vim is running in the GUI or in a resizable window, setting this
1557 option will cause the window size to be changed. When you only want
1558 to use the size for the GUI, put the command in your |gvimrc| file.
1559 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001560 number of columns of the display, the display may be messed up. For
1561 the GUI it is always possible and Vim limits the number of columns to
1562 what fits on the screen. You can use this command to get the widest
1563 window possible: >
1564 :set columns=9999
1565< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566
1567 *'comments'* *'com'* *E524* *E525*
1568'comments' 'com' string (default
1569 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1570 local to buffer
1571 {not in Vi}
1572 {not available when compiled without the |+comments|
1573 feature}
1574 A comma separated list of strings that can start a comment line. See
1575 |format-comments|. See |option-backslash| about using backslashes to
1576 insert a space.
1577
1578 *'commentstring'* *'cms'* *E537*
1579'commentstring' 'cms' string (default "/*%s*/")
1580 local to buffer
1581 {not in Vi}
1582 {not available when compiled without the |+folding|
1583 feature}
1584 A template for a comment. The "%s" in the value is replaced with the
1585 comment text. Currently only used to add markers for folding, see
1586 |fold-marker|.
1587
1588 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001589'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1590 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 global
1592 {not in Vi}
1593 This option has the effect of making Vim either more Vi-compatible, or
1594 make Vim behave in a more useful way.
1595 This is a special kind of option, because when it's set or reset,
1596 other options are also changed as a side effect. CAREFUL: Setting or
1597 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001598 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 set this option in your vimrc file, you should probably put it at the
1600 very start.
1601 By default this option is on and the Vi defaults are used for the
1602 options. This default was chosen for those people who want to use Vim
1603 just like Vi, and don't even (want to) know about the 'compatible'
1604 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001605 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001606 this option is switched off, and all options that have not been
1607 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001608 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001609 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001610 happen for the system-wide vimrc or gvimrc file, nor for a file given
1611 with the |-u| argument). Also see |compatible-default| and
1612 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 You can also set this option with the "-C" argument, and reset it with
1614 "-N". See |-C| and |-N|.
1615 Switching this option off makes the Vim defaults be used for options
1616 that have a different Vi and Vim default value. See the options
1617 marked with a '+' below. Other options are not modified.
1618 At the moment this option is set, several other options will be set
1619 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001620 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001621 editing.
1622 See also 'cpoptions'.
1623
1624 option + set value effect ~
1625
1626 'allowrevins' off no CTRL-_ command
1627 'backupcopy' Unix: "yes" backup file is a copy
1628 others: "auto" copy or rename backup file
1629 'backspace' "" normal backspace
1630 'backup' off no backup file
1631 'cindent' off no C code indentation
1632 'cedit' + "" no key to open the |cmdwin|
1633 'cpoptions' + (all flags) Vi-compatible flags
1634 'cscopetag' off don't use cscope for ":tag"
1635 'cscopetagorder' 0 see |cscopetagorder|
1636 'cscopeverbose' off see |cscopeverbose|
1637 'digraph' off no digraphs
1638 'esckeys' + off no <Esc>-keys in Insert mode
1639 'expandtab' off tabs not expanded to spaces
1640 'fileformats' + "" no automatic file format detection,
1641 "dos,unix" except for DOS, Windows and OS/2
1642 'formatoptions' + "vt" Vi compatible formatting
1643 'gdefault' off no default 'g' flag for ":s"
1644 'history' + 0 no commandline history
1645 'hkmap' off no Hebrew keyboard mapping
1646 'hkmapp' off no phonetic Hebrew keyboard mapping
1647 'hlsearch' off no highlighting of search matches
1648 'incsearch' off no incremental searching
1649 'indentexpr' "" no indenting by expression
1650 'insertmode' off do not start in Insert mode
1651 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1652 characters and '_'
1653 'joinspaces' on insert 2 spaces after period
1654 'modeline' + off no modelines
1655 'more' + off no pauses in listings
1656 'revins' off no reverse insert
1657 'ruler' off no ruler
1658 'scrolljump' 1 no jump scroll
1659 'scrolloff' 0 no scroll offset
1660 'shiftround' off indent not rounded to shiftwidth
1661 'shortmess' + "" no shortening of messages
1662 'showcmd' + off command characters not shown
1663 'showmode' + off current mode not shown
1664 'smartcase' off no automatic ignore case switch
1665 'smartindent' off no smart indentation
1666 'smarttab' off no smart tab size
1667 'softtabstop' 0 tabs are always 'tabstop' positions
1668 'startofline' on goto startofline with some commands
1669 'tagrelative' + off tag file names are not relative
1670 'textauto' + off no automatic textmode detection
1671 'textwidth' 0 no automatic line wrap
1672 'tildeop' off tilde is not an operator
1673 'ttimeout' off no terminal timeout
1674 'whichwrap' + "" left-right movements don't wrap
1675 'wildchar' + CTRL-E only when the current value is <Tab>
1676 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001677 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678
1679 *'complete'* *'cpt'* *E535*
1680'complete' 'cpt' string (default: ".,w,b,u,t,i")
1681 local to buffer
1682 {not in Vi}
1683 This option specifies how keyword completion |ins-completion| works
1684 when CTRL-P or CTRL-N are used. It is also used for whole-line
1685 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1686 and the places to scan. It is a comma separated list of flags:
1687 . scan the current buffer ('wrapscan' is ignored)
1688 w scan buffers from other windows
1689 b scan other loaded buffers that are in the buffer list
1690 u scan the unloaded buffers that are in the buffer list
1691 U scan the buffers that are not in the buffer list
1692 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001693 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 k{dict} scan the file {dict}. Several "k" flags can be given,
1695 patterns are valid too. For example: >
1696 :set cpt=k/usr/dict/*,k~/spanish
1697< s scan the files given with the 'thesaurus' option
1698 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1699 are valid too.
1700 i scan current and included files
1701 d scan current and included files for defined name or macro
1702 |i_CTRL-X_CTRL-D|
1703 ] tag completion
1704 t same as "]"
1705
1706 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1707 not executed, this may lead to unexpected completions from some files
1708 (gzipped files for example). Unloaded buffers are not scanned for
1709 whole-line completion.
1710
1711 The default is ".,w,b,u,t,i", which means to scan:
1712 1. the current buffer
1713 2. buffers in other windows
1714 3. other loaded buffers
1715 4. unloaded buffers
1716 5. tags
1717 6. included files
1718
1719 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001720 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1721 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001723 *'completefunc'* *'cfu'*
1724'completefunc' 'cfu' string (default: empty)
1725 local to buffer
1726 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001727 {not available when compiled without the |+eval|
1728 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001729 This option specifies a function to be used for Insert mode completion
1730 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001731 See |complete-functions| for an explanation of how the function is
1732 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001733 This option cannot be set from a |modeline| or in the |sandbox|, for
1734 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001735
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001736 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001737'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001738 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001739 {not available when compiled without the
1740 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001741 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001742 A comma separated list of options for Insert mode completion
1743 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001744
1745 menu Use a popup menu to show the possible completions. The
1746 menu is only shown when there is more than one match and
1747 sufficient colors are available. |ins-completion-menu|
1748
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001749 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001750 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001751 match, e.g., what file it comes from.
1752
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001753 longest Only insert the longest common text of the matches. If
1754 the menu is displayed you can use CTRL-L to add more
1755 characters. Whether case is ignored depends on the kind
1756 of completion. For buffer text the 'ignorecase' option is
1757 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001758
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001759 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001760 completion in the preview window. Only works in
1761 combination with "menu" or "menuone".
1762
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001763
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001764 *'concealcursor'* *'cocu'*
1765'concealcursor' 'cocu' string (default: "")
1766 local to window
1767 {not in Vi}
1768 {not available when compiled without the |+conceal|
1769 feature}
1770 Sets the modes in which text in the cursor line can also be concealed.
1771 When the current mode is listed then concealing happens just like in
1772 other lines.
1773 n Normal mode
1774 v Visual mode
1775 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001776 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001777
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001778 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001779 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001780 are moving around text is concealed, but when starting to insert text
1781 or selecting a Visual area the concealed text is displayed, so that
1782 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001783 Keep in mind that the cursor position is not always where it's
1784 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001785
1786
1787'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001788 number (default 0)
1789 local to window
1790 {not in Vi}
1791 {not available when compiled without the |+conceal|
1792 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001793 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1794 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001795
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001796 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001797 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001798 1 Each block of concealed text is replaced with one
1799 character. If the syntax item does not have a custom
1800 replacement character defined (see |:syn-cchar|) the
1801 character defined in 'listchars' is used (default is a
1802 space).
1803 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001804 2 Concealed text is completely hidden unless it has a
1805 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001806 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001807 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001808
Bram Moolenaara7781e02010-07-19 20:13:22 +02001809 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001810 edit and copy the text. This can be changed with the 'concealcursor'
1811 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001812
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1814'confirm' 'cf' boolean (default off)
1815 global
1816 {not in Vi}
1817 When 'confirm' is on, certain operations that would normally
1818 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1819 instead raise a |dialog| asking if you wish to save the current
1820 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1821 If 'confirm' is off you can still activate confirmation for one
1822 command only (this is most useful in mappings) with the |:confirm|
1823 command.
1824 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1825
1826 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1827'conskey' 'consk' boolean (default off)
1828 global
1829 {not in Vi} {only for MS-DOS}
1830 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001831 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 three methods of console input are available:
1833 'conskey' 'bioskey' action ~
1834 on on or off direct console input
1835 off on BIOS
1836 off off STDIN
1837
1838 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1839'copyindent' 'ci' boolean (default off)
1840 local to buffer
1841 {not in Vi}
1842 Copy the structure of the existing lines indent when autoindenting a
1843 new line. Normally the new indent is reconstructed by a series of
1844 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1845 in which case only spaces are used). Enabling this option makes the
1846 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001847 existing line. 'expandtab' has no effect on these characters, a Tab
1848 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 line, the remaining space is filled in the normal manner.
1850 NOTE: 'copyindent' is reset when 'compatible' is set.
1851 Also see 'preserveindent'.
1852
1853 *'cpoptions'* *'cpo'*
1854'cpoptions' 'cpo' string (Vim default: "aABceFs",
1855 Vi default: all flags)
1856 global
1857 {not in Vi}
1858 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001859 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 not being vi-compatible is mostly or sometimes preferred.
1861 'cpoptions' stands for "compatible-options".
1862 Commas can be added for readability.
1863 To avoid problems with flags that are added in the future, use the
1864 "+=" and "-=" feature of ":set" |add-option-flags|.
1865 NOTE: This option is set to the Vi default value when 'compatible' is
1866 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001867 NOTE: This option is set to the POSIX default value at startup when
1868 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001869 variable exists |posix|. This means Vim tries to behave like the
1870 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871
1872 contains behavior ~
1873 *cpo-a*
1874 a When included, a ":read" command with a file name
1875 argument will set the alternate file name for the
1876 current window.
1877 *cpo-A*
1878 A When included, a ":write" command with a file name
1879 argument will set the alternate file name for the
1880 current window.
1881 *cpo-b*
1882 b "\|" in a ":map" command is recognized as the end of
1883 the map command. The '\' is included in the mapping,
1884 the text after the '|' is interpreted as the next
1885 command. Use a CTRL-V instead of a backslash to
1886 include the '|' in the mapping. Applies to all
1887 mapping, abbreviation, menu and autocmd commands.
1888 See also |map_bar|.
1889 *cpo-B*
1890 B A backslash has no special meaning in mappings,
1891 abbreviations and the "to" part of the menu commands.
1892 Remove this flag to be able to use a backslash like a
1893 CTRL-V. For example, the command ":map X \<Esc>"
1894 results in X being mapped to:
1895 'B' included: "\^[" (^[ is a real <Esc>)
1896 'B' excluded: "<Esc>" (5 characters)
1897 ('<' excluded in both cases)
1898 *cpo-c*
1899 c Searching continues at the end of any match at the
1900 cursor position, but not further than the start of the
1901 next line. When not present searching continues
1902 one character from the cursor position. With 'c'
1903 "abababababab" only gets three matches when repeating
1904 "/abab", without 'c' there are five matches.
1905 *cpo-C*
1906 C Do not concatenate sourced lines that start with a
1907 backslash. See |line-continuation|.
1908 *cpo-d*
1909 d Using "./" in the 'tags' option doesn't mean to use
1910 the tags file relative to the current file, but the
1911 tags file in the current directory.
1912 *cpo-D*
1913 D Can't use CTRL-K to enter a digraph after Normal mode
1914 commands with a character argument, like |r|, |f| and
1915 |t|.
1916 *cpo-e*
1917 e When executing a register with ":@r", always add a
1918 <CR> to the last line, also when the register is not
1919 linewise. If this flag is not present, the register
1920 is not linewise and the last line does not end in a
1921 <CR>, then the last line is put on the command-line
1922 and can be edited before hitting <CR>.
1923 *cpo-E*
1924 E It is an error when using "y", "d", "c", "g~", "gu" or
1925 "gU" on an Empty region. The operators only work when
1926 at least one character is to be operate on. Example:
1927 This makes "y0" fail in the first column.
1928 *cpo-f*
1929 f When included, a ":read" command with a file name
1930 argument will set the file name for the current buffer,
1931 if the current buffer doesn't have a file name yet.
1932 *cpo-F*
1933 F When included, a ":write" command with a file name
1934 argument will set the file name for the current
1935 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001936 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 *cpo-g*
1938 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001939 *cpo-H*
1940 H When using "I" on a line with only blanks, insert
1941 before the last blank. Without this flag insert after
1942 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 *cpo-i*
1944 i When included, interrupting the reading of a file will
1945 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001946 *cpo-I*
1947 I When moving the cursor up or down just after inserting
1948 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 *cpo-j*
1950 j When joining lines, only add two spaces after a '.',
1951 not after '!' or '?'. Also see 'joinspaces'.
1952 *cpo-J*
1953 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001954 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 white space.
1956 *cpo-k*
1957 k Disable the recognition of raw key codes in
1958 mappings, abbreviations, and the "to" part of menu
1959 commands. For example, if <Key> sends ^[OA (where ^[
1960 is <Esc>), the command ":map X ^[OA" results in X
1961 being mapped to:
1962 'k' included: "^[OA" (3 characters)
1963 'k' excluded: "<Key>" (one key code)
1964 Also see the '<' flag below.
1965 *cpo-K*
1966 K Don't wait for a key code to complete when it is
1967 halfway a mapping. This breaks mapping <F1><F1> when
1968 only part of the second <F1> has been read. It
1969 enables cancelling the mapping by typing <F1><Esc>.
1970 *cpo-l*
1971 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001972 literally, only "\]", "\^", "\-" and "\\" are special.
1973 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1975 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001976 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977 *cpo-L*
1978 L When the 'list' option is set, 'wrapmargin',
1979 'textwidth', 'softtabstop' and Virtual Replace mode
1980 (see |gR|) count a <Tab> as two characters, instead of
1981 the normal behavior of a <Tab>.
1982 *cpo-m*
1983 m When included, a showmatch will always wait half a
1984 second. When not included, a showmatch will wait half
1985 a second or until a character is typed. |'showmatch'|
1986 *cpo-M*
1987 M When excluded, "%" matching will take backslashes into
1988 account. Thus in "( \( )" and "\( ( \)" the outer
1989 parenthesis match. When included "%" ignores
1990 backslashes, which is Vi compatible.
1991 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001992 n When included, the column used for 'number' and
1993 'relativenumber' will also be used for text of wrapped
1994 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 *cpo-o*
1996 o Line offset to search command is not remembered for
1997 next search.
1998 *cpo-O*
1999 O Don't complain if a file is being overwritten, even
2000 when it didn't exist when editing it. This is a
2001 protection against a file unexpectedly created by
2002 someone else. Vi didn't complain about this.
2003 *cpo-p*
2004 p Vi compatible Lisp indenting. When not present, a
2005 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002006 *cpo-P*
2007 P When included, a ":write" command that appends to a
2008 file will set the file name for the current buffer, if
2009 the current buffer doesn't have a file name yet and
2010 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002011 *cpo-q*
2012 q When joining multiple lines leave the cursor at the
2013 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 *cpo-r*
2015 r Redo ("." command) uses "/" to repeat a search
2016 command, instead of the actually used search string.
2017 *cpo-R*
2018 R Remove marks from filtered lines. Without this flag
2019 marks are kept like |:keepmarks| was used.
2020 *cpo-s*
2021 s Set buffer options when entering the buffer for the
2022 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002023 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 set when the buffer is created.
2025 *cpo-S*
2026 S Set buffer options always when entering a buffer
2027 (except 'readonly', 'fileformat', 'filetype' and
2028 'syntax'). This is the (most) Vi compatible setting.
2029 The options are set to the values in the current
2030 buffer. When you change an option and go to another
2031 buffer, the value is copied. Effectively makes the
2032 buffer options global to all buffers.
2033
2034 's' 'S' copy buffer options
2035 no no when buffer created
2036 yes no when buffer first entered (default)
2037 X yes each time when buffer entered (vi comp.)
2038 *cpo-t*
2039 t Search pattern for the tag command is remembered for
2040 "n" command. Otherwise Vim only puts the pattern in
2041 the history for search pattern, but doesn't change the
2042 last used search pattern.
2043 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002044 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 *cpo-v*
2046 v Backspaced characters remain visible on the screen in
2047 Insert mode. Without this flag the characters are
2048 erased from the screen right away. With this flag the
2049 screen newly typed text overwrites backspaced
2050 characters.
2051 *cpo-w*
2052 w When using "cw" on a blank character, only change one
2053 character and not all blanks until the start of the
2054 next word.
2055 *cpo-W*
2056 W Don't overwrite a readonly file. When omitted, ":w!"
2057 overwrites a readonly file, if possible.
2058 *cpo-x*
2059 x <Esc> on the command-line executes the command-line.
2060 The default in Vim is to abandon the command-line,
2061 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002062 *cpo-X*
2063 X When using a count with "R" the replaced text is
2064 deleted only once. Also when repeating "R" with "."
2065 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 *cpo-y*
2067 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002068 *cpo-Z*
2069 Z When using "w!" while the 'readonly' option is set,
2070 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 *cpo-!*
2072 ! When redoing a filter command, use the last used
2073 external command, whatever it was. Otherwise the last
2074 used -filter- command is used.
2075 *cpo-$*
2076 $ When making a change to one line, don't redisplay the
2077 line, but put a '$' at the end of the changed text.
2078 The changed text will be overwritten when you type the
2079 new text. The line is redisplayed if you type any
2080 command that moves the cursor from the insertion
2081 point.
2082 *cpo-%*
2083 % Vi-compatible matching is done for the "%" command.
2084 Does not recognize "#if", "#endif", etc.
2085 Does not recognize "/*" and "*/".
2086 Parens inside single and double quotes are also
2087 counted, causing a string that contains a paren to
2088 disturb the matching. For example, in a line like
2089 "if (strcmp("foo(", s))" the first paren does not
2090 match the last one. When this flag is not included,
2091 parens inside single and double quotes are treated
2092 specially. When matching a paren outside of quotes,
2093 everything inside quotes is ignored. When matching a
2094 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002095 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002096 This flag is also used for other features, such as
2097 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002098 *cpo--*
2099 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002100 it would go above the first line or below the last
2101 line. Without it the cursor moves to the first or
2102 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002103 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002104 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002105 *cpo-+*
2106 + When included, a ":write file" command will reset the
2107 'modified' flag of the buffer, even though the buffer
2108 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002109 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 * Use ":*" in the same way as ":@". When not included,
2111 ":*" is an alias for ":'<,'>", select the Visual area.
2112 *cpo-<*
2113 < Disable the recognition of special key codes in |<>|
2114 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002115 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 ":map X <Tab>" results in X being mapped to:
2117 '<' included: "<Tab>" (5 characters)
2118 '<' excluded: "^I" (^I is a real <Tab>)
2119 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002120 *cpo->*
2121 > When appending to a register, put a line break before
2122 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002123 *cpo-;*
2124 ; When using |,| or |;| to repeat the last |t| search
2125 and the cursor is right in front of the searched
2126 character, the cursor won't move. When not included,
2127 the cursor would skip over it and jump to the
2128 following occurence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002129
2130 POSIX flags. These are not included in the Vi default value, except
2131 when $VIM_POSIX was set on startup. |posix|
2132
2133 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002134 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002135 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002136 *cpo-&*
2137 & When ":preserve" was used keep the swap file when
2138 exiting normally while this buffer is still loaded.
2139 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002140 *cpo-\*
2141 \ Backslash in a [] range in a search pattern is taken
2142 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002143 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2144 '\' excluded: "/[ \-]" finds <Space> and '-'
2145 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002146 *cpo-/*
2147 / When "%" is used as the replacement string in a |:s|
2148 command, use the previous replacement string. |:s%|
2149 *cpo-{*
2150 { The |{| and |}| commands also stop at a "{" character
2151 at the start of a line.
2152 *cpo-.*
2153 . The ":chdir" and ":cd" commands fail if the current
2154 buffer is modified, unless ! is used. Vim doesn't
2155 need this, since it remembers the full path of an
2156 opened file.
2157 *cpo-bar*
2158 | The value of the $LINES and $COLUMNS environment
2159 variables overrule the terminal size values obtained
2160 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002161
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002163 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002164'cryptmethod' string (default "zip")
2165 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002166 {not in Vi}
2167 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002168 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002169 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002170 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002171 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002172 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002173 or later, files can NOT be read by Vim 7.2 and older.
2174 This adds a "seed" to the file, every time you write
2175 the file the encrypted bytes will be different.
2176
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002177 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002178 to the detected method of the file being read. Thus if you write it
2179 without changing 'cryptmethod' the same method will be used.
2180 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002181 explicitly write it, you don't get a warning unless there are other
2182 modifications. Also see |:X|.
2183
2184 When setting the global value to an empty string, it will end up with
2185 the value "zip". When setting the local value to an empty string the
2186 buffer will use the global value.
2187
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002188 When a new encryption method is added in a later version of Vim, and
2189 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002190 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002191
2192
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 *'cscopepathcomp'* *'cspc'*
2194'cscopepathcomp' 'cspc' number (default 0)
2195 global
2196 {not available when compiled without the |+cscope|
2197 feature}
2198 {not in Vi}
2199 Determines how many components of the path to show in a list of tags.
2200 See |cscopepathcomp|.
2201
2202 *'cscopeprg'* *'csprg'*
2203'cscopeprg' 'csprg' string (default "cscope")
2204 global
2205 {not available when compiled without the |+cscope|
2206 feature}
2207 {not in Vi}
2208 Specifies the command to execute cscope. See |cscopeprg|.
2209 This option cannot be set from a |modeline| or in the |sandbox|, for
2210 security reasons.
2211
2212 *'cscopequickfix'* *'csqf'*
2213'cscopequickfix' 'csqf' string (default "")
2214 global
2215 {not available when compiled without the |+cscope|
2216 or |+quickfix| features}
2217 {not in Vi}
2218 Specifies whether to use quickfix window to show cscope results.
2219 See |cscopequickfix|.
2220
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002221 *'cscoperelative'* *'csre'*
2222'cscoperelative' 'csre' boolean (default off)
2223 global
2224 {not available when compiled without the |+cscope|
2225 feature}
2226 {not in Vi}
2227 In the absence of a prefix (-P) for cscope. setting this option enables
2228 to use the basename of cscope.out path as the prefix.
2229 See |cscoperelative|.
2230
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2232'cscopetag' 'cst' boolean (default off)
2233 global
2234 {not available when compiled without the |+cscope|
2235 feature}
2236 {not in Vi}
2237 Use cscope for tag commands. See |cscope-options|.
2238 NOTE: This option is reset when 'compatible' is set.
2239
2240 *'cscopetagorder'* *'csto'*
2241'cscopetagorder' 'csto' number (default 0)
2242 global
2243 {not available when compiled without the |+cscope|
2244 feature}
2245 {not in Vi}
2246 Determines the order in which ":cstag" performs a search. See
2247 |cscopetagorder|.
2248 NOTE: This option is set to 0 when 'compatible' is set.
2249
2250 *'cscopeverbose'* *'csverb'*
2251 *'nocscopeverbose'* *'nocsverb'*
2252'cscopeverbose' 'csverb' boolean (default off)
2253 global
2254 {not available when compiled without the |+cscope|
2255 feature}
2256 {not in Vi}
2257 Give messages when adding a cscope database. See |cscopeverbose|.
2258 NOTE: This option is reset when 'compatible' is set.
2259
Bram Moolenaar860cae12010-06-05 23:22:07 +02002260 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2261'cursorbind' 'crb' boolean (default off)
2262 local to window
2263 {not in Vi}
2264 {not available when compiled without the |+cursorbind|
2265 feature}
2266 When this option is set, as the cursor in the current
2267 window moves other cursorbound windows (windows that also have
2268 this option set) move their cursors to the corresponding line and
2269 column. This option is useful for viewing the
2270 differences between two versions of a file (see 'diff'); in diff mode,
2271 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002272 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002273
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002274
2275 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2276'cursorcolumn' 'cuc' boolean (default off)
2277 local to window
2278 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002279 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002280 feature}
2281 Highlight the screen column of the cursor with CursorColumn
2282 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2283 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002284 If you only want the highlighting in the current window you can use
2285 these autocommands: >
2286 au WinLeave * set nocursorline nocursorcolumn
2287 au WinEnter * set cursorline cursorcolumn
2288<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002289
2290 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2291'cursorline' 'cul' boolean (default off)
2292 local to window
2293 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002294 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002295 feature}
2296 Highlight the screen line of the cursor with CursorLine
2297 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2298 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002299 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002300 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002301
2302
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 *'debug'*
2304'debug' string (default "")
2305 global
2306 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002307 These values can be used:
2308 msg Error messages that would otherwise be omitted will be given
2309 anyway.
2310 throw Error messages that would otherwise be omitted will be given
2311 anyway and also throw an exception and set |v:errmsg|.
2312 beep A message will be given when otherwise only a beep would be
2313 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002314 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002315 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2316 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317
2318 *'define'* *'def'*
2319'define' 'def' string (default "^\s*#\s*define")
2320 global or local to buffer |global-local|
2321 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002322 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002323 pattern, just like for the "/" command. This option is used for the
2324 commands like "[i" and "[d" |include-search|. The 'isident' option is
2325 used to recognize the defined name after the match:
2326 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2327 See |option-backslash| about inserting backslashes to include a space
2328 or backslash.
2329 The default value is for C programs. For C++ this value would be
2330 useful, to include const type declarations: >
2331 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2332< When using the ":set" command, you need to double the backslashes!
2333
2334 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2335'delcombine' 'deco' boolean (default off)
2336 global
2337 {not in Vi}
2338 {only available when compiled with the |+multi_byte|
2339 feature}
2340 If editing Unicode and this option is set, backspace and Normal mode
2341 "x" delete each combining character on its own. When it is off (the
2342 default) the character along with its combining characters are
2343 deleted.
2344 Note: When 'delcombine' is set "xx" may work different from "2x"!
2345
2346 This is useful for Arabic, Hebrew and many other languages where one
2347 may have combining characters overtop of base characters, and want
2348 to remove only the combining ones.
2349
2350 *'dictionary'* *'dict'*
2351'dictionary' 'dict' string (default "")
2352 global or local to buffer |global-local|
2353 {not in Vi}
2354 List of file names, separated by commas, that are used to lookup words
2355 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2356 contain a list of words. This can be one word per line, or several
2357 words per line, separated by non-keyword characters (white space is
2358 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002359 When this option is empty, or an entry "spell" is present, spell
2360 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002361 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 after a comma are ignored, otherwise spaces are included in the file
2363 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002364 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 Where to find a list of words?
2366 - On FreeBSD, there is the file "/usr/share/dict/words".
2367 - In the Simtel archive, look in the "msdos/linguist" directory.
2368 - In "miscfiles" of the GNU collection.
2369 The use of |:set+=| and |:set-=| is preferred when adding or removing
2370 directories from the list. This avoids problems when a future version
2371 uses another default.
2372 Backticks cannot be used in this option for security reasons.
2373
2374 *'diff'* *'nodiff'*
2375'diff' boolean (default off)
2376 local to window
2377 {not in Vi}
2378 {not available when compiled without the |+diff|
2379 feature}
2380 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002381 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382
2383 *'dex'* *'diffexpr'*
2384'diffexpr' 'dex' string (default "")
2385 global
2386 {not in Vi}
2387 {not available when compiled without the |+diff|
2388 feature}
2389 Expression which is evaluated to obtain an ed-style diff file from two
2390 versions of a file. See |diff-diffexpr|.
2391 This option cannot be set from a |modeline| or in the |sandbox|, for
2392 security reasons.
2393
2394 *'dip'* *'diffopt'*
2395'diffopt' 'dip' string (default "filler")
2396 global
2397 {not in Vi}
2398 {not available when compiled without the |+diff|
2399 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 All are optional. Items must be separated by a comma.
2402
2403 filler Show filler lines, to keep the text
2404 synchronized with a window that has inserted
2405 lines at the same position. Mostly useful
2406 when windows are side-by-side and 'scrollbind'
2407 is set.
2408
2409 context:{n} Use a context of {n} lines between a change
2410 and a fold that contains unchanged lines.
2411 When omitted a context of six lines is used.
2412 See |fold-diff|.
2413
2414 icase Ignore changes in case of text. "a" and "A"
2415 are considered the same. Adds the "-i" flag
2416 to the "diff" command if 'diffexpr' is empty.
2417
2418 iwhite Ignore changes in amount of white space. Adds
2419 the "-b" flag to the "diff" command if
2420 'diffexpr' is empty. Check the documentation
2421 of the "diff" command for what this does
2422 exactly. It should ignore adding trailing
2423 white space, but not leading white space.
2424
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002425 horizontal Start diff mode with horizontal splits (unless
2426 explicitly specified otherwise).
2427
2428 vertical Start diff mode with vertical splits (unless
2429 explicitly specified otherwise).
2430
2431 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2432 starting diff mode. Without this 2 is used.
2433
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 Examples: >
2435
2436 :set diffopt=filler,context:4
2437 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002438 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439<
2440 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2441'digraph' 'dg' boolean (default off)
2442 global
2443 {not in Vi}
2444 {not available when compiled without the |+digraphs|
2445 feature}
2446 Enable the entering of digraphs in Insert mode with {char1} <BS>
2447 {char2}. See |digraphs|.
2448 NOTE: This option is reset when 'compatible' is set.
2449
2450 *'directory'* *'dir'*
2451'directory' 'dir' string (default for Amiga: ".,t:",
2452 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2453 for Unix: ".,~/tmp,/var/tmp,/tmp")
2454 global
2455 List of directory names for the swap file, separated with commas.
2456 - The swap file will be created in the first directory where this is
2457 possible.
2458 - Empty means that no swap file will be used (recovery is
2459 impossible!).
2460 - A directory "." means to put the swap file in the same directory as
2461 the edited file. On Unix, a dot is prepended to the file name, so
2462 it doesn't show in a directory listing. On MS-Windows the "hidden"
2463 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002464 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 put the swap file relative to where the edited file is. The leading
2466 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002467 - For Unix and Win32, if a directory ends in two path separators "//"
2468 or "\\", the swap file name will be built from the complete path to
2469 the file with all path separators substituted to percent '%' signs.
2470 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002471 On Win32, when a separating comma is following, you must use "//",
2472 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 - Spaces after the comma are ignored, other spaces are considered part
2474 of the directory name. To have a space at the start of a directory
2475 name, precede it with a backslash.
2476 - To include a comma in a directory name precede it with a backslash.
2477 - A directory name may end in an ':' or '/'.
2478 - Environment variables are expanded |:set_env|.
2479 - Careful with '\' characters, type one before a space, type two to
2480 get one in the option (see |option-backslash|), for example: >
2481 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2482< - For backwards compatibility with Vim version 3.0 a '>' at the start
2483 of the option is removed.
2484 Using "." first in the list is recommended. This means that editing
2485 the same file twice will result in a warning. Using "/tmp" on Unix is
2486 discouraged: When the system crashes you lose the swap file.
2487 "/var/tmp" is often not cleared when rebooting, thus is a better
2488 choice than "/tmp". But it can contain a lot of files, your swap
2489 files get lost in the crowd. That is why a "tmp" directory in your
2490 home directory is tried first.
2491 The use of |:set+=| and |:set-=| is preferred when adding or removing
2492 directories from the list. This avoids problems when a future version
2493 uses another default.
2494 This option cannot be set from a |modeline| or in the |sandbox|, for
2495 security reasons.
2496 {Vi: directory to put temp file in, defaults to "/tmp"}
2497
2498 *'display'* *'dy'*
2499'display' 'dy' string (default "")
2500 global
2501 {not in Vi}
2502 Change the way text is displayed. This is comma separated list of
2503 flags:
2504 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002505 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 last line that doesn't fit is replaced with "@" lines.
2507 uhex Show unprintable characters hexadecimal as <xx>
2508 instead of using ^C and ~C.
2509
2510 *'eadirection'* *'ead'*
2511'eadirection' 'ead' string (default "both")
2512 global
2513 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002514 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 feature}
2516 Tells when the 'equalalways' option applies:
2517 ver vertically, width of windows is not affected
2518 hor horizontally, height of windows is not affected
2519 both width and height of windows is affected
2520
2521 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2522'edcompatible' 'ed' boolean (default off)
2523 global
2524 Makes the 'g' and 'c' flags of the ":substitute" command to be
2525 toggled each time the flag is given. See |complex-change|. See
2526 also 'gdefault' option.
2527 Switching this option on is discouraged!
2528
2529 *'encoding'* *'enc'* *E543*
2530'encoding' 'enc' string (default: "latin1" or value from $LANG)
2531 global
2532 {only available when compiled with the |+multi_byte|
2533 feature}
2534 {not in Vi}
2535 Sets the character encoding used inside Vim. It applies to text in
2536 the buffers, registers, Strings in expressions, text stored in the
2537 viminfo file, etc. It sets the kind of characters which Vim can work
2538 with. See |encoding-names| for the possible values.
2539
2540 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002541 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002543 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544
Bram Moolenaar865242e2010-07-14 21:12:05 +02002545 This option cannot be set from a |modeline|. It would most likely
2546 corrupt the text.
2547
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2549 "utf-8". Although care has been taken to allow different values of
2550 'encoding', "utf-8" is the natural choice for the environment and
2551 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002552 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 versions, and to avoid changing the encoding of newly created files
2554 without your knowledge (in case 'fileencodings' is empty).
2555
2556 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002557 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 iconv() or as specified with 'charconvert'.
2559
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002560 If you need to know whether 'encoding' is a multi-byte encoding, you
2561 can use: >
2562 if has("multi_byte_encoding")
2563<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 Normally 'encoding' will be equal to your current locale. This will
2565 be the default if Vim recognizes your environment settings. If
2566 'encoding' is not set to the current locale, 'termencoding' must be
2567 set to convert typed and displayed text. See |encoding-table|.
2568
2569 When you set this option, it fires the |EncodingChanged| autocommand
2570 event so that you can set up fonts if necessary.
2571
2572 When the option is set, the value is converted to lowercase. Thus
2573 you can set it with uppercase values too. Underscores are translated
2574 to '-' signs.
2575 When the encoding is recognized, it is changed to the standard name.
2576 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2577 "iso-8859-2" and "utf8" becomes "utf-8".
2578
2579 Note: "latin1" is also used when the encoding could not be detected.
2580 This only works when editing files in the same encoding! When the
2581 actual character set is not latin1, make sure 'fileencoding' and
2582 'fileencodings' are empty. When conversion is needed, switch to using
2583 utf-8.
2584
2585 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2586 You don't notice this while editing, but it does matter for the
2587 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2588 setting 'encoding' to one of these values instead of utf-8 only has
2589 effect for encoding used for files when 'fileencoding' is empty.
2590
Bram Moolenaar661b1822005-07-28 22:36:45 +00002591 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2592 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593
2594 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2595'endofline' 'eol' boolean (default on)
2596 local to buffer
2597 {not in Vi}
2598 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 option is automatically set when starting to edit a new file, unless
2601 the file does not have an <EOL> for the last line in the file, in
2602 which case it is reset. Normally you don't have to set or reset this
2603 option. When 'binary' is off the value is not used when writing the
2604 file. When 'binary' is on it is used to remember the presence of a
2605 <EOL> for the last line in the file, so that when you write the file
2606 the situation from the original file can be kept. But you can change
2607 it if you want to.
2608
2609 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2610'equalalways' 'ea' boolean (default on)
2611 global
2612 {not in Vi}
2613 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002614 splitting or closing a window. This also happens the moment the
2615 option is switched on. When off, splitting a window will reduce the
2616 size of the current window and leave the other windows the same. When
2617 closing a window the extra lines are given to the window next to it
2618 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 When mixing vertically and horizontally split windows, a minimal size
2620 is computed and some windows may be larger if there is room. The
2621 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002622 Changing the height and width of a window can be avoided by setting
2623 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002624 If a window size is specified when creating a new window sizes are
2625 currently not equalized (it's complicated, but may be implemented in
2626 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627
2628 *'equalprg'* *'ep'*
2629'equalprg' 'ep' string (default "")
2630 global or local to buffer |global-local|
2631 {not in Vi}
2632 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002633 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002634 or 'indentexpr'. When Vim was compiled without internal formatting,
2635 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002636 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 about including spaces and backslashes.
2638 This option cannot be set from a |modeline| or in the |sandbox|, for
2639 security reasons.
2640
2641 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2642'errorbells' 'eb' boolean (default off)
2643 global
2644 Ring the bell (beep or screen flash) for error messages. This only
2645 makes a difference for error messages, the bell will be used always
2646 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002647 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648 screen flash or do nothing.
2649
2650 *'errorfile'* *'ef'*
2651'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2652 others: "errors.err")
2653 global
2654 {not in Vi}
2655 {not available when compiled without the |+quickfix|
2656 feature}
2657 Name of the errorfile for the QuickFix mode (see |:cf|).
2658 When the "-q" command-line argument is used, 'errorfile' is set to the
2659 following argument. See |-q|.
2660 NOT used for the ":make" command. See 'makeef' for that.
2661 Environment variables are expanded |:set_env|.
2662 See |option-backslash| about including spaces and backslashes.
2663 This option cannot be set from a |modeline| or in the |sandbox|, for
2664 security reasons.
2665
2666 *'errorformat'* *'efm'*
2667'errorformat' 'efm' string (default is very long)
2668 global or local to buffer |global-local|
2669 {not in Vi}
2670 {not available when compiled without the |+quickfix|
2671 feature}
2672 Scanf-like description of the format for the lines in the error file
2673 (see |errorformat|).
2674
2675 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2676'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2677 global
2678 {not in Vi}
2679 Function keys that start with an <Esc> are recognized in Insert
2680 mode. When this option is off, the cursor and function keys cannot be
2681 used in Insert mode if they start with an <Esc>. The advantage of
2682 this is that the single <Esc> is recognized immediately, instead of
2683 after one second. Instead of resetting this option, you might want to
2684 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2685 when 'esckeys' is off, you can still map anything, but the cursor keys
2686 won't work by default.
2687 NOTE: This option is set to the Vi default value when 'compatible' is
2688 set and to the Vim default value when 'compatible' is reset.
2689
2690 *'eventignore'* *'ei'*
2691'eventignore' 'ei' string (default "")
2692 global
2693 {not in Vi}
2694 {not available when compiled without the |+autocmd|
2695 feature}
2696 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002697 When set to "all" or when "all" is one of the items, all autocommand
2698 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 Otherwise this is a comma separated list of event names. Example: >
2700 :set ei=WinEnter,WinLeave
2701<
2702 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2703'expandtab' 'et' boolean (default off)
2704 local to buffer
2705 {not in Vi}
2706 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002707 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2709 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2710 NOTE: This option is reset when 'compatible' is set.
2711
2712 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2713'exrc' 'ex' boolean (default off)
2714 global
2715 {not in Vi}
2716 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2717 directory. If you switch this option on you should also consider
2718 setting the 'secure' option (see |initialization|). Using a local
2719 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2720 also see |.vimrc| and |gui-init|.
2721 This option cannot be set from a |modeline| or in the |sandbox|, for
2722 security reasons.
2723
2724 *'fileencoding'* *'fenc'* *E213*
2725'fileencoding' 'fenc' string (default: "")
2726 local to buffer
2727 {only available when compiled with the |+multi_byte|
2728 feature}
2729 {not in Vi}
2730 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002731
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002733 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 When 'fileencoding' is empty, the same value as 'encoding' will be
2735 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002736 Conversion will also be done when 'encoding' and 'fileencoding' are
2737 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2738 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002740 'encoding' is "utf-8" or another Unicode encoding, conversion
2741 is most likely done in a way that the reverse conversion
2742 results in the same text. When 'encoding' is not "utf-8" some
2743 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002744
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 See 'encoding' for the possible values. Additionally, values may be
2746 specified that can be handled by the converter, see
2747 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002748
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 When reading a file 'fileencoding' will be set from 'fileencodings'.
2750 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002751 'fileencoding', use the |++enc| argument. One exception: when
2752 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002753 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002754
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2756 When the option is set, the value is converted to lowercase. Thus
2757 you can set it with uppercase values too. '_' characters are
2758 replaced with '-'. If a name is recognized from the list for
2759 'encoding', it is replaced by the standard name. For example
2760 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002761
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 When this option is set, after starting to edit a file, the 'modified'
2763 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002764
2765 Keep in mind that changing 'fenc' from a modeline happens
2766 AFTER the text has been read, thus it applies to when the file will be
2767 written. If you do set 'fenc' in a modeline, you might want to set
2768 'nomodified' to avoid not being able to ":q".
2769
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 This option can not be changed when 'modifiable' is off.
2771
2772 *'fe'*
2773 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 old short name was 'fe', which is no longer used.
2776
2777 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002778'fileencodings' 'fencs' string (default: "ucs-bom",
2779 "ucs-bom,utf-8,default,latin1" when
2780 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 global
2782 {only available when compiled with the |+multi_byte|
2783 feature}
2784 {not in Vi}
2785 This is a list of character encodings considered when starting to edit
2786 an existing file. When a file is read, Vim tries to use the first
2787 mentioned character encoding. If an error is detected, the next one
2788 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002789 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 an empty string, which means the value of 'encoding' is used.
2791 WARNING: Conversion can cause loss of information! When
2792 'encoding' is "utf-8" (or one of the other Unicode variants)
2793 conversion is most likely done in a way that the reverse
2794 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002795 "utf-8" some non-ASCII characters may be lost! You can use
2796 the |++bad| argument to specify what is done with characters
2797 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 For an empty file or a file with only ASCII characters most encodings
2799 will work and the first entry of 'fileencodings' will be used (except
2800 "ucs-bom", which requires the BOM to be present). If you prefer
2801 another encoding use an BufReadPost autocommand event to test if your
2802 preferred encoding is to be used. Example: >
2803 au BufReadPost * if search('\S', 'w') == 0 |
2804 \ set fenc=iso-2022-jp | endif
2805< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2806 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002807 When the |++enc| argument is used then the value of 'fileencodings' is
2808 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002809 Note that 'fileencodings' is not used for a new file, the global value
2810 of 'fileencoding' is used instead. You can set it with: >
2811 :setglobal fenc=iso-8859-2
2812< This means that a non-existing file may get a different encoding than
2813 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 The special value "ucs-bom" can be used to check for a Unicode BOM
2815 (Byte Order Mark) at the start of the file. It must not be preceded
2816 by "utf-8" or another Unicode encoding for this to work properly.
2817 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2818 because Vim cannot detect an error, thus the encoding is always
2819 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002820 The special value "default" can be used for the encoding from the
2821 environment. This is the default value for 'encoding'. It is useful
2822 when 'encoding' is set to "utf-8" and your environment uses a
2823 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002824 When 'encoding' is "utf-8" and a file contains an illegal byte
2825 sequence it won't be recognized as UTF-8. You can use the |8g8|
2826 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 WRONG VALUES: WHAT'S WRONG:
2828 latin1,utf-8 "latin1" will always be used
2829 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2830 file
2831 cp1250,latin1 "cp1250" will always be used
2832 If 'fileencodings' is empty, 'fileencoding' is not modified.
2833 See 'fileencoding' for the possible values.
2834 Setting this option does not have an effect until the next time a file
2835 is read.
2836
2837 *'fileformat'* *'ff'*
2838'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2839 Unix default: "unix",
2840 Macintosh default: "mac")
2841 local to buffer
2842 {not in Vi}
2843 This gives the <EOL> of the current buffer, which is used for
2844 reading/writing the buffer from/to a file:
2845 dos <CR> <NL>
2846 unix <NL>
2847 mac <CR>
2848 When "dos" is used, CTRL-Z at the end of a file is ignored.
2849 See |file-formats| and |file-read|.
2850 For the character encoding of the file see 'fileencoding'.
2851 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2852 works like it was set to "unix'.
2853 This option is set automatically when starting to edit a file and
2854 'fileformats' is not empty and 'binary' is off.
2855 When this option is set, after starting to edit a file, the 'modified'
2856 option is set, because the file would be different when written.
2857 This option can not be changed when 'modifiable' is off.
2858 For backwards compatibility: When this option is set to "dos",
2859 'textmode' is set, otherwise 'textmode' is reset.
2860
2861 *'fileformats'* *'ffs'*
2862'fileformats' 'ffs' string (default:
2863 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2864 Vim Unix: "unix,dos",
2865 Vim Mac: "mac,unix,dos",
2866 Vi Cygwin: "unix,dos",
2867 Vi others: "")
2868 global
2869 {not in Vi}
2870 This gives the end-of-line (<EOL>) formats that will be tried when
2871 starting to edit a new buffer and when reading a file into an existing
2872 buffer:
2873 - When empty, the format defined with 'fileformat' will be used
2874 always. It is not set automatically.
2875 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002876 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 'fileformats' name will be used when a file is read into an existing
2878 buffer, no matter what 'fileformat' for that buffer is set to.
2879 - When more than one name is present, separated by commas, automatic
2880 <EOL> detection will be done when reading a file. When starting to
2881 edit a file, a check is done for the <EOL>:
2882 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2883 'fileformat' is set to "dos".
2884 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002885 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002887 3. If 'fileformat' has not yet been set, and if 'fileformats'
2888 includes "mac", 'fileformat' is set to "mac".
2889 This means that "mac" is only chosen when:
2890 "unix" is not present or no <NL> is found in the file, and
2891 "dos" is not present or no <CR><NL> is found in the file.
2892 Except: if "unix" was chosen, but there is a <CR> before
2893 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002894 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 4. If 'fileformat' is still not set, the first name from
2896 'fileformats' is used.
2897 When reading a file into an existing buffer, the same is done, but
2898 this happens like 'fileformat' has been set appropriately for that
2899 file only, the option is not changed.
2900 When 'binary' is set, the value of 'fileformats' is not used.
2901
Bram Moolenaar81af9252010-12-10 20:35:50 +01002902 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002903 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002904
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2906 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2907 done:
2908 - When 'fileformats' is empty, there is no automatic detection. Dos
2909 format will be used.
2910 - When 'fileformats' is set to one or more names, automatic detection
2911 is done. This is based on the first <NL> in the file: If there is a
2912 <CR> in front of it, Dos format is used, otherwise Unix format is
2913 used.
2914 Also see |file-formats|.
2915 For backwards compatibility: When this option is set to an empty
2916 string or one format (no comma is included), 'textauto' is reset,
2917 otherwise 'textauto' is set.
2918 NOTE: This option is set to the Vi default value when 'compatible' is
2919 set and to the Vim default value when 'compatible' is reset.
2920
2921 *'filetype'* *'ft'*
2922'filetype' 'ft' string (default: "")
2923 local to buffer
2924 {not in Vi}
2925 {not available when compiled without the |+autocmd|
2926 feature}
2927 When this option is set, the FileType autocommand event is triggered.
2928 All autocommands that match with the value of this option will be
2929 executed. Thus the value of 'filetype' is used in place of the file
2930 name.
2931 Otherwise this option does not always reflect the current file type.
2932 This option is normally set when the file type is detected. To enable
2933 this use the ":filetype on" command. |:filetype|
2934 Setting this option to a different value is most useful in a modeline,
2935 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002936 Example, for in an IDL file:
2937 /* vim: set filetype=idl : */ ~
2938 |FileType| |filetypes|
2939 When a dot appears in the value then this separates two filetype
2940 names. Example:
2941 /* vim: set filetype=c.doxygen : */ ~
2942 This will use the "c" filetype first, then the "doxygen" filetype.
2943 This works both for filetype plugins and for syntax files. More than
2944 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 This option is not copied to another buffer, independent of the 's' or
2946 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002947 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948
2949 *'fillchars'* *'fcs'*
2950'fillchars' 'fcs' string (default "vert:|,fold:-")
2951 global
2952 {not in Vi}
2953 {not available when compiled without the |+windows|
2954 and |+folding| features}
2955 Characters to fill the statuslines and vertical separators.
2956 It is a comma separated list of items:
2957
2958 item default Used for ~
2959 stl:c ' ' or '^' statusline of the current window
2960 stlnc:c ' ' or '-' statusline of the non-current windows
2961 vert:c '|' vertical separators |:vsplit|
2962 fold:c '-' filling 'foldtext'
2963 diff:c '-' deleted lines of the 'diff' option
2964
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002965 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 "stlnc" the space will be used when there is highlighting, '^' or '-'
2967 otherwise.
2968
2969 Example: >
2970 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2971< This is similar to the default, except that these characters will also
2972 be used when there is highlighting.
2973
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002974 for "stl" and "stlnc" only single-byte values are supported.
2975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 The highlighting used for these items:
2977 item highlight group ~
2978 stl:c StatusLine |hl-StatusLine|
2979 stlnc:c StatusLineNC |hl-StatusLineNC|
2980 vert:c VertSplit |hl-VertSplit|
2981 fold:c Folded |hl-Folded|
2982 diff:c DiffDelete |hl-DiffDelete|
2983
2984 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2985'fkmap' 'fk' boolean (default off) *E198*
2986 global
2987 {not in Vi}
2988 {only available when compiled with the |+rightleft|
2989 feature}
2990 When on, the keyboard is mapped for the Farsi character set.
2991 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002992 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993
2994 *'foldclose'* *'fcl'*
2995'foldclose' 'fcl' string (default "")
2996 global
2997 {not in Vi}
2998 {not available when compiled without the |+folding|
2999 feature}
3000 When set to "all", a fold is closed when the cursor isn't in it and
3001 its level is higher than 'foldlevel'. Useful if you want folds to
3002 automatically close when moving out of them.
3003
3004 *'foldcolumn'* *'fdc'*
3005'foldcolumn' 'fdc' number (default 0)
3006 local to window
3007 {not in Vi}
3008 {not available when compiled without the |+folding|
3009 feature}
3010 When non-zero, a column with the specified width is shown at the side
3011 of the window which indicates open and closed folds. The maximum
3012 value is 12.
3013 See |folding|.
3014
3015 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3016'foldenable' 'fen' boolean (default on)
3017 local to window
3018 {not in Vi}
3019 {not available when compiled without the |+folding|
3020 feature}
3021 When off, all folds are open. This option can be used to quickly
3022 switch between showing all text unfolded and viewing the text with
3023 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003024 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 'foldenable' is off.
3026 This option is set by commands that create a new fold or close a fold.
3027 See |folding|.
3028
3029 *'foldexpr'* *'fde'*
3030'foldexpr' 'fde' string (default: "0")
3031 local to window
3032 {not in Vi}
3033 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003034 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003036 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003037
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003038 The expression may be evaluated in the |sandbox|, see
3039 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003040 This option can't be set from a |modeline| when the 'diff' option is
3041 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003042
3043 It is not allowed to change text or jump to another window while
3044 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045
3046 *'foldignore'* *'fdi'*
3047'foldignore' 'fdi' string (default: "#")
3048 local to window
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 Used only when 'foldmethod' is "indent". Lines starting with
3053 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003054 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 The default "#" works well for C programs. See |fold-indent|.
3056
3057 *'foldlevel'* *'fdl'*
3058'foldlevel' 'fdl' number (default: 0)
3059 local to window
3060 {not in Vi}
3061 {not available when compiled without the |+folding|
3062 feature}
3063 Sets the fold level: Folds with a higher level will be closed.
3064 Setting this option to zero will close all folds. Higher numbers will
3065 close fewer folds.
3066 This option is set by commands like |zm|, |zM| and |zR|.
3067 See |fold-foldlevel|.
3068
3069 *'foldlevelstart'* *'fdls'*
3070'foldlevelstart' 'fdls' number (default: -1)
3071 global
3072 {not in Vi}
3073 {not available when compiled without the |+folding|
3074 feature}
3075 Sets 'foldlevel' when starting to edit another buffer in a window.
3076 Useful to always start editing with all folds closed (value zero),
3077 some folds closed (one) or no folds closed (99).
3078 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003079 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 ignores this option and closes all folds.
3081 It is also done before BufReadPre autocommands, to allow an autocmd to
3082 overrule the 'foldlevel' value for specific files.
3083 When the value is negative, it is not used.
3084
3085 *'foldmarker'* *'fmr'* *E536*
3086'foldmarker' 'fmr' string (default: "{{{,}}}")
3087 local to window
3088 {not in Vi}
3089 {not available when compiled without the |+folding|
3090 feature}
3091 The start and end marker used when 'foldmethod' is "marker". There
3092 must be one comma, which separates the start and end marker. The
3093 marker is a literal string (a regular expression would be too slow).
3094 See |fold-marker|.
3095
3096 *'foldmethod'* *'fdm'*
3097'foldmethod' 'fdm' string (default: "manual")
3098 local to window
3099 {not in Vi}
3100 {not available when compiled without the |+folding|
3101 feature}
3102 The kind of folding used for the current window. Possible values:
3103 |fold-manual| manual Folds are created manually.
3104 |fold-indent| indent Lines with equal indent form a fold.
3105 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3106 |fold-marker| marker Markers are used to specify folds.
3107 |fold-syntax| syntax Syntax highlighting items specify folds.
3108 |fold-diff| diff Fold text that is not changed.
3109
3110 *'foldminlines'* *'fml'*
3111'foldminlines' 'fml' number (default: 1)
3112 local to window
3113 {not in Vi}
3114 {not available when compiled without the |+folding|
3115 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003116 Sets the number of screen lines above which a fold can be displayed
3117 closed. Also for manually closed folds. With the default value of
3118 one a fold can only be closed if it takes up two or more screen lines.
3119 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003120 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 "zc" to close a fold, which is displayed open because it's smaller
3122 than 'foldminlines', a following "zc" may close a containing fold.
3123
3124 *'foldnestmax'* *'fdn'*
3125'foldnestmax' 'fdn' number (default: 20)
3126 local to window
3127 {not in Vi}
3128 {not available when compiled without the |+folding|
3129 feature}
3130 Sets the maximum nesting of folds for the "indent" and "syntax"
3131 methods. This avoids that too many folds will be created. Using more
3132 than 20 doesn't work, because the internal limit is 20.
3133
3134 *'foldopen'* *'fdo'*
3135'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3136 search,tag,undo")
3137 global
3138 {not in Vi}
3139 {not available when compiled without the |+folding|
3140 feature}
3141 Specifies for which type of commands folds will be opened, if the
3142 command moves the cursor into a closed fold. It is a comma separated
3143 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003144 NOTE: When the command is part of a mapping this option is not used.
3145 Add the |zv| command to the mapping to get the same effect.
3146 (rationale: the mapping may want to control opening folds itself)
3147
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 item commands ~
3149 all any
3150 block "(", "{", "[[", "[{", etc.
3151 hor horizontal movements: "l", "w", "fx", etc.
3152 insert any command in Insert mode
3153 jump far jumps: "G", "gg", etc.
3154 mark jumping to a mark: "'m", CTRL-O, etc.
3155 percent "%"
3156 quickfix ":cn", ":crew", ":make", etc.
3157 search search for a pattern: "/", "n", "*", "gd", etc.
3158 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003159 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 tag jumping to a tag: ":ta", CTRL-T, etc.
3161 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 When a movement command is used for an operator (e.g., "dl" or "y%")
3163 this option is not used. This means the operator will include the
3164 whole closed fold.
3165 Note that vertical movements are not here, because it would make it
3166 very difficult to move onto a closed fold.
3167 In insert mode the folds containing the cursor will always be open
3168 when text is inserted.
3169 To close folds you can re-apply 'foldlevel' with the |zx| command or
3170 set the 'foldclose' option to "all".
3171
3172 *'foldtext'* *'fdt'*
3173'foldtext' 'fdt' string (default: "foldtext()")
3174 local to window
3175 {not in Vi}
3176 {not available when compiled without the |+folding|
3177 feature}
3178 An expression which is used to specify the text displayed for a closed
3179 fold. See |fold-foldtext|.
3180
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003181 The expression may be evaluated in the |sandbox|, see
3182 |sandbox-option|.
3183
3184 It is not allowed to change text or jump to another window while
3185 evaluating 'foldtext' |textlock|.
3186
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 *'formatoptions'* *'fo'*
3188'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3189 local to buffer
3190 {not in Vi}
3191 This is a sequence of letters which describes how automatic
3192 formatting is to be done. See |fo-table|. When the 'paste' option is
3193 on, no formatting is done (like 'formatoptions' is empty). Commas can
3194 be inserted for readability.
3195 To avoid problems with flags that are added in the future, use the
3196 "+=" and "-=" feature of ":set" |add-option-flags|.
3197 NOTE: This option is set to the Vi default value when 'compatible' is
3198 set and to the Vim default value when 'compatible' is reset.
3199
Bram Moolenaar86b68352004-12-27 21:59:20 +00003200 *'formatlistpat'* *'flp'*
3201'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3202 local to buffer
3203 {not in Vi}
3204 A pattern that is used to recognize a list header. This is used for
3205 the "n" flag in 'formatoptions'.
3206 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003207 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003208 while still checking more characters. There must be a character
3209 following the pattern, when it matches the whole line it is handled
3210 like there is no match.
3211 The default recognizes a number, followed by an optional punctuation
3212 character and white space.
3213
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 *'formatprg'* *'fp'*
3215'formatprg' 'fp' string (default "")
3216 global
3217 {not in Vi}
3218 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003219 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003221 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003222 If the 'formatexpr' option is not empty it will be used instead.
3223 Otherwise, if 'formatprg' option is an empty string, the internal
3224 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003225 Environment variables are expanded |:set_env|. See |option-backslash|
3226 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003227 The expression may be evaluated in the |sandbox|, see
3228 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003230 *'formatexpr'* *'fex'*
3231'formatexpr' 'fex' string (default "")
3232 local to buffer
3233 {not in Vi}
3234 {not available when compiled without the |+eval|
3235 feature}
3236 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003237 operator or automatic formatting (see 'formatoptions'). When this
3238 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003239
3240 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003241 The |v:count| variable holds the number of lines to be formatted.
3242 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003243 inserted if the expression is being evaluated due to
3244 automatic formatting. This can be empty. Don't insert
3245 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003246
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003247 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003248 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003249< This will invoke the mylang#Format() function in the
3250 autoload/mylang.vim file in 'runtimepath'. |autoload|
3251
3252 The expression is also evaluated when 'textwidth' is set and adding
3253 text beyond that limit. This happens under the same conditions as
3254 when internal formatting is used. Make sure the cursor is kept in the
3255 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003256 return "i" or "R" in this situation.
3257
3258 When the expression evaluates to non-zero Vim will fall back to using
3259 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003260
3261 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003262 |sandbox-option|. That stops the option from working, since changing
3263 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003264
3265 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003266'fsync' 'fs' boolean (default on)
3267 global
3268 {not in Vi}
3269 When on, the library function fsync() will be called after writing a
3270 file. This will flush a file to disk, ensuring that it is safely
3271 written even on filesystems which do metadata-only journaling. This
3272 will force the harddrive to spin up on Linux systems running in laptop
3273 mode, so it may be undesirable in some situations. Be warned that
3274 turning this off increases the chances of data loss after a crash. On
3275 systems without an fsync() implementation, this variable is always
3276 off.
3277 Also see 'swapsync' for controlling fsync() on swap files.
3278
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3280'gdefault' 'gd' boolean (default off)
3281 global
3282 {not in Vi}
3283 When on, the ":substitute" flag 'g' is default on. This means that
3284 all matches in a line are substituted instead of one. When a 'g' flag
3285 is given to a ":substitute" command, this will toggle the substitution
3286 of all or one match. See |complex-change|.
3287
3288 command 'gdefault' on 'gdefault' off ~
3289 :s/// subst. all subst. one
3290 :s///g subst. one subst. all
3291 :s///gg subst. all subst. one
3292
3293 NOTE: This option is reset when 'compatible' is set.
3294
3295 *'grepformat'* *'gfm'*
3296'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3297 global
3298 {not in Vi}
3299 Format to recognize for the ":grep" command output.
3300 This is a scanf-like string that uses the same format as the
3301 'errorformat' option: see |errorformat|.
3302
3303 *'grepprg'* *'gp'*
3304'grepprg' 'gp' string (default "grep -n ",
3305 Unix: "grep -n $* /dev/null",
3306 Win32: "findstr /n" or "grep -n",
3307 VMS: "SEARCH/NUMBERS ")
3308 global or local to buffer |global-local|
3309 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003310 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311 and '#' characters, which are expanded like when used in a command-
3312 line. The placeholder "$*" is allowed to specify where the arguments
3313 will be included. Environment variables are expanded |:set_env|. See
3314 |option-backslash| about including spaces and backslashes.
3315 When your "grep" accepts the "-H" argument, use this to make ":grep"
3316 also work well with a single file: >
3317 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003318< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003319 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3320 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003321 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 apply equally to 'grepprg'.
3323 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3324 otherwise it's "grep -n".
3325 This option cannot be set from a |modeline| or in the |sandbox|, for
3326 security reasons.
3327
3328 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3329'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3330 ve:ver35-Cursor,
3331 o:hor50-Cursor,
3332 i-ci:ver25-Cursor/lCursor,
3333 r-cr:hor20-Cursor/lCursor,
3334 sm:block-Cursor
3335 -blinkwait175-blinkoff150-blinkon175",
3336 for MS-DOS and Win32 console:
3337 "n-v-c:block,o:hor50,i-ci:hor15,
3338 r-cr:hor30,sm:block")
3339 global
3340 {not in Vi}
3341 {only available when compiled with GUI enabled, and
3342 for MS-DOS and Win32 console}
3343 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 the height of the cursor can be changed. This can be done by
3346 specifying a block cursor, or a percentage for a vertical or
3347 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003348 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003350 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 mode-list and an argument-list:
3352 mode-list:argument-list,mode-list:argument-list,..
3353 The mode-list is a dash separated list of these modes:
3354 n Normal mode
3355 v Visual mode
3356 ve Visual mode with 'selection' "exclusive" (same as 'v',
3357 if not specified)
3358 o Operator-pending mode
3359 i Insert mode
3360 r Replace mode
3361 c Command-line Normal (append) mode
3362 ci Command-line Insert mode
3363 cr Command-line Replace mode
3364 sm showmatch in Insert mode
3365 a all modes
3366 The argument-list is a dash separated list of these arguments:
3367 hor{N} horizontal bar, {N} percent of the character height
3368 ver{N} vertical bar, {N} percent of the character width
3369 block block cursor, fills the whole character
3370 [only one of the above three should be present]
3371 blinkwait{N} *cursor-blinking*
3372 blinkon{N}
3373 blinkoff{N}
3374 blink times for cursor: blinkwait is the delay before
3375 the cursor starts blinking, blinkon is the time that
3376 the cursor is shown and blinkoff is the time that the
3377 cursor is not shown. The times are in msec. When one
3378 of the numbers is zero, there is no blinking. The
3379 default is: "blinkwait700-blinkon400-blinkoff250".
3380 These numbers are used for a missing entry. This
3381 means that blinking is enabled by default. To switch
3382 blinking off you can use "blinkon0". The cursor only
3383 blinks when Vim is waiting for input, not while
3384 executing a command.
3385 To make the cursor blink in an xterm, see
3386 |xterm-blink|.
3387 {group-name}
3388 a highlight group name, that sets the color and font
3389 for the cursor
3390 {group-name}/{group-name}
3391 Two highlight group names, the first is used when
3392 no language mappings are used, the other when they
3393 are. |language-mapping|
3394
3395 Examples of parts:
3396 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3397 block cursor with colors from the "nCursor"
3398 highlight group
3399 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3400 In Insert and Command-line Insert mode, use a
3401 30% vertical bar cursor with colors from the
3402 "iCursor" highlight group. Blink a bit
3403 faster.
3404
3405 The 'a' mode is different. It will set the given argument-list for
3406 all modes. It does not reset anything to defaults. This can be used
3407 to do a common setting for all modes. For example, to switch off
3408 blinking: "a:blinkon0"
3409
3410 Examples of cursor highlighting: >
3411 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3412 :highlight Cursor gui=NONE guifg=bg guibg=fg
3413<
3414 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003415 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003416'guifont' 'gfn' string (default "")
3417 global
3418 {not in Vi}
3419 {only available when compiled with GUI enabled}
3420 This is a list of fonts which will be used for the GUI version of Vim.
3421 In its simplest form the value is just one font name. When
3422 the font cannot be found you will get an error message. To try other
3423 font names a list can be specified, font names separated with commas.
3424 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003425
Bram Moolenaar05159a02005-02-26 23:04:13 +00003426 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3427 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003428
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 Spaces after a comma are ignored. To include a comma in a font name
3430 precede it with a backslash. Setting an option requires an extra
3431 backslash before a space and a backslash. See also
3432 |option-backslash|. For example: >
3433 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003434< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003436
3437 If none of the fonts can be loaded, Vim will keep the current setting.
3438 If an empty font list is given, Vim will try using other resource
3439 settings (for X, it will use the Vim.font resource), and finally it
3440 will try some builtin default which should always be there ("7x13" in
3441 the case of X). The font names given should be "normal" fonts. Vim
3442 will try to find the related bold and italic fonts.
3443
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003444 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003445 :set guifont=*
3446< will bring up a font requester, where you can pick the font you want.
3447
3448 The font name depends on the GUI used. See |setting-guifont| for a
3449 way to set 'guifont' for various systems.
3450
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 For the GTK+ 2 GUI the font name looks like this: >
3452 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003453< That's all. XLFDs are not used. For Chinese this is reported to work
3454 well: >
3455 if has("gui_gtk2")
3456 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3457 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3458 endif
3459<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003460 For Mac OSX you can use something like this: >
3461 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003462< Also see 'macatsui', it can help fix display problems.
3463 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003465 width). An exception is GTK 2: all fonts are accepted, but
3466 mono-spaced fonts look best.
3467
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 To preview a font on X11, you might be able to use the "xfontsel"
3469 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003470
Bram Moolenaar071d4272004-06-13 20:20:40 +00003471 For the Win32 GUI *E244* *E245*
3472 - takes these options in the font name:
3473 hXX - height is XX (points, can be floating-point)
3474 wXX - width is XX (points, can be floating-point)
3475 b - bold
3476 i - italic
3477 u - underline
3478 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003479 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3481 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3482 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003483 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484
3485 Use a ':' to separate the options.
3486 - A '_' can be used in the place of a space, so you don't need to use
3487 backslashes to escape the spaces.
3488 - Examples: >
3489 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3490 :set guifont=Andale_Mono:h7.5:w4.5
3491< See also |font-sizes|.
3492
3493 *'guifontset'* *'gfs'*
3494 *E250* *E252* *E234* *E597* *E598*
3495'guifontset' 'gfs' string (default "")
3496 global
3497 {not in Vi}
3498 {only available when compiled with GUI enabled and
3499 with the |+xfontset| feature}
3500 {not available in the GTK+ 2 GUI}
3501 When not empty, specifies two (or more) fonts to be used. The first
3502 one for normal English, the second one for your special language. See
3503 |xfontset|.
3504 Setting this option also means that all font names will be handled as
3505 a fontset name. Also the ones used for the "font" argument of the
3506 |:highlight| command.
3507 The fonts must match with the current locale. If fonts for the
3508 character sets that the current locale uses are not included, setting
3509 'guifontset' will fail.
3510 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3511 the comma-separated names are alternative names, one of which will be
3512 used. In 'guifontset' the whole string is one fontset name,
3513 including the commas. It is not possible to specify alternative
3514 fontset names.
3515 This example works on many X11 systems: >
3516 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3517<
3518 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3519'guifontwide' 'gfw' string (default "")
3520 global
3521 {not in Vi}
3522 {only available when compiled with GUI enabled}
3523 When not empty, specifies a comma-separated list of fonts to be used
3524 for double-width characters. The first font that can be loaded is
3525 used.
3526 Note: The size of these fonts must be exactly twice as wide as the one
3527 specified with 'guifont' and the same height.
3528
3529 All GUI versions but GTK+ 2:
3530
3531 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3532 'guifontset' is empty or invalid.
3533 When 'guifont' is set and a valid font is found in it and
3534 'guifontwide' is empty Vim will attempt to find a matching
3535 double-width font and set 'guifontwide' to it.
3536
3537 GTK+ 2 GUI only: *guifontwide_gtk2*
3538
3539 If set and valid, 'guifontwide' is always used for double width
3540 characters, even if 'encoding' is not set to "utf-8".
3541 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003542 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 font for characters not available in 'guifont'. Thus you do not need
3544 to set 'guifontwide' at all unless you want to override the choice
3545 made by Pango/Xft.
3546
3547 *'guiheadroom'* *'ghr'*
3548'guiheadroom' 'ghr' number (default 50)
3549 global
3550 {not in Vi} {only for GTK and X11 GUI}
3551 The number of pixels subtracted from the screen height when fitting
3552 the GUI window on the screen. Set this before the GUI is started,
3553 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003554 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 lines will be left for window decorations and other items on the
3556 screen. Set it to a negative value to allow windows taller than the
3557 screen.
3558
3559 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003560'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3561 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 global
3563 {not in Vi}
3564 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003565 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 sequence of letters which describes what components and options of the
3567 GUI should be used.
3568 To avoid problems with flags that are added in the future, use the
3569 "+=" and "-=" feature of ":set" |add-option-flags|.
3570
3571 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003572 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 'a' Autoselect: If present, then whenever VISUAL mode is started,
3574 or the Visual area extended, Vim tries to become the owner of
3575 the windowing system's global selection. This means that the
3576 Visually highlighted text is available for pasting into other
3577 applications as well as into Vim itself. When the Visual mode
3578 ends, possibly due to an operation on the text, or when an
3579 application wants to paste the selection, the highlighted text
3580 is automatically yanked into the "* selection register.
3581 Thus the selection is still available for pasting into other
3582 applications after the VISUAL mode has ended.
3583 If not present, then Vim won't become the owner of the
3584 windowing system's global selection unless explicitly told to
3585 by a yank or delete operation for the "* register.
3586 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003587 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003588 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 applies to the modeless selection.
3590
3591 'guioptions' autoselect Visual autoselect modeless ~
3592 "" - -
3593 "a" yes yes
3594 "A" - yes
3595 "aA" yes yes
3596
Bram Moolenaar02467872007-05-06 13:22:01 +00003597 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 'c' Use console dialogs instead of popup dialogs for simple
3599 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003600 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003601 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003602 'guitablabel' can be used to change the text in the labels.
3603 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003604 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003605 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003606 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 'f' Foreground: Don't use fork() to detach the GUI from the shell
3608 where it was started. Use this for programs that wait for the
3609 editor to finish (e.g., an e-mail program). Alternatively you
3610 can use "gvim -f" or ":gui -f" to start the GUI in the
3611 foreground. |gui-fork|
3612 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003613 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003614 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3616 corner of the window. It's black&white on non-GTK, because of
3617 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003618 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003620 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003621 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003622 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003623 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 file is sourced the system menu has already been loaded; the
3625 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003626 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 'g' Grey menu items: Make menu items that are not active grey. If
3628 'g' is not included inactive menu items are not shown at all.
3629 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003630 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 't' Include tearoff menu items. Currently only works for Win32,
3632 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003633 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003634 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003635 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003636 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003638 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 'R' Right-hand scrollbar is present when there is a vertically
3640 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003641 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003643 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 'L' Left-hand scrollbar is present when there is a vertically
3645 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003646 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3648 the longest visible line, or on the cursor line if the 'h'
3649 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003650 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 'h' Limit horizontal scrollbar size to the length of the cursor
3652 line. Reduces computations. |gui-horiz-scroll|
3653
3654 And yes, you may even have scrollbars on the left AND the right if
3655 you really want to :-). See |gui-scrollbars| for more information.
3656
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003657 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 'v' Use a vertical button layout for dialogs. When not included,
3659 a horizontal layout is preferred, but when it doesn't fit a
3660 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003661 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 'p' Use Pointer callbacks for X11 GUI. This is required for some
3663 window managers. If the cursor is not blinking or hollow at
3664 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003665 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003667 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003668 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669
Bram Moolenaar02467872007-05-06 13:22:01 +00003670
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 *'guipty'* *'noguipty'*
3672'guipty' boolean (default on)
3673 global
3674 {not in Vi}
3675 {only available when compiled with GUI enabled}
3676 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3677 I/O to/from shell commands. See |gui-pty|.
3678
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003679 *'guitablabel'* *'gtl'*
3680'guitablabel' 'gtl' string (default empty)
3681 global
3682 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003683 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003684 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003685 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003686 pages line. When empty and when the result is empty Vim will use a
3687 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003688
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003689 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003690 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003691
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003692 Only used when the GUI tab pages line is displayed. 'e' must be
3693 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3694 used.
3695
Bram Moolenaar57657d82006-04-21 22:12:41 +00003696 *'guitabtooltip'* *'gtt'*
3697'guitabtooltip' 'gtt' string (default empty)
3698 global
3699 {not in Vi}
3700 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003701 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003702 When nonempty describes the text to use in a tooltip for the GUI tab
3703 pages line. When empty Vim will use a default tooltip.
3704 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003705 You can include a line break. Simplest method is to use |:let|: >
3706 :let &guitabtooltip = "line one\nline two"
3707<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003708
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 *'helpfile'* *'hf'*
3710'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3711 (others) "$VIMRUNTIME/doc/help.txt")
3712 global
3713 {not in Vi}
3714 Name of the main help file. All distributed help files should be
3715 placed together in one directory. Additionally, all "doc" directories
3716 in 'runtimepath' will be used.
3717 Environment variables are expanded |:set_env|. For example:
3718 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003719 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 spaces and backslashes.
3721 This option cannot be set from a |modeline| or in the |sandbox|, for
3722 security reasons.
3723
3724 *'helpheight'* *'hh'*
3725'helpheight' 'hh' number (default 20)
3726 global
3727 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003728 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 feature}
3730 Minimal initial height of the help window when it is opened with the
3731 ":help" command. The initial height of the help window is half of the
3732 current window, or (when the 'ea' option is on) the same as other
3733 windows. When the height is less than 'helpheight', the height is
3734 set to 'helpheight'. Set to zero to disable.
3735
3736 *'helplang'* *'hlg'*
3737'helplang' 'hlg' string (default: messages language or empty)
3738 global
3739 {only available when compiled with the |+multi_lang|
3740 feature}
3741 {not in Vi}
3742 Comma separated list of languages. Vim will use the first language
3743 for which the desired help can be found. The English help will always
3744 be used as a last resort. You can add "en" to prefer English over
3745 another language, but that will only find tags that exist in that
3746 language and not in the English help.
3747 Example: >
3748 :set helplang=de,it
3749< This will first search German, then Italian and finally English help
3750 files.
3751 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3752 try to find the tag in the current language before using this option.
3753 See |help-translated|.
3754
3755 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3756'hidden' 'hid' boolean (default off)
3757 global
3758 {not in Vi}
3759 When off a buffer is unloaded when it is |abandon|ed. When on a
3760 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3761 displayed in another window, it does not become hidden, of course.
3762 The commands that move through the buffer list sometimes make a buffer
3763 hidden although the 'hidden' option is off: When the buffer is
3764 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003765 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003766 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 This option is set for one command with ":hide {command}" |:hide|.
3768 WARNING: It's easy to forget that you have changes in hidden buffers.
3769 Think twice when using ":q!" or ":qa!".
3770
3771 *'highlight'* *'hl'*
3772'highlight' 'hl' string (default (as a single string):
3773 "8:SpecialKey,@:NonText,d:Directory,
3774 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3775 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003776 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3778 f:Folded,F:FoldColumn,A:DiffAdd,
3779 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003780 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003781 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003782 +:Pmenu,=:PmenuSel,
3783 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 global
3785 {not in Vi}
3786 This option can be used to set highlighting mode for various
3787 occasions. It is a comma separated list of character pairs. The
3788 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3791 |hl-NonText| @ '~' and '@' at the end of the window and
3792 characters from 'showbreak'
3793 |hl-Directory| d directories in CTRL-D listing and other special
3794 things in listings
3795 |hl-ErrorMsg| e error messages
3796 h (obsolete, ignored)
3797 |hl-IncSearch| i 'incsearch' highlighting
3798 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3799 |hl-MoreMsg| m |more-prompt|
3800 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003801 |hl-LineNr| n line number for ":number" and ":#" commands, and
3802 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 |hl-Question| r |hit-enter| prompt and yes/no questions
3804 |hl-StatusLine| s status line of current window |status-line|
3805 |hl-StatusLineNC| S status lines of not-current windows
3806 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3807 |hl-VertSplit| c column used to separate vertically split windows
3808 |hl-Visual| v Visual mode
3809 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3810 Selection" Only X11 Gui's |gui-x11| and
3811 |xterm-clipboard|.
3812 |hl-WarningMsg| w warning messages
3813 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3814 |hl-Folded| f line used for closed folds
3815 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003816 |hl-DiffAdd| A added line in diff mode
3817 |hl-DiffChange| C changed line in diff mode
3818 |hl-DiffDelete| D deleted line in diff mode
3819 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003821 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003822 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003823 |hl-SpellRare| R rare word |spell|
3824 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003825 |hl-Conceal| - the placeholders used for concealed characters
3826 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003827 |hl-Pmenu| + popup menu normal line
3828 |hl-PmenuSel| = popup menu normal line
3829 |hl-PmenuSbar| x popup menu scrollbar
3830 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831
3832 The display modes are:
3833 r reverse (termcap entry "mr" and "me")
3834 i italic (termcap entry "ZH" and "ZR")
3835 b bold (termcap entry "md" and "me")
3836 s standout (termcap entry "so" and "se")
3837 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003838 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 n no highlighting
3840 - no highlighting
3841 : use a highlight group
3842 The default is used for occasions that are not included.
3843 If you want to change what the display modes do, see |dos-colors|
3844 for an example.
3845 When using the ':' display mode, this must be followed by the name of
3846 a highlight group. A highlight group can be used to define any type
3847 of highlighting, including using color. See |:highlight| on how to
3848 define one. The default uses a different group for each occasion.
3849 See |highlight-default| for the default highlight groups.
3850
3851 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3852'hlsearch' 'hls' boolean (default off)
3853 global
3854 {not in Vi}
3855 {not available when compiled without the
3856 |+extra_search| feature}
3857 When there is a previous search pattern, highlight all its matches.
3858 The type of highlighting used can be set with the 'l' occasion in the
3859 'highlight' option. This uses the "Search" highlight group by
3860 default. Note that only the matching text is highlighted, any offsets
3861 are not applied.
3862 See also: 'incsearch' and |:match|.
3863 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003864 off with |:nohlsearch|. This does not change the option value, as
3865 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003866 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 When the search pattern can match an end-of-line, Vim will try to
3868 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003869 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003870 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003871 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003872 You can specify whether the highlight status is restored on startup
3873 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 NOTE: This option is reset when 'compatible' is set.
3875
3876 *'history'* *'hi'*
3877'history' 'hi' number (Vim default: 20, Vi default: 0)
3878 global
3879 {not in Vi}
3880 A history of ":" commands, and a history of previous search patterns
3881 are remembered. This option decides how many entries may be stored in
3882 each of these histories (see |cmdline-editing|).
3883 NOTE: This option is set to the Vi default value when 'compatible' is
3884 set and to the Vim default value when 'compatible' is reset.
3885
3886 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3887'hkmap' 'hk' boolean (default off)
3888 global
3889 {not in Vi}
3890 {only available when compiled with the |+rightleft|
3891 feature}
3892 When on, the keyboard is mapped for the Hebrew character set.
3893 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3894 toggle this option. See |rileft.txt|.
3895 NOTE: This option is reset when 'compatible' is set.
3896
3897 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3898'hkmapp' 'hkp' boolean (default off)
3899 global
3900 {not in Vi}
3901 {only available when compiled with the |+rightleft|
3902 feature}
3903 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3904 This is useful if you have a non-Hebrew keyboard.
3905 See |rileft.txt|.
3906 NOTE: This option is reset when 'compatible' is set.
3907
3908 *'icon'* *'noicon'*
3909'icon' boolean (default off, on when title can be restored)
3910 global
3911 {not in Vi}
3912 {not available when compiled without the |+title|
3913 feature}
3914 When on, the icon text of the window will be set to the value of
3915 'iconstring' (if it is not empty), or to the name of the file
3916 currently being edited. Only the last part of the name is used.
3917 Overridden by the 'iconstring' option.
3918 Only works if the terminal supports setting window icons (currently
3919 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3920 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3921 builtin termcap).
3922 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003923 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 X11.
3925
3926 *'iconstring'*
3927'iconstring' string (default "")
3928 global
3929 {not in Vi}
3930 {not available when compiled without the |+title|
3931 feature}
3932 When this option is not empty, it will be used for the icon text of
3933 the window. This happens only when the 'icon' option is on.
3934 Only works if the terminal supports setting window icon text
3935 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3936 Does not work for MS Windows.
3937 When Vim was compiled with HAVE_X11 defined, the original icon will be
3938 restored if possible |X11|.
3939 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003940 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941 'titlestring' for example settings.
3942 {not available when compiled without the |+statusline| feature}
3943
3944 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3945'ignorecase' 'ic' boolean (default off)
3946 global
3947 Ignore case in search patterns. Also used when searching in the tags
3948 file.
3949 Also see 'smartcase'.
3950 Can be overruled by using "\c" or "\C" in the pattern, see
3951 |/ignorecase|.
3952
3953 *'imactivatekey'* *'imak'*
3954'imactivatekey' 'imak' string (default "")
3955 global
3956 {not in Vi}
3957 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003958 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 Specifies the key that your Input Method in X-Windows uses for
3960 activation. When this is specified correctly, vim can fully control
3961 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3962 You can't use this option to change the activation key, the option
3963 tells Vim what the key is.
3964 Format:
3965 [MODIFIER_FLAG-]KEY_STRING
3966
3967 These characters can be used for MODIFIER_FLAG (case is ignored):
3968 S Shift key
3969 L Lock key
3970 C Control key
3971 1 Mod1 key
3972 2 Mod2 key
3973 3 Mod3 key
3974 4 Mod4 key
3975 5 Mod5 key
3976 Combinations are allowed, for example "S-C-space" or "SC-space" are
3977 both shift+ctrl+space.
3978 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3979
3980 Example: >
3981 :set imactivatekey=S-space
3982< "S-space" means shift+space. This is the activation key for kinput2 +
3983 canna (Japanese), and ami (Korean).
3984
3985 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3986'imcmdline' 'imc' boolean (default off)
3987 global
3988 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003989 {only available when compiled with the |+xim|,
3990 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 When set the Input Method is always on when starting to edit a command
3992 line, unless entering a search pattern (see 'imsearch' for that).
3993 Setting this option is useful when your input method allows entering
3994 English characters directly, e.g., when it's used to type accented
3995 characters with dead keys.
3996
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003997 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3999 global
4000 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004001 {only available when compiled with the |+xim|,
4002 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 When set the Input Method is never used. This is useful to disable
4004 the IM when it doesn't work properly.
4005 Currently this option is on by default for SGI/IRIX machines. This
4006 may change in later releases.
4007
4008 *'iminsert'* *'imi'*
4009'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4010 local to buffer
4011 {not in Vi}
4012 Specifies whether :lmap or an Input Method (IM) is to be used in
4013 Insert mode. Valid values:
4014 0 :lmap is off and IM is off
4015 1 :lmap is ON and IM is off
4016 2 :lmap is off and IM is ON
4017 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4018 or |global-ime|.
4019 To always reset the option to zero when leaving Insert mode with <Esc>
4020 this can be used: >
4021 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4022< This makes :lmap and IM turn off automatically when leaving Insert
4023 mode.
4024 Note that this option changes when using CTRL-^ in Insert mode
4025 |i_CTRL-^|.
4026 The value is set to 1 when setting 'keymap' to a valid keymap name.
4027 It is also used for the argument of commands like "r" and "f".
4028 The value 0 may not work correctly with Athena and Motif with some XIM
4029 methods. Use 'imdisable' to disable XIM then.
4030
4031 *'imsearch'* *'ims'*
4032'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4033 local to buffer
4034 {not in Vi}
4035 Specifies whether :lmap or an Input Method (IM) is to be used when
4036 entering a search pattern. Valid values:
4037 -1 the value of 'iminsert' is used, makes it look like
4038 'iminsert' is also used when typing a search pattern
4039 0 :lmap is off and IM is off
4040 1 :lmap is ON and IM is off
4041 2 :lmap is off and IM is ON
4042 Note that this option changes when using CTRL-^ in Command-line mode
4043 |c_CTRL-^|.
4044 The value is set to 1 when it is not -1 and setting the 'keymap'
4045 option to a valid keymap name.
4046 The value 0 may not work correctly with Athena and Motif with some XIM
4047 methods. Use 'imdisable' to disable XIM then.
4048
4049 *'include'* *'inc'*
4050'include' 'inc' string (default "^\s*#\s*include")
4051 global or local to buffer |global-local|
4052 {not in Vi}
4053 {not available when compiled without the
4054 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004055 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 pattern, just like for the "/" command (See |pattern|). The default
4057 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004058 "]I", "[d", etc.
4059 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004060 comes after the matched pattern. But if "\zs" appears in the pattern
4061 then the text matched from "\zs" to the end, or until "\ze" if it
4062 appears, is used as the file name. Use this to include characters
4063 that are not in 'isfname', such as a space. You can then use
4064 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004065 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066
4067 *'includeexpr'* *'inex'*
4068'includeexpr' 'inex' string (default "")
4069 local to buffer
4070 {not in Vi}
4071 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004072 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004074 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 :set includeexpr=substitute(v:fname,'\\.','/','g')
4076< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004077
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004079 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 Also used for |<cfile>|.
4081
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004082 The expression may be evaluated in the |sandbox|, see
4083 |sandbox-option|.
4084
4085 It is not allowed to change text or jump to another window while
4086 evaluating 'includeexpr' |textlock|.
4087
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4089'incsearch' 'is' boolean (default off)
4090 global
4091 {not in Vi}
4092 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004093 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004094 While typing a search command, show where the pattern, as it was typed
4095 so far, matches. The matched string is highlighted. If the pattern
4096 is invalid or not found, nothing is shown. The screen will be updated
4097 often, this is only useful on fast terminals.
4098 Note that the match will be shown, but the cursor will return to its
4099 original position when no match is found and when pressing <Esc>. You
4100 still need to finish the search command with <Enter> to move the
4101 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004102 When compiled with the |+reltime| feature Vim only searches for about
4103 half a second. With a complicated pattern and/or a lot of text the
4104 match may not be found. This is to avoid that Vim hangs while you
4105 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004106 The highlighting can be set with the 'i' flag in 'highlight'.
4107 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004108 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004109 to the command line. If 'ignorecase' and 'smartcase' are set and the
4110 command line has no uppercase characters, the added character is
4111 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004112 CTRL-R CTRL-W can be used to add the word at the end of the current
4113 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 NOTE: This option is reset when 'compatible' is set.
4115
4116 *'indentexpr'* *'inde'*
4117'indentexpr' 'inde' string (default "")
4118 local to buffer
4119 {not in Vi}
4120 {not available when compiled without the |+cindent|
4121 or |+eval| features}
4122 Expression which is evaluated to obtain the proper indent for a line.
4123 It is used when a new line is created, for the |=| operator and
4124 in Insert mode as specified with the 'indentkeys' option.
4125 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004126 'smartindent' indenting. When 'lisp' is set, this option is
4127 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 When 'paste' is set this option is not used for indenting.
4129 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004130 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 when the expression is evaluated (but it may be moved around).
4132 The expression must return the number of spaces worth of indent. It
4133 can return "-1" to keep the current indent (this means 'autoindent' is
4134 used for the indent).
4135 Functions useful for computing the indent are |indent()|, |cindent()|
4136 and |lispindent()|.
4137 The evaluation of the expression must not have side effects! It must
4138 not change the text, jump to another window, etc. Afterwards the
4139 cursor position is always restored, thus the cursor may be moved.
4140 Normally this option would be set to call a function: >
4141 :set indentexpr=GetMyIndent()
4142< Error messages will be suppressed, unless the 'debug' option contains
4143 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004144 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 NOTE: This option is made empty when 'compatible' is set.
4146
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004147 The expression may be evaluated in the |sandbox|, see
4148 |sandbox-option|.
4149
4150 It is not allowed to change text or jump to another window while
4151 evaluating 'indentexpr' |textlock|.
4152
4153
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 *'indentkeys'* *'indk'*
4155'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4156 local to buffer
4157 {not in Vi}
4158 {not available when compiled without the |+cindent|
4159 feature}
4160 A list of keys that, when typed in Insert mode, cause reindenting of
4161 the current line. Only happens if 'indentexpr' isn't empty.
4162 The format is identical to 'cinkeys', see |indentkeys-format|.
4163 See |C-indenting| and |indent-expression|.
4164
4165 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4166'infercase' 'inf' boolean (default off)
4167 local to buffer
4168 {not in Vi}
4169 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004170 'ignorecase' is also on, the case of the match is adjusted depending
4171 on the typed text. If the typed text contains a lowercase letter
4172 where the match has an upper case letter, the completed part is made
4173 lowercase. If the typed text has no lowercase letters and the match
4174 has a lowercase letter where the typed text has an uppercase letter,
4175 and there is a letter before it, the completed part is made uppercase.
4176 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177
4178 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4179'insertmode' 'im' boolean (default off)
4180 global
4181 {not in Vi}
4182 Makes Vim work in a way that Insert mode is the default mode. Useful
4183 if you want to use Vim as a modeless editor. Used for |evim|.
4184 These Insert mode commands will be useful:
4185 - Use the cursor keys to move around.
4186 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4187 this is a mapping, it is executed as if 'insertmode' was off.
4188 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004190 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4191 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192
4193 These items change when 'insertmode' is set:
4194 - when starting to edit of a file, Vim goes to Insert mode.
4195 - <Esc> in Insert mode is a no-op and beeps.
4196 - <Esc> in Normal mode makes Vim go to Insert mode.
4197 - CTRL-L in Insert mode is a command, it is not inserted.
4198 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4199 However, when <Esc> is used inside a mapping, it behaves like
4200 'insertmode' was not set. This was done to be able to use the same
4201 mappings with 'insertmode' set or not set.
4202 When executing commands with |:normal| 'insertmode' is not used.
4203
4204 NOTE: This option is reset when 'compatible' is set.
4205
4206 *'isfname'* *'isf'*
4207'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4208 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4209 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4210 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4211 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4212 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4213 global
4214 {not in Vi}
4215 The characters specified by this option are included in file names and
4216 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 Multi-byte characters 256 and above are always included, only the
4219 characters up to 255 are specified with this option.
4220 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004221 Think twice before adding white space to this option. Although a
4222 space may appear inside a file name, the effect will be that Vim
4223 doesn't know where a file name starts or ends when doing completion.
4224 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225
4226 Note that on systems using a backslash as path separator, Vim tries to
4227 do its best to make it work as you would expect. That is a bit
4228 tricky, since Vi originally used the backslash to escape special
4229 characters. Vim will not remove a backslash in front of a normal file
4230 name character on these systems, but it will on Unix and alikes. The
4231 '&' and '^' are not included by default, because these are special for
4232 cmd.exe.
4233
4234 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004235 Each part can be a single character number or a range. A range is two
4236 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 decimal number between 0 and 255 or the ASCII character itself (does
4238 not work for digits). Example:
4239 "_,-,128-140,#-43" (include '_' and '-' and the range
4240 128 to 140 and '#' to 43)
4241 If a part starts with '^', the following character number or range
4242 will be excluded from the option. The option is interpreted from left
4243 to right. Put the excluded character after the range where it is
4244 included. To include '^' itself use it as the last character of the
4245 option or the end of a range. Example:
4246 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4247 If the character is '@', all characters where isalpha() returns TRUE
4248 are included. Normally these are the characters a to z and A to Z,
4249 plus accented characters. To include '@' itself use "@-@". Examples:
4250 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004251 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 "a-z,A-Z,@-@" All letters plus the '@' character.
4253 A comma can be included by using it where a character number is
4254 expected. Example:
4255 "48-57,,,_" Digits, comma and underscore.
4256 A comma can be excluded by prepending a '^'. Example:
4257 " -~,^,,9" All characters from space to '~', excluding
4258 comma, plus <Tab>.
4259 See |option-backslash| about including spaces and backslashes.
4260
4261 *'isident'* *'isi'*
4262'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4263 "@,48-57,_,128-167,224-235"
4264 otherwise: "@,48-57,_,192-255")
4265 global
4266 {not in Vi}
4267 The characters given by this option are included in identifiers.
4268 Identifiers are used in recognizing environment variables and after a
4269 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004270 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 option.
4272 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004273 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4275
4276 *'iskeyword'* *'isk'*
4277'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4278 "@,48-57,_,128-167,224-235"
4279 otherwise: "@,48-57,_,192-255"
4280 Vi default: "@,48-57,_")
4281 local to buffer
4282 {not in Vi}
4283 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004284 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 'isfname' for a description of the format of this option. For C
4286 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4287 For a help file it is set to all non-blank printable characters except
4288 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4289 command).
4290 When the 'lisp' option is on the '-' character is always included.
4291 NOTE: This option is set to the Vi default value when 'compatible' is
4292 set and to the Vim default value when 'compatible' is reset.
4293
4294 *'isprint'* *'isp'*
4295'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4296 "@,~-255"; otherwise: "@,161-255")
4297 global
4298 {not in Vi}
4299 The characters given by this option are displayed directly on the
4300 screen. It is also used for "\p" in a |pattern|. The characters from
4301 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4302 even when they are not included in 'isprint' or excluded. See
4303 'isfname' for a description of the format of this option.
4304
4305 Non-printable characters are displayed with two characters:
4306 0 - 31 "^@" - "^_"
4307 32 - 126 always single characters
4308 127 "^?"
4309 128 - 159 "~@" - "~_"
4310 160 - 254 "| " - "|~"
4311 255 "~?"
4312 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4313 displayed as <xx>, with the hexadecimal value of the byte.
4314 When 'display' contains "uhex" all unprintable characters are
4315 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004316 The SpecialKey highlighting will be used for unprintable characters.
4317 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318
4319 Multi-byte characters 256 and above are always included, only the
4320 characters up to 255 are specified with this option. When a character
4321 is printable but it is not available in the current font, a
4322 replacement character will be shown.
4323 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4324 There is no option to specify these characters.
4325
4326 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4327'joinspaces' 'js' boolean (default on)
4328 global
4329 {not in Vi}
4330 Insert two spaces after a '.', '?' and '!' with a join command.
4331 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4332 Otherwise only one space is inserted.
4333 NOTE: This option is set when 'compatible' is set.
4334
4335 *'key'*
4336'key' string (default "")
4337 local to buffer
4338 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004339 {only available when compiled with the |+cryptv|
4340 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004342 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 Careful: Do not set the key value by hand, someone might see the typed
4344 key. Use the |:X| command. But you can make 'key' empty: >
4345 :set key=
4346< It is not possible to get the value of this option with ":set key" or
4347 "echo &key". This is to avoid showing it to someone who shouldn't
4348 know. It also means you cannot see it yourself once you have set it,
4349 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004350 You can use "&key" in an expression to detect whether encryption is
4351 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352
4353 *'keymap'* *'kmp'* *E544*
4354'keymap' 'kmp' string (default "")
4355 local to buffer
4356 {not in Vi}
4357 {only available when compiled with the |+keymap|
4358 feature}
4359 Name of a keyboard mapping. See |mbyte-keymap|.
4360 Setting this option to a valid keymap name has the side effect of
4361 setting 'iminsert' to one, so that the keymap becomes effective.
4362 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004363 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364
4365 *'keymodel'* *'km'*
4366'keymodel' 'km' string (default "")
4367 global
4368 {not in Vi}
4369 List of comma separated words, which enable special things that keys
4370 can do. These values can be used:
4371 startsel Using a shifted special key starts selection (either
4372 Select mode or Visual mode, depending on "key" being
4373 present in 'selectmode').
4374 stopsel Using a not-shifted special key stops selection.
4375 Special keys in this context are the cursor keys, <End>, <Home>,
4376 <PageUp> and <PageDown>.
4377 The 'keymodel' option is set by the |:behave| command.
4378
4379 *'keywordprg'* *'kp'*
4380'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4381 OS/2: "view /", VMS: "help")
4382 global or local to buffer |global-local|
4383 {not in Vi}
4384 Program to use for the |K| command. Environment variables are
4385 expanded |:set_env|. ":help" may be used to access the Vim internal
4386 help. (Note that previously setting the global option to the empty
4387 value did this, which is now deprecated.)
4388 When "man" is used, Vim will automatically translate a count for the
4389 "K" command to a section number. Also for "man -s", in which case the
4390 "-s" is removed when there is no count.
4391 See |option-backslash| about including spaces and backslashes.
4392 Example: >
4393 :set keywordprg=man\ -s
4394< This option cannot be set from a |modeline| or in the |sandbox|, for
4395 security reasons.
4396
4397 *'langmap'* *'lmap'* *E357* *E358*
4398'langmap' 'lmap' string (default "")
4399 global
4400 {not in Vi}
4401 {only available when compiled with the |+langmap|
4402 feature}
4403 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004404 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 inserted directly. When in command mode the 'langmap' option takes
4406 care of translating these special characters to the original meaning
4407 of the key. This means you don't have to change the keyboard mode to
4408 be able to execute Normal mode commands.
4409 This is the opposite of the 'keymap' option, where characters are
4410 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004412 Example (for Greek, in UTF-8): *greek* >
4413 :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 +00004414< Example (exchanges meaning of z and y for commands): >
4415 :set langmap=zy,yz,ZY,YZ
4416<
4417 The 'langmap' option is a list of parts, separated with commas. Each
4418 part can be in one of two forms:
4419 1. A list of pairs. Each pair is a "from" character immediately
4420 followed by the "to" character. Examples: "aA", "aAbBcC".
4421 2. A list of "from" characters, a semi-colon and a list of "to"
4422 characters. Example: "abc;ABC"
4423 Example: "aA,fgh;FGH,cCdDeE"
4424 Special characters need to be preceded with a backslash. These are
4425 ";", ',' and backslash itself.
4426
4427 This will allow you to activate vim actions without having to switch
4428 back and forth between the languages. Your language characters will
4429 be understood as normal vim English characters (according to the
4430 langmap mappings) in the following cases:
4431 o Normal/Visual mode (commands, buffer/register names, user mappings)
4432 o Insert/Replace Mode: Register names after CTRL-R
4433 o Insert/Replace Mode: Mappings
4434 Characters entered in Command-line mode will NOT be affected by
4435 this option. Note that this option can be changed at any time
4436 allowing to switch between mappings for different languages/encodings.
4437 Use a mapping to avoid having to type it each time!
4438
4439 *'langmenu'* *'lm'*
4440'langmenu' 'lm' string (default "")
4441 global
4442 {not in Vi}
4443 {only available when compiled with the |+menu| and
4444 |+multi_lang| features}
4445 Language to use for menu translation. Tells which file is loaded
4446 from the "lang" directory in 'runtimepath': >
4447 "lang/menu_" . &langmenu . ".vim"
4448< (without the spaces). For example, to always use the Dutch menus, no
4449 matter what $LANG is set to: >
4450 :set langmenu=nl_NL.ISO_8859-1
4451< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004452 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 If your $LANG is set to a non-English language but you do want to use
4454 the English menus: >
4455 :set langmenu=none
4456< This option must be set before loading menus, switching on filetype
4457 detection or syntax highlighting. Once the menus are defined setting
4458 this option has no effect. But you could do this: >
4459 :source $VIMRUNTIME/delmenu.vim
4460 :set langmenu=de_DE.ISO_8859-1
4461 :source $VIMRUNTIME/menu.vim
4462< Warning: This deletes all menus that you defined yourself!
4463
4464 *'laststatus'* *'ls'*
4465'laststatus' 'ls' number (default 1)
4466 global
4467 {not in Vi}
4468 The value of this option influences when the last window will have a
4469 status line:
4470 0: never
4471 1: only if there are at least two windows
4472 2: always
4473 The screen looks nicer with a status line if you have several
4474 windows, but it takes another screen line. |status-line|
4475
4476 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4477'lazyredraw' 'lz' boolean (default off)
4478 global
4479 {not in Vi}
4480 When this option is set, the screen will not be redrawn while
4481 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004482 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 update use |:redraw|.
4484
4485 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4486'linebreak' 'lbr' boolean (default off)
4487 local to window
4488 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004489 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 feature}
4491 If on Vim will wrap long lines at a character in 'breakat' rather
4492 than at the last character that fits on the screen. Unlike
4493 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4494 it only affects the way the file is displayed, not its contents. The
4495 value of 'showbreak' is used to put in front of wrapped lines.
4496 This option is not used when the 'wrap' option is off or 'list' is on.
4497 Note that <Tab> characters after an <EOL> are mostly not displayed
4498 with the right amount of white space.
4499
4500 *'lines'* *E593*
4501'lines' number (default 24 or terminal height)
4502 global
4503 Number of lines of the Vim window.
4504 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004505 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004506 When Vim is running in the GUI or in a resizable window, setting this
4507 option will cause the window size to be changed. When you only want
4508 to use the size for the GUI, put the command in your |gvimrc| file.
4509 Vim limits the number of lines to what fits on the screen. You can
4510 use this command to get the tallest window possible: >
4511 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004512< Minimum value is 2, maximum value is 1000.
4513 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 When you set this option and Vim is unable to change the physical
4515 number of lines of the display, the display may be messed up.
4516
4517 *'linespace'* *'lsp'*
4518'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4519 global
4520 {not in Vi}
4521 {only in the GUI}
4522 Number of pixel lines inserted between characters. Useful if the font
4523 uses the full character cell height, making lines touch each other.
4524 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004525 With some fonts there can be too much room between lines (to have
4526 space for ascents and descents). Then it makes sense to set
4527 'linespace' to a negative value. This may cause display problems
4528 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529
4530 *'lisp'* *'nolisp'*
4531'lisp' boolean (default off)
4532 local to buffer
4533 {not available when compiled without the |+lispindent|
4534 feature}
4535 Lisp mode: When <Enter> is typed in insert mode set the indent for
4536 the next line to Lisp standards (well, sort of). Also happens with
4537 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4538 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4539 better. Also see 'lispwords'.
4540 The '-' character is included in keyword characters. Redefines the
4541 "=" operator to use this same indentation algorithm rather than
4542 calling an external program if 'equalprg' is empty.
4543 This option is not used when 'paste' is set.
4544 {Vi: Does it a little bit differently}
4545
4546 *'lispwords'* *'lw'*
4547'lispwords' 'lw' string (default is very long)
4548 global
4549 {not in Vi}
4550 {not available when compiled without the |+lispindent|
4551 feature}
4552 Comma separated list of words that influence the Lisp indenting.
4553 |'lisp'|
4554
4555 *'list'* *'nolist'*
4556'list' boolean (default off)
4557 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004558 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4559 line. Useful to see the difference between tabs and spaces and for
4560 trailing blanks. Further changed by the 'listchars' option.
4561
4562 The cursor is displayed at the start of the space a Tab character
4563 occupies, not at the end as usual in Normal mode. To get this cursor
4564 position while displaying Tabs with spaces, use: >
4565 :set list lcs=tab\ \
4566<
4567 Note that list mode will also affect formatting (set with 'textwidth'
4568 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 changing the way tabs are displayed.
4570
4571 *'listchars'* *'lcs'*
4572'listchars' 'lcs' string (default "eol:$")
4573 global
4574 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004575 Strings to use in 'list' mode and for the |:list| command. It is a
4576 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 eol:c Character to show at the end of each line. When
4578 omitted, there is no extra character at the end of the
4579 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004580 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004582 fill the space that the tab normally occupies.
4583 "tab:>-" will show a tab that takes four spaces as
4584 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004585 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586 trailing spaces are blank.
4587 extends:c Character to show in the last column, when 'wrap' is
4588 off and the line continues beyond the right of the
4589 screen.
4590 precedes:c Character to show in the first column, when 'wrap'
4591 is off and there is text preceding the character
4592 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004593 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004594 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004595 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004596 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004598 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004600 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
4602 Examples: >
4603 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004604 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 :set lcs=extends:>,precedes:<
4606< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004607 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004608 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609
4610 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4611'loadplugins' 'lpl' boolean (default on)
4612 global
4613 {not in Vi}
4614 When on the plugin scripts are loaded when starting up |load-plugins|.
4615 This option can be reset in your |vimrc| file to disable the loading
4616 of plugins.
4617 Note that using the "-u NONE" and "--noplugin" command line arguments
4618 reset this option. |-u| |--noplugin|
4619
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004620 *'macatsui'* *'nomacatsui'*
4621'macatsui' boolean (default on)
4622 global
4623 {only available in Mac GUI version}
4624 This is a workaround for when drawing doesn't work properly. When set
4625 and compiled with multi-byte support ATSUI text drawing is used. When
4626 not set ATSUI text drawing is not used. Switch this option off when
4627 you experience drawing problems. In a future version the problems may
4628 be solved and this option becomes obsolete. Therefore use this method
4629 to unset it: >
4630 if exists('&macatsui')
4631 set nomacatsui
4632 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004633< Another option to check if you have drawing problems is
4634 'termencoding'.
4635
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 *'magic'* *'nomagic'*
4637'magic' boolean (default on)
4638 global
4639 Changes the special characters that can be used in search patterns.
4640 See |pattern|.
4641 NOTE: To avoid portability problems with using patterns, always keep
4642 this option at the default "on". Only switch it off when working with
4643 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004644 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
4646 *'makeef'* *'mef'*
4647'makeef' 'mef' string (default: "")
4648 global
4649 {not in Vi}
4650 {not available when compiled without the |+quickfix|
4651 feature}
4652 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4653 and the |:grep| command.
4654 When it is empty, an internally generated temp file will be used.
4655 When "##" is included, it is replaced by a number to make the name
4656 unique. This makes sure that the ":make" command doesn't overwrite an
4657 existing file.
4658 NOT used for the ":cf" command. See 'errorfile' for that.
4659 Environment variables are expanded |:set_env|.
4660 See |option-backslash| about including spaces and backslashes.
4661 This option cannot be set from a |modeline| or in the |sandbox|, for
4662 security reasons.
4663
4664 *'makeprg'* *'mp'*
4665'makeprg' 'mp' string (default "make", VMS: "MMS")
4666 global or local to buffer |global-local|
4667 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004668 Program to use for the ":make" command. See |:make_makeprg|.
4669 This option may contain '%' and '#' characters, which are expanded to
4670 the current and alternate file name. |:_%| |:_#|
4671 Environment variables are expanded |:set_env|. See |option-backslash|
4672 about including spaces and backslashes.
4673 Note that a '|' must be escaped twice: once for ":set" and once for
4674 the interpretation of a command. When you use a filter called
4675 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 :set makeprg=gmake\ \\\|\ myfilter
4677< The placeholder "$*" can be given (even multiple times) to specify
4678 where the arguments will be included, for example: >
4679 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4680< This option cannot be set from a |modeline| or in the |sandbox|, for
4681 security reasons.
4682
4683 *'matchpairs'* *'mps'*
4684'matchpairs' 'mps' string (default "(:),{:},[:]")
4685 local to buffer
4686 {not in Vi}
4687 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004688 other. Currently only single byte character pairs are allowed, and
4689 they must be different. The characters must be separated by a colon.
4690 The pairs must be separated by a comma. Example for including '<' and
4691 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 :set mps+=<:>
4693
4694< A more exotic example, to jump between the '=' and ';' in an
4695 assignment, useful for languages like C and Java: >
4696 :au FileType c,cpp,java set mps+==:;
4697
4698< For a more advanced way of using "%", see the matchit.vim plugin in
4699 the $VIMRUNTIME/macros directory. |add-local-help|
4700
4701 *'matchtime'* *'mat'*
4702'matchtime' 'mat' number (default 5)
4703 global
4704 {not in Vi}{in Nvi}
4705 Tenths of a second to show the matching paren, when 'showmatch' is
4706 set. Note that this is not in milliseconds, like other options that
4707 set a time. This is to be compatible with Nvi.
4708
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004709 *'maxcombine'* *'mco'*
4710'maxcombine' 'mco' number (default 2)
4711 global
4712 {not in Vi}
4713 {only available when compiled with the |+multi_byte|
4714 feature}
4715 The maximum number of combining characters supported for displaying.
4716 Only used when 'encoding' is "utf-8".
4717 The default is OK for most languages. Hebrew may require 4.
4718 Maximum value is 6.
4719 Even when this option is set to 2 you can still edit text with more
4720 combining characters, you just can't see them. Use |g8| or |ga|.
4721 See |mbyte-combining|.
4722
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 *'maxfuncdepth'* *'mfd'*
4724'maxfuncdepth' 'mfd' number (default 100)
4725 global
4726 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004727 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004728 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 Maximum depth of function calls for user functions. This normally
4730 catches endless recursion. When using a recursive function with
4731 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4732 more memory, there is the danger of failing when memory is exhausted.
4733 See also |:function|.
4734
4735 *'maxmapdepth'* *'mmd'* *E223*
4736'maxmapdepth' 'mmd' number (default 1000)
4737 global
4738 {not in Vi}
4739 Maximum number of times a mapping is done without resulting in a
4740 character to be used. This normally catches endless mappings, like
4741 ":map x y" with ":map y x". It still does not catch ":map g wg",
4742 because the 'w' is used before the next mapping is done. See also
4743 |key-mapping|.
4744
4745 *'maxmem'* *'mm'*
4746'maxmem' 'mm' number (default between 256 to 5120 (system
4747 dependent) or half the amount of memory
4748 available)
4749 global
4750 {not in Vi}
4751 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4752 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004753 other memory to be freed. The maximum usable value is about 2000000.
4754 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004756 *'maxmempattern'* *'mmp'*
4757'maxmempattern' 'mmp' number (default 1000)
4758 global
4759 {not in Vi}
4760 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004761 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004762 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004763 When Vim runs into the limit it gives an error message and mostly
4764 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004765 Running into the limit often means that the pattern is very
4766 inefficient or too complex. This may already happen with the pattern
4767 "\(.\)*" on a very long line. ".*" works much better.
4768 Vim may run out of memory before hitting the 'maxmempattern' limit.
4769
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 *'maxmemtot'* *'mmt'*
4771'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4772 dependent) or half the amount of memory
4773 available)
4774 global
4775 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004776 Maximum amount of memory in Kbyte to use for all buffers together.
4777 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4778 without a limit. On 64 bit machines higher values might work. But
4779 hey, do you really need more than 2 Gbyte for text editing?
4780 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781
4782 *'menuitems'* *'mis'*
4783'menuitems' 'mis' number (default 25)
4784 global
4785 {not in Vi}
4786 {not available when compiled without the |+menu|
4787 feature}
4788 Maximum number of items to use in a menu. Used for menus that are
4789 generated from a list of items, e.g., the Buffers menu. Changing this
4790 option has no direct effect, the menu must be refreshed first.
4791
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004792 *'mkspellmem'* *'msm'*
4793'mkspellmem' 'msm' string (default "460000,2000,500")
4794 global
4795 {not in Vi}
4796 {not available when compiled without the |+syntax|
4797 feature}
4798 Parameters for |:mkspell|. This tunes when to start compressing the
4799 word tree. Compression can be slow when there are many words, but
4800 it's needed to avoid running out of memory. The amount of memory used
4801 per word depends very much on how similar the words are, that's why
4802 this tuning is complicated.
4803
4804 There are three numbers, separated by commas:
4805 {start},{inc},{added}
4806
4807 For most languages the uncompressed word tree fits in memory. {start}
4808 gives the amount of memory in Kbyte that can be used before any
4809 compression is done. It should be a bit smaller than the amount of
4810 memory that is available to Vim.
4811
4812 When going over the {start} limit the {inc} number specifies the
4813 amount of memory in Kbyte that can be allocated before another
4814 compression is done. A low number means compression is done after
4815 less words are added, which is slow. A high number means more memory
4816 will be allocated.
4817
4818 After doing compression, {added} times 1024 words can be added before
4819 the {inc} limit is ignored and compression is done when any extra
4820 amount of memory is needed. A low number means there is a smaller
4821 chance of hitting the {inc} limit, less memory is used but it's
4822 slower.
4823
4824 The languages for which these numbers are important are Italian and
4825 Hungarian. The default works for when you have about 512 Mbyte. If
4826 you have 1 Gbyte you could use: >
4827 :set mkspellmem=900000,3000,800
4828< If you have less than 512 Mbyte |:mkspell| may fail for some
4829 languages, no matter what you set 'mkspellmem' to.
4830
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004832'modeline' 'ml' boolean (Vim default: on (off for root),
4833 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 local to buffer
4835 *'modelines'* *'mls'*
4836'modelines' 'mls' number (default 5)
4837 global
4838 {not in Vi}
4839 If 'modeline' is on 'modelines' gives the number of lines that is
4840 checked for set commands. If 'modeline' is off or 'modelines' is zero
4841 no lines are checked. See |modeline|.
4842 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4843 set and to the Vim default value when 'compatible' is reset.
4844
4845 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4846'modifiable' 'ma' boolean (default on)
4847 local to buffer
4848 {not in Vi} *E21*
4849 When off the buffer contents cannot be changed. The 'fileformat' and
4850 'fileencoding' options also can't be changed.
4851 Can be reset with the |-M| command line argument.
4852
4853 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4854'modified' 'mod' boolean (default off)
4855 local to buffer
4856 {not in Vi}
4857 When on, the buffer is considered to be modified. This option is set
4858 when:
4859 1. A change was made to the text since it was last written. Using the
4860 |undo| command to go back to the original text will reset the
4861 option. But undoing changes that were made before writing the
4862 buffer will set the option again, since the text is different from
4863 when it was written.
4864 2. 'fileformat' or 'fileencoding' is different from its original
4865 value. The original value is set when the buffer is read or
4866 written. A ":set nomodified" command also resets the original
4867 values to the current values and the 'modified' option will be
4868 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004869 This option is not set when a change is made to the buffer as the
4870 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4871 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4872 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4874 will be ignored.
4875
4876 *'more'* *'nomore'*
4877'more' boolean (Vim default: on, Vi default: off)
4878 global
4879 {not in Vi}
4880 When on, listings pause when the whole screen is filled. You will get
4881 the |more-prompt|. When this option is off there are no pauses, the
4882 listing continues until finished.
4883 NOTE: This option is set to the Vi default value when 'compatible' is
4884 set and to the Vim default value when 'compatible' is reset.
4885
4886 *'mouse'* *E538*
4887'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4888 global
4889 {not in Vi}
4890 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004891 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4892 sysmouse and Linux console with gpm). For using the mouse in the
4893 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 The mouse can be enabled for different modes:
4895 n Normal mode
4896 v Visual mode
4897 i Insert mode
4898 c Command-line mode
4899 h all previous modes when editing a help file
4900 a all previous modes
4901 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 Normally you would enable the mouse in all four modes with: >
4903 :set mouse=a
4904< When the mouse is not enabled, the GUI will still use the mouse for
4905 modeless selection. This doesn't move the text cursor.
4906
4907 See |mouse-using|. Also see |'clipboard'|.
4908
4909 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004910 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 the mouse buttons can still be used by keeping the shift key pressed.
4912 Also see the 'clipboard' option.
4913
4914 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4915'mousefocus' 'mousef' boolean (default off)
4916 global
4917 {not in Vi}
4918 {only works in the GUI}
4919 The window that the mouse pointer is on is automatically activated.
4920 When changing the window layout or window focus in another way, the
4921 mouse pointer is moved to the window with keyboard focus. Off is the
4922 default because it makes using the pull down menus a little goofy, as
4923 a pointer transit may activate a window unintentionally.
4924
4925 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4926'mousehide' 'mh' boolean (default on)
4927 global
4928 {not in Vi}
4929 {only works in the GUI}
4930 When on, the mouse pointer is hidden when characters are typed.
4931 The mouse pointer is restored when the mouse is moved.
4932
4933 *'mousemodel'* *'mousem'*
4934'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4935 global
4936 {not in Vi}
4937 Sets the model to use for the mouse. The name mostly specifies what
4938 the right mouse button is used for:
4939 extend Right mouse button extends a selection. This works
4940 like in an xterm.
4941 popup Right mouse button pops up a menu. The shifted left
4942 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004943 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 popup_setpos Like "popup", but the cursor will be moved to the
4945 position where the mouse was clicked, and thus the
4946 selected operation will act upon the clicked object.
4947 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004948 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 course, that right clicking outside a selection will
4950 end Visual mode.
4951 Overview of what button does what for each model:
4952 mouse extend popup(_setpos) ~
4953 left click place cursor place cursor
4954 left drag start selection start selection
4955 shift-left search word extend selection
4956 right click extend selection popup menu (place cursor)
4957 right drag extend selection -
4958 middle click paste paste
4959
4960 In the "popup" model the right mouse button produces a pop-up menu.
4961 You need to define this first, see |popup-menu|.
4962
4963 Note that you can further refine the meaning of buttons with mappings.
4964 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4965 selection (because that's handled in the GUI code directly).
4966
4967 The 'mousemodel' option is set by the |:behave| command.
4968
4969 *'mouseshape'* *'mouses'* *E547*
4970'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004971 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 global
4973 {not in Vi}
4974 {only available when compiled with the |+mouseshape|
4975 feature}
4976 This option tells Vim what the mouse pointer should look like in
4977 different modes. The option is a comma separated list of parts, much
4978 like used for 'guicursor'. Each part consist of a mode/location-list
4979 and an argument-list:
4980 mode-list:shape,mode-list:shape,..
4981 The mode-list is a dash separated list of these modes/locations:
4982 In a normal window: ~
4983 n Normal mode
4984 v Visual mode
4985 ve Visual mode with 'selection' "exclusive" (same as 'v',
4986 if not specified)
4987 o Operator-pending mode
4988 i Insert mode
4989 r Replace mode
4990
4991 Others: ~
4992 c appending to the command-line
4993 ci inserting in the command-line
4994 cr replacing in the command-line
4995 m at the 'Hit ENTER' or 'More' prompts
4996 ml idem, but cursor in the last line
4997 e any mode, pointer below last window
4998 s any mode, pointer on a status line
4999 sd any mode, while dragging a status line
5000 vs any mode, pointer on a vertical separator line
5001 vd any mode, while dragging a vertical separator line
5002 a everywhere
5003
5004 The shape is one of the following:
5005 avail name looks like ~
5006 w x arrow Normal mouse pointer
5007 w x blank no pointer at all (use with care!)
5008 w x beam I-beam
5009 w x updown up-down sizing arrows
5010 w x leftright left-right sizing arrows
5011 w x busy The system's usual busy pointer
5012 w x no The system's usual 'no input' pointer
5013 x udsizing indicates up-down resizing
5014 x lrsizing indicates left-right resizing
5015 x crosshair like a big thin +
5016 x hand1 black hand
5017 x hand2 white hand
5018 x pencil what you write with
5019 x question big ?
5020 x rightup-arrow arrow pointing right-up
5021 w x up-arrow arrow pointing up
5022 x <number> any X11 pointer number (see X11/cursorfont.h)
5023
5024 The "avail" column contains a 'w' if the shape is available for Win32,
5025 x for X11.
5026 Any modes not specified or shapes not available use the normal mouse
5027 pointer.
5028
5029 Example: >
5030 :set mouseshape=s:udsizing,m:no
5031< will make the mouse turn to a sizing arrow over the status lines and
5032 indicate no input when the hit-enter prompt is displayed (since
5033 clicking the mouse has no effect in this state.)
5034
5035 *'mousetime'* *'mouset'*
5036'mousetime' 'mouset' number (default 500)
5037 global
5038 {not in Vi}
5039 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5040 time in msec between two mouse clicks for the second click to be
5041 recognized as a multi click.
5042
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005043 *'mzquantum'* *'mzq'*
5044'mzquantum' 'mzq' number (default 100)
5045 global
5046 {not in Vi}
5047 {not available when compiled without the |+mzscheme|
5048 feature}
5049 The number of milliseconds between polls for MzScheme threads.
5050 Negative or zero value means no thread scheduling.
5051
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 *'nrformats'* *'nf'*
5053'nrformats' 'nf' string (default "octal,hex")
5054 local to buffer
5055 {not in Vi}
5056 This defines what bases Vim will consider for numbers when using the
5057 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5058 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005059 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005061 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005062 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005064 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 considered to be hexadecimal. Example: Using CTRL-X on
5066 "0x100" results in "0x0ff".
5067 Numbers which simply begin with a digit in the range 1-9 are always
5068 considered decimal. This also happens for numbers that are not
5069 recognized as octal or hex.
5070
5071 *'number'* *'nu'* *'nonumber'* *'nonu'*
5072'number' 'nu' boolean (default off)
5073 local to window
5074 Print the line number in front of each line. When the 'n' option is
5075 excluded from 'cpoptions' a wrapped line will not use the column of
5076 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005077 The 'numberwidth' option can be used to set the room used for the line
5078 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 When a long, wrapped line doesn't start with the first character, '-'
5080 characters are put before the number.
5081 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005082 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005084 *'numberwidth'* *'nuw'*
5085'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5086 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005087 {not in Vi}
5088 {only available when compiled with the |+linebreak|
5089 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005090 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005091 when the 'number' or 'relativenumber' option is set or printing lines
5092 with a line number. Since one space is always between the number and
5093 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005094 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005095 fit the highest line number in the buffer respectively the number of
5096 rows in the window, depending on whether 'number' or 'relativenumber'
5097 is set. Thus with the Vim default of 4 there is room for a line number
5098 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005099 The minimum value is 1, the maximum value is 10.
5100 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5101
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005102 *'omnifunc'* *'ofu'*
5103'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005104 local to buffer
5105 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005106 {not available when compiled without the |+eval|
5107 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005108 This option specifies a function to be used for Insert mode omni
5109 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005110 See |complete-functions| for an explanation of how the function is
5111 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005112 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005113 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005114
5115
Bram Moolenaar02467872007-05-06 13:22:01 +00005116 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005117'opendevice' 'odev' boolean (default off)
5118 global
5119 {not in Vi}
5120 {only for MS-DOS, MS-Windows and OS/2}
5121 Enable reading and writing from devices. This may get Vim stuck on a
5122 device that can be opened but doesn't actually do the I/O. Therefore
5123 it is off by default.
5124 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5125 result in editing a device.
5126
5127
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005128 *'operatorfunc'* *'opfunc'*
5129'operatorfunc' 'opfunc' string (default: empty)
5130 global
5131 {not in Vi}
5132 This option specifies a function to be called by the |g@| operator.
5133 See |:map-operator| for more info and an example.
5134
5135 This option cannot be set from a |modeline| or in the |sandbox|, for
5136 security reasons.
5137
5138
Bram Moolenaar251e1912011-06-19 05:09:16 +02005139 *'osfiletype'* *'oft'*
5140'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 local to buffer
5142 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005143 This option was supported on RISC OS, which has been removed.
5144
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145
5146 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005147'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148 global
5149 Specifies the nroff macros that separate paragraphs. These are pairs
5150 of two letters (see |object-motions|).
5151
5152 *'paste'* *'nopaste'*
5153'paste' boolean (default off)
5154 global
5155 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005156 Put Vim in Paste mode. This is useful if you want to cut or copy
5157 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 unexpected effects.
5159 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005160 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 knows about pasting and will mostly do the right thing without 'paste'
5162 being set. The same is true for a terminal where Vim handles the
5163 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005164 This option is reset when starting the GUI. Thus if you set it in
5165 your .vimrc it will work in a terminal, but not in the GUI. Setting
5166 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5167 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 When the 'paste' option is switched on (also when it was already on):
5169 - mapping in Insert mode and Command-line mode is disabled
5170 - abbreviations are disabled
5171 - 'textwidth' is set to 0
5172 - 'wrapmargin' is set to 0
5173 - 'autoindent' is reset
5174 - 'smartindent' is reset
5175 - 'softtabstop' is set to 0
5176 - 'revins' is reset
5177 - 'ruler' is reset
5178 - 'showmatch' is reset
5179 - 'formatoptions' is used like it is empty
5180 These options keep their value, but their effect is disabled:
5181 - 'lisp'
5182 - 'indentexpr'
5183 - 'cindent'
5184 NOTE: When you start editing another file while the 'paste' option is
5185 on, settings from the modelines or autocommands may change the
5186 settings again, causing trouble when pasting text. You might want to
5187 set the 'paste' option again.
5188 When the 'paste' option is reset the mentioned options are restored to
5189 the value before the moment 'paste' was switched from off to on.
5190 Resetting 'paste' before ever setting it does not have any effect.
5191 Since mapping doesn't work while 'paste' is active, you need to use
5192 the 'pastetoggle' option to toggle the 'paste' option with some key.
5193
5194 *'pastetoggle'* *'pt'*
5195'pastetoggle' 'pt' string (default "")
5196 global
5197 {not in Vi}
5198 When non-empty, specifies the key sequence that toggles the 'paste'
5199 option. This is like specifying a mapping: >
5200 :map {keys} :set invpaste<CR>
5201< Where {keys} is the value of 'pastetoggle'.
5202 The difference is that it will work even when 'paste' is set.
5203 'pastetoggle' works in Insert mode and Normal mode, but not in
5204 Command-line mode.
5205 Mappings are checked first, thus overrule 'pastetoggle'. However,
5206 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5207 this: >
5208 :map <F10> :set paste<CR>
5209 :map <F11> :set nopaste<CR>
5210 :imap <F10> <C-O>:set paste<CR>
5211 :imap <F11> <nop>
5212 :set pastetoggle=<F11>
5213< This will make <F10> start paste mode and <F11> stop paste mode.
5214 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5215 mode everything is inserted literally, except the 'pastetoggle' key
5216 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005217 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218
5219 *'pex'* *'patchexpr'*
5220'patchexpr' 'pex' string (default "")
5221 global
5222 {not in Vi}
5223 {not available when compiled without the |+diff|
5224 feature}
5225 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005226 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227
5228 *'patchmode'* *'pm'* *E206*
5229'patchmode' 'pm' string (default "")
5230 global
5231 {not in Vi}
5232 When non-empty the oldest version of a file is kept. This can be used
5233 to keep the original version of a file if you are changing files in a
5234 source distribution. Only the first time that a file is written a
5235 copy of the original file will be kept. The name of the copy is the
5236 name of the original file with the string in the 'patchmode' option
5237 appended. This option should start with a dot. Use a string like
5238 ".org". 'backupdir' must not be empty for this to work (Detail: The
5239 backup file is renamed to the patchmode file after the new file has
5240 been successfully written, that's why it must be possible to write a
5241 backup file). If there was no file to be backed up, an empty file is
5242 created.
5243 When the 'backupskip' pattern matches, a patchmode file is not made.
5244 Using 'patchmode' for compressed files appends the extension at the
5245 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5246 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005247 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005249 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250'path' 'pa' string (default on Unix: ".,/usr/include,,"
5251 on OS/2: ".,/emx/include,,"
5252 other systems: ".,,")
5253 global or local to buffer |global-local|
5254 {not in Vi}
5255 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005256 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5257 provided that the file being searched for has a relative path (not
5258 starting with "/", "./" or "../"). The directories in the 'path'
5259 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 - Use commas to separate directory names: >
5261 :set path=.,/usr/local/include,/usr/include
5262< - Spaces can also be used to separate directory names (for backwards
5263 compatibility with version 3.0). To have a space in a directory
5264 name, precede it with an extra backslash, and escape the space: >
5265 :set path=.,/dir/with\\\ space
5266< - To include a comma in a directory name precede it with an extra
5267 backslash: >
5268 :set path=.,/dir/with\\,comma
5269< - To search relative to the directory of the current file, use: >
5270 :set path=.
5271< - To search in the current directory use an empty string between two
5272 commas: >
5273 :set path=,,
5274< - A directory name may end in a ':' or '/'.
5275 - Environment variables are expanded |:set_env|.
5276 - When using |netrw.vim| URLs can be used. For example, adding
5277 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005278 - Search upwards and downwards in a directory tree using "*", "**" and
5279 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 {not available when compiled without the |+path_extra| feature}
5281 - Careful with '\' characters, type two to get one in the option: >
5282 :set path=.,c:\\include
5283< Or just use '/' instead: >
5284 :set path=.,c:/include
5285< Don't forget "." or files won't even be found in the same directory as
5286 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005287 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 it is something like 256 or 1024 characters.
5289 You can check if all the include files are found, using the value of
5290 'path', see |:checkpath|.
5291 The use of |:set+=| and |:set-=| is preferred when adding or removing
5292 directories from the list. This avoids problems when a future version
5293 uses another default. To remove the current directory use: >
5294 :set path-=
5295< To add the current directory use: >
5296 :set path+=
5297< To use an environment variable, you probably need to replace the
5298 separator. Here is an example to append $INCL, in which directory
5299 names are separated with a semi-colon: >
5300 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5301< Replace the ';' with a ':' or whatever separator is used. Note that
5302 this doesn't work when $INCL contains a comma or white space.
5303
5304 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5305'preserveindent' 'pi' boolean (default off)
5306 local to buffer
5307 {not in Vi}
5308 When changing the indent of the current line, preserve as much of the
5309 indent structure as possible. Normally the indent is replaced by a
5310 series of tabs followed by spaces as required (unless |'expandtab'| is
5311 enabled, in which case only spaces are used). Enabling this option
5312 means the indent will preserve as many existing characters as possible
5313 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005314 'expandtab' does not apply to the preserved white space, a Tab remains
5315 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 NOTE: When using ">>" multiple times the resulting indent is a mix of
5317 tabs and spaces. You might not like this.
5318 NOTE: 'preserveindent' is reset when 'compatible' is set.
5319 Also see 'copyindent'.
5320 Use |:retab| to clean up white space.
5321
5322 *'previewheight'* *'pvh'*
5323'previewheight' 'pvh' number (default 12)
5324 global
5325 {not in Vi}
5326 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005327 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 Default height for a preview window. Used for |:ptag| and associated
5329 commands. Used for |CTRL-W_}| when no count is given.
5330
5331 *'previewwindow'* *'nopreviewwindow'*
5332 *'pvw'* *'nopvw'* *E590*
5333'previewwindow' 'pvw' boolean (default off)
5334 local to window
5335 {not in Vi}
5336 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005337 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005338 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 set. It's normally not set directly, but by using one of the commands
5340 |:ptag|, |:pedit|, etc.
5341
5342 *'printdevice'* *'pdev'*
5343'printdevice' 'pdev' string (default empty)
5344 global
5345 {not in Vi}
5346 {only available when compiled with the |+printer|
5347 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005348 The name of the printer to be used for |:hardcopy|.
5349 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005350 This option cannot be set from a |modeline| or in the |sandbox|, for
5351 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352
Bram Moolenaar8299df92004-07-10 09:47:34 +00005353 *'printencoding'* *'penc'*
5354'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 global
5356 {not in Vi}
5357 {only available when compiled with the |+printer|
5358 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005359 Sets the character encoding used when printing.
5360 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361
5362 *'printexpr'* *'pexpr'*
5363'printexpr' 'pexpr' String (default: see below)
5364 global
5365 {not in Vi}
5366 {only available when compiled with the |+printer|
5367 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005368 Expression used to print the PostScript produced with |:hardcopy|.
5369 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370
Bram Moolenaar8299df92004-07-10 09:47:34 +00005371 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372'printfont' 'pfn' string (default "courier")
5373 global
5374 {not in Vi}
5375 {only available when compiled with the |+printer|
5376 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005377 The name of the font that will be used for |:hardcopy|.
5378 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379
5380 *'printheader'* *'pheader'*
5381'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5382 global
5383 {not in Vi}
5384 {only available when compiled with the |+printer|
5385 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005386 The format of the header produced in |:hardcopy| output.
5387 See |pheader-option|.
5388
5389 *'printmbcharset'* *'pmbcs'*
5390'printmbcharset' 'pmbcs' string (default "")
5391 global
5392 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005393 {only available when compiled with the |+printer|,
5394 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005395 The CJK character set to be used for CJK output from |:hardcopy|.
5396 See |pmbcs-option|.
5397
5398 *'printmbfont'* *'pmbfn'*
5399'printmbfont' 'pmbfn' string (default "")
5400 global
5401 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005402 {only available when compiled with the |+printer|,
5403 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005404 List of font names to be used for CJK output from |:hardcopy|.
5405 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406
5407 *'printoptions'* *'popt'*
5408'printoptions' 'popt' string (default "")
5409 global
5410 {not in Vi}
5411 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005412 List of items that control the format of the output of |:hardcopy|.
5413 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005415 *'prompt'* *'noprompt'*
5416'prompt' boolean (default on)
5417 global
5418 When on a ":" prompt is used in Ex mode.
5419
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005420 *'pumheight'* *'ph'*
5421'pumheight' 'ph' number (default 0)
5422 global
5423 {not available when compiled without the
5424 |+insert_expand| feature}
5425 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005426 Determines the maximum number of items to show in the popup menu for
5427 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005428 |ins-completion-menu|.
5429
5430
Bram Moolenaar677ee682005-01-27 14:41:15 +00005431 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005432'quoteescape' 'qe' string (default "\")
5433 local to buffer
5434 {not in Vi}
5435 The characters that are used to escape quotes in a string. Used for
5436 objects like a', a" and a` |a'|.
5437 When one of the characters in this option is found inside a string,
5438 the following character will be skipped. The default value makes the
5439 text "foo\"bar\\" considered to be one string.
5440
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5442'readonly' 'ro' boolean (default off)
5443 local to buffer
5444 If on, writes fail unless you use a '!'. Protects you from
5445 accidentally overwriting a file. Default on when Vim is started
5446 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005447 When using ":w!" the 'readonly' option is reset for the current
5448 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005450 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005451
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005452 *'redrawtime'* *'rdt'*
5453'redrawtime' 'rdt' number (default 2000)
5454 global
5455 {not in Vi}
5456 {only available when compiled with the |+reltime|
5457 feature}
5458 The time in milliseconds for redrawing the display. This applies to
5459 searching for patterns for 'hlsearch' and |:match| highlighting.
5460 When redrawing takes more than this many milliseconds no further
5461 matches will be highlighted. This is used to avoid that Vim hangs
5462 when using a very complicated pattern.
5463
Bram Moolenaar64486672010-05-16 15:46:46 +02005464 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5465'relativenumber' 'rnu' boolean (default off)
5466 local to window
5467 {not in Vi}
5468 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005469 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005470 precede some vertical motion commands (e.g. j k + -) with, without
5471 having to calculate it yourself. Especially useful in combination with
5472 other commands (e.g. y d c < > gq gw =).
5473 When the 'n' option is excluded from 'cpoptions' a wrapped
5474 line will not use the column of line numbers (this is the default when
5475 'compatible' isn't set).
5476 The 'numberwidth' option can be used to set the room used for the line
5477 number.
5478 When a long, wrapped line doesn't start with the first character, '-'
5479 characters are put before the number.
5480 See |hl-LineNr| for the highlighting used for the number.
5481 When setting this option, 'number' is reset.
5482
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 *'remap'* *'noremap'*
5484'remap' boolean (default on)
5485 global
5486 Allows for mappings to work recursively. If you do not want this for
5487 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005488 NOTE: To avoid portability problems with Vim scripts, always keep
5489 this option at the default "on". Only switch it off when working with
5490 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491
5492 *'report'*
5493'report' number (default 2)
5494 global
5495 Threshold for reporting number of lines changed. When the number of
5496 changed lines is more than 'report' a message will be given for most
5497 ":" commands. If you want it always, set 'report' to 0.
5498 For the ":substitute" command the number of substitutions is used
5499 instead of the number of lines.
5500
5501 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5502'restorescreen' 'rs' boolean (default on)
5503 global
5504 {not in Vi} {only in Windows 95/NT console version}
5505 When set, the screen contents is restored when exiting Vim. This also
5506 happens when executing external commands.
5507
5508 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5509 options in your .vimrc. To disable restoring:
5510 set t_ti= t_te=
5511 To enable restoring (for an xterm):
5512 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5513 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5514
5515 *'revins'* *'ri'* *'norevins'* *'nori'*
5516'revins' 'ri' boolean (default off)
5517 global
5518 {not in Vi}
5519 {only available when compiled with the |+rightleft|
5520 feature}
5521 Inserting characters in Insert mode will work backwards. See "typing
5522 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5523 command in Insert mode, when 'allowrevins' is set.
5524 NOTE: This option is reset when 'compatible' or 'paste' is set.
5525
5526 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5527'rightleft' 'rl' boolean (default off)
5528 local to window
5529 {not in Vi}
5530 {only available when compiled with the |+rightleft|
5531 feature}
5532 When on, display orientation becomes right-to-left, i.e., characters
5533 that are stored in the file appear from the right to the left.
5534 Using this option, it is possible to edit files for languages that
5535 are written from the right to the left such as Hebrew and Arabic.
5536 This option is per window, so it is possible to edit mixed files
5537 simultaneously, or to view the same file in both ways (this is
5538 useful whenever you have a mixed text file with both right-to-left
5539 and left-to-right strings so that both sets are displayed properly
5540 in different windows). Also see |rileft.txt|.
5541
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005542 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543'rightleftcmd' 'rlc' string (default "search")
5544 local to window
5545 {not in Vi}
5546 {only available when compiled with the |+rightleft|
5547 feature}
5548 Each word in this option enables the command line editing to work in
5549 right-to-left mode for a group of commands:
5550
5551 search "/" and "?" commands
5552
5553 This is useful for languages such as Hebrew, Arabic and Farsi.
5554 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5555
5556 *'ruler'* *'ru'* *'noruler'* *'noru'*
5557'ruler' 'ru' boolean (default off)
5558 global
5559 {not in Vi}
5560 {not available when compiled without the
5561 |+cmdline_info| feature}
5562 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005563 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 text in the file is shown on the far right:
5565 Top first line is visible
5566 Bot last line is visible
5567 All first and last line are visible
5568 45% relative position in the file
5569 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005570 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005572 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 this option takes precedence over 'ruler' and 'rulerformat'
5574 If the number of characters displayed is different from the number of
5575 bytes in the text (e.g., for a TAB or a multi-byte character), both
5576 the text column (byte number) and the screen column are shown,
5577 separated with a dash.
5578 For an empty line "0-1" is shown.
5579 For an empty buffer the line number will also be zero: "0,0-1".
5580 This option is reset when the 'paste' option is set.
5581 If you don't want to see the ruler all the time but want to know where
5582 you are, use "g CTRL-G" |g_CTRL-G|.
5583 NOTE: This option is reset when 'compatible' is set.
5584
5585 *'rulerformat'* *'ruf'*
5586'rulerformat' 'ruf' string (default empty)
5587 global
5588 {not in Vi}
5589 {not available when compiled without the |+statusline|
5590 feature}
5591 When this option is not empty, it determines the content of the ruler
5592 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005593 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 The default ruler width is 17 characters. To make the ruler 15
5595 characters wide, put "%15(" at the start and "%)" at the end.
5596 Example: >
5597 :set rulerformat=%15(%c%V\ %p%%%)
5598<
5599 *'runtimepath'* *'rtp'* *vimfiles*
5600'runtimepath' 'rtp' string (default:
5601 Unix: "$HOME/.vim,
5602 $VIM/vimfiles,
5603 $VIMRUNTIME,
5604 $VIM/vimfiles/after,
5605 $HOME/.vim/after"
5606 Amiga: "home:vimfiles,
5607 $VIM/vimfiles,
5608 $VIMRUNTIME,
5609 $VIM/vimfiles/after,
5610 home:vimfiles/after"
5611 PC, OS/2: "$HOME/vimfiles,
5612 $VIM/vimfiles,
5613 $VIMRUNTIME,
5614 $VIM/vimfiles/after,
5615 $HOME/vimfiles/after"
5616 Macintosh: "$VIM:vimfiles,
5617 $VIMRUNTIME,
5618 $VIM:vimfiles:after"
5619 RISC-OS: "Choices:vimfiles,
5620 $VIMRUNTIME,
5621 Choices:vimfiles/after"
5622 VMS: "sys$login:vimfiles,
5623 $VIM/vimfiles,
5624 $VIMRUNTIME,
5625 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005626 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 global
5628 {not in Vi}
5629 This is a list of directories which will be searched for runtime
5630 files:
5631 filetype.vim filetypes by file name |new-filetype|
5632 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005633 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 colors/ color scheme files |:colorscheme|
5635 compiler/ compiler files |:compiler|
5636 doc/ documentation |write-local-help|
5637 ftplugin/ filetype plugins |write-filetype-plugin|
5638 indent/ indent scripts |indent-expression|
5639 keymap/ key mapping files |mbyte-keymap|
5640 lang/ menu translations |:menutrans|
5641 menu.vim GUI menus |menu.vim|
5642 plugin/ plugin scripts |write-plugin|
5643 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005644 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 syntax/ syntax files |mysyntaxfile|
5646 tutor/ files for vimtutor |tutor|
5647
5648 And any other file searched for with the |:runtime| command.
5649
5650 The defaults for most systems are setup to search five locations:
5651 1. In your home directory, for your personal preferences.
5652 2. In a system-wide Vim directory, for preferences from the system
5653 administrator.
5654 3. In $VIMRUNTIME, for files distributed with Vim.
5655 *after-directory*
5656 4. In the "after" directory in the system-wide Vim directory. This is
5657 for the system administrator to overrule or add to the distributed
5658 defaults (rarely needed)
5659 5. In the "after" directory in your home directory. This is for
5660 personal preferences to overrule or add to the distributed defaults
5661 or system-wide settings (rarely needed).
5662
5663 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5664 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005665 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 wildcards.
5667 See |:runtime|.
5668 Example: >
5669 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5670< This will use the directory "~/vimruntime" first (containing your
5671 personal Vim runtime files), then "/mygroup/vim" (shared between a
5672 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5673 files).
5674 You probably should always include $VIMRUNTIME somewhere, to use the
5675 distributed runtime files. You can put a directory before $VIMRUNTIME
5676 to find files which replace a distributed runtime files. You can put
5677 a directory after $VIMRUNTIME to find files which add to distributed
5678 runtime files.
5679 This option cannot be set from a |modeline| or in the |sandbox|, for
5680 security reasons.
5681
5682 *'scroll'* *'scr'*
5683'scroll' 'scr' number (default: half the window height)
5684 local to window
5685 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5686 set to half the number of lines in the window when the window size
5687 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005688 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5690 the number of screen lines instead of file lines, makes a difference
5691 when lines wrap}
5692
5693 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5694'scrollbind' 'scb' boolean (default off)
5695 local to window
5696 {not in Vi}
5697 {not available when compiled without the |+scrollbind|
5698 feature}
5699 See also |scroll-binding|. When this option is set, the current
5700 window scrolls as other scrollbind windows (windows that also have
5701 this option set) scroll. This option is useful for viewing the
5702 differences between two versions of a file, see 'diff'.
5703 See |'scrollopt'| for options that determine how this option should be
5704 interpreted.
5705 This option is mostly reset when splitting a window to edit another
5706 file. This means that ":split | edit file" results in two windows
5707 with scroll-binding, but ":split file" does not.
5708
5709 *'scrolljump'* *'sj'*
5710'scrolljump' 'sj' number (default 1)
5711 global
5712 {not in Vi}
5713 Minimal number of lines to scroll when the cursor gets off the
5714 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5715 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005716 When set to a negative number from -1 to -100 this is used as the
5717 percentage of the window height. Thus -50 scrolls half the window
5718 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 NOTE: This option is set to 1 when 'compatible' is set.
5720
5721 *'scrolloff'* *'so'*
5722'scrolloff' 'so' number (default 0)
5723 global
5724 {not in Vi}
5725 Minimal number of screen lines to keep above and below the cursor.
5726 This will make some context visible around where you are working. If
5727 you set it to a very large value (999) the cursor line will always be
5728 in the middle of the window (except at the start or end of the file or
5729 when long lines wrap).
5730 For scrolling horizontally see 'sidescrolloff'.
5731 NOTE: This option is set to 0 when 'compatible' is set.
5732
5733 *'scrollopt'* *'sbo'*
5734'scrollopt' 'sbo' string (default "ver,jump")
5735 global
5736 {not available when compiled without the |+scrollbind|
5737 feature}
5738 {not in Vi}
5739 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005740 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5741 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742 The following words are available:
5743 ver Bind vertical scrolling for 'scrollbind' windows
5744 hor Bind horizontal scrolling for 'scrollbind' windows
5745 jump Applies to the offset between two windows for vertical
5746 scrolling. This offset is the difference in the first
5747 displayed line of the bound windows. When moving
5748 around in a window, another 'scrollbind' window may
5749 reach a position before the start or after the end of
5750 the buffer. The offset is not changed though, when
5751 moving back the 'scrollbind' window will try to scroll
5752 to the desired position when possible.
5753 When now making that window the current one, two
5754 things can be done with the relative offset:
5755 1. When "jump" is not included, the relative offset is
5756 adjusted for the scroll position in the new current
5757 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005758 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 2. When "jump" is included, the other windows are
5760 scrolled to keep the same relative offset. When
5761 going back to the other window, it still uses the
5762 same relative offset.
5763 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005764 When 'diff' mode is active there always is vertical scroll binding,
5765 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
5767 *'sections'* *'sect'*
5768'sections' 'sect' string (default "SHNHH HUnhsh")
5769 global
5770 Specifies the nroff macros that separate sections. These are pairs of
5771 two letters (See |object-motions|). The default makes a section start
5772 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5773
5774 *'secure'* *'nosecure'* *E523*
5775'secure' boolean (default off)
5776 global
5777 {not in Vi}
5778 When on, ":autocmd", shell and write commands are not allowed in
5779 ".vimrc" and ".exrc" in the current directory and map commands are
5780 displayed. Switch it off only if you know that you will not run into
5781 problems, or when the 'exrc' option is off. On Unix this option is
5782 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005783 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 'secure' at the end of your ~/.vimrc then.
5785 This option cannot be set from a |modeline| or in the |sandbox|, for
5786 security reasons.
5787
5788 *'selection'* *'sel'*
5789'selection' 'sel' string (default "inclusive")
5790 global
5791 {not in Vi}
5792 This option defines the behavior of the selection. It is only used
5793 in Visual and Select mode.
5794 Possible values:
5795 value past line inclusive ~
5796 old no yes
5797 inclusive yes yes
5798 exclusive yes no
5799 "past line" means that the cursor is allowed to be positioned one
5800 character past the line.
5801 "inclusive" means that the last character of the selection is included
5802 in an operation. For example, when "x" is used to delete the
5803 selection.
5804 Note that when "exclusive" is used and selecting from the end
5805 backwards, you cannot include the last character of a line, when
5806 starting in Normal mode and 'virtualedit' empty.
5807
5808 The 'selection' option is set by the |:behave| command.
5809
5810 *'selectmode'* *'slm'*
5811'selectmode' 'slm' string (default "")
5812 global
5813 {not in Vi}
5814 This is a comma separated list of words, which specifies when to start
5815 Select mode instead of Visual mode, when a selection is started.
5816 Possible values:
5817 mouse when using the mouse
5818 key when using shifted special keys
5819 cmd when using "v", "V" or CTRL-V
5820 See |Select-mode|.
5821 The 'selectmode' option is set by the |:behave| command.
5822
5823 *'sessionoptions'* *'ssop'*
5824'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005825 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 global
5827 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005828 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 feature}
5830 Changes the effect of the |:mksession| command. It is a comma
5831 separated list of words. Each word enables saving and restoring
5832 something:
5833 word save and restore ~
5834 blank empty windows
5835 buffers hidden and unloaded buffers, not just those in windows
5836 curdir the current directory
5837 folds manually created folds, opened/closed folds and local
5838 fold options
5839 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005840 and contain at least one lowercase letter. Only
5841 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 help the help window
5843 localoptions options and mappings local to a window or buffer (not
5844 global values for local options)
5845 options all options and mappings (also global values for local
5846 options)
5847 resize size of the Vim window: 'lines' and 'columns'
5848 sesdir the directory in which the session file is located
5849 will become the current directory (useful with
5850 projects accessed over a network from different
5851 systems)
5852 slash backslashes in file names replaced with forward
5853 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005854 tabpages all tab pages; without this only the current tab page
5855 is restored, so that you can make a session for each
5856 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 unix with Unix end-of-line format (single <NL>), even when
5858 on Windows or DOS
5859 winpos position of the whole Vim window
5860 winsize window sizes
5861
5862 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005863 When neither "curdir" nor "sesdir" is included, file names are stored
5864 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 "slash" and "unix" are useful on Windows when sharing session files
5866 with Unix. The Unix version of Vim cannot source dos format scripts,
5867 but the Windows version of Vim can source unix format scripts.
5868
5869 *'shell'* *'sh'* *E91*
5870'shell' 'sh' string (default $SHELL or "sh",
5871 MS-DOS and Win32: "command.com" or
5872 "cmd.exe", OS/2: "cmd")
5873 global
5874 Name of the shell to use for ! and :! commands. When changing the
5875 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5876 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 See |option-backslash| about including spaces and backslashes.
5879 Environment variables are expanded |:set_env|.
5880 If the name of the shell contains a space, you might need to enclose
5881 it in quotes. Example: >
5882 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5883< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005884 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005885 "-f" is not inside the quotes, because it is not part of the command
5886 name. And Vim automagically recognizes the backslashes that are path
5887 separators.
5888 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5889 variable to change the way external commands are executed. See the
5890 libc.inf file of DJGPP.
5891 Under MS-Windows, when the executable ends in ".com" it must be
5892 included. Thus setting the shell to "command.com" or "4dos.com"
5893 works, but "command" and "4dos" do not work for all commands (e.g.,
5894 filtering).
5895 For unknown reasons, when using "4dos.com" the current directory is
5896 changed to "C:\". To avoid this set 'shell' like this: >
5897 :set shell=command.com\ /c\ 4dos
5898< This option cannot be set from a |modeline| or in the |sandbox|, for
5899 security reasons.
5900
5901 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005902'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005903 MS-DOS and Win32, when 'shell' does not
5904 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 global
5906 {not in Vi}
5907 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5908 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5909 systems, the default is set according to the value of 'shell', to
5910 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005911 OS/2 (EMX figures this out itself).
5912 On Unix it can have more than one flag. Each white space separated
5913 part is passed as an argument to the shell command.
5914 See |option-backslash| about including spaces and backslashes.
5915 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 This option cannot be set from a |modeline| or in the |sandbox|, for
5917 security reasons.
5918
5919 *'shellpipe'* *'sp'*
5920'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5921 global
5922 {not in Vi}
5923 {not available when compiled without the |+quickfix|
5924 feature}
5925 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005926 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 including spaces and backslashes.
5928 The name of the temporary file can be represented by "%s" if necessary
5929 (the file name is appended automatically if no %s appears in the value
5930 of this option).
5931 For the Amiga and MS-DOS the default is ">". The output is directly
5932 saved in a file and not echoed to the screen.
5933 For Unix the default it "| tee". The stdout of the compiler is saved
5934 in a file and echoed to the screen. If the 'shell' option is "csh" or
5935 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005936 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5937 default becomes "2>&1| tee". This means that stderr is also included.
5938 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5939 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 The initialization of this option is done after reading the ".vimrc"
5941 and the other initializations, so that when the 'shell' option is set
5942 there, the 'shellpipe' option changes automatically, unless it was
5943 explicitly set before.
5944 When 'shellpipe' is set to an empty string, no redirection of the
5945 ":make" output will be done. This is useful if you use a 'makeprg'
5946 that writes to 'makeef' by itself. If you want no piping, but do
5947 want to include the 'makeef', set 'shellpipe' to a single space.
5948 Don't forget to precede the space with a backslash: ":set sp=\ ".
5949 In the future pipes may be used for filtering and this option will
5950 become obsolete (at least for Unix).
5951 This option cannot be set from a |modeline| or in the |sandbox|, for
5952 security reasons.
5953
5954 *'shellquote'* *'shq'*
5955'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5956 contains "sh" somewhere: "\"")
5957 global
5958 {not in Vi}
5959 Quoting character(s), put around the command passed to the shell, for
5960 the "!" and ":!" commands. The redirection is kept outside of the
5961 quoting. See 'shellxquote' to include the redirection. It's
5962 probably not useful to set both options.
5963 This is an empty string by default. Only known to be useful for
5964 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5965 or bash, where it should be "\"". The default is adjusted according
5966 the value of 'shell', to reduce the need to set this option by the
5967 user. See |dos-shell|.
5968 This option cannot be set from a |modeline| or in the |sandbox|, for
5969 security reasons.
5970
5971 *'shellredir'* *'srr'*
5972'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5973 global
5974 {not in Vi}
5975 String to be used to put the output of a filter command in a temporary
5976 file. See also |:!|. See |option-backslash| about including spaces
5977 and backslashes.
5978 The name of the temporary file can be represented by "%s" if necessary
5979 (the file name is appended automatically if no %s appears in the value
5980 of this option).
5981 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5982 or "zsh" during initializations, the default becomes ">&". If the
5983 'shell' option is "sh", "ksh" or "bash" the default becomes
5984 ">%s 2>&1". This means that stderr is also included.
5985 For Win32, the Unix checks are done and additionally "cmd" is checked
5986 for, which makes the default ">%s 2>&1". Also, the same names with
5987 ".exe" appended are checked for.
5988 The initialization of this option is done after reading the ".vimrc"
5989 and the other initializations, so that when the 'shell' option is set
5990 there, the 'shellredir' option changes automatically unless it was
5991 explicitly set before.
5992 In the future pipes may be used for filtering and this option will
5993 become obsolete (at least for Unix).
5994 This option cannot be set from a |modeline| or in the |sandbox|, for
5995 security reasons.
5996
5997 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5998'shellslash' 'ssl' boolean (default off)
5999 global
6000 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6001 When set, a forward slash is used when expanding file names. This is
6002 useful when a Unix-like shell is used instead of command.com or
6003 cmd.exe. Backward slashes can still be typed, but they are changed to
6004 forward slashes by Vim.
6005 Note that setting or resetting this option has no effect for some
6006 existing file names, thus this option needs to be set before opening
6007 any file for best results. This might change in the future.
6008 'shellslash' only works when a backslash can be used as a path
6009 separator. To test if this is so use: >
6010 if exists('+shellslash')
6011<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006012 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6013'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6014 global
6015 {not in Vi}
6016 When on, use temp files for shell commands. When off use a pipe.
6017 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006018 Currently a pipe is only supported on Unix and MS-Windows 2K and
6019 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006020 :if has("filterpipe")
6021< The advantage of using a pipe is that nobody can read the temp file
6022 and the 'shell' command does not need to support redirection.
6023 The advantage of using a temp file is that the file type and encoding
6024 can be detected.
6025 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6026 |FilterWritePost| autocommands event are not triggered when
6027 'shelltemp' is off.
6028
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 *'shelltype'* *'st'*
6030'shelltype' 'st' number (default 0)
6031 global
6032 {not in Vi} {only for the Amiga}
6033 On the Amiga this option influences the way how the commands work
6034 which use a shell.
6035 0 and 1: always use the shell
6036 2 and 3: use the shell only to filter lines
6037 4 and 5: use shell only for ':sh' command
6038 When not using the shell, the command is executed directly.
6039
6040 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6041 1 and 3: use "shell cmd" to start external commands
6042
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006043 *'shellxescape'* *'sxe'*
6044'shellxescape' 'sxe' string (default: "";
6045 for MS-DOS and MS-Windows: "\"&|<>()@^")
6046 global
6047 {not in Vi}
6048 When 'shellxquote' is set to "(" then the characters listed in this
6049 option will be escaped with a '^' character. This makes it possible
6050 to execute most external commands with cmd.exe.
6051
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 *'shellxquote'* *'sxq'*
6053'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006054 for Win32, when 'shell' is cmd.exe: "("
6055 for Win32, when 'shell' contains "sh"
6056 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 for Unix, when using system(): "\"")
6058 global
6059 {not in Vi}
6060 Quoting character(s), put around the command passed to the shell, for
6061 the "!" and ":!" commands. Includes the redirection. See
6062 'shellquote' to exclude the redirection. It's probably not useful
6063 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006064 When the value is '(' then ')' is appended. When the value is '"('
6065 then ')"' is appended.
6066 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006067 This is an empty string by default on most systems, but is known to be
6068 useful for on Win32 version, either for cmd.exe which automatically
6069 strips off the first and last quote on a command, or 3rd-party shells
6070 such as the MKS Korn Shell or bash, where it should be "\"". The
6071 default is adjusted according the value of 'shell', to reduce the need
6072 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 This option cannot be set from a |modeline| or in the |sandbox|, for
6074 security reasons.
6075
6076 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6077'shiftround' 'sr' boolean (default off)
6078 global
6079 {not in Vi}
6080 Round indent to multiple of 'shiftwidth'. Applies to > and <
6081 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6082 a multiple of 'shiftwidth' (this is Vi compatible).
6083 NOTE: This option is reset when 'compatible' is set.
6084
6085 *'shiftwidth'* *'sw'*
6086'shiftwidth' 'sw' number (default 8)
6087 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006088 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006089 |'cindent'|, |>>|, |<<|, etc.
6090
6091 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006092'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6093 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 global
6095 {not in Vi}
6096 This option helps to avoid all the |hit-enter| prompts caused by file
6097 messages, for example with CTRL-G, and to avoid some other messages.
6098 It is a list of flags:
6099 flag meaning when present ~
6100 f use "(3 of 5)" instead of "(file 3 of 5)"
6101 i use "[noeol]" instead of "[Incomplete last line]"
6102 l use "999L, 888C" instead of "999 lines, 888 characters"
6103 m use "[+]" instead of "[Modified]"
6104 n use "[New]" instead of "[New File]"
6105 r use "[RO]" instead of "[readonly]"
6106 w use "[w]" instead of "written" for file write message
6107 and "[a]" instead of "appended" for ':w >> file' command
6108 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6109 "[unix format]" and "[mac]" instead of "[mac format]".
6110 a all of the above abbreviations
6111
6112 o overwrite message for writing a file with subsequent message
6113 for reading a file (useful for ":wn" or when 'autowrite' on)
6114 O message for reading a file overwrites any previous message.
6115 Also for quickfix message (e.g., ":cn").
6116 s don't give "search hit BOTTOM, continuing at TOP" or "search
6117 hit TOP, continuing at BOTTOM" messages
6118 t truncate file message at the start if it is too long to fit
6119 on the command-line, "<" will appear in the left most column.
6120 Ignored in Ex mode.
6121 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006122 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 Ignored in Ex mode.
6124 W don't give "written" or "[w]" when writing a file
6125 A don't give the "ATTENTION" message when an existing swap file
6126 is found.
6127 I don't give the intro message when starting Vim |:intro|.
6128
6129 This gives you the opportunity to avoid that a change between buffers
6130 requires you to hit <Enter>, but still gives as useful a message as
6131 possible for the space available. To get the whole message that you
6132 would have got with 'shm' empty, use ":file!"
6133 Useful values:
6134 shm= No abbreviation of message.
6135 shm=a Abbreviation, but no loss of information.
6136 shm=at Abbreviation, and truncate message when necessary.
6137
6138 NOTE: This option is set to the Vi default value when 'compatible' is
6139 set and to the Vim default value when 'compatible' is reset.
6140
6141 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6142'shortname' 'sn' boolean (default off)
6143 local to buffer
6144 {not in Vi, not in MS-DOS versions}
6145 Filenames are assumed to be 8 characters plus one extension of 3
6146 characters. Multiple dots in file names are not allowed. When this
6147 option is on, dots in file names are replaced with underscores when
6148 adding an extension (".~" or ".swp"). This option is not available
6149 for MS-DOS, because then it would always be on. This option is useful
6150 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6151 or crossdos. When running the Win32 GUI version under Win32s, this
6152 option is always on by default.
6153
6154 *'showbreak'* *'sbr'* *E595*
6155'showbreak' 'sbr' string (default "")
6156 global
6157 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006158 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 feature}
6160 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006161 values are "> " or "+++ ": >
6162 :set showbreak=>\
6163< Note the backslash to escape the trailing space. It's easier like
6164 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006165 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006166< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 comma (in a future version the comma might be used to separate the
6168 part that is shown at the end and at the start of a line).
6169 The characters are highlighted according to the '@' flag in
6170 'highlight'.
6171 Note that tabs after the showbreak will be displayed differently.
6172 If you want the 'showbreak' to appear in between line numbers, add the
6173 "n" flag to 'cpoptions'.
6174
6175 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6176'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6177 off)
6178 global
6179 {not in Vi}
6180 {not available when compiled without the
6181 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006182 Show (partial) command in the last line of the screen. Set this
6183 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184 In Visual mode the size of the selected area is shown:
6185 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006186 If the number of bytes is different it is also displayed: "2-6"
6187 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006189 - When selecting a block, the size in screen characters:
6190 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 NOTE: This option is set to the Vi default value when 'compatible' is
6192 set and to the Vim default value when 'compatible' is reset.
6193
6194 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6195'showfulltag' 'sft' boolean (default off)
6196 global
6197 {not in Vi}
6198 When completing a word in insert mode (see |ins-completion|) from the
6199 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006200 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 matched a C function, you can see a template for what arguments are
6202 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006203 Note that this doesn't work well together with having "longest" in
6204 'completeopt', because the completion from the search pattern may not
6205 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206
6207 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6208'showmatch' 'sm' boolean (default off)
6209 global
6210 When a bracket is inserted, briefly jump to the matching one. The
6211 jump is only done if the match can be seen on the screen. The time to
6212 show the match can be set with 'matchtime'.
6213 A Beep is given if there is no match (no matter if the match can be
6214 seen or not). This option is reset when the 'paste' option is set.
6215 When the 'm' flag is not included in 'cpoptions', typing a character
6216 will immediately move the cursor back to where it belongs.
6217 See the "sm" field in 'guicursor' for setting the cursor shape and
6218 blinking when showing the match.
6219 The 'matchpairs' option can be used to specify the characters to show
6220 matches for. 'rightleft' and 'revins' are used to look for opposite
6221 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006222 Also see the matchparen plugin for highlighting the match when moving
6223 around |pi_paren.txt|.
6224 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225
6226 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6227'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6228 global
6229 If in Insert, Replace or Visual mode put a message on the last line.
6230 Use the 'M' flag in 'highlight' to set the type of highlighting for
6231 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006232 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 doesn't mean XIM is really active, especially when 'imactivatekey' is
6234 not set.
6235 NOTE: This option is set to the Vi default value when 'compatible' is
6236 set and to the Vim default value when 'compatible' is reset.
6237
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006238 *'showtabline'* *'stal'*
6239'showtabline' 'stal' number (default 1)
6240 global
6241 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006242 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006243 feature}
6244 The value of this option specifies when the line with tab page labels
6245 will be displayed:
6246 0: never
6247 1: only if there are at least two tab pages
6248 2: always
6249 This is both for the GUI and non-GUI implementation of the tab pages
6250 line.
6251 See |tab-page| for more information about tab pages.
6252
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 *'sidescroll'* *'ss'*
6254'sidescroll' 'ss' number (default 0)
6255 global
6256 {not in Vi}
6257 The minimal number of columns to scroll horizontally. Used only when
6258 the 'wrap' option is off and the cursor is moved off of the screen.
6259 When it is zero the cursor will be put in the middle of the screen.
6260 When using a slow terminal set it to a large number or 0. When using
6261 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6262 commands.
6263
6264 *'sidescrolloff'* *'siso'*
6265'sidescrolloff' 'siso' number (default 0)
6266 global
6267 {not in Vi}
6268 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006269 right of the cursor if 'nowrap' is set. Setting this option to a
6270 value greater than 0 while having |'sidescroll'| also at a non-zero
6271 value makes some context visible in the line you are scrolling in
6272 horizontally (except at beginning of the line). Setting this option
6273 to a large value (like 999) has the effect of keeping the cursor
6274 horizontally centered in the window, as long as one does not come too
6275 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 NOTE: This option is set to 0 when 'compatible' is set.
6277
6278 Example: Try this together with 'sidescroll' and 'listchars' as
6279 in the following example to never allow the cursor to move
6280 onto the "extends" character:
6281
6282 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6283 :set sidescrolloff=1
6284
6285
6286 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6287'smartcase' 'scs' boolean (default off)
6288 global
6289 {not in Vi}
6290 Override the 'ignorecase' option if the search pattern contains upper
6291 case characters. Only used when the search pattern is typed and
6292 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006293 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6295 recalling the search pattern from history and hitting <Enter>.
6296 NOTE: This option is reset when 'compatible' is set.
6297
6298 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6299'smartindent' 'si' boolean (default off)
6300 local to buffer
6301 {not in Vi}
6302 {not available when compiled without the
6303 |+smartindent| feature}
6304 Do smart autoindenting when starting a new line. Works for C-like
6305 programs, but can also be used for other languages. 'cindent' does
6306 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006307 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006308 setting 'si' has no effect. 'indentexpr' is a more advanced
6309 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006310 Normally 'autoindent' should also be on when using 'smartindent'.
6311 An indent is automatically inserted:
6312 - After a line ending in '{'.
6313 - After a line starting with a keyword from 'cinwords'.
6314 - Before a line starting with '}' (only with the "O" command).
6315 When typing '}' as the first character in a new line, that line is
6316 given the same indent as the matching '{'.
6317 When typing '#' as the first character in a new line, the indent for
6318 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006319 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6321 When using the ">>" command, lines starting with '#' are not shifted
6322 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006323 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 is set smart indenting is disabled.
6325
6326 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6327'smarttab' 'sta' boolean (default off)
6328 global
6329 {not in Vi}
6330 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006331 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6332 <BS> will delete a 'shiftwidth' worth of space at the start of the
6333 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006334 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006335 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6336 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006337 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006339 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 NOTE: This option is reset when 'compatible' is set.
6341
6342 *'softtabstop'* *'sts'*
6343'softtabstop' 'sts' number (default 0)
6344 local to buffer
6345 {not in Vi}
6346 Number of spaces that a <Tab> counts for while performing editing
6347 operations, like inserting a <Tab> or using <BS>. It "feels" like
6348 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6349 used. This is useful to keep the 'ts' setting at its standard value
6350 of 8, while being able to edit like it is set to 'sts'. However,
6351 commands like "x" still work on the actual characters.
6352 When 'sts' is zero, this feature is off.
6353 'softtabstop' is set to 0 when the 'paste' option is set.
6354 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6355 spaces is minimized by using <Tab>s.
6356 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6357 set.
6358 NOTE: This option is set to 0 when 'compatible' is set.
6359
Bram Moolenaar217ad922005-03-20 22:37:15 +00006360 *'spell'* *'nospell'*
6361'spell' boolean (default off)
6362 local to window
6363 {not in Vi}
6364 {not available when compiled without the |+syntax|
6365 feature}
6366 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006367 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006368
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006369 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006370'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006371 local to buffer
6372 {not in Vi}
6373 {not available when compiled without the |+syntax|
6374 feature}
6375 Pattern to locate the end of a sentence. The following word will be
6376 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006377 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006378 When this check is not wanted make this option empty.
6379 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006380 Be careful with special characters, see |option-backslash| about
6381 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006382 To set this option automatically depending on the language, see
6383 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006384
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006385 *'spellfile'* *'spf'*
6386'spellfile' 'spf' string (default empty)
6387 local to buffer
6388 {not in Vi}
6389 {not available when compiled without the |+syntax|
6390 feature}
6391 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006392 commands. It must end in ".{encoding}.add". You need to include the
6393 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006394 *E765*
6395 It may also be a comma separated list of names. A count before the
6396 |zg| and |zw| commands can be used to access each. This allows using
6397 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006398 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006399 you: Using the first directory in 'runtimepath' that is writable. If
6400 there is no "spell" directory yet it will be created. For the file
6401 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006402 ignoring the region.
6403 The resulting ".spl" file will be used for spell checking, it does not
6404 have to appear in 'spelllang'.
6405 Normally one file is used for all regions, but you can add the region
6406 name if you want to. However, it will then only be used when
6407 'spellfile' is set to it, for entries in 'spelllang' only files
6408 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006409 This option cannot be set from a |modeline| or in the |sandbox|, for
6410 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006411
Bram Moolenaar217ad922005-03-20 22:37:15 +00006412 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006413'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006414 local to buffer
6415 {not in Vi}
6416 {not available when compiled without the |+syntax|
6417 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006418 A comma separated list of word list names. When the 'spell' option is
6419 on spellchecking will be done for these languages. Example: >
6420 set spelllang=en_us,nl,medical
6421< This means US English, Dutch and medical words are recognized. Words
6422 that are not recognized will be highlighted.
6423 The word list name must not include a comma or dot. Using a dash is
6424 recommended to separate the two letter language name from a
6425 specification. Thus "en-rare" is used for rare English words.
6426 A region name must come last and have the form "_xx", where "xx" is
6427 the two-letter, lower case region name. You can use more than one
6428 region by listing them: "en_us,en_ca" supports both US and Canadian
6429 English, but not words specific for Australia, New Zealand or Great
6430 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006431 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006432 As a special case the name of a .spl file can be given as-is. The
6433 first "_xx" in the name is removed and used as the region name
6434 (_xx is an underscore, two letters and followed by a non-letter).
6435 This is mainly for testing purposes. You must make sure the correct
6436 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006437 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006438 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6439 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006440 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006441
Bram Moolenaar98692072006-02-04 00:57:42 +00006442 If the |spellfile.vim| plugin is active and you use a language name
6443 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6444 will ask you if you want to download the file.
6445
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006446 After this option has been set successfully, Vim will source the files
6447 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006448 up to the first comma, dot or underscore.
6449 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006450
6451
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006452 *'spellsuggest'* *'sps'*
6453'spellsuggest' 'sps' string (default "best")
6454 global
6455 {not in Vi}
6456 {not available when compiled without the |+syntax|
6457 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006458 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006459 the |spellsuggest()| function. This is a comma-separated list of
6460 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006461
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006462 best Internal method that works best for English. Finds
6463 changes like "fast" and uses a bit of sound-a-like
6464 scoring to improve the ordering.
6465
6466 double Internal method that uses two methods and mixes the
6467 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006468 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006469 word. That only works when the language specifies
6470 sound folding. Can be slow and doesn't always give
6471 better results.
6472
6473 fast Internal method that only checks for simple changes:
6474 character inserts/deletes/swaps. Works well for
6475 simple typing mistakes.
6476
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006477 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006478 Not used for |spellsuggest()|. The number of
6479 suggestions is never more than the value of 'lines'
6480 minus two.
6481
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006482 file:{filename} Read file {filename}, which must have two columns,
6483 separated by a slash. The first column contains the
6484 bad word, the second column the suggested good word.
6485 Example:
6486 theribal/terrible ~
6487 Use this for common mistakes that do not appear at the
6488 top of the suggestion list with the internal methods.
6489 Lines without a slash are ignored, use this for
6490 comments.
6491 The file is used for all languages.
6492
6493 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6494 trouble with spaces. |v:val| holds the badly spelled
6495 word. The expression must evaluate to a List of
6496 Lists, each with a suggestion and a score.
6497 Example:
6498 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006499 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006500 internal methods use. A lower score is better.
6501 This may invoke |spellsuggest()| if you temporarily
6502 set 'spellsuggest' to exclude the "expr:" part.
6503 Errors are silently ignored, unless you set the
6504 'verbose' option to a non-zero value.
6505
6506 Only one of "best", "double" or "fast" may be used. The others may
6507 appear several times in any order. Example: >
6508 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6509<
6510 This option cannot be set from a |modeline| or in the |sandbox|, for
6511 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006512
6513
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6515'splitbelow' 'sb' boolean (default off)
6516 global
6517 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006518 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 feature}
6520 When on, splitting a window will put the new window below the current
6521 one. |:split|
6522
6523 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6524'splitright' 'spr' boolean (default off)
6525 global
6526 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006527 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 feature}
6529 When on, splitting a window will put the new window right of the
6530 current one. |:vsplit|
6531
6532 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6533'startofline' 'sol' boolean (default on)
6534 global
6535 {not in Vi}
6536 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006537 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006538 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006539 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 with a linewise operator, with "%" with a count and to buffer changing
6541 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6542 only has a line number, e.g., ":25" or ":+".
6543 In case of buffer changing commands the cursor is placed at the column
6544 where it was the last time the buffer was edited.
6545 NOTE: This option is set when 'compatible' is set.
6546
Bram Moolenaar00654022011-02-25 14:42:19 +01006547 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006549 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 {not in Vi}
6551 {not available when compiled without the |+statusline|
6552 feature}
6553 When nonempty, this option determines the content of the status line.
6554 Also see |status-line|.
6555
6556 The option consists of printf style '%' items interspersed with
6557 normal text. Each status line item is of the form:
6558 %-0{minwid}.{maxwid}{item}
6559 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006560 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561
Bram Moolenaar238a5642006-02-21 22:12:05 +00006562 When the option starts with "%!" then it is used as an expression,
6563 evaluated and the result is used as the option value. Example: >
6564 :set statusline=%!MyStatusLine()
6565< The result can contain %{} items that will be evaluated too.
6566
6567 When there is error while evaluating the option then it will be made
6568 empty to avoid further errors. Otherwise screen updating would loop.
6569
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 Note that the only effect of 'ruler' when this option is set (and
6571 'laststatus' is 2) is controlling the output of |CTRL-G|.
6572
6573 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006574 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006576 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 minwid Minimum width of the item, padding as set by '-' & '0'.
6578 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006579 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 on the left for text items. Numeric items will be
6581 shifted down to maxwid-2 digits followed by '>'number
6582 where number is the amount of missing digits, much like
6583 an exponential notation.
6584 item A one letter code as described below.
6585
6586 Following is a description of the possible statusline items. The
6587 second character in "item" is the type:
6588 N for number
6589 S for string
6590 F for flags as described below
6591 - not applicable
6592
6593 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006594 f S Path to the file in the buffer, as typed or relative to current
6595 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 F S Full path to the file in the buffer.
6597 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006598 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006600 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006602 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006604 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006606 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6608 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006609 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6611 being used: "<keymap>"
6612 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006613 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 B N As above, in hexadecimal.
6615 o N Byte number in file of byte under cursor, first byte is 1.
6616 Mnemonic: Offset from start of file (with one added)
6617 {not available when compiled without |+byte_offset| feature}
6618 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006619 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 l N Line number.
6621 L N Number of lines in buffer.
6622 c N Column number.
6623 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006624 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 p N Percentage through file in lines as in |CTRL-G|.
6626 P S Percentage through file of displayed window. This is like the
6627 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006628 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006630 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006631 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 ( - Start of item group. Can be used for setting the width and
6633 alignment of a section. Must be followed by %) somewhere.
6634 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006635 T N For 'tabline': start of tab page N label. Use %T after the last
6636 label. This information is used for mouse clicks.
6637 X N For 'tabline': start of close tab N label. Use %X after the
6638 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6639 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 < - Where to truncate line if too long. Default is at the start.
6641 No width fields allowed.
6642 = - Separation point between left and right aligned items.
6643 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006644 # - Set highlight group. The name must follow and then a # again.
6645 Thus use %#HLname# for highlight group HLname. The same
6646 highlighting is used, also for the statusline of non-current
6647 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006649 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 The difference between User{N} and StatusLine will be applied
6651 to StatusLineNC for the statusline of non-current windows.
6652 The number N must be between 1 and 9. See |hl-User1..9|
6653
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006654 When displaying a flag, Vim removes the leading comma, if any, when
6655 that flag comes right after plaintext. This will make a nice display
6656 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657
Bram Moolenaar582fd852005-03-28 20:58:01 +00006658 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 not set) and a minwid is not set for the group, the whole group will
6660 become empty. This will make a group like the following disappear
6661 completely from the statusline when none of the flags are set. >
6662 :set statusline=...%(\ [%M%R%H]%)...
6663<
6664 Beware that an expression is evaluated each and every time the status
6665 line is displayed. The current buffer and current window will be set
6666 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006667 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006669 real current buffer.
6670
6671 The 'statusline' option may be evaluated in the |sandbox|, see
6672 |sandbox-option|.
6673
6674 It is not allowed to change text or jump to another window while
6675 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676
6677 If the statusline is not updated when you want it (e.g., after setting
6678 a variable that's used in an expression), you can force an update by
6679 setting an option without changing its value. Example: >
6680 :let &ro = &ro
6681
6682< A result of all digits is regarded a number for display purposes.
6683 Otherwise the result is taken as flag text and applied to the rules
6684 described above.
6685
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006686 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6688 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6689
6690 Examples:
6691 Emulate standard status line with 'ruler' set >
6692 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6693< Similar, but add ASCII value of char under the cursor (like "ga") >
6694 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6695< Display byte count and byte value, modified flag in red. >
6696 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6697 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6698< Display a ,GZ flag if a compressed file is loaded >
6699 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6700< In the |:autocmd|'s: >
6701 :let b:gzflag = 1
6702< And: >
6703 :unlet b:gzflag
6704< And define this function: >
6705 :function VarExists(var, val)
6706 : if exists(a:var) | return a:val | else | return '' | endif
6707 :endfunction
6708<
6709 *'suffixes'* *'su'*
6710'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6711 global
6712 {not in Vi}
6713 Files with these suffixes get a lower priority when multiple files
6714 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006715 suffixes. Spaces after the comma are ignored. A dot is also seen as
6716 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717 separator, precede it with a backslash (see |option-backslash| about
6718 including spaces and backslashes).
6719 See 'wildignore' for completely ignoring files.
6720 The use of |:set+=| and |:set-=| is preferred when adding or removing
6721 suffixes from the list. This avoids problems when a future version
6722 uses another default.
6723
6724 *'suffixesadd'* *'sua'*
6725'suffixesadd' 'sua' string (default "")
6726 local to buffer
6727 {not in Vi}
6728 {not available when compiled without the
6729 |+file_in_path| feature}
6730 Comma separated list of suffixes, which are used when searching for a
6731 file for the "gf", "[I", etc. commands. Example: >
6732 :set suffixesadd=.java
6733<
6734 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6735'swapfile' 'swf' boolean (default on)
6736 local to buffer
6737 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006738 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 swapfile is not wanted for a specific buffer. For example, with
6740 confidential information that even root must not be able to access.
6741 Careful: All text will be in memory:
6742 - Don't use this for big files.
6743 - Recovery will be impossible!
6744 A swapfile will only be present when |'updatecount'| is non-zero and
6745 'swapfile' is set.
6746 When 'swapfile' is reset, the swap file for the current buffer is
6747 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6748 non-zero, a swap file is immediately created.
6749 Also see |swap-file| and |'swapsync'|.
6750
6751 This option is used together with 'bufhidden' and 'buftype' to
6752 specify special kinds of buffers. See |special-buffers|.
6753
6754 *'swapsync'* *'sws'*
6755'swapsync' 'sws' string (default "fsync")
6756 global
6757 {not in Vi}
6758 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006759 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760 When this option is empty parts of the swap file may be in memory and
6761 not written to disk. When the system crashes you may lose more work.
6762 On Unix the system does a sync now and then without Vim asking for it,
6763 so the disadvantage of setting this option off is small. On some
6764 systems the swap file will not be written at all. For a unix system
6765 setting it to "sync" will use the sync() call instead of the default
6766 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006767 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768
6769 *'switchbuf'* *'swb'*
6770'switchbuf' 'swb' string (default "")
6771 global
6772 {not in Vi}
6773 This option controls the behavior when switching between buffers.
6774 Possible values (comma separated list):
6775 useopen If included, jump to the first open window that
6776 contains the specified buffer (if there is one).
6777 Otherwise: Do not examine other windows.
6778 This setting is checked with |quickfix| commands, when
6779 jumping to errors (":cc", ":cn", "cp", etc.). It is
6780 also used in all buffer related split commands, for
6781 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006782 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006783 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006785 a buffer for a |quickfix| command that display errors.
6786 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006787 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006788 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006790 *'synmaxcol'* *'smc'*
6791'synmaxcol' 'smc' number (default 3000)
6792 local to buffer
6793 {not in Vi}
6794 {not available when compiled without the |+syntax|
6795 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006796 Maximum column in which to search for syntax items. In long lines the
6797 text after this column is not highlighted and following lines may not
6798 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006799 This helps to avoid very slow redrawing for an XML file that is one
6800 long line.
6801 Set to zero to remove the limit.
6802
Bram Moolenaar071d4272004-06-13 20:20:40 +00006803 *'syntax'* *'syn'*
6804'syntax' 'syn' string (default empty)
6805 local to buffer
6806 {not in Vi}
6807 {not available when compiled without the |+syntax|
6808 feature}
6809 When this option is set, the syntax with this name is loaded, unless
6810 syntax highlighting has been switched off with ":syntax off".
6811 Otherwise this option does not always reflect the current syntax (the
6812 b:current_syntax variable does).
6813 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006814 not automatically recognized. Example, in an IDL file:
6815 /* vim: set syntax=idl : */ ~
6816 When a dot appears in the value then this separates two filetype
6817 names. Example:
6818 /* vim: set syntax=c.doxygen : */ ~
6819 This will use the "c" syntax first, then the "doxygen" syntax.
6820 Note that the second one must be prepared to be loaded as an addition,
6821 otherwise it will be skipped. More than one dot may appear.
6822 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 :set syntax=OFF
6824< To switch syntax highlighting on according to the current value of the
6825 'filetype' option: >
6826 :set syntax=ON
6827< What actually happens when setting the 'syntax' option is that the
6828 Syntax autocommand event is triggered with the value as argument.
6829 This option is not copied to another buffer, independent of the 's' or
6830 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006831 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006833 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006834'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006835 global
6836 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006837 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006838 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006839 When nonempty, this option determines the content of the tab pages
6840 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006841 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006842
6843 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006844 option and only when there is no GUI tab line. When 'e' is in
6845 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006846 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006847
6848 The value is evaluated like with 'statusline'. You can use
6849 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006850 the text to be displayed. Use "%1T" for the first label, "%2T" for
6851 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006852
6853 Keep in mind that only one of the tab pages is the current one, others
6854 are invisible and you can't jump to their windows.
6855
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006856
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006857 *'tabpagemax'* *'tpm'*
6858'tabpagemax' 'tpm' number (default 10)
6859 global
6860 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006861 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006862 feature}
6863 Maximum number of tab pages to be opened by the |-p| command line
6864 argument or the ":tab all" command. |tabpage|
6865
6866
6867 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868'tabstop' 'ts' number (default 8)
6869 local to buffer
6870 Number of spaces that a <Tab> in the file counts for. Also see
6871 |:retab| command, and 'softtabstop' option.
6872
6873 Note: Setting 'tabstop' to any other value than 8 can make your file
6874 appear wrong in many places (e.g., when printing it).
6875
6876 There are four main ways to use tabs in Vim:
6877 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6878 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006879 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 behave like a tab appears every 4 (or 3) characters.
6881 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6882 'expandtab'. This way you will always insert spaces. The
6883 formatting will never be messed up when 'tabstop' is changed.
6884 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006885 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886 works when using Vim to edit the file.
6887 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6888 'noexpandtab'. This should then work (for initial indents only)
6889 for any tabstop setting that people use. It might be nice to have
6890 tabs after the first non-blank inserted as spaces if you do this
6891 though. Otherwise aligned comments will be wrong when 'tabstop' is
6892 changed.
6893
6894 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6895'tagbsearch' 'tbs' boolean (default on)
6896 global
6897 {not in Vi}
6898 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006899 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 searching makes searching for a tag a LOT faster, but a linear search
6901 will find more tags if the tags file wasn't properly sorted.
6902 Vim normally assumes that your tags files are sorted, or indicate that
6903 they are not sorted. Only when this is not the case does the
6904 'tagbsearch' option need to be switched off.
6905
6906 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006907 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 certain files, or retry all files with a linear search. When
6909 'tagbsearch' is off, only a linear search is done.
6910
6911 Linear searching is done anyway, for one file, when Vim finds a line
6912 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006913 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914< [The whitespace before and after the '0' must be a single <Tab>]
6915
6916 When a binary search was done and no match was found in any of the
6917 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6918 instead of a normal tag name, a retry is done with a linear search.
6919 Tags in unsorted tags files, and matches with different case will only
6920 be found in the retry.
6921
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006922 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 linear search can be avoided for the 'ignorecase' case. Use a value
6924 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6925 case-fold sorted with the -f switch to "sort" in most unices, as in
6926 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006927 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6928 for this as well. Note that case must be folded to uppercase for this
6929 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930
6931 When 'tagbsearch' is off, tags searching is slower when a full match
6932 exists, but faster when no full match exists. Tags in unsorted tags
6933 files may only be found with 'tagbsearch' off.
6934 When the tags file is not sorted, or sorted in a wrong way (not on
6935 ASCII byte value), 'tagbsearch' should be off, or the line given above
6936 must be included in the tags file.
6937 This option doesn't affect commands that find all matching tags (e.g.,
6938 command-line completion and ":help").
6939 {Vi: always uses binary search in some versions}
6940
6941 *'taglength'* *'tl'*
6942'taglength' 'tl' number (default 0)
6943 global
6944 If non-zero, tags are significant up to this number of characters.
6945
6946 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6947'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6948 global
6949 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006950 If on and using a tags file in another directory, file names in that
6951 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006952 NOTE: This option is set to the Vi default value when 'compatible' is
6953 set and to the Vim default value when 'compatible' is reset.
6954
6955 *'tags'* *'tag'* *E433*
6956'tags' 'tag' string (default "./tags,tags", when compiled with
6957 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6958 global or local to buffer |global-local|
6959 Filenames for the tag command, separated by spaces or commas. To
6960 include a space or comma in a file name, precede it with a backslash
6961 (see |option-backslash| about including spaces and backslashes).
6962 When a file name starts with "./", the '.' is replaced with the path
6963 of the current file. But only when the 'd' flag is not included in
6964 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6965 |tags-option|.
6966 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006967 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6968 find all files named "tags" below "/lib". The filename itself cannot
6969 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6970 files called "tags?". {not available when compiled without the
6971 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006972 The |tagfiles()| function can be used to get a list of the file names
6973 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6975 files are also supported. They are automatically recognized. The
6976 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6977 differences are ignored (MS-Windows). |emacs-tags|
6978 The use of |:set+=| and |:set-=| is preferred when adding or removing
6979 file names from the list. This avoids problems when a future version
6980 uses another default.
6981 {Vi: default is "tags /usr/lib/tags"}
6982
6983 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6984'tagstack' 'tgst' boolean (default on)
6985 global
6986 {not in all versions of Vi}
6987 When on, the |tagstack| is used normally. When off, a ":tag" or
6988 ":tselect" command with an argument will not push the tag onto the
6989 tagstack. A following ":tag" without an argument, a ":pop" command or
6990 any other command that uses the tagstack will use the unmodified
6991 tagstack, but does change the pointer to the active entry.
6992 Resetting this option is useful when using a ":tag" command in a
6993 mapping which should not change the tagstack.
6994
6995 *'term'* *E529* *E530* *E531*
6996'term' string (default is $TERM, if that fails:
6997 in the GUI: "builtin_gui"
6998 on Amiga: "amiga"
6999 on BeOS: "beos-ansi"
7000 on Mac: "mac-ansi"
7001 on MiNT: "vt52"
7002 on MS-DOS: "pcterm"
7003 on OS/2: "os2ansi"
7004 on Unix: "ansi"
7005 on VMS: "ansi"
7006 on Win 32: "win32")
7007 global
7008 Name of the terminal. Used for choosing the terminal control
7009 characters. Environment variables are expanded |:set_env|.
7010 For example: >
7011 :set term=$TERM
7012< See |termcap|.
7013
7014 *'termbidi'* *'tbidi'*
7015 *'notermbidi'* *'notbidi'*
7016'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7017 global
7018 {not in Vi}
7019 {only available when compiled with the |+arabic|
7020 feature}
7021 The terminal is in charge of Bi-directionality of text (as specified
7022 by Unicode). The terminal is also expected to do the required shaping
7023 that some languages (such as Arabic) require.
7024 Setting this option implies that 'rightleft' will not be set when
7025 'arabic' is set and the value of 'arabicshape' will be ignored.
7026 Note that setting 'termbidi' has the immediate effect that
7027 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7028 This option is reset when the GUI is started.
7029 For further details see |arabic.txt|.
7030
7031 *'termencoding'* *'tenc'*
7032'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7033 Macintosh GUI: "macroman")
7034 global
7035 {only available when compiled with the |+multi_byte|
7036 feature}
7037 {not in Vi}
7038 Encoding used for the terminal. This specifies what character
7039 encoding the keyboard produces and the display will understand. For
7040 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007041 display). Except for the Mac when 'macatsui' is off, then
7042 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 In the Win32 console version the default value is the console codepage
7044 when it differs from the ANSI codepage.
7045 *E617*
7046 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7047 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7048 Any attempts to set a different value will be rejected, and an error
7049 message is shown.
7050 For the Win32 GUI 'termencoding' is not used for typed characters,
7051 because the Win32 system always passes Unicode characters.
7052 When empty, the same encoding is used as for the 'encoding' option.
7053 This is the normal value.
7054 Not all combinations for 'termencoding' and 'encoding' are valid. See
7055 |encoding-table|.
7056 The value for this option must be supported by internal conversions or
7057 iconv(). When this is not possible no conversion will be done and you
7058 will probably experience problems with non-ASCII characters.
7059 Example: You are working with the locale set to euc-jp (Japanese) and
7060 want to edit a UTF-8 file: >
7061 :let &termencoding = &encoding
7062 :set encoding=utf-8
7063< You need to do this when your system has no locale support for UTF-8.
7064
7065 *'terse'* *'noterse'*
7066'terse' boolean (default off)
7067 global
7068 When set: Add 's' flag to 'shortmess' option (this makes the message
7069 for a search that hits the start or end of the file not being
7070 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7071 shortens a lot of messages}
7072
7073 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7074'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7075 global
7076 {not in Vi}
7077 This option is obsolete. Use 'fileformats'.
7078 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7079 set to the default value for the current system. When 'textauto' is
7080 reset, 'fileformats' is made empty.
7081 NOTE: This option is set to the Vi default value when 'compatible' is
7082 set and to the Vim default value when 'compatible' is reset.
7083
7084 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7085'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7086 others: default off)
7087 local to buffer
7088 {not in Vi}
7089 This option is obsolete. Use 'fileformat'.
7090 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7091 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7092 "unix".
7093
7094 *'textwidth'* *'tw'*
7095'textwidth' 'tw' number (default 0)
7096 local to buffer
7097 {not in Vi}
7098 Maximum width of text that is being inserted. A longer line will be
7099 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007100 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7101 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007103 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007104 NOTE: This option is set to 0 when 'compatible' is set.
7105
7106 *'thesaurus'* *'tsr'*
7107'thesaurus' 'tsr' string (default "")
7108 global or local to buffer |global-local|
7109 {not in Vi}
7110 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007111 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007112 the file should contain words with similar meaning, separated by
7113 non-keyword characters (white space is preferred). Maximum line
7114 length is 510 bytes.
7115 To obtain a file to be used here, check out the wordlist FAQ at
7116 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007117 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007118 after a comma are ignored, otherwise spaces are included in the file
7119 name. See |option-backslash| about using backslashes.
7120 The use of |:set+=| and |:set-=| is preferred when adding or removing
7121 directories from the list. This avoids problems when a future version
7122 uses another default.
7123 Backticks cannot be used in this option for security reasons.
7124
7125 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7126'tildeop' 'top' boolean (default off)
7127 global
7128 {not in Vi}
7129 When on: The tilde command "~" behaves like an operator.
7130 NOTE: This option is reset when 'compatible' is set.
7131
7132 *'timeout'* *'to'* *'notimeout'* *'noto'*
7133'timeout' 'to' boolean (default on)
7134 global
7135 *'ttimeout'* *'nottimeout'*
7136'ttimeout' boolean (default off)
7137 global
7138 {not in Vi}
7139 These two options together determine the behavior when part of a
7140 mapped key sequence or keyboard code has been received:
7141
7142 'timeout' 'ttimeout' action ~
7143 off off do not time out
7144 on on or off time out on :mappings and key codes
7145 off on time out on key codes
7146
7147 If both options are off, Vim will wait until either the complete
7148 mapping or key sequence has been received, or it is clear that there
7149 is no mapping or key sequence for the received characters. For
7150 example: if you have mapped "vl" and Vim has received 'v', the next
7151 character is needed to see if the 'v' is followed by an 'l'.
7152 When one of the options is on, Vim will wait for about 1 second for
7153 the next character to arrive. After that the already received
7154 characters are interpreted as single characters. The waiting time can
7155 be changed with the 'timeoutlen' option.
7156 On slow terminals or very busy systems timing out may cause
7157 malfunctioning cursor keys. If both options are off, Vim waits
7158 forever after an entered <Esc> if there are key codes that start
7159 with <Esc>. You will have to type <Esc> twice. If you do not have
7160 problems with key codes, but would like to have :mapped key
7161 sequences not timing out in 1 second, set the 'ttimeout' option and
7162 reset the 'timeout' option.
7163
7164 NOTE: 'ttimeout' is reset when 'compatible' is set.
7165
7166 *'timeoutlen'* *'tm'*
7167'timeoutlen' 'tm' number (default 1000)
7168 global
7169 {not in all versions of Vi}
7170 *'ttimeoutlen'* *'ttm'*
7171'ttimeoutlen' 'ttm' number (default -1)
7172 global
7173 {not in Vi}
7174 The time in milliseconds that is waited for a key code or mapped key
7175 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7176 when part of a command has been typed.
7177 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7178 different timeout value for key codes is desired set 'ttimeoutlen' to
7179 a non-negative number.
7180
7181 ttimeoutlen mapping delay key code delay ~
7182 < 0 'timeoutlen' 'timeoutlen'
7183 >= 0 'timeoutlen' 'ttimeoutlen'
7184
7185 The timeout only happens when the 'timeout' and 'ttimeout' options
7186 tell so. A useful setting would be >
7187 :set timeout timeoutlen=3000 ttimeoutlen=100
7188< (time out on mapping after three seconds, time out on key codes after
7189 a tenth of a second).
7190
7191 *'title'* *'notitle'*
7192'title' boolean (default off, on when title can be restored)
7193 global
7194 {not in Vi}
7195 {not available when compiled without the |+title|
7196 feature}
7197 When on, the title of the window will be set to the value of
7198 'titlestring' (if it is not empty), or to:
7199 filename [+=-] (path) - VIM
7200 Where:
7201 filename the name of the file being edited
7202 - indicates the file cannot be modified, 'ma' off
7203 + indicates the file was modified
7204 = indicates the file is read-only
7205 =+ indicates the file is read-only and modified
7206 (path) is the path of the file being edited
7207 - VIM the server name |v:servername| or "VIM"
7208 Only works if the terminal supports setting window titles
7209 (currently Amiga console, Win32 console, all GUI versions and
7210 terminals with a non- empty 't_ts' option - these are Unix xterm and
7211 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7212 *X11*
7213 When Vim was compiled with HAVE_X11 defined, the original title will
7214 be restored if possible. The output of ":version" will include "+X11"
7215 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7216 works for the icon name |'icon'|.
7217 But: When Vim was started with the |-X| argument, restoring the title
7218 will not work (except in the GUI).
7219 If the title cannot be restored, it is set to the value of 'titleold'.
7220 You might want to restore the title outside of Vim then.
7221 When using an xterm from a remote machine you can use this command:
7222 rsh machine_name xterm -display $DISPLAY &
7223 then the WINDOWID environment variable should be inherited and the
7224 title of the window should change back to what it should be after
7225 exiting Vim.
7226
7227 *'titlelen'*
7228'titlelen' number (default 85)
7229 global
7230 {not in Vi}
7231 {not available when compiled without the |+title|
7232 feature}
7233 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007234 title. When the title is longer, only the end of the path name is
7235 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 Using a percentage makes this adapt to the width of the window. But
7237 it won't work perfectly, because the actual number of characters
7238 available also depends on the font used and other things in the title
7239 bar. When 'titlelen' is zero the full path is used. Otherwise,
7240 values from 1 to 30000 percent can be used.
7241 'titlelen' is also used for the 'titlestring' option.
7242
7243 *'titleold'*
7244'titleold' string (default "Thanks for flying Vim")
7245 global
7246 {not in Vi}
7247 {only available when compiled with the |+title|
7248 feature}
7249 This option will be used for the window title when exiting Vim if the
7250 original title cannot be restored. Only happens if 'title' is on or
7251 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007252 This option cannot be set from a |modeline| or in the |sandbox|, for
7253 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 *'titlestring'*
7255'titlestring' string (default "")
7256 global
7257 {not in Vi}
7258 {not available when compiled without the |+title|
7259 feature}
7260 When this option is not empty, it will be used for the title of the
7261 window. This happens only when the 'title' option is on.
7262 Only works if the terminal supports setting window titles (currently
7263 Amiga console, Win32 console, all GUI versions and terminals with a
7264 non-empty 't_ts' option).
7265 When Vim was compiled with HAVE_X11 defined, the original title will
7266 be restored if possible |X11|.
7267 When this option contains printf-style '%' items, they will be
7268 expanded according to the rules used for 'statusline'.
7269 Example: >
7270 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7271 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7272< The value of 'titlelen' is used to align items in the middle or right
7273 of the available space.
7274 Some people prefer to have the file name first: >
7275 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7276< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007277 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 separating space only when needed.
7279 NOTE: Use of special characters in 'titlestring' may cause the display
7280 to be garbled (e.g., when it contains a CR or NL character).
7281 {not available when compiled without the |+statusline| feature}
7282
7283 *'toolbar'* *'tb'*
7284'toolbar' 'tb' string (default "icons,tooltips")
7285 global
7286 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7287 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007288 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 possible values are:
7290 icons Toolbar buttons are shown with icons.
7291 text Toolbar buttons shown with text.
7292 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007293 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 tooltips Tooltips are active for toolbar buttons.
7295 Tooltips refer to the popup help text which appears after the mouse
7296 cursor is placed over a toolbar button for a brief moment.
7297
7298 If you want the toolbar to be shown with icons as well as text, do the
7299 following: >
7300 :set tb=icons,text
7301< Motif and Athena cannot display icons and text at the same time. They
7302 will show icons if both are requested.
7303
7304 If none of the strings specified in 'toolbar' are valid or if
7305 'toolbar' is empty, this option is ignored. If you want to disable
7306 the toolbar, you need to set the 'guioptions' option. For example: >
7307 :set guioptions-=T
7308< Also see |gui-toolbar|.
7309
7310 *'toolbariconsize'* *'tbis'*
7311'toolbariconsize' 'tbis' string (default "small")
7312 global
7313 {not in Vi}
7314 {only in the GTK+ 2 GUI}
7315 Controls the size of toolbar icons. The possible values are:
7316 tiny Use tiny toolbar icons.
7317 small Use small toolbar icons (default).
7318 medium Use medium-sized toolbar icons.
7319 large Use large toolbar icons.
7320 The exact dimensions in pixels of the various icon sizes depend on
7321 the current theme. Common dimensions are large=32x32, medium=24x24,
7322 small=20x20 and tiny=16x16.
7323
7324 If 'toolbariconsize' is empty, the global default size as determined
7325 by user preferences or the current theme is used.
7326
7327 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7328'ttybuiltin' 'tbi' boolean (default on)
7329 global
7330 {not in Vi}
7331 When on, the builtin termcaps are searched before the external ones.
7332 When off the builtin termcaps are searched after the external ones.
7333 When this option is changed, you should set the 'term' option next for
7334 the change to take effect, for example: >
7335 :set notbi term=$TERM
7336< See also |termcap|.
7337 Rationale: The default for this option is "on", because the builtin
7338 termcap entries are generally better (many systems contain faulty
7339 xterm entries...).
7340
7341 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7342'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7343 sun-cmd, screen, rxvt, dtterm or
7344 iris-ansi; also on when running Vim in
7345 a DOS console)
7346 global
7347 {not in Vi}
7348 Indicates a fast terminal connection. More characters will be sent to
7349 the screen for redrawing, instead of using insert/delete line
7350 commands. Improves smoothness of redrawing when there are multiple
7351 windows and the terminal does not support a scrolling region.
7352 Also enables the extra writing of characters at the end of each screen
7353 line for lines that wrap. This helps when using copy/paste with the
7354 mouse in an xterm and other terminals.
7355
7356 *'ttymouse'* *'ttym'*
7357'ttymouse' 'ttym' string (default depends on 'term')
7358 global
7359 {not in Vi}
7360 {only in Unix and VMS, doesn't work in the GUI; not
7361 available when compiled without |+mouse|}
7362 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007363 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 *xterm-mouse*
7365 xterm xterm-like mouse handling. The mouse generates
7366 "<Esc>[Mscr", where "scr" is three bytes:
7367 "s" = button state
7368 "c" = column plus 33
7369 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007370 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007371 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 xterm2 Works like "xterm", but with the xterm reporting the
7373 mouse position while the mouse is dragged. This works
7374 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007375 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 work. See below for how Vim detects this
7377 automatically.
7378 *netterm-mouse*
7379 netterm NetTerm mouse handling. The mouse generates
7380 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7381 for the row and column.
7382 *dec-mouse*
7383 dec DEC terminal mouse handling. The mouse generates a
7384 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007385 This is also available for an Xterm, if it was
7386 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 *jsbterm-mouse*
7388 jsbterm JSB term mouse handling.
7389 *pterm-mouse*
7390 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007391 *urxvt-mouse*
7392 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393
7394 The mouse handling must be enabled at compile time |+mouse_xterm|
7395 |+mouse_dec| |+mouse_netterm|.
7396 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7397 recognized, if enabled at compile time. DEC terminal mouse codes
7398 are recognized if enabled at compile time, and 'ttymouse' is not
7399 "xterm" (because the xterm and dec mouse codes conflict).
7400 This option is automatically set to "xterm", when the 'term' option is
7401 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7402 or "xterm2" already. The main use of this option is to set it to
7403 "xterm", when the terminal name doesn't start with "xterm", but it can
7404 handle xterm mouse codes.
7405 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007406 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007407 feature and if |t_RV| is set to the escape sequence to request the
7408 xterm version number. Otherwise "xterm2" must be set explicitly.
7409 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7410 t_RV to an empty string: >
7411 :set t_RV=
7412<
7413 *'ttyscroll'* *'tsl'*
7414'ttyscroll' 'tsl' number (default 999)
7415 global
7416 Maximum number of lines to scroll the screen. If there are more lines
7417 to scroll the window is redrawn. For terminals where scrolling is
7418 very slow and redrawing is not slow this can be set to a small number,
7419 e.g., 3, to speed up displaying.
7420
7421 *'ttytype'* *'tty'*
7422'ttytype' 'tty' string (default from $TERM)
7423 global
7424 Alias for 'term', see above.
7425
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007426 *'undodir'* *'udir'*
7427'undodir' 'udir' string (default ".")
7428 global
7429 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007430 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007431 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007432 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007433 "." means using the directory of the file. The undo file name for
7434 "file.txt" is ".file.txt.un~".
7435 For other directories the file name is the full path of the edited
7436 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007437 When writing: The first directory that exists is used. "." always
7438 works, no directories after "." will be used for writing.
7439 When reading all entries are tried to find an undo file. The first
7440 undo file that exists is used. When it cannot be read an error is
7441 given, no further entry is used.
7442 See |undo-persistence|.
7443
7444 *'undofile'* *'udf'*
7445'undofile' 'udf' boolean (default off)
7446 local to buffer
7447 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007448 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007449 When on, Vim automatically saves undo history to an undo file when
7450 writing a buffer to a file, and restores undo history from the same
7451 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007452 The directory where the undo file is stored is specified by 'undodir'.
7453 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007454 The undo file is not read when 'undoreload' causes the buffer from
7455 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007456 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007457
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 *'undolevels'* *'ul'*
7459'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7460 Win32 and OS/2)
7461 global
7462 {not in Vi}
7463 Maximum number of changes that can be undone. Since undo information
7464 is kept in memory, higher numbers will cause more memory to be used
7465 (nevertheless, a single change can use an unlimited amount of memory).
7466 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7467 itself: >
7468 set ul=0
7469< But you can also get Vi compatibility by including the 'u' flag in
7470 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007471 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 Set to a negative number for no undo at all: >
7473 set ul=-1
7474< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007475 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007477 *'undoreload'* *'ur'*
7478'undoreload' 'ur' number (default 10000)
7479 global
7480 {not in Vi}
7481 Save the whole buffer for undo when reloading it. This applies to the
7482 ":e!" command and reloading for when the buffer changed outside of
7483 Vim. |FileChangedShell|
7484 The save only happens when this options is negative or when the number
7485 of lines is smaller than the value of this option.
7486 Set this option to zero to disable undo for a reload.
7487
7488 When saving undo for a reload, any undo file is not read.
7489
7490 Note that this causes the whole buffer to be stored in memory. Set
7491 this option to a lower value if you run out of memory.
7492
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 *'updatecount'* *'uc'*
7494'updatecount' 'uc' number (default: 200)
7495 global
7496 {not in Vi}
7497 After typing this many characters the swap file will be written to
7498 disk. When zero, no swap file will be created at all (see chapter on
7499 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7500 Vim with the "-n" option, see |startup|. When editing in readonly
7501 mode this option will be initialized to 10000.
7502 The swapfile can be disabled per buffer with |'swapfile'|.
7503 When 'updatecount' is set from zero to non-zero, swap files are
7504 created for all buffers that have 'swapfile' set. When 'updatecount'
7505 is set to zero, existing swap files are not deleted.
7506 Also see |'swapsync'|.
7507 This option has no meaning in buffers where |'buftype'| is "nofile"
7508 or "nowrite".
7509
7510 *'updatetime'* *'ut'*
7511'updatetime' 'ut' number (default 4000)
7512 global
7513 {not in Vi}
7514 If this many milliseconds nothing is typed the swap file will be
7515 written to disk (see |crash-recovery|). Also used for the
7516 |CursorHold| autocommand event.
7517
7518 *'verbose'* *'vbs'*
7519'verbose' 'vbs' number (default 0)
7520 global
7521 {not in Vi, although some versions have a boolean
7522 verbose option}
7523 When bigger than zero, Vim will give messages about what it is doing.
7524 Currently, these messages are given:
7525 >= 1 When the viminfo file is read or written.
7526 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007527 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 >= 8 Files for which a group of autocommands is executed.
7529 >= 9 Every executed autocommand.
7530 >= 12 Every executed function.
7531 >= 13 When an exception is thrown, caught, finished, or discarded.
7532 >= 14 Anything pending in a ":finally" clause.
7533 >= 15 Every executed Ex command (truncated at 200 characters).
7534
7535 This option can also be set with the "-V" argument. See |-V|.
7536 This option is also set by the |:verbose| command.
7537
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007538 When the 'verbosefile' option is set then the verbose messages are not
7539 displayed.
7540
7541 *'verbosefile'* *'vfile'*
7542'verbosefile' 'vfile' string (default empty)
7543 global
7544 {not in Vi}
7545 When not empty all messages are written in a file with this name.
7546 When the file exists messages are appended.
7547 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007548 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007549 Setting 'verbosefile' to a new value is like making it empty first.
7550 The difference with |:redir| is that verbose messages are not
7551 displayed when 'verbosefile' is set.
7552
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 *'viewdir'* *'vdir'*
7554'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7555 "$VIM/vimfiles/view",
7556 for Unix: "~/.vim/view",
7557 for Macintosh: "$VIM:vimfiles:view"
7558 for VMS: "sys$login:vimfiles/view"
7559 for RiscOS: "Choices:vimfiles/view")
7560 global
7561 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007562 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 feature}
7564 Name of the directory where to store files for |:mkview|.
7565 This option cannot be set from a |modeline| or in the |sandbox|, for
7566 security reasons.
7567
7568 *'viewoptions'* *'vop'*
7569'viewoptions' 'vop' string (default: "folds,options,cursor")
7570 global
7571 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007572 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 feature}
7574 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007575 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 word save and restore ~
7577 cursor cursor position in file and in window
7578 folds manually created folds, opened/closed folds and local
7579 fold options
7580 options options and mappings local to a window or buffer (not
7581 global values for local options)
7582 slash backslashes in file names replaced with forward
7583 slashes
7584 unix with Unix end-of-line format (single <NL>), even when
7585 on Windows or DOS
7586
7587 "slash" and "unix" are useful on Windows when sharing view files
7588 with Unix. The Unix version of Vim cannot source dos format scripts,
7589 but the Windows version of Vim can source unix format scripts.
7590
7591 *'viminfo'* *'vi'* *E526* *E527* *E528*
7592'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007593 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7594 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7595 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007596 global
7597 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007598 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007599 feature}
7600 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007601 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 separated list of parameters, each consisting of a single character
7603 identifying the particular parameter, followed by a number or string
7604 which specifies the value of that parameter. If a particular
7605 character is left out, then the default value is used for that
7606 parameter. The following is a list of the identifying characters and
7607 the effect of their value.
7608 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007609 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 ! When included, save and restore global variables that start
7611 with an uppercase letter, and don't contain a lowercase
7612 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007613 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007614 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007615 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 " Maximum number of lines saved for each register. Old name of
7617 the '<' item, with the disadvantage that you need to put a
7618 backslash before the ", otherwise it will be recognized as the
7619 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007620 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 % When included, save and restore the buffer list. If Vim is
7622 started with a file name argument, the buffer list is not
7623 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007624 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 without a file name and buffers for help files are not written
7626 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007627 When followed by a number, the number specifies the maximum
7628 number of buffers that are stored. Without a number all
7629 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007630 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007631 ' Maximum number of previously edited files for which the marks
7632 are remembered. This parameter must always be included when
7633 'viminfo' is non-empty.
7634 Including this item also means that the |jumplist| and the
7635 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007636 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007638 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007639 patterns are also saved. When not included, the value of
7640 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007641 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007642 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007643 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007644 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 < Maximum number of lines saved for each register. If zero then
7646 registers are not saved. When not included, all lines are
7647 saved. '"' is the old name for this item.
7648 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007649 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007651 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007652 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 c When included, convert the text in the viminfo file from the
7654 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007655 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007656 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 f Whether file marks need to be stored. If zero, file marks ('0
7658 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007659 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007661 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 h Disable the effect of 'hlsearch' when loading the viminfo
7663 file. When not included, it depends on whether ":nohlsearch"
7664 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007665 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 n Name of the viminfo file. The name must immediately follow
7667 the 'n'. Must be the last one! If the "-i" argument was
7668 given when starting Vim, that file name overrides the one
7669 given here with 'viminfo'. Environment variables are expanded
7670 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007671 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 r Removable media. The argument is a string (up to the next
7673 ','). This parameter can be given several times. Each
7674 specifies the start of a path for which no marks will be
7675 stored. This is to avoid removable media. For MS-DOS you
7676 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7677 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7678 ignored. Maximum length of each 'r' argument is 50
7679 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007680 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 s Maximum size of an item in Kbyte. If zero then registers are
7682 not saved. Currently only applies to registers. The default
7683 "s10" will exclude registers with more than 10 Kbyte of text.
7684 Also see the '<' item above: line count limit.
7685
7686 Example: >
7687 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7688<
7689 '50 Marks will be remembered for the last 50 files you
7690 edited.
7691 <1000 Contents of registers (up to 1000 lines each) will be
7692 remembered.
7693 s100 Registers with more than 100 Kbyte text are skipped.
7694 :0 Command-line history will not be saved.
7695 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7696 no / Since '/' is not specified, the default will be used,
7697 that is, save all of the search history, and also the
7698 previous search and substitute patterns.
7699 no % The buffer list will not be saved nor read back.
7700 no h 'hlsearch' highlighting will be restored.
7701
7702 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7703 load the contents of the file, this is not done automatically.
7704
7705 This option cannot be set from a |modeline| or in the |sandbox|, for
7706 security reasons.
7707
7708 *'virtualedit'* *'ve'*
7709'virtualedit' 've' string (default "")
7710 global
7711 {not in Vi}
7712 {not available when compiled without the
7713 |+virtualedit| feature}
7714 A comma separated list of these words:
7715 block Allow virtual editing in Visual block mode.
7716 insert Allow virtual editing in Insert mode.
7717 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007718 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007719
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007721 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 of the line. Useful for selecting a rectangle in Visual mode and
7723 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007724 "onemore" is not the same, it will only allow moving the cursor just
7725 after the last character of the line. This makes some commands more
7726 consistent. Previously the cursor was always past the end of the line
7727 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007728 break some plugins or Vim scripts. For example because |l| can move
7729 the cursor after the last character. Use with care!
7730 Using the |$| command will move to the last character in the line, not
7731 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007732 It doesn't make sense to combine "all" with "onemore", but you will
7733 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734
7735 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7736'visualbell' 'vb' boolean (default off)
7737 global
7738 {not in Vi}
7739 Use visual bell instead of beeping. The terminal code to display the
7740 visual bell is given with 't_vb'. When no beep or flash is wanted,
7741 use ":set vb t_vb=".
7742 Note: When the GUI starts, 't_vb' is reset to its default value. You
7743 might want to set it again in your |gvimrc|.
7744 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7745 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7746 where 40 is the time in msec.
7747 Does not work on the Amiga, you always get a screen flash.
7748 Also see 'errorbells'.
7749
7750 *'warn'* *'nowarn'*
7751'warn' boolean (default on)
7752 global
7753 Give a warning message when a shell command is used while the buffer
7754 has been changed.
7755
7756 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7757'weirdinvert' 'wiv' boolean (default off)
7758 global
7759 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007760 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 It is provided for backwards compatibility with version 4.x.
7762 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7763 vice versa. Has no effect when the GUI is running.
7764
7765 *'whichwrap'* *'ww'*
7766'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7767 global
7768 {not in Vi}
7769 Allow specified keys that move the cursor left/right to move to the
7770 previous/next line when the cursor is on the first/last character in
7771 the line. Concatenate characters to allow this for these keys:
7772 char key mode ~
7773 b <BS> Normal and Visual
7774 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007775 h "h" Normal and Visual (not recommended)
7776 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007777 < <Left> Normal and Visual
7778 > <Right> Normal and Visual
7779 ~ "~" Normal
7780 [ <Left> Insert and Replace
7781 ] <Right> Insert and Replace
7782 For example: >
7783 :set ww=<,>,[,]
7784< allows wrap only when cursor keys are used.
7785 When the movement keys are used in combination with a delete or change
7786 operator, the <EOL> also counts for a character. This makes "3h"
7787 different from "3dh" when the cursor crosses the end of a line. This
7788 is also true for "x" and "X", because they do the same as "dl" and
7789 "dh". If you use this, you may also want to use the mapping
7790 ":map <BS> X" to make backspace delete the character in front of the
7791 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007792 When 'l' is included and it is used after an operator at the end of a
7793 line then it will not move to the next line. This makes "dl", "cl",
7794 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 NOTE: This option is set to the Vi default value when 'compatible' is
7796 set and to the Vim default value when 'compatible' is reset.
7797
7798 *'wildchar'* *'wc'*
7799'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7800 global
7801 {not in Vi}
7802 Character you have to type to start wildcard expansion in the
7803 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007804 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 The character is not recognized when used inside a macro. See
7806 'wildcharm' for that.
7807 Although 'wc' is a number option, you can set it to a special key: >
7808 :set wc=<Esc>
7809< NOTE: This option is set to the Vi default value when 'compatible' is
7810 set and to the Vim default value when 'compatible' is reset.
7811
7812 *'wildcharm'* *'wcm'*
7813'wildcharm' 'wcm' number (default: none (0))
7814 global
7815 {not in Vi}
7816 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007817 recognized when used inside a macro. You can find "spare" command-line
7818 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 you'll never actually type 'wildcharm', just use it in mappings that
7820 automatically invoke completion mode, e.g.: >
7821 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007822 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823< Then after typing :ss you can use CTRL-P & CTRL-N.
7824
7825 *'wildignore'* *'wig'*
7826'wildignore' 'wig' string (default "")
7827 global
7828 {not in Vi}
7829 {not available when compiled without the |+wildignore|
7830 feature}
7831 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007832 patterns is ignored when completing file or directory names, and
7833 influences the result of |expand()|, |glob()| and |globpath()| unless
7834 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7836 Also see 'suffixes'.
7837 Example: >
7838 :set wildignore=*.o,*.obj
7839< The use of |:set+=| and |:set-=| is preferred when adding or removing
7840 a pattern from the list. This avoids problems when a future version
7841 uses another default.
7842
Bram Moolenaar94950a92010-12-02 16:01:29 +01007843
Bram Moolenaar81af9252010-12-10 20:35:50 +01007844 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007845'wildignorecase' 'wic' boolean (default off)
7846 global
7847 {not in Vi}
7848 When set case is ignored when completing file names and directories.
7849 Has no effect on systems where file name case is generally ignored.
7850 Does not apply when the shell is used to expand wildcards, which
7851 happens when there are special characters.
7852
7853
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7855'wildmenu' 'wmnu' boolean (default off)
7856 global
7857 {not in Vi}
7858 {not available if compiled without the |+wildmenu|
7859 feature}
7860 When 'wildmenu' is on, command-line completion operates in an enhanced
7861 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7862 the possible matches are shown just above the command line, with the
7863 first match highlighted (overwriting the status line, if there is
7864 one). Keys that show the previous/next match, such as <Tab> or
7865 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7866 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7867 specified. "longest" and "list" do not start "wildmenu" mode.
7868 If there are more matches than can fit in the line, a ">" is shown on
7869 the right and/or a "<" is shown on the left. The status line scrolls
7870 as needed.
7871 The "wildmenu" mode is abandoned when a key is hit that is not used
7872 for selecting a completion.
7873 While the "wildmenu" is active the following keys have special
7874 meanings:
7875
7876 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7877 <Down> - in filename/menu name completion: move into a
7878 subdirectory or submenu.
7879 <CR> - in menu completion, when the cursor is just after a
7880 dot: move into a submenu.
7881 <Up> - in filename/menu name completion: move up into
7882 parent directory or parent menu.
7883
7884 This makes the menus accessible from the console |console-menus|.
7885
7886 If you prefer the <Left> and <Right> keys to move the cursor instead
7887 of selecting a different match, use this: >
7888 :cnoremap <Left> <Space><BS><Left>
7889 :cnoremap <Right> <Space><BS><Right>
7890<
7891 The "WildMenu" highlighting is used for displaying the current match
7892 |hl-WildMenu|.
7893
7894 *'wildmode'* *'wim'*
7895'wildmode' 'wim' string (Vim default: "full")
7896 global
7897 {not in Vi}
7898 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007899 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007900 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 first part specifies the behavior for the first use of 'wildchar',
7902 The second part for the second use, etc.
7903 These are the possible values for each part:
7904 "" Complete only the first match.
7905 "full" Complete the next full match. After the last match,
7906 the original string is used and then the first match
7907 again.
7908 "longest" Complete till longest common string. If this doesn't
7909 result in a longer string, use the next part.
7910 "longest:full" Like "longest", but also start 'wildmenu' if it is
7911 enabled.
7912 "list" When more than one match, list all matches.
7913 "list:full" When more than one match, list all matches and
7914 complete first match.
7915 "list:longest" When more than one match, list all matches and
7916 complete till longest common string.
7917 When there is only a single match, it is fully completed in all cases.
7918
7919 Examples: >
7920 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007921< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 :set wildmode=longest,full
7923< Complete longest common string, then each full match >
7924 :set wildmode=list:full
7925< List all matches and complete each full match >
7926 :set wildmode=list,full
7927< List all matches without completing, then each full match >
7928 :set wildmode=longest,list
7929< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007930 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007932 *'wildoptions'* *'wop'*
7933'wildoptions' 'wop' string (default "")
7934 global
7935 {not in Vi}
7936 {not available when compiled without the |+wildignore|
7937 feature}
7938 A list of words that change how command line completion is done.
7939 Currently only one word is allowed:
7940 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007941 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007942 is displayed per line. Often used tag kinds are:
7943 d #define
7944 f function
7945 Also see |cmdline-completion|.
7946
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 *'winaltkeys'* *'wak'*
7948'winaltkeys' 'wak' string (default "menu")
7949 global
7950 {not in Vi}
7951 {only used in Win32, Motif, GTK and Photon GUI}
7952 Some GUI versions allow the access to menu entries by using the ALT
7953 key in combination with a character that appears underlined in the
7954 menu. This conflicts with the use of the ALT key for mappings and
7955 entering special characters. This option tells what to do:
7956 no Don't use ALT keys for menus. ALT key combinations can be
7957 mapped, but there is no automatic handling. This can then be
7958 done with the |:simalt| command.
7959 yes ALT key handling is done by the windowing system. ALT key
7960 combinations cannot be mapped.
7961 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007962 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 keys can be mapped.
7964 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7965 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007966 This option is not used for <F10>; on Win32 and with GTK <F10> will
7967 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007969 *'window'* *'wi'*
7970'window' 'wi' number (default screen height - 1)
7971 global
7972 Window height. Do not confuse this with the height of the Vim window,
7973 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007974 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7975 value is smaller than 'lines' minus one. The screen will scroll
7976 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007977 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7978 in a much smarter way, taking care of wrapping lines.
7979 When resizing the Vim window, the value is smaller than 1 or more than
7980 or equal to 'lines' it will be set to 'lines' minus 1.
7981 {Vi also uses the option to specify the number of displayed lines}
7982
Bram Moolenaar071d4272004-06-13 20:20:40 +00007983 *'winheight'* *'wh'* *E591*
7984'winheight' 'wh' number (default 1)
7985 global
7986 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007987 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 feature}
7989 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007990 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007991 focus goes to a window that is smaller, its size is increased, at the
7992 cost of the height of other windows.
7993 Set 'winheight' to a small number for normal editing.
7994 Set it to 999 to make the current window fill most of the screen.
7995 Other windows will be only 'winminheight' high. This has the drawback
7996 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7997 to create only two windows, set the option after startup is done,
7998 using the |VimEnter| event: >
7999 au VimEnter * set winheight=999
8000< Minimum value is 1.
8001 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 height of the current window.
8003 'winheight' applies to the current window. Use 'winminheight' to set
8004 the minimal height for other windows.
8005
8006 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8007'winfixheight' 'wfh' boolean (default off)
8008 local to window
8009 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008010 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 feature}
8012 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008013 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8014 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 The height may be changed anyway when running out of room.
8016
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008017 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8018'winfixwidth' 'wfw' boolean (default off)
8019 local to window
8020 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008021 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008022 feature}
8023 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008024 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008025 The width may be changed anyway when running out of room.
8026
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 *'winminheight'* *'wmh'*
8028'winminheight' 'wmh' number (default 1)
8029 global
8030 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008031 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 feature}
8033 The minimal height of a window, when it's not the current window.
8034 This is a hard minimum, windows will never become smaller.
8035 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8036 status bar) if necessary. They will return to at least one line when
8037 they become active (since the cursor has to have somewhere to go.)
8038 Use 'winheight' to set the minimal height of the current window.
8039 This option is only checked when making a window smaller. Don't use a
8040 large number, it will cause errors when opening more than a few
8041 windows. A value of 0 to 3 is reasonable.
8042
8043 *'winminwidth'* *'wmw'*
8044'winminwidth' 'wmw' number (default 1)
8045 global
8046 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008047 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008048 feature}
8049 The minimal width of a window, when it's not the current window.
8050 This is a hard minimum, windows will never become smaller.
8051 When set to zero, windows may be "squashed" to zero columns (i.e. just
8052 a vertical separator) if necessary. They will return to at least one
8053 line when they become active (since the cursor has to have somewhere
8054 to go.)
8055 Use 'winwidth' to set the minimal width of the current window.
8056 This option is only checked when making a window smaller. Don't use a
8057 large number, it will cause errors when opening more than a few
8058 windows. A value of 0 to 12 is reasonable.
8059
8060 *'winwidth'* *'wiw'* *E592*
8061'winwidth' 'wiw' number (default 20)
8062 global
8063 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008064 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 feature}
8066 Minimal number of columns for the current window. This is not a hard
8067 minimum, Vim will use fewer columns if there is not enough room. If
8068 the current window is smaller, its size is increased, at the cost of
8069 the width of other windows. Set it to 999 to make the current window
8070 always fill the screen. Set it to a small number for normal editing.
8071 The width is not adjusted after one of the commands to change the
8072 width of the current window.
8073 'winwidth' applies to the current window. Use 'winminwidth' to set
8074 the minimal width for other windows.
8075
8076 *'wrap'* *'nowrap'*
8077'wrap' boolean (default on)
8078 local to window
8079 {not in Vi}
8080 This option changes how text is displayed. It doesn't change the text
8081 in the buffer, see 'textwidth' for that.
8082 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008083 displaying continues on the next line. When off lines will not wrap
8084 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 moved to a part that is not shown, the screen will scroll
8086 horizontally.
8087 The line will be broken in the middle of a word if necessary. See
8088 'linebreak' to get the break at a word boundary.
8089 To make scrolling horizontally a bit more useful, try this: >
8090 :set sidescroll=5
8091 :set listchars+=precedes:<,extends:>
8092< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008093 This option can't be set from a |modeline| when the 'diff' option is
8094 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008095
8096 *'wrapmargin'* *'wm'*
8097'wrapmargin' 'wm' number (default 0)
8098 local to buffer
8099 Number of characters from the right window border where wrapping
8100 starts. When typing text beyond this limit, an <EOL> will be inserted
8101 and inserting continues on the next line.
8102 Options that add a margin, such as 'number' and 'foldcolumn', cause
8103 the text width to be further reduced. This is Vi compatible.
8104 When 'textwidth' is non-zero, this option is not used.
8105 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8106 and less usefully}
8107
8108 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8109'wrapscan' 'ws' boolean (default on) *E384* *E385*
8110 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008111 Searches wrap around the end of the file. Also applies to |]s| and
8112 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113
8114 *'write'* *'nowrite'*
8115'write' boolean (default on)
8116 global
8117 {not in Vi}
8118 Allows writing files. When not set, writing a file is not allowed.
8119 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008120 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 argument. Filtering text is still possible, even though this requires
8122 writing a temporary file.
8123
8124 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8125'writeany' 'wa' boolean (default off)
8126 global
8127 Allows writing to any file with no need for "!" override.
8128
8129 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8130'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8131 otherwise)
8132 global
8133 {not in Vi}
8134 Make a backup before overwriting a file. The backup is removed after
8135 the file was successfully written, unless the 'backup' option is
8136 also on. Reset this option if your file system is almost full. See
8137 |backup-table| for another explanation.
8138 When the 'backupskip' pattern matches, a backup is not made anyway.
8139 NOTE: This option is set to the default value when 'compatible' is
8140 set.
8141
8142 *'writedelay'* *'wd'*
8143'writedelay' 'wd' number (default 0)
8144 global
8145 {not in Vi}
8146 The number of microseconds to wait for each character sent to the
8147 screen. When non-zero, characters are sent to the terminal one by
8148 one. For MS-DOS pcterm this does not work. For debugging purposes.
8149
8150 vim:tw=78:ts=8:ft=help:norl: