blob: b5360edb332b38d396144383b9f2bb7ae45d457d [file] [log] [blame]
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02001*options.txt* For Vim version 7.3. Last change: 2012 Apr 28
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,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003775 M:ModeMsg,n:LineNr,N:CursorLineNr,
3776 r:Question,s:StatusLine,S:StatusLineNC,
3777 c:VertSplit, t:Title,v:Visual,
3778 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 f:Folded,F:FoldColumn,A:DiffAdd,
3780 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003781 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003782 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003783 +:Pmenu,=:PmenuSel,
3784 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 global
3786 {not in Vi}
3787 This option can be used to set highlighting mode for various
3788 occasions. It is a comma separated list of character pairs. The
3789 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003790 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3792 |hl-NonText| @ '~' and '@' at the end of the window and
3793 characters from 'showbreak'
3794 |hl-Directory| d directories in CTRL-D listing and other special
3795 things in listings
3796 |hl-ErrorMsg| e error messages
3797 h (obsolete, ignored)
3798 |hl-IncSearch| i 'incsearch' highlighting
3799 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3800 |hl-MoreMsg| m |more-prompt|
3801 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003802 |hl-LineNr| n line number for ":number" and ":#" commands, and
3803 when 'number' or 'relativenumber' option is set.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003804 |hl-CursorLineNr| N like n for when 'cursorline' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 |hl-Question| r |hit-enter| prompt and yes/no questions
3806 |hl-StatusLine| s status line of current window |status-line|
3807 |hl-StatusLineNC| S status lines of not-current windows
3808 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3809 |hl-VertSplit| c column used to separate vertically split windows
3810 |hl-Visual| v Visual mode
3811 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3812 Selection" Only X11 Gui's |gui-x11| and
3813 |xterm-clipboard|.
3814 |hl-WarningMsg| w warning messages
3815 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3816 |hl-Folded| f line used for closed folds
3817 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003818 |hl-DiffAdd| A added line in diff mode
3819 |hl-DiffChange| C changed line in diff mode
3820 |hl-DiffDelete| D deleted line in diff mode
3821 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003823 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003824 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003825 |hl-SpellRare| R rare word |spell|
3826 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003827 |hl-Conceal| - the placeholders used for concealed characters
3828 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003829 |hl-Pmenu| + popup menu normal line
3830 |hl-PmenuSel| = popup menu normal line
3831 |hl-PmenuSbar| x popup menu scrollbar
3832 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833
3834 The display modes are:
3835 r reverse (termcap entry "mr" and "me")
3836 i italic (termcap entry "ZH" and "ZR")
3837 b bold (termcap entry "md" and "me")
3838 s standout (termcap entry "so" and "se")
3839 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003840 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 n no highlighting
3842 - no highlighting
3843 : use a highlight group
3844 The default is used for occasions that are not included.
3845 If you want to change what the display modes do, see |dos-colors|
3846 for an example.
3847 When using the ':' display mode, this must be followed by the name of
3848 a highlight group. A highlight group can be used to define any type
3849 of highlighting, including using color. See |:highlight| on how to
3850 define one. The default uses a different group for each occasion.
3851 See |highlight-default| for the default highlight groups.
3852
3853 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3854'hlsearch' 'hls' boolean (default off)
3855 global
3856 {not in Vi}
3857 {not available when compiled without the
3858 |+extra_search| feature}
3859 When there is a previous search pattern, highlight all its matches.
3860 The type of highlighting used can be set with the 'l' occasion in the
3861 'highlight' option. This uses the "Search" highlight group by
3862 default. Note that only the matching text is highlighted, any offsets
3863 are not applied.
3864 See also: 'incsearch' and |:match|.
3865 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003866 off with |:nohlsearch|. This does not change the option value, as
3867 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003868 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 When the search pattern can match an end-of-line, Vim will try to
3870 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003871 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003873 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003874 You can specify whether the highlight status is restored on startup
3875 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 NOTE: This option is reset when 'compatible' is set.
3877
3878 *'history'* *'hi'*
3879'history' 'hi' number (Vim default: 20, Vi default: 0)
3880 global
3881 {not in Vi}
3882 A history of ":" commands, and a history of previous search patterns
3883 are remembered. This option decides how many entries may be stored in
3884 each of these histories (see |cmdline-editing|).
3885 NOTE: This option is set to the Vi default value when 'compatible' is
3886 set and to the Vim default value when 'compatible' is reset.
3887
3888 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3889'hkmap' 'hk' boolean (default off)
3890 global
3891 {not in Vi}
3892 {only available when compiled with the |+rightleft|
3893 feature}
3894 When on, the keyboard is mapped for the Hebrew character set.
3895 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3896 toggle this option. See |rileft.txt|.
3897 NOTE: This option is reset when 'compatible' is set.
3898
3899 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3900'hkmapp' 'hkp' boolean (default off)
3901 global
3902 {not in Vi}
3903 {only available when compiled with the |+rightleft|
3904 feature}
3905 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3906 This is useful if you have a non-Hebrew keyboard.
3907 See |rileft.txt|.
3908 NOTE: This option is reset when 'compatible' is set.
3909
3910 *'icon'* *'noicon'*
3911'icon' boolean (default off, on when title can be restored)
3912 global
3913 {not in Vi}
3914 {not available when compiled without the |+title|
3915 feature}
3916 When on, the icon text of the window will be set to the value of
3917 'iconstring' (if it is not empty), or to the name of the file
3918 currently being edited. Only the last part of the name is used.
3919 Overridden by the 'iconstring' option.
3920 Only works if the terminal supports setting window icons (currently
3921 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3922 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3923 builtin termcap).
3924 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003925 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 X11.
3927
3928 *'iconstring'*
3929'iconstring' string (default "")
3930 global
3931 {not in Vi}
3932 {not available when compiled without the |+title|
3933 feature}
3934 When this option is not empty, it will be used for the icon text of
3935 the window. This happens only when the 'icon' option is on.
3936 Only works if the terminal supports setting window icon text
3937 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3938 Does not work for MS Windows.
3939 When Vim was compiled with HAVE_X11 defined, the original icon will be
3940 restored if possible |X11|.
3941 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003942 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 'titlestring' for example settings.
3944 {not available when compiled without the |+statusline| feature}
3945
3946 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3947'ignorecase' 'ic' boolean (default off)
3948 global
3949 Ignore case in search patterns. Also used when searching in the tags
3950 file.
3951 Also see 'smartcase'.
3952 Can be overruled by using "\c" or "\C" in the pattern, see
3953 |/ignorecase|.
3954
3955 *'imactivatekey'* *'imak'*
3956'imactivatekey' 'imak' string (default "")
3957 global
3958 {not in Vi}
3959 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003960 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 Specifies the key that your Input Method in X-Windows uses for
3962 activation. When this is specified correctly, vim can fully control
3963 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3964 You can't use this option to change the activation key, the option
3965 tells Vim what the key is.
3966 Format:
3967 [MODIFIER_FLAG-]KEY_STRING
3968
3969 These characters can be used for MODIFIER_FLAG (case is ignored):
3970 S Shift key
3971 L Lock key
3972 C Control key
3973 1 Mod1 key
3974 2 Mod2 key
3975 3 Mod3 key
3976 4 Mod4 key
3977 5 Mod5 key
3978 Combinations are allowed, for example "S-C-space" or "SC-space" are
3979 both shift+ctrl+space.
3980 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3981
3982 Example: >
3983 :set imactivatekey=S-space
3984< "S-space" means shift+space. This is the activation key for kinput2 +
3985 canna (Japanese), and ami (Korean).
3986
3987 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3988'imcmdline' 'imc' boolean (default off)
3989 global
3990 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003991 {only available when compiled with the |+xim|,
3992 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 When set the Input Method is always on when starting to edit a command
3994 line, unless entering a search pattern (see 'imsearch' for that).
3995 Setting this option is useful when your input method allows entering
3996 English characters directly, e.g., when it's used to type accented
3997 characters with dead keys.
3998
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003999 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4001 global
4002 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004003 {only available when compiled with the |+xim|,
4004 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 When set the Input Method is never used. This is useful to disable
4006 the IM when it doesn't work properly.
4007 Currently this option is on by default for SGI/IRIX machines. This
4008 may change in later releases.
4009
4010 *'iminsert'* *'imi'*
4011'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4012 local to buffer
4013 {not in Vi}
4014 Specifies whether :lmap or an Input Method (IM) is to be used in
4015 Insert mode. Valid values:
4016 0 :lmap is off and IM is off
4017 1 :lmap is ON and IM is off
4018 2 :lmap is off and IM is ON
4019 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4020 or |global-ime|.
4021 To always reset the option to zero when leaving Insert mode with <Esc>
4022 this can be used: >
4023 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4024< This makes :lmap and IM turn off automatically when leaving Insert
4025 mode.
4026 Note that this option changes when using CTRL-^ in Insert mode
4027 |i_CTRL-^|.
4028 The value is set to 1 when setting 'keymap' to a valid keymap name.
4029 It is also used for the argument of commands like "r" and "f".
4030 The value 0 may not work correctly with Athena and Motif with some XIM
4031 methods. Use 'imdisable' to disable XIM then.
4032
4033 *'imsearch'* *'ims'*
4034'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4035 local to buffer
4036 {not in Vi}
4037 Specifies whether :lmap or an Input Method (IM) is to be used when
4038 entering a search pattern. Valid values:
4039 -1 the value of 'iminsert' is used, makes it look like
4040 'iminsert' is also used when typing a search pattern
4041 0 :lmap is off and IM is off
4042 1 :lmap is ON and IM is off
4043 2 :lmap is off and IM is ON
4044 Note that this option changes when using CTRL-^ in Command-line mode
4045 |c_CTRL-^|.
4046 The value is set to 1 when it is not -1 and setting the 'keymap'
4047 option to a valid keymap name.
4048 The value 0 may not work correctly with Athena and Motif with some XIM
4049 methods. Use 'imdisable' to disable XIM then.
4050
4051 *'include'* *'inc'*
4052'include' 'inc' string (default "^\s*#\s*include")
4053 global or local to buffer |global-local|
4054 {not in Vi}
4055 {not available when compiled without the
4056 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004057 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058 pattern, just like for the "/" command (See |pattern|). The default
4059 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004060 "]I", "[d", etc.
4061 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004062 comes after the matched pattern. But if "\zs" appears in the pattern
4063 then the text matched from "\zs" to the end, or until "\ze" if it
4064 appears, is used as the file name. Use this to include characters
4065 that are not in 'isfname', such as a space. You can then use
4066 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004067 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068
4069 *'includeexpr'* *'inex'*
4070'includeexpr' 'inex' string (default "")
4071 local to buffer
4072 {not in Vi}
4073 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004074 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004076 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 :set includeexpr=substitute(v:fname,'\\.','/','g')
4078< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004079
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004081 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 Also used for |<cfile>|.
4083
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004084 The expression may be evaluated in the |sandbox|, see
4085 |sandbox-option|.
4086
4087 It is not allowed to change text or jump to another window while
4088 evaluating 'includeexpr' |textlock|.
4089
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4091'incsearch' 'is' boolean (default off)
4092 global
4093 {not in Vi}
4094 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004095 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004096 While typing a search command, show where the pattern, as it was typed
4097 so far, matches. The matched string is highlighted. If the pattern
4098 is invalid or not found, nothing is shown. The screen will be updated
4099 often, this is only useful on fast terminals.
4100 Note that the match will be shown, but the cursor will return to its
4101 original position when no match is found and when pressing <Esc>. You
4102 still need to finish the search command with <Enter> to move the
4103 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004104 When compiled with the |+reltime| feature Vim only searches for about
4105 half a second. With a complicated pattern and/or a lot of text the
4106 match may not be found. This is to avoid that Vim hangs while you
4107 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004108 The highlighting can be set with the 'i' flag in 'highlight'.
4109 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004110 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004111 to the command line. If 'ignorecase' and 'smartcase' are set and the
4112 command line has no uppercase characters, the added character is
4113 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004114 CTRL-R CTRL-W can be used to add the word at the end of the current
4115 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 NOTE: This option is reset when 'compatible' is set.
4117
4118 *'indentexpr'* *'inde'*
4119'indentexpr' 'inde' string (default "")
4120 local to buffer
4121 {not in Vi}
4122 {not available when compiled without the |+cindent|
4123 or |+eval| features}
4124 Expression which is evaluated to obtain the proper indent for a line.
4125 It is used when a new line is created, for the |=| operator and
4126 in Insert mode as specified with the 'indentkeys' option.
4127 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004128 'smartindent' indenting. When 'lisp' is set, this option is
4129 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 When 'paste' is set this option is not used for indenting.
4131 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004132 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 when the expression is evaluated (but it may be moved around).
4134 The expression must return the number of spaces worth of indent. It
4135 can return "-1" to keep the current indent (this means 'autoindent' is
4136 used for the indent).
4137 Functions useful for computing the indent are |indent()|, |cindent()|
4138 and |lispindent()|.
4139 The evaluation of the expression must not have side effects! It must
4140 not change the text, jump to another window, etc. Afterwards the
4141 cursor position is always restored, thus the cursor may be moved.
4142 Normally this option would be set to call a function: >
4143 :set indentexpr=GetMyIndent()
4144< Error messages will be suppressed, unless the 'debug' option contains
4145 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004146 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 NOTE: This option is made empty when 'compatible' is set.
4148
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004149 The expression may be evaluated in the |sandbox|, see
4150 |sandbox-option|.
4151
4152 It is not allowed to change text or jump to another window while
4153 evaluating 'indentexpr' |textlock|.
4154
4155
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 *'indentkeys'* *'indk'*
4157'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4158 local to buffer
4159 {not in Vi}
4160 {not available when compiled without the |+cindent|
4161 feature}
4162 A list of keys that, when typed in Insert mode, cause reindenting of
4163 the current line. Only happens if 'indentexpr' isn't empty.
4164 The format is identical to 'cinkeys', see |indentkeys-format|.
4165 See |C-indenting| and |indent-expression|.
4166
4167 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4168'infercase' 'inf' boolean (default off)
4169 local to buffer
4170 {not in Vi}
4171 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004172 'ignorecase' is also on, the case of the match is adjusted depending
4173 on the typed text. If the typed text contains a lowercase letter
4174 where the match has an upper case letter, the completed part is made
4175 lowercase. If the typed text has no lowercase letters and the match
4176 has a lowercase letter where the typed text has an uppercase letter,
4177 and there is a letter before it, the completed part is made uppercase.
4178 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179
4180 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4181'insertmode' 'im' boolean (default off)
4182 global
4183 {not in Vi}
4184 Makes Vim work in a way that Insert mode is the default mode. Useful
4185 if you want to use Vim as a modeless editor. Used for |evim|.
4186 These Insert mode commands will be useful:
4187 - Use the cursor keys to move around.
4188 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4189 this is a mapping, it is executed as if 'insertmode' was off.
4190 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004192 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4193 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194
4195 These items change when 'insertmode' is set:
4196 - when starting to edit of a file, Vim goes to Insert mode.
4197 - <Esc> in Insert mode is a no-op and beeps.
4198 - <Esc> in Normal mode makes Vim go to Insert mode.
4199 - CTRL-L in Insert mode is a command, it is not inserted.
4200 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4201 However, when <Esc> is used inside a mapping, it behaves like
4202 'insertmode' was not set. This was done to be able to use the same
4203 mappings with 'insertmode' set or not set.
4204 When executing commands with |:normal| 'insertmode' is not used.
4205
4206 NOTE: This option is reset when 'compatible' is set.
4207
4208 *'isfname'* *'isf'*
4209'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4210 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4211 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4212 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4213 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4214 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4215 global
4216 {not in Vi}
4217 The characters specified by this option are included in file names and
4218 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004219 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 Multi-byte characters 256 and above are always included, only the
4221 characters up to 255 are specified with this option.
4222 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004223 Think twice before adding white space to this option. Although a
4224 space may appear inside a file name, the effect will be that Vim
4225 doesn't know where a file name starts or ends when doing completion.
4226 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227
4228 Note that on systems using a backslash as path separator, Vim tries to
4229 do its best to make it work as you would expect. That is a bit
4230 tricky, since Vi originally used the backslash to escape special
4231 characters. Vim will not remove a backslash in front of a normal file
4232 name character on these systems, but it will on Unix and alikes. The
4233 '&' and '^' are not included by default, because these are special for
4234 cmd.exe.
4235
4236 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004237 Each part can be a single character number or a range. A range is two
4238 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239 decimal number between 0 and 255 or the ASCII character itself (does
4240 not work for digits). Example:
4241 "_,-,128-140,#-43" (include '_' and '-' and the range
4242 128 to 140 and '#' to 43)
4243 If a part starts with '^', the following character number or range
4244 will be excluded from the option. The option is interpreted from left
4245 to right. Put the excluded character after the range where it is
4246 included. To include '^' itself use it as the last character of the
4247 option or the end of a range. Example:
4248 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4249 If the character is '@', all characters where isalpha() returns TRUE
4250 are included. Normally these are the characters a to z and A to Z,
4251 plus accented characters. To include '@' itself use "@-@". Examples:
4252 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004253 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 "a-z,A-Z,@-@" All letters plus the '@' character.
4255 A comma can be included by using it where a character number is
4256 expected. Example:
4257 "48-57,,,_" Digits, comma and underscore.
4258 A comma can be excluded by prepending a '^'. Example:
4259 " -~,^,,9" All characters from space to '~', excluding
4260 comma, plus <Tab>.
4261 See |option-backslash| about including spaces and backslashes.
4262
4263 *'isident'* *'isi'*
4264'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4265 "@,48-57,_,128-167,224-235"
4266 otherwise: "@,48-57,_,192-255")
4267 global
4268 {not in Vi}
4269 The characters given by this option are included in identifiers.
4270 Identifiers are used in recognizing environment variables and after a
4271 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004272 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 option.
4274 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004275 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4277
4278 *'iskeyword'* *'isk'*
4279'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4280 "@,48-57,_,128-167,224-235"
4281 otherwise: "@,48-57,_,192-255"
4282 Vi default: "@,48-57,_")
4283 local to buffer
4284 {not in Vi}
4285 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004286 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 'isfname' for a description of the format of this option. For C
4288 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4289 For a help file it is set to all non-blank printable characters except
4290 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4291 command).
4292 When the 'lisp' option is on the '-' character is always included.
4293 NOTE: This option is set to the Vi default value when 'compatible' is
4294 set and to the Vim default value when 'compatible' is reset.
4295
4296 *'isprint'* *'isp'*
4297'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4298 "@,~-255"; otherwise: "@,161-255")
4299 global
4300 {not in Vi}
4301 The characters given by this option are displayed directly on the
4302 screen. It is also used for "\p" in a |pattern|. The characters from
4303 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4304 even when they are not included in 'isprint' or excluded. See
4305 'isfname' for a description of the format of this option.
4306
4307 Non-printable characters are displayed with two characters:
4308 0 - 31 "^@" - "^_"
4309 32 - 126 always single characters
4310 127 "^?"
4311 128 - 159 "~@" - "~_"
4312 160 - 254 "| " - "|~"
4313 255 "~?"
4314 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4315 displayed as <xx>, with the hexadecimal value of the byte.
4316 When 'display' contains "uhex" all unprintable characters are
4317 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004318 The SpecialKey highlighting will be used for unprintable characters.
4319 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320
4321 Multi-byte characters 256 and above are always included, only the
4322 characters up to 255 are specified with this option. When a character
4323 is printable but it is not available in the current font, a
4324 replacement character will be shown.
4325 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4326 There is no option to specify these characters.
4327
4328 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4329'joinspaces' 'js' boolean (default on)
4330 global
4331 {not in Vi}
4332 Insert two spaces after a '.', '?' and '!' with a join command.
4333 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4334 Otherwise only one space is inserted.
4335 NOTE: This option is set when 'compatible' is set.
4336
4337 *'key'*
4338'key' string (default "")
4339 local to buffer
4340 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004341 {only available when compiled with the |+cryptv|
4342 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004344 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 Careful: Do not set the key value by hand, someone might see the typed
4346 key. Use the |:X| command. But you can make 'key' empty: >
4347 :set key=
4348< It is not possible to get the value of this option with ":set key" or
4349 "echo &key". This is to avoid showing it to someone who shouldn't
4350 know. It also means you cannot see it yourself once you have set it,
4351 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004352 You can use "&key" in an expression to detect whether encryption is
4353 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354
4355 *'keymap'* *'kmp'* *E544*
4356'keymap' 'kmp' string (default "")
4357 local to buffer
4358 {not in Vi}
4359 {only available when compiled with the |+keymap|
4360 feature}
4361 Name of a keyboard mapping. See |mbyte-keymap|.
4362 Setting this option to a valid keymap name has the side effect of
4363 setting 'iminsert' to one, so that the keymap becomes effective.
4364 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004365 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366
4367 *'keymodel'* *'km'*
4368'keymodel' 'km' string (default "")
4369 global
4370 {not in Vi}
4371 List of comma separated words, which enable special things that keys
4372 can do. These values can be used:
4373 startsel Using a shifted special key starts selection (either
4374 Select mode or Visual mode, depending on "key" being
4375 present in 'selectmode').
4376 stopsel Using a not-shifted special key stops selection.
4377 Special keys in this context are the cursor keys, <End>, <Home>,
4378 <PageUp> and <PageDown>.
4379 The 'keymodel' option is set by the |:behave| command.
4380
4381 *'keywordprg'* *'kp'*
4382'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4383 OS/2: "view /", VMS: "help")
4384 global or local to buffer |global-local|
4385 {not in Vi}
4386 Program to use for the |K| command. Environment variables are
4387 expanded |:set_env|. ":help" may be used to access the Vim internal
4388 help. (Note that previously setting the global option to the empty
4389 value did this, which is now deprecated.)
4390 When "man" is used, Vim will automatically translate a count for the
4391 "K" command to a section number. Also for "man -s", in which case the
4392 "-s" is removed when there is no count.
4393 See |option-backslash| about including spaces and backslashes.
4394 Example: >
4395 :set keywordprg=man\ -s
4396< This option cannot be set from a |modeline| or in the |sandbox|, for
4397 security reasons.
4398
4399 *'langmap'* *'lmap'* *E357* *E358*
4400'langmap' 'lmap' string (default "")
4401 global
4402 {not in Vi}
4403 {only available when compiled with the |+langmap|
4404 feature}
4405 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004406 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 inserted directly. When in command mode the 'langmap' option takes
4408 care of translating these special characters to the original meaning
4409 of the key. This means you don't have to change the keyboard mode to
4410 be able to execute Normal mode commands.
4411 This is the opposite of the 'keymap' option, where characters are
4412 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004414 Example (for Greek, in UTF-8): *greek* >
4415 :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 +00004416< Example (exchanges meaning of z and y for commands): >
4417 :set langmap=zy,yz,ZY,YZ
4418<
4419 The 'langmap' option is a list of parts, separated with commas. Each
4420 part can be in one of two forms:
4421 1. A list of pairs. Each pair is a "from" character immediately
4422 followed by the "to" character. Examples: "aA", "aAbBcC".
4423 2. A list of "from" characters, a semi-colon and a list of "to"
4424 characters. Example: "abc;ABC"
4425 Example: "aA,fgh;FGH,cCdDeE"
4426 Special characters need to be preceded with a backslash. These are
4427 ";", ',' and backslash itself.
4428
4429 This will allow you to activate vim actions without having to switch
4430 back and forth between the languages. Your language characters will
4431 be understood as normal vim English characters (according to the
4432 langmap mappings) in the following cases:
4433 o Normal/Visual mode (commands, buffer/register names, user mappings)
4434 o Insert/Replace Mode: Register names after CTRL-R
4435 o Insert/Replace Mode: Mappings
4436 Characters entered in Command-line mode will NOT be affected by
4437 this option. Note that this option can be changed at any time
4438 allowing to switch between mappings for different languages/encodings.
4439 Use a mapping to avoid having to type it each time!
4440
4441 *'langmenu'* *'lm'*
4442'langmenu' 'lm' string (default "")
4443 global
4444 {not in Vi}
4445 {only available when compiled with the |+menu| and
4446 |+multi_lang| features}
4447 Language to use for menu translation. Tells which file is loaded
4448 from the "lang" directory in 'runtimepath': >
4449 "lang/menu_" . &langmenu . ".vim"
4450< (without the spaces). For example, to always use the Dutch menus, no
4451 matter what $LANG is set to: >
4452 :set langmenu=nl_NL.ISO_8859-1
4453< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004454 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 If your $LANG is set to a non-English language but you do want to use
4456 the English menus: >
4457 :set langmenu=none
4458< This option must be set before loading menus, switching on filetype
4459 detection or syntax highlighting. Once the menus are defined setting
4460 this option has no effect. But you could do this: >
4461 :source $VIMRUNTIME/delmenu.vim
4462 :set langmenu=de_DE.ISO_8859-1
4463 :source $VIMRUNTIME/menu.vim
4464< Warning: This deletes all menus that you defined yourself!
4465
4466 *'laststatus'* *'ls'*
4467'laststatus' 'ls' number (default 1)
4468 global
4469 {not in Vi}
4470 The value of this option influences when the last window will have a
4471 status line:
4472 0: never
4473 1: only if there are at least two windows
4474 2: always
4475 The screen looks nicer with a status line if you have several
4476 windows, but it takes another screen line. |status-line|
4477
4478 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4479'lazyredraw' 'lz' boolean (default off)
4480 global
4481 {not in Vi}
4482 When this option is set, the screen will not be redrawn while
4483 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004484 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 update use |:redraw|.
4486
4487 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4488'linebreak' 'lbr' boolean (default off)
4489 local to window
4490 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004491 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 feature}
4493 If on Vim will wrap long lines at a character in 'breakat' rather
4494 than at the last character that fits on the screen. Unlike
4495 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4496 it only affects the way the file is displayed, not its contents. The
4497 value of 'showbreak' is used to put in front of wrapped lines.
4498 This option is not used when the 'wrap' option is off or 'list' is on.
4499 Note that <Tab> characters after an <EOL> are mostly not displayed
4500 with the right amount of white space.
4501
4502 *'lines'* *E593*
4503'lines' number (default 24 or terminal height)
4504 global
4505 Number of lines of the Vim window.
4506 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004507 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 When Vim is running in the GUI or in a resizable window, setting this
4509 option will cause the window size to be changed. When you only want
4510 to use the size for the GUI, put the command in your |gvimrc| file.
4511 Vim limits the number of lines to what fits on the screen. You can
4512 use this command to get the tallest window possible: >
4513 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004514< Minimum value is 2, maximum value is 1000.
4515 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 When you set this option and Vim is unable to change the physical
4517 number of lines of the display, the display may be messed up.
4518
4519 *'linespace'* *'lsp'*
4520'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4521 global
4522 {not in Vi}
4523 {only in the GUI}
4524 Number of pixel lines inserted between characters. Useful if the font
4525 uses the full character cell height, making lines touch each other.
4526 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004527 With some fonts there can be too much room between lines (to have
4528 space for ascents and descents). Then it makes sense to set
4529 'linespace' to a negative value. This may cause display problems
4530 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531
4532 *'lisp'* *'nolisp'*
4533'lisp' boolean (default off)
4534 local to buffer
4535 {not available when compiled without the |+lispindent|
4536 feature}
4537 Lisp mode: When <Enter> is typed in insert mode set the indent for
4538 the next line to Lisp standards (well, sort of). Also happens with
4539 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4540 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4541 better. Also see 'lispwords'.
4542 The '-' character is included in keyword characters. Redefines the
4543 "=" operator to use this same indentation algorithm rather than
4544 calling an external program if 'equalprg' is empty.
4545 This option is not used when 'paste' is set.
4546 {Vi: Does it a little bit differently}
4547
4548 *'lispwords'* *'lw'*
4549'lispwords' 'lw' string (default is very long)
4550 global
4551 {not in Vi}
4552 {not available when compiled without the |+lispindent|
4553 feature}
4554 Comma separated list of words that influence the Lisp indenting.
4555 |'lisp'|
4556
4557 *'list'* *'nolist'*
4558'list' boolean (default off)
4559 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004560 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4561 line. Useful to see the difference between tabs and spaces and for
4562 trailing blanks. Further changed by the 'listchars' option.
4563
4564 The cursor is displayed at the start of the space a Tab character
4565 occupies, not at the end as usual in Normal mode. To get this cursor
4566 position while displaying Tabs with spaces, use: >
4567 :set list lcs=tab\ \
4568<
4569 Note that list mode will also affect formatting (set with 'textwidth'
4570 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 changing the way tabs are displayed.
4572
4573 *'listchars'* *'lcs'*
4574'listchars' 'lcs' string (default "eol:$")
4575 global
4576 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004577 Strings to use in 'list' mode and for the |:list| command. It is a
4578 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579 eol:c Character to show at the end of each line. When
4580 omitted, there is no extra character at the end of the
4581 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004582 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004584 fill the space that the tab normally occupies.
4585 "tab:>-" will show a tab that takes four spaces as
4586 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004587 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 trailing spaces are blank.
4589 extends:c Character to show in the last column, when 'wrap' is
4590 off and the line continues beyond the right of the
4591 screen.
4592 precedes:c Character to show in the first column, when 'wrap'
4593 is off and there is text preceding the character
4594 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004595 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004596 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004597 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004598 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004599
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004600 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004602 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 Examples: >
4605 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004606 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 :set lcs=extends:>,precedes:<
4608< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004609 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004610 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611
4612 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4613'loadplugins' 'lpl' boolean (default on)
4614 global
4615 {not in Vi}
4616 When on the plugin scripts are loaded when starting up |load-plugins|.
4617 This option can be reset in your |vimrc| file to disable the loading
4618 of plugins.
4619 Note that using the "-u NONE" and "--noplugin" command line arguments
4620 reset this option. |-u| |--noplugin|
4621
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004622 *'macatsui'* *'nomacatsui'*
4623'macatsui' boolean (default on)
4624 global
4625 {only available in Mac GUI version}
4626 This is a workaround for when drawing doesn't work properly. When set
4627 and compiled with multi-byte support ATSUI text drawing is used. When
4628 not set ATSUI text drawing is not used. Switch this option off when
4629 you experience drawing problems. In a future version the problems may
4630 be solved and this option becomes obsolete. Therefore use this method
4631 to unset it: >
4632 if exists('&macatsui')
4633 set nomacatsui
4634 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004635< Another option to check if you have drawing problems is
4636 'termencoding'.
4637
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 *'magic'* *'nomagic'*
4639'magic' boolean (default on)
4640 global
4641 Changes the special characters that can be used in search patterns.
4642 See |pattern|.
4643 NOTE: To avoid portability problems with using patterns, always keep
4644 this option at the default "on". Only switch it off when working with
4645 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004646 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647
4648 *'makeef'* *'mef'*
4649'makeef' 'mef' string (default: "")
4650 global
4651 {not in Vi}
4652 {not available when compiled without the |+quickfix|
4653 feature}
4654 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4655 and the |:grep| command.
4656 When it is empty, an internally generated temp file will be used.
4657 When "##" is included, it is replaced by a number to make the name
4658 unique. This makes sure that the ":make" command doesn't overwrite an
4659 existing file.
4660 NOT used for the ":cf" command. See 'errorfile' for that.
4661 Environment variables are expanded |:set_env|.
4662 See |option-backslash| about including spaces and backslashes.
4663 This option cannot be set from a |modeline| or in the |sandbox|, for
4664 security reasons.
4665
4666 *'makeprg'* *'mp'*
4667'makeprg' 'mp' string (default "make", VMS: "MMS")
4668 global or local to buffer |global-local|
4669 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004670 Program to use for the ":make" command. See |:make_makeprg|.
4671 This option may contain '%' and '#' characters, which are expanded to
4672 the current and alternate file name. |:_%| |:_#|
4673 Environment variables are expanded |:set_env|. See |option-backslash|
4674 about including spaces and backslashes.
4675 Note that a '|' must be escaped twice: once for ":set" and once for
4676 the interpretation of a command. When you use a filter called
4677 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 :set makeprg=gmake\ \\\|\ myfilter
4679< The placeholder "$*" can be given (even multiple times) to specify
4680 where the arguments will be included, for example: >
4681 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4682< This option cannot be set from a |modeline| or in the |sandbox|, for
4683 security reasons.
4684
4685 *'matchpairs'* *'mps'*
4686'matchpairs' 'mps' string (default "(:),{:},[:]")
4687 local to buffer
4688 {not in Vi}
4689 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004690 other. Currently only single byte character pairs are allowed, and
4691 they must be different. The characters must be separated by a colon.
4692 The pairs must be separated by a comma. Example for including '<' and
4693 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694 :set mps+=<:>
4695
4696< A more exotic example, to jump between the '=' and ';' in an
4697 assignment, useful for languages like C and Java: >
4698 :au FileType c,cpp,java set mps+==:;
4699
4700< For a more advanced way of using "%", see the matchit.vim plugin in
4701 the $VIMRUNTIME/macros directory. |add-local-help|
4702
4703 *'matchtime'* *'mat'*
4704'matchtime' 'mat' number (default 5)
4705 global
4706 {not in Vi}{in Nvi}
4707 Tenths of a second to show the matching paren, when 'showmatch' is
4708 set. Note that this is not in milliseconds, like other options that
4709 set a time. This is to be compatible with Nvi.
4710
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004711 *'maxcombine'* *'mco'*
4712'maxcombine' 'mco' number (default 2)
4713 global
4714 {not in Vi}
4715 {only available when compiled with the |+multi_byte|
4716 feature}
4717 The maximum number of combining characters supported for displaying.
4718 Only used when 'encoding' is "utf-8".
4719 The default is OK for most languages. Hebrew may require 4.
4720 Maximum value is 6.
4721 Even when this option is set to 2 you can still edit text with more
4722 combining characters, you just can't see them. Use |g8| or |ga|.
4723 See |mbyte-combining|.
4724
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 *'maxfuncdepth'* *'mfd'*
4726'maxfuncdepth' 'mfd' number (default 100)
4727 global
4728 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004729 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004730 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 Maximum depth of function calls for user functions. This normally
4732 catches endless recursion. When using a recursive function with
4733 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4734 more memory, there is the danger of failing when memory is exhausted.
4735 See also |:function|.
4736
4737 *'maxmapdepth'* *'mmd'* *E223*
4738'maxmapdepth' 'mmd' number (default 1000)
4739 global
4740 {not in Vi}
4741 Maximum number of times a mapping is done without resulting in a
4742 character to be used. This normally catches endless mappings, like
4743 ":map x y" with ":map y x". It still does not catch ":map g wg",
4744 because the 'w' is used before the next mapping is done. See also
4745 |key-mapping|.
4746
4747 *'maxmem'* *'mm'*
4748'maxmem' 'mm' number (default between 256 to 5120 (system
4749 dependent) or half the amount of memory
4750 available)
4751 global
4752 {not in Vi}
4753 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4754 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004755 other memory to be freed. The maximum usable value is about 2000000.
4756 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004758 *'maxmempattern'* *'mmp'*
4759'maxmempattern' 'mmp' number (default 1000)
4760 global
4761 {not in Vi}
4762 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004763 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004764 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004765 When Vim runs into the limit it gives an error message and mostly
4766 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004767 Running into the limit often means that the pattern is very
4768 inefficient or too complex. This may already happen with the pattern
4769 "\(.\)*" on a very long line. ".*" works much better.
4770 Vim may run out of memory before hitting the 'maxmempattern' limit.
4771
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 *'maxmemtot'* *'mmt'*
4773'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4774 dependent) or half the amount of memory
4775 available)
4776 global
4777 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004778 Maximum amount of memory in Kbyte to use for all buffers together.
4779 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4780 without a limit. On 64 bit machines higher values might work. But
4781 hey, do you really need more than 2 Gbyte for text editing?
4782 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783
4784 *'menuitems'* *'mis'*
4785'menuitems' 'mis' number (default 25)
4786 global
4787 {not in Vi}
4788 {not available when compiled without the |+menu|
4789 feature}
4790 Maximum number of items to use in a menu. Used for menus that are
4791 generated from a list of items, e.g., the Buffers menu. Changing this
4792 option has no direct effect, the menu must be refreshed first.
4793
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004794 *'mkspellmem'* *'msm'*
4795'mkspellmem' 'msm' string (default "460000,2000,500")
4796 global
4797 {not in Vi}
4798 {not available when compiled without the |+syntax|
4799 feature}
4800 Parameters for |:mkspell|. This tunes when to start compressing the
4801 word tree. Compression can be slow when there are many words, but
4802 it's needed to avoid running out of memory. The amount of memory used
4803 per word depends very much on how similar the words are, that's why
4804 this tuning is complicated.
4805
4806 There are three numbers, separated by commas:
4807 {start},{inc},{added}
4808
4809 For most languages the uncompressed word tree fits in memory. {start}
4810 gives the amount of memory in Kbyte that can be used before any
4811 compression is done. It should be a bit smaller than the amount of
4812 memory that is available to Vim.
4813
4814 When going over the {start} limit the {inc} number specifies the
4815 amount of memory in Kbyte that can be allocated before another
4816 compression is done. A low number means compression is done after
4817 less words are added, which is slow. A high number means more memory
4818 will be allocated.
4819
4820 After doing compression, {added} times 1024 words can be added before
4821 the {inc} limit is ignored and compression is done when any extra
4822 amount of memory is needed. A low number means there is a smaller
4823 chance of hitting the {inc} limit, less memory is used but it's
4824 slower.
4825
4826 The languages for which these numbers are important are Italian and
4827 Hungarian. The default works for when you have about 512 Mbyte. If
4828 you have 1 Gbyte you could use: >
4829 :set mkspellmem=900000,3000,800
4830< If you have less than 512 Mbyte |:mkspell| may fail for some
4831 languages, no matter what you set 'mkspellmem' to.
4832
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004834'modeline' 'ml' boolean (Vim default: on (off for root),
4835 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836 local to buffer
4837 *'modelines'* *'mls'*
4838'modelines' 'mls' number (default 5)
4839 global
4840 {not in Vi}
4841 If 'modeline' is on 'modelines' gives the number of lines that is
4842 checked for set commands. If 'modeline' is off or 'modelines' is zero
4843 no lines are checked. See |modeline|.
4844 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4845 set and to the Vim default value when 'compatible' is reset.
4846
4847 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4848'modifiable' 'ma' boolean (default on)
4849 local to buffer
4850 {not in Vi} *E21*
4851 When off the buffer contents cannot be changed. The 'fileformat' and
4852 'fileencoding' options also can't be changed.
4853 Can be reset with the |-M| command line argument.
4854
4855 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4856'modified' 'mod' boolean (default off)
4857 local to buffer
4858 {not in Vi}
4859 When on, the buffer is considered to be modified. This option is set
4860 when:
4861 1. A change was made to the text since it was last written. Using the
4862 |undo| command to go back to the original text will reset the
4863 option. But undoing changes that were made before writing the
4864 buffer will set the option again, since the text is different from
4865 when it was written.
4866 2. 'fileformat' or 'fileencoding' is different from its original
4867 value. The original value is set when the buffer is read or
4868 written. A ":set nomodified" command also resets the original
4869 values to the current values and the 'modified' option will be
4870 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004871 This option is not set when a change is made to the buffer as the
4872 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4873 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4874 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4876 will be ignored.
4877
4878 *'more'* *'nomore'*
4879'more' boolean (Vim default: on, Vi default: off)
4880 global
4881 {not in Vi}
4882 When on, listings pause when the whole screen is filled. You will get
4883 the |more-prompt|. When this option is off there are no pauses, the
4884 listing continues until finished.
4885 NOTE: This option is set to the Vi default value when 'compatible' is
4886 set and to the Vim default value when 'compatible' is reset.
4887
4888 *'mouse'* *E538*
4889'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4890 global
4891 {not in Vi}
4892 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004893 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4894 sysmouse and Linux console with gpm). For using the mouse in the
4895 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 The mouse can be enabled for different modes:
4897 n Normal mode
4898 v Visual mode
4899 i Insert mode
4900 c Command-line mode
4901 h all previous modes when editing a help file
4902 a all previous modes
4903 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 Normally you would enable the mouse in all four modes with: >
4905 :set mouse=a
4906< When the mouse is not enabled, the GUI will still use the mouse for
4907 modeless selection. This doesn't move the text cursor.
4908
4909 See |mouse-using|. Also see |'clipboard'|.
4910
4911 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004912 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 the mouse buttons can still be used by keeping the shift key pressed.
4914 Also see the 'clipboard' option.
4915
4916 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4917'mousefocus' 'mousef' boolean (default off)
4918 global
4919 {not in Vi}
4920 {only works in the GUI}
4921 The window that the mouse pointer is on is automatically activated.
4922 When changing the window layout or window focus in another way, the
4923 mouse pointer is moved to the window with keyboard focus. Off is the
4924 default because it makes using the pull down menus a little goofy, as
4925 a pointer transit may activate a window unintentionally.
4926
4927 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4928'mousehide' 'mh' boolean (default on)
4929 global
4930 {not in Vi}
4931 {only works in the GUI}
4932 When on, the mouse pointer is hidden when characters are typed.
4933 The mouse pointer is restored when the mouse is moved.
4934
4935 *'mousemodel'* *'mousem'*
4936'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4937 global
4938 {not in Vi}
4939 Sets the model to use for the mouse. The name mostly specifies what
4940 the right mouse button is used for:
4941 extend Right mouse button extends a selection. This works
4942 like in an xterm.
4943 popup Right mouse button pops up a menu. The shifted left
4944 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004945 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 popup_setpos Like "popup", but the cursor will be moved to the
4947 position where the mouse was clicked, and thus the
4948 selected operation will act upon the clicked object.
4949 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004950 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 course, that right clicking outside a selection will
4952 end Visual mode.
4953 Overview of what button does what for each model:
4954 mouse extend popup(_setpos) ~
4955 left click place cursor place cursor
4956 left drag start selection start selection
4957 shift-left search word extend selection
4958 right click extend selection popup menu (place cursor)
4959 right drag extend selection -
4960 middle click paste paste
4961
4962 In the "popup" model the right mouse button produces a pop-up menu.
4963 You need to define this first, see |popup-menu|.
4964
4965 Note that you can further refine the meaning of buttons with mappings.
4966 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4967 selection (because that's handled in the GUI code directly).
4968
4969 The 'mousemodel' option is set by the |:behave| command.
4970
4971 *'mouseshape'* *'mouses'* *E547*
4972'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004973 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 global
4975 {not in Vi}
4976 {only available when compiled with the |+mouseshape|
4977 feature}
4978 This option tells Vim what the mouse pointer should look like in
4979 different modes. The option is a comma separated list of parts, much
4980 like used for 'guicursor'. Each part consist of a mode/location-list
4981 and an argument-list:
4982 mode-list:shape,mode-list:shape,..
4983 The mode-list is a dash separated list of these modes/locations:
4984 In a normal window: ~
4985 n Normal mode
4986 v Visual mode
4987 ve Visual mode with 'selection' "exclusive" (same as 'v',
4988 if not specified)
4989 o Operator-pending mode
4990 i Insert mode
4991 r Replace mode
4992
4993 Others: ~
4994 c appending to the command-line
4995 ci inserting in the command-line
4996 cr replacing in the command-line
4997 m at the 'Hit ENTER' or 'More' prompts
4998 ml idem, but cursor in the last line
4999 e any mode, pointer below last window
5000 s any mode, pointer on a status line
5001 sd any mode, while dragging a status line
5002 vs any mode, pointer on a vertical separator line
5003 vd any mode, while dragging a vertical separator line
5004 a everywhere
5005
5006 The shape is one of the following:
5007 avail name looks like ~
5008 w x arrow Normal mouse pointer
5009 w x blank no pointer at all (use with care!)
5010 w x beam I-beam
5011 w x updown up-down sizing arrows
5012 w x leftright left-right sizing arrows
5013 w x busy The system's usual busy pointer
5014 w x no The system's usual 'no input' pointer
5015 x udsizing indicates up-down resizing
5016 x lrsizing indicates left-right resizing
5017 x crosshair like a big thin +
5018 x hand1 black hand
5019 x hand2 white hand
5020 x pencil what you write with
5021 x question big ?
5022 x rightup-arrow arrow pointing right-up
5023 w x up-arrow arrow pointing up
5024 x <number> any X11 pointer number (see X11/cursorfont.h)
5025
5026 The "avail" column contains a 'w' if the shape is available for Win32,
5027 x for X11.
5028 Any modes not specified or shapes not available use the normal mouse
5029 pointer.
5030
5031 Example: >
5032 :set mouseshape=s:udsizing,m:no
5033< will make the mouse turn to a sizing arrow over the status lines and
5034 indicate no input when the hit-enter prompt is displayed (since
5035 clicking the mouse has no effect in this state.)
5036
5037 *'mousetime'* *'mouset'*
5038'mousetime' 'mouset' number (default 500)
5039 global
5040 {not in Vi}
5041 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5042 time in msec between two mouse clicks for the second click to be
5043 recognized as a multi click.
5044
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005045 *'mzquantum'* *'mzq'*
5046'mzquantum' 'mzq' number (default 100)
5047 global
5048 {not in Vi}
5049 {not available when compiled without the |+mzscheme|
5050 feature}
5051 The number of milliseconds between polls for MzScheme threads.
5052 Negative or zero value means no thread scheduling.
5053
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 *'nrformats'* *'nf'*
5055'nrformats' 'nf' string (default "octal,hex")
5056 local to buffer
5057 {not in Vi}
5058 This defines what bases Vim will consider for numbers when using the
5059 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5060 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005061 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005063 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005064 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005066 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 considered to be hexadecimal. Example: Using CTRL-X on
5068 "0x100" results in "0x0ff".
5069 Numbers which simply begin with a digit in the range 1-9 are always
5070 considered decimal. This also happens for numbers that are not
5071 recognized as octal or hex.
5072
5073 *'number'* *'nu'* *'nonumber'* *'nonu'*
5074'number' 'nu' boolean (default off)
5075 local to window
5076 Print the line number in front of each line. When the 'n' option is
5077 excluded from 'cpoptions' a wrapped line will not use the column of
5078 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005079 The 'numberwidth' option can be used to set the room used for the line
5080 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005081 When a long, wrapped line doesn't start with the first character, '-'
5082 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005083 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5084 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005085 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005087 *'numberwidth'* *'nuw'*
5088'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5089 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005090 {not in Vi}
5091 {only available when compiled with the |+linebreak|
5092 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005093 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005094 when the 'number' or 'relativenumber' option is set or printing lines
5095 with a line number. Since one space is always between the number and
5096 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005097 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005098 fit the highest line number in the buffer respectively the number of
5099 rows in the window, depending on whether 'number' or 'relativenumber'
5100 is set. Thus with the Vim default of 4 there is room for a line number
5101 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005102 The minimum value is 1, the maximum value is 10.
5103 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5104
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005105 *'omnifunc'* *'ofu'*
5106'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005107 local to buffer
5108 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005109 {not available when compiled without the |+eval|
5110 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005111 This option specifies a function to be used for Insert mode omni
5112 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005113 See |complete-functions| for an explanation of how the function is
5114 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005115 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005116 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005117
5118
Bram Moolenaar02467872007-05-06 13:22:01 +00005119 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005120'opendevice' 'odev' boolean (default off)
5121 global
5122 {not in Vi}
5123 {only for MS-DOS, MS-Windows and OS/2}
5124 Enable reading and writing from devices. This may get Vim stuck on a
5125 device that can be opened but doesn't actually do the I/O. Therefore
5126 it is off by default.
5127 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5128 result in editing a device.
5129
5130
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005131 *'operatorfunc'* *'opfunc'*
5132'operatorfunc' 'opfunc' string (default: empty)
5133 global
5134 {not in Vi}
5135 This option specifies a function to be called by the |g@| operator.
5136 See |:map-operator| for more info and an example.
5137
5138 This option cannot be set from a |modeline| or in the |sandbox|, for
5139 security reasons.
5140
5141
Bram Moolenaar251e1912011-06-19 05:09:16 +02005142 *'osfiletype'* *'oft'*
5143'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 local to buffer
5145 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005146 This option was supported on RISC OS, which has been removed.
5147
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148
5149 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005150'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 global
5152 Specifies the nroff macros that separate paragraphs. These are pairs
5153 of two letters (see |object-motions|).
5154
5155 *'paste'* *'nopaste'*
5156'paste' boolean (default off)
5157 global
5158 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005159 Put Vim in Paste mode. This is useful if you want to cut or copy
5160 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 unexpected effects.
5162 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005163 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164 knows about pasting and will mostly do the right thing without 'paste'
5165 being set. The same is true for a terminal where Vim handles the
5166 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005167 This option is reset when starting the GUI. Thus if you set it in
5168 your .vimrc it will work in a terminal, but not in the GUI. Setting
5169 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5170 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171 When the 'paste' option is switched on (also when it was already on):
5172 - mapping in Insert mode and Command-line mode is disabled
5173 - abbreviations are disabled
5174 - 'textwidth' is set to 0
5175 - 'wrapmargin' is set to 0
5176 - 'autoindent' is reset
5177 - 'smartindent' is reset
5178 - 'softtabstop' is set to 0
5179 - 'revins' is reset
5180 - 'ruler' is reset
5181 - 'showmatch' is reset
5182 - 'formatoptions' is used like it is empty
5183 These options keep their value, but their effect is disabled:
5184 - 'lisp'
5185 - 'indentexpr'
5186 - 'cindent'
5187 NOTE: When you start editing another file while the 'paste' option is
5188 on, settings from the modelines or autocommands may change the
5189 settings again, causing trouble when pasting text. You might want to
5190 set the 'paste' option again.
5191 When the 'paste' option is reset the mentioned options are restored to
5192 the value before the moment 'paste' was switched from off to on.
5193 Resetting 'paste' before ever setting it does not have any effect.
5194 Since mapping doesn't work while 'paste' is active, you need to use
5195 the 'pastetoggle' option to toggle the 'paste' option with some key.
5196
5197 *'pastetoggle'* *'pt'*
5198'pastetoggle' 'pt' string (default "")
5199 global
5200 {not in Vi}
5201 When non-empty, specifies the key sequence that toggles the 'paste'
5202 option. This is like specifying a mapping: >
5203 :map {keys} :set invpaste<CR>
5204< Where {keys} is the value of 'pastetoggle'.
5205 The difference is that it will work even when 'paste' is set.
5206 'pastetoggle' works in Insert mode and Normal mode, but not in
5207 Command-line mode.
5208 Mappings are checked first, thus overrule 'pastetoggle'. However,
5209 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5210 this: >
5211 :map <F10> :set paste<CR>
5212 :map <F11> :set nopaste<CR>
5213 :imap <F10> <C-O>:set paste<CR>
5214 :imap <F11> <nop>
5215 :set pastetoggle=<F11>
5216< This will make <F10> start paste mode and <F11> stop paste mode.
5217 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5218 mode everything is inserted literally, except the 'pastetoggle' key
5219 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005220 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221
5222 *'pex'* *'patchexpr'*
5223'patchexpr' 'pex' string (default "")
5224 global
5225 {not in Vi}
5226 {not available when compiled without the |+diff|
5227 feature}
5228 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005229 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230
5231 *'patchmode'* *'pm'* *E206*
5232'patchmode' 'pm' string (default "")
5233 global
5234 {not in Vi}
5235 When non-empty the oldest version of a file is kept. This can be used
5236 to keep the original version of a file if you are changing files in a
5237 source distribution. Only the first time that a file is written a
5238 copy of the original file will be kept. The name of the copy is the
5239 name of the original file with the string in the 'patchmode' option
5240 appended. This option should start with a dot. Use a string like
5241 ".org". 'backupdir' must not be empty for this to work (Detail: The
5242 backup file is renamed to the patchmode file after the new file has
5243 been successfully written, that's why it must be possible to write a
5244 backup file). If there was no file to be backed up, an empty file is
5245 created.
5246 When the 'backupskip' pattern matches, a patchmode file is not made.
5247 Using 'patchmode' for compressed files appends the extension at the
5248 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5249 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005250 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005252 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253'path' 'pa' string (default on Unix: ".,/usr/include,,"
5254 on OS/2: ".,/emx/include,,"
5255 other systems: ".,,")
5256 global or local to buffer |global-local|
5257 {not in Vi}
5258 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005259 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5260 provided that the file being searched for has a relative path (not
5261 starting with "/", "./" or "../"). The directories in the 'path'
5262 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005263 - Use commas to separate directory names: >
5264 :set path=.,/usr/local/include,/usr/include
5265< - Spaces can also be used to separate directory names (for backwards
5266 compatibility with version 3.0). To have a space in a directory
5267 name, precede it with an extra backslash, and escape the space: >
5268 :set path=.,/dir/with\\\ space
5269< - To include a comma in a directory name precede it with an extra
5270 backslash: >
5271 :set path=.,/dir/with\\,comma
5272< - To search relative to the directory of the current file, use: >
5273 :set path=.
5274< - To search in the current directory use an empty string between two
5275 commas: >
5276 :set path=,,
5277< - A directory name may end in a ':' or '/'.
5278 - Environment variables are expanded |:set_env|.
5279 - When using |netrw.vim| URLs can be used. For example, adding
5280 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005281 - Search upwards and downwards in a directory tree using "*", "**" and
5282 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005283 {not available when compiled without the |+path_extra| feature}
5284 - Careful with '\' characters, type two to get one in the option: >
5285 :set path=.,c:\\include
5286< Or just use '/' instead: >
5287 :set path=.,c:/include
5288< Don't forget "." or files won't even be found in the same directory as
5289 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005290 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 it is something like 256 or 1024 characters.
5292 You can check if all the include files are found, using the value of
5293 'path', see |:checkpath|.
5294 The use of |:set+=| and |:set-=| is preferred when adding or removing
5295 directories from the list. This avoids problems when a future version
5296 uses another default. To remove the current directory use: >
5297 :set path-=
5298< To add the current directory use: >
5299 :set path+=
5300< To use an environment variable, you probably need to replace the
5301 separator. Here is an example to append $INCL, in which directory
5302 names are separated with a semi-colon: >
5303 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5304< Replace the ';' with a ':' or whatever separator is used. Note that
5305 this doesn't work when $INCL contains a comma or white space.
5306
5307 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5308'preserveindent' 'pi' boolean (default off)
5309 local to buffer
5310 {not in Vi}
5311 When changing the indent of the current line, preserve as much of the
5312 indent structure as possible. Normally the indent is replaced by a
5313 series of tabs followed by spaces as required (unless |'expandtab'| is
5314 enabled, in which case only spaces are used). Enabling this option
5315 means the indent will preserve as many existing characters as possible
5316 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005317 'expandtab' does not apply to the preserved white space, a Tab remains
5318 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 NOTE: When using ">>" multiple times the resulting indent is a mix of
5320 tabs and spaces. You might not like this.
5321 NOTE: 'preserveindent' is reset when 'compatible' is set.
5322 Also see 'copyindent'.
5323 Use |:retab| to clean up white space.
5324
5325 *'previewheight'* *'pvh'*
5326'previewheight' 'pvh' number (default 12)
5327 global
5328 {not in Vi}
5329 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005330 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331 Default height for a preview window. Used for |:ptag| and associated
5332 commands. Used for |CTRL-W_}| when no count is given.
5333
5334 *'previewwindow'* *'nopreviewwindow'*
5335 *'pvw'* *'nopvw'* *E590*
5336'previewwindow' 'pvw' boolean (default off)
5337 local to window
5338 {not in Vi}
5339 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005340 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005341 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005342 set. It's normally not set directly, but by using one of the commands
5343 |:ptag|, |:pedit|, etc.
5344
5345 *'printdevice'* *'pdev'*
5346'printdevice' 'pdev' string (default empty)
5347 global
5348 {not in Vi}
5349 {only available when compiled with the |+printer|
5350 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005351 The name of the printer to be used for |:hardcopy|.
5352 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005353 This option cannot be set from a |modeline| or in the |sandbox|, for
5354 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355
Bram Moolenaar8299df92004-07-10 09:47:34 +00005356 *'printencoding'* *'penc'*
5357'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005358 global
5359 {not in Vi}
5360 {only available when compiled with the |+printer|
5361 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005362 Sets the character encoding used when printing.
5363 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364
5365 *'printexpr'* *'pexpr'*
5366'printexpr' 'pexpr' String (default: see below)
5367 global
5368 {not in Vi}
5369 {only available when compiled with the |+printer|
5370 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005371 Expression used to print the PostScript produced with |:hardcopy|.
5372 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373
Bram Moolenaar8299df92004-07-10 09:47:34 +00005374 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375'printfont' 'pfn' string (default "courier")
5376 global
5377 {not in Vi}
5378 {only available when compiled with the |+printer|
5379 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005380 The name of the font that will be used for |:hardcopy|.
5381 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382
5383 *'printheader'* *'pheader'*
5384'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5385 global
5386 {not in Vi}
5387 {only available when compiled with the |+printer|
5388 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005389 The format of the header produced in |:hardcopy| output.
5390 See |pheader-option|.
5391
5392 *'printmbcharset'* *'pmbcs'*
5393'printmbcharset' 'pmbcs' string (default "")
5394 global
5395 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005396 {only available when compiled with the |+printer|,
5397 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005398 The CJK character set to be used for CJK output from |:hardcopy|.
5399 See |pmbcs-option|.
5400
5401 *'printmbfont'* *'pmbfn'*
5402'printmbfont' 'pmbfn' string (default "")
5403 global
5404 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005405 {only available when compiled with the |+printer|,
5406 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005407 List of font names to be used for CJK output from |:hardcopy|.
5408 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409
5410 *'printoptions'* *'popt'*
5411'printoptions' 'popt' string (default "")
5412 global
5413 {not in Vi}
5414 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005415 List of items that control the format of the output of |:hardcopy|.
5416 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005418 *'prompt'* *'noprompt'*
5419'prompt' boolean (default on)
5420 global
5421 When on a ":" prompt is used in Ex mode.
5422
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005423 *'pumheight'* *'ph'*
5424'pumheight' 'ph' number (default 0)
5425 global
5426 {not available when compiled without the
5427 |+insert_expand| feature}
5428 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005429 Determines the maximum number of items to show in the popup menu for
5430 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005431 |ins-completion-menu|.
5432
5433
Bram Moolenaar677ee682005-01-27 14:41:15 +00005434 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005435'quoteescape' 'qe' string (default "\")
5436 local to buffer
5437 {not in Vi}
5438 The characters that are used to escape quotes in a string. Used for
5439 objects like a', a" and a` |a'|.
5440 When one of the characters in this option is found inside a string,
5441 the following character will be skipped. The default value makes the
5442 text "foo\"bar\\" considered to be one string.
5443
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5445'readonly' 'ro' boolean (default off)
5446 local to buffer
5447 If on, writes fail unless you use a '!'. Protects you from
5448 accidentally overwriting a file. Default on when Vim is started
5449 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005450 When using ":w!" the 'readonly' option is reset for the current
5451 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005453 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005454
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005455 *'redrawtime'* *'rdt'*
5456'redrawtime' 'rdt' number (default 2000)
5457 global
5458 {not in Vi}
5459 {only available when compiled with the |+reltime|
5460 feature}
5461 The time in milliseconds for redrawing the display. This applies to
5462 searching for patterns for 'hlsearch' and |:match| highlighting.
5463 When redrawing takes more than this many milliseconds no further
5464 matches will be highlighted. This is used to avoid that Vim hangs
5465 when using a very complicated pattern.
5466
Bram Moolenaar64486672010-05-16 15:46:46 +02005467 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5468'relativenumber' 'rnu' boolean (default off)
5469 local to window
5470 {not in Vi}
5471 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005472 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005473 precede some vertical motion commands (e.g. j k + -) with, without
5474 having to calculate it yourself. Especially useful in combination with
5475 other commands (e.g. y d c < > gq gw =).
5476 When the 'n' option is excluded from 'cpoptions' a wrapped
5477 line will not use the column of line numbers (this is the default when
5478 'compatible' isn't set).
5479 The 'numberwidth' option can be used to set the room used for the line
5480 number.
5481 When a long, wrapped line doesn't start with the first character, '-'
5482 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005483 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5484 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005485 When setting this option, 'number' is reset.
5486
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 *'remap'* *'noremap'*
5488'remap' boolean (default on)
5489 global
5490 Allows for mappings to work recursively. If you do not want this for
5491 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005492 NOTE: To avoid portability problems with Vim scripts, always keep
5493 this option at the default "on". Only switch it off when working with
5494 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005495
5496 *'report'*
5497'report' number (default 2)
5498 global
5499 Threshold for reporting number of lines changed. When the number of
5500 changed lines is more than 'report' a message will be given for most
5501 ":" commands. If you want it always, set 'report' to 0.
5502 For the ":substitute" command the number of substitutions is used
5503 instead of the number of lines.
5504
5505 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5506'restorescreen' 'rs' boolean (default on)
5507 global
5508 {not in Vi} {only in Windows 95/NT console version}
5509 When set, the screen contents is restored when exiting Vim. This also
5510 happens when executing external commands.
5511
5512 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5513 options in your .vimrc. To disable restoring:
5514 set t_ti= t_te=
5515 To enable restoring (for an xterm):
5516 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5517 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5518
5519 *'revins'* *'ri'* *'norevins'* *'nori'*
5520'revins' 'ri' boolean (default off)
5521 global
5522 {not in Vi}
5523 {only available when compiled with the |+rightleft|
5524 feature}
5525 Inserting characters in Insert mode will work backwards. See "typing
5526 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5527 command in Insert mode, when 'allowrevins' is set.
5528 NOTE: This option is reset when 'compatible' or 'paste' is set.
5529
5530 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5531'rightleft' 'rl' boolean (default off)
5532 local to window
5533 {not in Vi}
5534 {only available when compiled with the |+rightleft|
5535 feature}
5536 When on, display orientation becomes right-to-left, i.e., characters
5537 that are stored in the file appear from the right to the left.
5538 Using this option, it is possible to edit files for languages that
5539 are written from the right to the left such as Hebrew and Arabic.
5540 This option is per window, so it is possible to edit mixed files
5541 simultaneously, or to view the same file in both ways (this is
5542 useful whenever you have a mixed text file with both right-to-left
5543 and left-to-right strings so that both sets are displayed properly
5544 in different windows). Also see |rileft.txt|.
5545
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005546 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547'rightleftcmd' 'rlc' string (default "search")
5548 local to window
5549 {not in Vi}
5550 {only available when compiled with the |+rightleft|
5551 feature}
5552 Each word in this option enables the command line editing to work in
5553 right-to-left mode for a group of commands:
5554
5555 search "/" and "?" commands
5556
5557 This is useful for languages such as Hebrew, Arabic and Farsi.
5558 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5559
5560 *'ruler'* *'ru'* *'noruler'* *'noru'*
5561'ruler' 'ru' boolean (default off)
5562 global
5563 {not in Vi}
5564 {not available when compiled without the
5565 |+cmdline_info| feature}
5566 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005567 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 text in the file is shown on the far right:
5569 Top first line is visible
5570 Bot last line is visible
5571 All first and last line are visible
5572 45% relative position in the file
5573 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005574 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005576 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005577 this option takes precedence over 'ruler' and 'rulerformat'
5578 If the number of characters displayed is different from the number of
5579 bytes in the text (e.g., for a TAB or a multi-byte character), both
5580 the text column (byte number) and the screen column are shown,
5581 separated with a dash.
5582 For an empty line "0-1" is shown.
5583 For an empty buffer the line number will also be zero: "0,0-1".
5584 This option is reset when the 'paste' option is set.
5585 If you don't want to see the ruler all the time but want to know where
5586 you are, use "g CTRL-G" |g_CTRL-G|.
5587 NOTE: This option is reset when 'compatible' is set.
5588
5589 *'rulerformat'* *'ruf'*
5590'rulerformat' 'ruf' string (default empty)
5591 global
5592 {not in Vi}
5593 {not available when compiled without the |+statusline|
5594 feature}
5595 When this option is not empty, it determines the content of the ruler
5596 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005597 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 The default ruler width is 17 characters. To make the ruler 15
5599 characters wide, put "%15(" at the start and "%)" at the end.
5600 Example: >
5601 :set rulerformat=%15(%c%V\ %p%%%)
5602<
5603 *'runtimepath'* *'rtp'* *vimfiles*
5604'runtimepath' 'rtp' string (default:
5605 Unix: "$HOME/.vim,
5606 $VIM/vimfiles,
5607 $VIMRUNTIME,
5608 $VIM/vimfiles/after,
5609 $HOME/.vim/after"
5610 Amiga: "home:vimfiles,
5611 $VIM/vimfiles,
5612 $VIMRUNTIME,
5613 $VIM/vimfiles/after,
5614 home:vimfiles/after"
5615 PC, OS/2: "$HOME/vimfiles,
5616 $VIM/vimfiles,
5617 $VIMRUNTIME,
5618 $VIM/vimfiles/after,
5619 $HOME/vimfiles/after"
5620 Macintosh: "$VIM:vimfiles,
5621 $VIMRUNTIME,
5622 $VIM:vimfiles:after"
5623 RISC-OS: "Choices:vimfiles,
5624 $VIMRUNTIME,
5625 Choices:vimfiles/after"
5626 VMS: "sys$login:vimfiles,
5627 $VIM/vimfiles,
5628 $VIMRUNTIME,
5629 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005630 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 global
5632 {not in Vi}
5633 This is a list of directories which will be searched for runtime
5634 files:
5635 filetype.vim filetypes by file name |new-filetype|
5636 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005637 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 colors/ color scheme files |:colorscheme|
5639 compiler/ compiler files |:compiler|
5640 doc/ documentation |write-local-help|
5641 ftplugin/ filetype plugins |write-filetype-plugin|
5642 indent/ indent scripts |indent-expression|
5643 keymap/ key mapping files |mbyte-keymap|
5644 lang/ menu translations |:menutrans|
5645 menu.vim GUI menus |menu.vim|
5646 plugin/ plugin scripts |write-plugin|
5647 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005648 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 syntax/ syntax files |mysyntaxfile|
5650 tutor/ files for vimtutor |tutor|
5651
5652 And any other file searched for with the |:runtime| command.
5653
5654 The defaults for most systems are setup to search five locations:
5655 1. In your home directory, for your personal preferences.
5656 2. In a system-wide Vim directory, for preferences from the system
5657 administrator.
5658 3. In $VIMRUNTIME, for files distributed with Vim.
5659 *after-directory*
5660 4. In the "after" directory in the system-wide Vim directory. This is
5661 for the system administrator to overrule or add to the distributed
5662 defaults (rarely needed)
5663 5. In the "after" directory in your home directory. This is for
5664 personal preferences to overrule or add to the distributed defaults
5665 or system-wide settings (rarely needed).
5666
5667 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5668 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005669 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 wildcards.
5671 See |:runtime|.
5672 Example: >
5673 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5674< This will use the directory "~/vimruntime" first (containing your
5675 personal Vim runtime files), then "/mygroup/vim" (shared between a
5676 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5677 files).
5678 You probably should always include $VIMRUNTIME somewhere, to use the
5679 distributed runtime files. You can put a directory before $VIMRUNTIME
5680 to find files which replace a distributed runtime files. You can put
5681 a directory after $VIMRUNTIME to find files which add to distributed
5682 runtime files.
5683 This option cannot be set from a |modeline| or in the |sandbox|, for
5684 security reasons.
5685
5686 *'scroll'* *'scr'*
5687'scroll' 'scr' number (default: half the window height)
5688 local to window
5689 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5690 set to half the number of lines in the window when the window size
5691 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005692 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5694 the number of screen lines instead of file lines, makes a difference
5695 when lines wrap}
5696
5697 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5698'scrollbind' 'scb' boolean (default off)
5699 local to window
5700 {not in Vi}
5701 {not available when compiled without the |+scrollbind|
5702 feature}
5703 See also |scroll-binding|. When this option is set, the current
5704 window scrolls as other scrollbind windows (windows that also have
5705 this option set) scroll. This option is useful for viewing the
5706 differences between two versions of a file, see 'diff'.
5707 See |'scrollopt'| for options that determine how this option should be
5708 interpreted.
5709 This option is mostly reset when splitting a window to edit another
5710 file. This means that ":split | edit file" results in two windows
5711 with scroll-binding, but ":split file" does not.
5712
5713 *'scrolljump'* *'sj'*
5714'scrolljump' 'sj' number (default 1)
5715 global
5716 {not in Vi}
5717 Minimal number of lines to scroll when the cursor gets off the
5718 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5719 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005720 When set to a negative number from -1 to -100 this is used as the
5721 percentage of the window height. Thus -50 scrolls half the window
5722 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 NOTE: This option is set to 1 when 'compatible' is set.
5724
5725 *'scrolloff'* *'so'*
5726'scrolloff' 'so' number (default 0)
5727 global
5728 {not in Vi}
5729 Minimal number of screen lines to keep above and below the cursor.
5730 This will make some context visible around where you are working. If
5731 you set it to a very large value (999) the cursor line will always be
5732 in the middle of the window (except at the start or end of the file or
5733 when long lines wrap).
5734 For scrolling horizontally see 'sidescrolloff'.
5735 NOTE: This option is set to 0 when 'compatible' is set.
5736
5737 *'scrollopt'* *'sbo'*
5738'scrollopt' 'sbo' string (default "ver,jump")
5739 global
5740 {not available when compiled without the |+scrollbind|
5741 feature}
5742 {not in Vi}
5743 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005744 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5745 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 The following words are available:
5747 ver Bind vertical scrolling for 'scrollbind' windows
5748 hor Bind horizontal scrolling for 'scrollbind' windows
5749 jump Applies to the offset between two windows for vertical
5750 scrolling. This offset is the difference in the first
5751 displayed line of the bound windows. When moving
5752 around in a window, another 'scrollbind' window may
5753 reach a position before the start or after the end of
5754 the buffer. The offset is not changed though, when
5755 moving back the 'scrollbind' window will try to scroll
5756 to the desired position when possible.
5757 When now making that window the current one, two
5758 things can be done with the relative offset:
5759 1. When "jump" is not included, the relative offset is
5760 adjusted for the scroll position in the new current
5761 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005762 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 2. When "jump" is included, the other windows are
5764 scrolled to keep the same relative offset. When
5765 going back to the other window, it still uses the
5766 same relative offset.
5767 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005768 When 'diff' mode is active there always is vertical scroll binding,
5769 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
5771 *'sections'* *'sect'*
5772'sections' 'sect' string (default "SHNHH HUnhsh")
5773 global
5774 Specifies the nroff macros that separate sections. These are pairs of
5775 two letters (See |object-motions|). The default makes a section start
5776 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5777
5778 *'secure'* *'nosecure'* *E523*
5779'secure' boolean (default off)
5780 global
5781 {not in Vi}
5782 When on, ":autocmd", shell and write commands are not allowed in
5783 ".vimrc" and ".exrc" in the current directory and map commands are
5784 displayed. Switch it off only if you know that you will not run into
5785 problems, or when the 'exrc' option is off. On Unix this option is
5786 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005787 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 'secure' at the end of your ~/.vimrc then.
5789 This option cannot be set from a |modeline| or in the |sandbox|, for
5790 security reasons.
5791
5792 *'selection'* *'sel'*
5793'selection' 'sel' string (default "inclusive")
5794 global
5795 {not in Vi}
5796 This option defines the behavior of the selection. It is only used
5797 in Visual and Select mode.
5798 Possible values:
5799 value past line inclusive ~
5800 old no yes
5801 inclusive yes yes
5802 exclusive yes no
5803 "past line" means that the cursor is allowed to be positioned one
5804 character past the line.
5805 "inclusive" means that the last character of the selection is included
5806 in an operation. For example, when "x" is used to delete the
5807 selection.
5808 Note that when "exclusive" is used and selecting from the end
5809 backwards, you cannot include the last character of a line, when
5810 starting in Normal mode and 'virtualedit' empty.
5811
5812 The 'selection' option is set by the |:behave| command.
5813
5814 *'selectmode'* *'slm'*
5815'selectmode' 'slm' string (default "")
5816 global
5817 {not in Vi}
5818 This is a comma separated list of words, which specifies when to start
5819 Select mode instead of Visual mode, when a selection is started.
5820 Possible values:
5821 mouse when using the mouse
5822 key when using shifted special keys
5823 cmd when using "v", "V" or CTRL-V
5824 See |Select-mode|.
5825 The 'selectmode' option is set by the |:behave| command.
5826
5827 *'sessionoptions'* *'ssop'*
5828'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005829 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 global
5831 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005832 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 feature}
5834 Changes the effect of the |:mksession| command. It is a comma
5835 separated list of words. Each word enables saving and restoring
5836 something:
5837 word save and restore ~
5838 blank empty windows
5839 buffers hidden and unloaded buffers, not just those in windows
5840 curdir the current directory
5841 folds manually created folds, opened/closed folds and local
5842 fold options
5843 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005844 and contain at least one lowercase letter. Only
5845 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 help the help window
5847 localoptions options and mappings local to a window or buffer (not
5848 global values for local options)
5849 options all options and mappings (also global values for local
5850 options)
5851 resize size of the Vim window: 'lines' and 'columns'
5852 sesdir the directory in which the session file is located
5853 will become the current directory (useful with
5854 projects accessed over a network from different
5855 systems)
5856 slash backslashes in file names replaced with forward
5857 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005858 tabpages all tab pages; without this only the current tab page
5859 is restored, so that you can make a session for each
5860 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005861 unix with Unix end-of-line format (single <NL>), even when
5862 on Windows or DOS
5863 winpos position of the whole Vim window
5864 winsize window sizes
5865
5866 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005867 When neither "curdir" nor "sesdir" is included, file names are stored
5868 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 "slash" and "unix" are useful on Windows when sharing session files
5870 with Unix. The Unix version of Vim cannot source dos format scripts,
5871 but the Windows version of Vim can source unix format scripts.
5872
5873 *'shell'* *'sh'* *E91*
5874'shell' 'sh' string (default $SHELL or "sh",
5875 MS-DOS and Win32: "command.com" or
5876 "cmd.exe", OS/2: "cmd")
5877 global
5878 Name of the shell to use for ! and :! commands. When changing the
5879 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5880 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005881 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 See |option-backslash| about including spaces and backslashes.
5883 Environment variables are expanded |:set_env|.
5884 If the name of the shell contains a space, you might need to enclose
5885 it in quotes. Example: >
5886 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5887< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005888 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 "-f" is not inside the quotes, because it is not part of the command
5890 name. And Vim automagically recognizes the backslashes that are path
5891 separators.
5892 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5893 variable to change the way external commands are executed. See the
5894 libc.inf file of DJGPP.
5895 Under MS-Windows, when the executable ends in ".com" it must be
5896 included. Thus setting the shell to "command.com" or "4dos.com"
5897 works, but "command" and "4dos" do not work for all commands (e.g.,
5898 filtering).
5899 For unknown reasons, when using "4dos.com" the current directory is
5900 changed to "C:\". To avoid this set 'shell' like this: >
5901 :set shell=command.com\ /c\ 4dos
5902< This option cannot be set from a |modeline| or in the |sandbox|, for
5903 security reasons.
5904
5905 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005906'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005907 MS-DOS and Win32, when 'shell' does not
5908 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 global
5910 {not in Vi}
5911 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5912 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5913 systems, the default is set according to the value of 'shell', to
5914 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005915 OS/2 (EMX figures this out itself).
5916 On Unix it can have more than one flag. Each white space separated
5917 part is passed as an argument to the shell command.
5918 See |option-backslash| about including spaces and backslashes.
5919 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 This option cannot be set from a |modeline| or in the |sandbox|, for
5921 security reasons.
5922
5923 *'shellpipe'* *'sp'*
5924'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5925 global
5926 {not in Vi}
5927 {not available when compiled without the |+quickfix|
5928 feature}
5929 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005930 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 including spaces and backslashes.
5932 The name of the temporary file can be represented by "%s" if necessary
5933 (the file name is appended automatically if no %s appears in the value
5934 of this option).
5935 For the Amiga and MS-DOS the default is ">". The output is directly
5936 saved in a file and not echoed to the screen.
5937 For Unix the default it "| tee". The stdout of the compiler is saved
5938 in a file and echoed to the screen. If the 'shell' option is "csh" or
5939 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005940 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5941 default becomes "2>&1| tee". This means that stderr is also included.
5942 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5943 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 The initialization of this option is done after reading the ".vimrc"
5945 and the other initializations, so that when the 'shell' option is set
5946 there, the 'shellpipe' option changes automatically, unless it was
5947 explicitly set before.
5948 When 'shellpipe' is set to an empty string, no redirection of the
5949 ":make" output will be done. This is useful if you use a 'makeprg'
5950 that writes to 'makeef' by itself. If you want no piping, but do
5951 want to include the 'makeef', set 'shellpipe' to a single space.
5952 Don't forget to precede the space with a backslash: ":set sp=\ ".
5953 In the future pipes may be used for filtering and this option will
5954 become obsolete (at least for Unix).
5955 This option cannot be set from a |modeline| or in the |sandbox|, for
5956 security reasons.
5957
5958 *'shellquote'* *'shq'*
5959'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5960 contains "sh" somewhere: "\"")
5961 global
5962 {not in Vi}
5963 Quoting character(s), put around the command passed to the shell, for
5964 the "!" and ":!" commands. The redirection is kept outside of the
5965 quoting. See 'shellxquote' to include the redirection. It's
5966 probably not useful to set both options.
5967 This is an empty string by default. Only known to be useful for
5968 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5969 or bash, where it should be "\"". The default is adjusted according
5970 the value of 'shell', to reduce the need to set this option by the
5971 user. See |dos-shell|.
5972 This option cannot be set from a |modeline| or in the |sandbox|, for
5973 security reasons.
5974
5975 *'shellredir'* *'srr'*
5976'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5977 global
5978 {not in Vi}
5979 String to be used to put the output of a filter command in a temporary
5980 file. See also |:!|. See |option-backslash| about including spaces
5981 and backslashes.
5982 The name of the temporary file can be represented by "%s" if necessary
5983 (the file name is appended automatically if no %s appears in the value
5984 of this option).
5985 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5986 or "zsh" during initializations, the default becomes ">&". If the
5987 'shell' option is "sh", "ksh" or "bash" the default becomes
5988 ">%s 2>&1". This means that stderr is also included.
5989 For Win32, the Unix checks are done and additionally "cmd" is checked
5990 for, which makes the default ">%s 2>&1". Also, the same names with
5991 ".exe" appended are checked for.
5992 The initialization of this option is done after reading the ".vimrc"
5993 and the other initializations, so that when the 'shell' option is set
5994 there, the 'shellredir' option changes automatically unless it was
5995 explicitly set before.
5996 In the future pipes may be used for filtering and this option will
5997 become obsolete (at least for Unix).
5998 This option cannot be set from a |modeline| or in the |sandbox|, for
5999 security reasons.
6000
6001 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6002'shellslash' 'ssl' boolean (default off)
6003 global
6004 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6005 When set, a forward slash is used when expanding file names. This is
6006 useful when a Unix-like shell is used instead of command.com or
6007 cmd.exe. Backward slashes can still be typed, but they are changed to
6008 forward slashes by Vim.
6009 Note that setting or resetting this option has no effect for some
6010 existing file names, thus this option needs to be set before opening
6011 any file for best results. This might change in the future.
6012 'shellslash' only works when a backslash can be used as a path
6013 separator. To test if this is so use: >
6014 if exists('+shellslash')
6015<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006016 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6017'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6018 global
6019 {not in Vi}
6020 When on, use temp files for shell commands. When off use a pipe.
6021 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006022 Currently a pipe is only supported on Unix and MS-Windows 2K and
6023 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006024 :if has("filterpipe")
6025< The advantage of using a pipe is that nobody can read the temp file
6026 and the 'shell' command does not need to support redirection.
6027 The advantage of using a temp file is that the file type and encoding
6028 can be detected.
6029 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6030 |FilterWritePost| autocommands event are not triggered when
6031 'shelltemp' is off.
6032
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 *'shelltype'* *'st'*
6034'shelltype' 'st' number (default 0)
6035 global
6036 {not in Vi} {only for the Amiga}
6037 On the Amiga this option influences the way how the commands work
6038 which use a shell.
6039 0 and 1: always use the shell
6040 2 and 3: use the shell only to filter lines
6041 4 and 5: use shell only for ':sh' command
6042 When not using the shell, the command is executed directly.
6043
6044 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6045 1 and 3: use "shell cmd" to start external commands
6046
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006047 *'shellxescape'* *'sxe'*
6048'shellxescape' 'sxe' string (default: "";
6049 for MS-DOS and MS-Windows: "\"&|<>()@^")
6050 global
6051 {not in Vi}
6052 When 'shellxquote' is set to "(" then the characters listed in this
6053 option will be escaped with a '^' character. This makes it possible
6054 to execute most external commands with cmd.exe.
6055
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 *'shellxquote'* *'sxq'*
6057'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006058 for Win32, when 'shell' is cmd.exe: "("
6059 for Win32, when 'shell' contains "sh"
6060 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 for Unix, when using system(): "\"")
6062 global
6063 {not in Vi}
6064 Quoting character(s), put around the command passed to the shell, for
6065 the "!" and ":!" commands. Includes the redirection. See
6066 'shellquote' to exclude the redirection. It's probably not useful
6067 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006068 When the value is '(' then ')' is appended. When the value is '"('
6069 then ')"' is appended.
6070 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006071 This is an empty string by default on most systems, but is known to be
6072 useful for on Win32 version, either for cmd.exe which automatically
6073 strips off the first and last quote on a command, or 3rd-party shells
6074 such as the MKS Korn Shell or bash, where it should be "\"". The
6075 default is adjusted according the value of 'shell', to reduce the need
6076 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 This option cannot be set from a |modeline| or in the |sandbox|, for
6078 security reasons.
6079
6080 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6081'shiftround' 'sr' boolean (default off)
6082 global
6083 {not in Vi}
6084 Round indent to multiple of 'shiftwidth'. Applies to > and <
6085 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6086 a multiple of 'shiftwidth' (this is Vi compatible).
6087 NOTE: This option is reset when 'compatible' is set.
6088
6089 *'shiftwidth'* *'sw'*
6090'shiftwidth' 'sw' number (default 8)
6091 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006092 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 |'cindent'|, |>>|, |<<|, etc.
6094
6095 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006096'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6097 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 global
6099 {not in Vi}
6100 This option helps to avoid all the |hit-enter| prompts caused by file
6101 messages, for example with CTRL-G, and to avoid some other messages.
6102 It is a list of flags:
6103 flag meaning when present ~
6104 f use "(3 of 5)" instead of "(file 3 of 5)"
6105 i use "[noeol]" instead of "[Incomplete last line]"
6106 l use "999L, 888C" instead of "999 lines, 888 characters"
6107 m use "[+]" instead of "[Modified]"
6108 n use "[New]" instead of "[New File]"
6109 r use "[RO]" instead of "[readonly]"
6110 w use "[w]" instead of "written" for file write message
6111 and "[a]" instead of "appended" for ':w >> file' command
6112 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6113 "[unix format]" and "[mac]" instead of "[mac format]".
6114 a all of the above abbreviations
6115
6116 o overwrite message for writing a file with subsequent message
6117 for reading a file (useful for ":wn" or when 'autowrite' on)
6118 O message for reading a file overwrites any previous message.
6119 Also for quickfix message (e.g., ":cn").
6120 s don't give "search hit BOTTOM, continuing at TOP" or "search
6121 hit TOP, continuing at BOTTOM" messages
6122 t truncate file message at the start if it is too long to fit
6123 on the command-line, "<" will appear in the left most column.
6124 Ignored in Ex mode.
6125 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006126 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 Ignored in Ex mode.
6128 W don't give "written" or "[w]" when writing a file
6129 A don't give the "ATTENTION" message when an existing swap file
6130 is found.
6131 I don't give the intro message when starting Vim |:intro|.
6132
6133 This gives you the opportunity to avoid that a change between buffers
6134 requires you to hit <Enter>, but still gives as useful a message as
6135 possible for the space available. To get the whole message that you
6136 would have got with 'shm' empty, use ":file!"
6137 Useful values:
6138 shm= No abbreviation of message.
6139 shm=a Abbreviation, but no loss of information.
6140 shm=at Abbreviation, and truncate message when necessary.
6141
6142 NOTE: This option is set to the Vi default value when 'compatible' is
6143 set and to the Vim default value when 'compatible' is reset.
6144
6145 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6146'shortname' 'sn' boolean (default off)
6147 local to buffer
6148 {not in Vi, not in MS-DOS versions}
6149 Filenames are assumed to be 8 characters plus one extension of 3
6150 characters. Multiple dots in file names are not allowed. When this
6151 option is on, dots in file names are replaced with underscores when
6152 adding an extension (".~" or ".swp"). This option is not available
6153 for MS-DOS, because then it would always be on. This option is useful
6154 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6155 or crossdos. When running the Win32 GUI version under Win32s, this
6156 option is always on by default.
6157
6158 *'showbreak'* *'sbr'* *E595*
6159'showbreak' 'sbr' string (default "")
6160 global
6161 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006162 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006163 feature}
6164 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006165 values are "> " or "+++ ": >
6166 :set showbreak=>\
6167< Note the backslash to escape the trailing space. It's easier like
6168 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006169 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006170< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 comma (in a future version the comma might be used to separate the
6172 part that is shown at the end and at the start of a line).
6173 The characters are highlighted according to the '@' flag in
6174 'highlight'.
6175 Note that tabs after the showbreak will be displayed differently.
6176 If you want the 'showbreak' to appear in between line numbers, add the
6177 "n" flag to 'cpoptions'.
6178
6179 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6180'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6181 off)
6182 global
6183 {not in Vi}
6184 {not available when compiled without the
6185 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006186 Show (partial) command in the last line of the screen. Set this
6187 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 In Visual mode the size of the selected area is shown:
6189 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006190 If the number of bytes is different it is also displayed: "2-6"
6191 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006193 - When selecting a block, the size in screen characters:
6194 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006195 NOTE: This option is set to the Vi default value when 'compatible' is
6196 set and to the Vim default value when 'compatible' is reset.
6197
6198 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6199'showfulltag' 'sft' boolean (default off)
6200 global
6201 {not in Vi}
6202 When completing a word in insert mode (see |ins-completion|) from the
6203 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006204 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 matched a C function, you can see a template for what arguments are
6206 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006207 Note that this doesn't work well together with having "longest" in
6208 'completeopt', because the completion from the search pattern may not
6209 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210
6211 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6212'showmatch' 'sm' boolean (default off)
6213 global
6214 When a bracket is inserted, briefly jump to the matching one. The
6215 jump is only done if the match can be seen on the screen. The time to
6216 show the match can be set with 'matchtime'.
6217 A Beep is given if there is no match (no matter if the match can be
6218 seen or not). This option is reset when the 'paste' option is set.
6219 When the 'm' flag is not included in 'cpoptions', typing a character
6220 will immediately move the cursor back to where it belongs.
6221 See the "sm" field in 'guicursor' for setting the cursor shape and
6222 blinking when showing the match.
6223 The 'matchpairs' option can be used to specify the characters to show
6224 matches for. 'rightleft' and 'revins' are used to look for opposite
6225 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006226 Also see the matchparen plugin for highlighting the match when moving
6227 around |pi_paren.txt|.
6228 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229
6230 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6231'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6232 global
6233 If in Insert, Replace or Visual mode put a message on the last line.
6234 Use the 'M' flag in 'highlight' to set the type of highlighting for
6235 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006236 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006237 doesn't mean XIM is really active, especially when 'imactivatekey' is
6238 not set.
6239 NOTE: This option is set to the Vi default value when 'compatible' is
6240 set and to the Vim default value when 'compatible' is reset.
6241
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006242 *'showtabline'* *'stal'*
6243'showtabline' 'stal' number (default 1)
6244 global
6245 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006246 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006247 feature}
6248 The value of this option specifies when the line with tab page labels
6249 will be displayed:
6250 0: never
6251 1: only if there are at least two tab pages
6252 2: always
6253 This is both for the GUI and non-GUI implementation of the tab pages
6254 line.
6255 See |tab-page| for more information about tab pages.
6256
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 *'sidescroll'* *'ss'*
6258'sidescroll' 'ss' number (default 0)
6259 global
6260 {not in Vi}
6261 The minimal number of columns to scroll horizontally. Used only when
6262 the 'wrap' option is off and the cursor is moved off of the screen.
6263 When it is zero the cursor will be put in the middle of the screen.
6264 When using a slow terminal set it to a large number or 0. When using
6265 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6266 commands.
6267
6268 *'sidescrolloff'* *'siso'*
6269'sidescrolloff' 'siso' number (default 0)
6270 global
6271 {not in Vi}
6272 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006273 right of the cursor if 'nowrap' is set. Setting this option to a
6274 value greater than 0 while having |'sidescroll'| also at a non-zero
6275 value makes some context visible in the line you are scrolling in
6276 horizontally (except at beginning of the line). Setting this option
6277 to a large value (like 999) has the effect of keeping the cursor
6278 horizontally centered in the window, as long as one does not come too
6279 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280 NOTE: This option is set to 0 when 'compatible' is set.
6281
6282 Example: Try this together with 'sidescroll' and 'listchars' as
6283 in the following example to never allow the cursor to move
6284 onto the "extends" character:
6285
6286 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6287 :set sidescrolloff=1
6288
6289
6290 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6291'smartcase' 'scs' boolean (default off)
6292 global
6293 {not in Vi}
6294 Override the 'ignorecase' option if the search pattern contains upper
6295 case characters. Only used when the search pattern is typed and
6296 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006297 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6299 recalling the search pattern from history and hitting <Enter>.
6300 NOTE: This option is reset when 'compatible' is set.
6301
6302 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6303'smartindent' 'si' boolean (default off)
6304 local to buffer
6305 {not in Vi}
6306 {not available when compiled without the
6307 |+smartindent| feature}
6308 Do smart autoindenting when starting a new line. Works for C-like
6309 programs, but can also be used for other languages. 'cindent' does
6310 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006311 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006312 setting 'si' has no effect. 'indentexpr' is a more advanced
6313 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 Normally 'autoindent' should also be on when using 'smartindent'.
6315 An indent is automatically inserted:
6316 - After a line ending in '{'.
6317 - After a line starting with a keyword from 'cinwords'.
6318 - Before a line starting with '}' (only with the "O" command).
6319 When typing '}' as the first character in a new line, that line is
6320 given the same indent as the matching '{'.
6321 When typing '#' as the first character in a new line, the indent for
6322 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006323 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6325 When using the ">>" command, lines starting with '#' are not shifted
6326 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006327 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006328 is set smart indenting is disabled.
6329
6330 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6331'smarttab' 'sta' boolean (default off)
6332 global
6333 {not in Vi}
6334 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006335 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6336 <BS> will delete a 'shiftwidth' worth of space at the start of the
6337 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006338 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006339 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6340 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006341 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006343 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 NOTE: This option is reset when 'compatible' is set.
6345
6346 *'softtabstop'* *'sts'*
6347'softtabstop' 'sts' number (default 0)
6348 local to buffer
6349 {not in Vi}
6350 Number of spaces that a <Tab> counts for while performing editing
6351 operations, like inserting a <Tab> or using <BS>. It "feels" like
6352 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6353 used. This is useful to keep the 'ts' setting at its standard value
6354 of 8, while being able to edit like it is set to 'sts'. However,
6355 commands like "x" still work on the actual characters.
6356 When 'sts' is zero, this feature is off.
6357 'softtabstop' is set to 0 when the 'paste' option is set.
6358 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6359 spaces is minimized by using <Tab>s.
6360 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6361 set.
6362 NOTE: This option is set to 0 when 'compatible' is set.
6363
Bram Moolenaar217ad922005-03-20 22:37:15 +00006364 *'spell'* *'nospell'*
6365'spell' boolean (default off)
6366 local to window
6367 {not in Vi}
6368 {not available when compiled without the |+syntax|
6369 feature}
6370 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006371 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006372
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006373 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006374'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006375 local to buffer
6376 {not in Vi}
6377 {not available when compiled without the |+syntax|
6378 feature}
6379 Pattern to locate the end of a sentence. The following word will be
6380 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006381 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006382 When this check is not wanted make this option empty.
6383 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006384 Be careful with special characters, see |option-backslash| about
6385 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006386 To set this option automatically depending on the language, see
6387 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006388
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006389 *'spellfile'* *'spf'*
6390'spellfile' 'spf' string (default empty)
6391 local to buffer
6392 {not in Vi}
6393 {not available when compiled without the |+syntax|
6394 feature}
6395 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006396 commands. It must end in ".{encoding}.add". You need to include the
6397 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006398 *E765*
6399 It may also be a comma separated list of names. A count before the
6400 |zg| and |zw| commands can be used to access each. This allows using
6401 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006402 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006403 you: Using the first directory in 'runtimepath' that is writable. If
6404 there is no "spell" directory yet it will be created. For the file
6405 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006406 ignoring the region.
6407 The resulting ".spl" file will be used for spell checking, it does not
6408 have to appear in 'spelllang'.
6409 Normally one file is used for all regions, but you can add the region
6410 name if you want to. However, it will then only be used when
6411 'spellfile' is set to it, for entries in 'spelllang' only files
6412 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006413 This option cannot be set from a |modeline| or in the |sandbox|, for
6414 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006415
Bram Moolenaar217ad922005-03-20 22:37:15 +00006416 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006417'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006418 local to buffer
6419 {not in Vi}
6420 {not available when compiled without the |+syntax|
6421 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006422 A comma separated list of word list names. When the 'spell' option is
6423 on spellchecking will be done for these languages. Example: >
6424 set spelllang=en_us,nl,medical
6425< This means US English, Dutch and medical words are recognized. Words
6426 that are not recognized will be highlighted.
6427 The word list name must not include a comma or dot. Using a dash is
6428 recommended to separate the two letter language name from a
6429 specification. Thus "en-rare" is used for rare English words.
6430 A region name must come last and have the form "_xx", where "xx" is
6431 the two-letter, lower case region name. You can use more than one
6432 region by listing them: "en_us,en_ca" supports both US and Canadian
6433 English, but not words specific for Australia, New Zealand or Great
6434 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006435 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006436 As a special case the name of a .spl file can be given as-is. The
6437 first "_xx" in the name is removed and used as the region name
6438 (_xx is an underscore, two letters and followed by a non-letter).
6439 This is mainly for testing purposes. You must make sure the correct
6440 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006441 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006442 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6443 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006444 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006445
Bram Moolenaar98692072006-02-04 00:57:42 +00006446 If the |spellfile.vim| plugin is active and you use a language name
6447 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6448 will ask you if you want to download the file.
6449
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006450 After this option has been set successfully, Vim will source the files
6451 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006452 up to the first comma, dot or underscore.
6453 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006454
6455
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006456 *'spellsuggest'* *'sps'*
6457'spellsuggest' 'sps' string (default "best")
6458 global
6459 {not in Vi}
6460 {not available when compiled without the |+syntax|
6461 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006462 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006463 the |spellsuggest()| function. This is a comma-separated list of
6464 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006465
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006466 best Internal method that works best for English. Finds
6467 changes like "fast" and uses a bit of sound-a-like
6468 scoring to improve the ordering.
6469
6470 double Internal method that uses two methods and mixes the
6471 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006472 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006473 word. That only works when the language specifies
6474 sound folding. Can be slow and doesn't always give
6475 better results.
6476
6477 fast Internal method that only checks for simple changes:
6478 character inserts/deletes/swaps. Works well for
6479 simple typing mistakes.
6480
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006481 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006482 Not used for |spellsuggest()|. The number of
6483 suggestions is never more than the value of 'lines'
6484 minus two.
6485
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006486 file:{filename} Read file {filename}, which must have two columns,
6487 separated by a slash. The first column contains the
6488 bad word, the second column the suggested good word.
6489 Example:
6490 theribal/terrible ~
6491 Use this for common mistakes that do not appear at the
6492 top of the suggestion list with the internal methods.
6493 Lines without a slash are ignored, use this for
6494 comments.
6495 The file is used for all languages.
6496
6497 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6498 trouble with spaces. |v:val| holds the badly spelled
6499 word. The expression must evaluate to a List of
6500 Lists, each with a suggestion and a score.
6501 Example:
6502 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006503 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006504 internal methods use. A lower score is better.
6505 This may invoke |spellsuggest()| if you temporarily
6506 set 'spellsuggest' to exclude the "expr:" part.
6507 Errors are silently ignored, unless you set the
6508 'verbose' option to a non-zero value.
6509
6510 Only one of "best", "double" or "fast" may be used. The others may
6511 appear several times in any order. Example: >
6512 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6513<
6514 This option cannot be set from a |modeline| or in the |sandbox|, for
6515 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006516
6517
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6519'splitbelow' 'sb' boolean (default off)
6520 global
6521 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006522 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 feature}
6524 When on, splitting a window will put the new window below the current
6525 one. |:split|
6526
6527 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6528'splitright' 'spr' boolean (default off)
6529 global
6530 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006531 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 feature}
6533 When on, splitting a window will put the new window right of the
6534 current one. |:vsplit|
6535
6536 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6537'startofline' 'sol' boolean (default on)
6538 global
6539 {not in Vi}
6540 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006541 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006542 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006543 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 with a linewise operator, with "%" with a count and to buffer changing
6545 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6546 only has a line number, e.g., ":25" or ":+".
6547 In case of buffer changing commands the cursor is placed at the column
6548 where it was the last time the buffer was edited.
6549 NOTE: This option is set when 'compatible' is set.
6550
Bram Moolenaar00654022011-02-25 14:42:19 +01006551 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006553 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 {not in Vi}
6555 {not available when compiled without the |+statusline|
6556 feature}
6557 When nonempty, this option determines the content of the status line.
6558 Also see |status-line|.
6559
6560 The option consists of printf style '%' items interspersed with
6561 normal text. Each status line item is of the form:
6562 %-0{minwid}.{maxwid}{item}
6563 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006564 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565
Bram Moolenaar238a5642006-02-21 22:12:05 +00006566 When the option starts with "%!" then it is used as an expression,
6567 evaluated and the result is used as the option value. Example: >
6568 :set statusline=%!MyStatusLine()
6569< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006570 Note that the "%!" expression is evaluated in the context of the
6571 current window and buffer, while %{} items are evaluated in the
6572 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006573
6574 When there is error while evaluating the option then it will be made
6575 empty to avoid further errors. Otherwise screen updating would loop.
6576
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 Note that the only effect of 'ruler' when this option is set (and
6578 'laststatus' is 2) is controlling the output of |CTRL-G|.
6579
6580 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006581 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006583 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 minwid Minimum width of the item, padding as set by '-' & '0'.
6585 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006586 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 on the left for text items. Numeric items will be
6588 shifted down to maxwid-2 digits followed by '>'number
6589 where number is the amount of missing digits, much like
6590 an exponential notation.
6591 item A one letter code as described below.
6592
6593 Following is a description of the possible statusline items. The
6594 second character in "item" is the type:
6595 N for number
6596 S for string
6597 F for flags as described below
6598 - not applicable
6599
6600 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006601 f S Path to the file in the buffer, as typed or relative to current
6602 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 F S Full path to the file in the buffer.
6604 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006605 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006607 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006609 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006611 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006613 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6615 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006616 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6618 being used: "<keymap>"
6619 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006620 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 B N As above, in hexadecimal.
6622 o N Byte number in file of byte under cursor, first byte is 1.
6623 Mnemonic: Offset from start of file (with one added)
6624 {not available when compiled without |+byte_offset| feature}
6625 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006626 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 l N Line number.
6628 L N Number of lines in buffer.
6629 c N Column number.
6630 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006631 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 p N Percentage through file in lines as in |CTRL-G|.
6633 P S Percentage through file of displayed window. This is like the
6634 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006635 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006637 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006638 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 ( - Start of item group. Can be used for setting the width and
6640 alignment of a section. Must be followed by %) somewhere.
6641 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006642 T N For 'tabline': start of tab page N label. Use %T after the last
6643 label. This information is used for mouse clicks.
6644 X N For 'tabline': start of close tab N label. Use %X after the
6645 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6646 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 < - Where to truncate line if too long. Default is at the start.
6648 No width fields allowed.
6649 = - Separation point between left and right aligned items.
6650 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006651 # - Set highlight group. The name must follow and then a # again.
6652 Thus use %#HLname# for highlight group HLname. The same
6653 highlighting is used, also for the statusline of non-current
6654 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006656 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 The difference between User{N} and StatusLine will be applied
6658 to StatusLineNC for the statusline of non-current windows.
6659 The number N must be between 1 and 9. See |hl-User1..9|
6660
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006661 When displaying a flag, Vim removes the leading comma, if any, when
6662 that flag comes right after plaintext. This will make a nice display
6663 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664
Bram Moolenaar582fd852005-03-28 20:58:01 +00006665 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006666 not set) and a minwid is not set for the group, the whole group will
6667 become empty. This will make a group like the following disappear
6668 completely from the statusline when none of the flags are set. >
6669 :set statusline=...%(\ [%M%R%H]%)...
6670<
6671 Beware that an expression is evaluated each and every time the status
6672 line is displayed. The current buffer and current window will be set
6673 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006674 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006676 real current buffer.
6677
6678 The 'statusline' option may be evaluated in the |sandbox|, see
6679 |sandbox-option|.
6680
6681 It is not allowed to change text or jump to another window while
6682 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683
6684 If the statusline is not updated when you want it (e.g., after setting
6685 a variable that's used in an expression), you can force an update by
6686 setting an option without changing its value. Example: >
6687 :let &ro = &ro
6688
6689< A result of all digits is regarded a number for display purposes.
6690 Otherwise the result is taken as flag text and applied to the rules
6691 described above.
6692
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006693 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6695 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6696
6697 Examples:
6698 Emulate standard status line with 'ruler' set >
6699 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6700< Similar, but add ASCII value of char under the cursor (like "ga") >
6701 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6702< Display byte count and byte value, modified flag in red. >
6703 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6704 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6705< Display a ,GZ flag if a compressed file is loaded >
6706 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6707< In the |:autocmd|'s: >
6708 :let b:gzflag = 1
6709< And: >
6710 :unlet b:gzflag
6711< And define this function: >
6712 :function VarExists(var, val)
6713 : if exists(a:var) | return a:val | else | return '' | endif
6714 :endfunction
6715<
6716 *'suffixes'* *'su'*
6717'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6718 global
6719 {not in Vi}
6720 Files with these suffixes get a lower priority when multiple files
6721 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006722 suffixes. Spaces after the comma are ignored. A dot is also seen as
6723 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724 separator, precede it with a backslash (see |option-backslash| about
6725 including spaces and backslashes).
6726 See 'wildignore' for completely ignoring files.
6727 The use of |:set+=| and |:set-=| is preferred when adding or removing
6728 suffixes from the list. This avoids problems when a future version
6729 uses another default.
6730
6731 *'suffixesadd'* *'sua'*
6732'suffixesadd' 'sua' string (default "")
6733 local to buffer
6734 {not in Vi}
6735 {not available when compiled without the
6736 |+file_in_path| feature}
6737 Comma separated list of suffixes, which are used when searching for a
6738 file for the "gf", "[I", etc. commands. Example: >
6739 :set suffixesadd=.java
6740<
6741 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6742'swapfile' 'swf' boolean (default on)
6743 local to buffer
6744 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006745 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 swapfile is not wanted for a specific buffer. For example, with
6747 confidential information that even root must not be able to access.
6748 Careful: All text will be in memory:
6749 - Don't use this for big files.
6750 - Recovery will be impossible!
6751 A swapfile will only be present when |'updatecount'| is non-zero and
6752 'swapfile' is set.
6753 When 'swapfile' is reset, the swap file for the current buffer is
6754 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6755 non-zero, a swap file is immediately created.
6756 Also see |swap-file| and |'swapsync'|.
6757
6758 This option is used together with 'bufhidden' and 'buftype' to
6759 specify special kinds of buffers. See |special-buffers|.
6760
6761 *'swapsync'* *'sws'*
6762'swapsync' 'sws' string (default "fsync")
6763 global
6764 {not in Vi}
6765 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 When this option is empty parts of the swap file may be in memory and
6768 not written to disk. When the system crashes you may lose more work.
6769 On Unix the system does a sync now and then without Vim asking for it,
6770 so the disadvantage of setting this option off is small. On some
6771 systems the swap file will not be written at all. For a unix system
6772 setting it to "sync" will use the sync() call instead of the default
6773 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006774 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775
6776 *'switchbuf'* *'swb'*
6777'switchbuf' 'swb' string (default "")
6778 global
6779 {not in Vi}
6780 This option controls the behavior when switching between buffers.
6781 Possible values (comma separated list):
6782 useopen If included, jump to the first open window that
6783 contains the specified buffer (if there is one).
6784 Otherwise: Do not examine other windows.
6785 This setting is checked with |quickfix| commands, when
6786 jumping to errors (":cc", ":cn", "cp", etc.). It is
6787 also used in all buffer related split commands, for
6788 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006789 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006790 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006792 a buffer for a |quickfix| command that display errors.
6793 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006794 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006795 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006797 *'synmaxcol'* *'smc'*
6798'synmaxcol' 'smc' number (default 3000)
6799 local to buffer
6800 {not in Vi}
6801 {not available when compiled without the |+syntax|
6802 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006803 Maximum column in which to search for syntax items. In long lines the
6804 text after this column is not highlighted and following lines may not
6805 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006806 This helps to avoid very slow redrawing for an XML file that is one
6807 long line.
6808 Set to zero to remove the limit.
6809
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810 *'syntax'* *'syn'*
6811'syntax' 'syn' string (default empty)
6812 local to buffer
6813 {not in Vi}
6814 {not available when compiled without the |+syntax|
6815 feature}
6816 When this option is set, the syntax with this name is loaded, unless
6817 syntax highlighting has been switched off with ":syntax off".
6818 Otherwise this option does not always reflect the current syntax (the
6819 b:current_syntax variable does).
6820 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006821 not automatically recognized. Example, in an IDL file:
6822 /* vim: set syntax=idl : */ ~
6823 When a dot appears in the value then this separates two filetype
6824 names. Example:
6825 /* vim: set syntax=c.doxygen : */ ~
6826 This will use the "c" syntax first, then the "doxygen" syntax.
6827 Note that the second one must be prepared to be loaded as an addition,
6828 otherwise it will be skipped. More than one dot may appear.
6829 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 :set syntax=OFF
6831< To switch syntax highlighting on according to the current value of the
6832 'filetype' option: >
6833 :set syntax=ON
6834< What actually happens when setting the 'syntax' option is that the
6835 Syntax autocommand event is triggered with the value as argument.
6836 This option is not copied to another buffer, independent of the 's' or
6837 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006838 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006840 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006841'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006842 global
6843 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006844 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006845 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006846 When nonempty, this option determines the content of the tab pages
6847 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006848 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006849
6850 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006851 option and only when there is no GUI tab line. When 'e' is in
6852 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006853 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006854
6855 The value is evaluated like with 'statusline'. You can use
6856 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006857 the text to be displayed. Use "%1T" for the first label, "%2T" for
6858 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006859
6860 Keep in mind that only one of the tab pages is the current one, others
6861 are invisible and you can't jump to their windows.
6862
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006863
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006864 *'tabpagemax'* *'tpm'*
6865'tabpagemax' 'tpm' number (default 10)
6866 global
6867 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006868 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006869 feature}
6870 Maximum number of tab pages to be opened by the |-p| command line
6871 argument or the ":tab all" command. |tabpage|
6872
6873
6874 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875'tabstop' 'ts' number (default 8)
6876 local to buffer
6877 Number of spaces that a <Tab> in the file counts for. Also see
6878 |:retab| command, and 'softtabstop' option.
6879
6880 Note: Setting 'tabstop' to any other value than 8 can make your file
6881 appear wrong in many places (e.g., when printing it).
6882
6883 There are four main ways to use tabs in Vim:
6884 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6885 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006886 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 behave like a tab appears every 4 (or 3) characters.
6888 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6889 'expandtab'. This way you will always insert spaces. The
6890 formatting will never be messed up when 'tabstop' is changed.
6891 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006892 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 works when using Vim to edit the file.
6894 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6895 'noexpandtab'. This should then work (for initial indents only)
6896 for any tabstop setting that people use. It might be nice to have
6897 tabs after the first non-blank inserted as spaces if you do this
6898 though. Otherwise aligned comments will be wrong when 'tabstop' is
6899 changed.
6900
6901 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6902'tagbsearch' 'tbs' boolean (default on)
6903 global
6904 {not in Vi}
6905 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006906 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 searching makes searching for a tag a LOT faster, but a linear search
6908 will find more tags if the tags file wasn't properly sorted.
6909 Vim normally assumes that your tags files are sorted, or indicate that
6910 they are not sorted. Only when this is not the case does the
6911 'tagbsearch' option need to be switched off.
6912
6913 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006914 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 certain files, or retry all files with a linear search. When
6916 'tagbsearch' is off, only a linear search is done.
6917
6918 Linear searching is done anyway, for one file, when Vim finds a line
6919 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006920 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921< [The whitespace before and after the '0' must be a single <Tab>]
6922
6923 When a binary search was done and no match was found in any of the
6924 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6925 instead of a normal tag name, a retry is done with a linear search.
6926 Tags in unsorted tags files, and matches with different case will only
6927 be found in the retry.
6928
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006929 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 linear search can be avoided for the 'ignorecase' case. Use a value
6931 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6932 case-fold sorted with the -f switch to "sort" in most unices, as in
6933 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006934 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6935 for this as well. Note that case must be folded to uppercase for this
6936 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937
6938 When 'tagbsearch' is off, tags searching is slower when a full match
6939 exists, but faster when no full match exists. Tags in unsorted tags
6940 files may only be found with 'tagbsearch' off.
6941 When the tags file is not sorted, or sorted in a wrong way (not on
6942 ASCII byte value), 'tagbsearch' should be off, or the line given above
6943 must be included in the tags file.
6944 This option doesn't affect commands that find all matching tags (e.g.,
6945 command-line completion and ":help").
6946 {Vi: always uses binary search in some versions}
6947
6948 *'taglength'* *'tl'*
6949'taglength' 'tl' number (default 0)
6950 global
6951 If non-zero, tags are significant up to this number of characters.
6952
6953 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6954'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6955 global
6956 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006957 If on and using a tags file in another directory, file names in that
6958 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 NOTE: This option is set to the Vi default value when 'compatible' is
6960 set and to the Vim default value when 'compatible' is reset.
6961
6962 *'tags'* *'tag'* *E433*
6963'tags' 'tag' string (default "./tags,tags", when compiled with
6964 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6965 global or local to buffer |global-local|
6966 Filenames for the tag command, separated by spaces or commas. To
6967 include a space or comma in a file name, precede it with a backslash
6968 (see |option-backslash| about including spaces and backslashes).
6969 When a file name starts with "./", the '.' is replaced with the path
6970 of the current file. But only when the 'd' flag is not included in
6971 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6972 |tags-option|.
6973 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006974 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6975 find all files named "tags" below "/lib". The filename itself cannot
6976 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6977 files called "tags?". {not available when compiled without the
6978 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006979 The |tagfiles()| function can be used to get a list of the file names
6980 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6982 files are also supported. They are automatically recognized. The
6983 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6984 differences are ignored (MS-Windows). |emacs-tags|
6985 The use of |:set+=| and |:set-=| is preferred when adding or removing
6986 file names from the list. This avoids problems when a future version
6987 uses another default.
6988 {Vi: default is "tags /usr/lib/tags"}
6989
6990 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6991'tagstack' 'tgst' boolean (default on)
6992 global
6993 {not in all versions of Vi}
6994 When on, the |tagstack| is used normally. When off, a ":tag" or
6995 ":tselect" command with an argument will not push the tag onto the
6996 tagstack. A following ":tag" without an argument, a ":pop" command or
6997 any other command that uses the tagstack will use the unmodified
6998 tagstack, but does change the pointer to the active entry.
6999 Resetting this option is useful when using a ":tag" command in a
7000 mapping which should not change the tagstack.
7001
7002 *'term'* *E529* *E530* *E531*
7003'term' string (default is $TERM, if that fails:
7004 in the GUI: "builtin_gui"
7005 on Amiga: "amiga"
7006 on BeOS: "beos-ansi"
7007 on Mac: "mac-ansi"
7008 on MiNT: "vt52"
7009 on MS-DOS: "pcterm"
7010 on OS/2: "os2ansi"
7011 on Unix: "ansi"
7012 on VMS: "ansi"
7013 on Win 32: "win32")
7014 global
7015 Name of the terminal. Used for choosing the terminal control
7016 characters. Environment variables are expanded |:set_env|.
7017 For example: >
7018 :set term=$TERM
7019< See |termcap|.
7020
7021 *'termbidi'* *'tbidi'*
7022 *'notermbidi'* *'notbidi'*
7023'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7024 global
7025 {not in Vi}
7026 {only available when compiled with the |+arabic|
7027 feature}
7028 The terminal is in charge of Bi-directionality of text (as specified
7029 by Unicode). The terminal is also expected to do the required shaping
7030 that some languages (such as Arabic) require.
7031 Setting this option implies that 'rightleft' will not be set when
7032 'arabic' is set and the value of 'arabicshape' will be ignored.
7033 Note that setting 'termbidi' has the immediate effect that
7034 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7035 This option is reset when the GUI is started.
7036 For further details see |arabic.txt|.
7037
7038 *'termencoding'* *'tenc'*
7039'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7040 Macintosh GUI: "macroman")
7041 global
7042 {only available when compiled with the |+multi_byte|
7043 feature}
7044 {not in Vi}
7045 Encoding used for the terminal. This specifies what character
7046 encoding the keyboard produces and the display will understand. For
7047 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007048 display). Except for the Mac when 'macatsui' is off, then
7049 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 In the Win32 console version the default value is the console codepage
7051 when it differs from the ANSI codepage.
7052 *E617*
7053 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7054 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7055 Any attempts to set a different value will be rejected, and an error
7056 message is shown.
7057 For the Win32 GUI 'termencoding' is not used for typed characters,
7058 because the Win32 system always passes Unicode characters.
7059 When empty, the same encoding is used as for the 'encoding' option.
7060 This is the normal value.
7061 Not all combinations for 'termencoding' and 'encoding' are valid. See
7062 |encoding-table|.
7063 The value for this option must be supported by internal conversions or
7064 iconv(). When this is not possible no conversion will be done and you
7065 will probably experience problems with non-ASCII characters.
7066 Example: You are working with the locale set to euc-jp (Japanese) and
7067 want to edit a UTF-8 file: >
7068 :let &termencoding = &encoding
7069 :set encoding=utf-8
7070< You need to do this when your system has no locale support for UTF-8.
7071
7072 *'terse'* *'noterse'*
7073'terse' boolean (default off)
7074 global
7075 When set: Add 's' flag to 'shortmess' option (this makes the message
7076 for a search that hits the start or end of the file not being
7077 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7078 shortens a lot of messages}
7079
7080 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7081'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7082 global
7083 {not in Vi}
7084 This option is obsolete. Use 'fileformats'.
7085 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7086 set to the default value for the current system. When 'textauto' is
7087 reset, 'fileformats' is made empty.
7088 NOTE: This option is set to the Vi default value when 'compatible' is
7089 set and to the Vim default value when 'compatible' is reset.
7090
7091 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7092'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7093 others: default off)
7094 local to buffer
7095 {not in Vi}
7096 This option is obsolete. Use 'fileformat'.
7097 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7098 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7099 "unix".
7100
7101 *'textwidth'* *'tw'*
7102'textwidth' 'tw' number (default 0)
7103 local to buffer
7104 {not in Vi}
7105 Maximum width of text that is being inserted. A longer line will be
7106 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007107 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7108 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007110 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 NOTE: This option is set to 0 when 'compatible' is set.
7112
7113 *'thesaurus'* *'tsr'*
7114'thesaurus' 'tsr' string (default "")
7115 global or local to buffer |global-local|
7116 {not in Vi}
7117 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007118 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 the file should contain words with similar meaning, separated by
7120 non-keyword characters (white space is preferred). Maximum line
7121 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007122 To obtain a file to be used here, check out this ftp site:
7123 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007124 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 after a comma are ignored, otherwise spaces are included in the file
7126 name. See |option-backslash| about using backslashes.
7127 The use of |:set+=| and |:set-=| is preferred when adding or removing
7128 directories from the list. This avoids problems when a future version
7129 uses another default.
7130 Backticks cannot be used in this option for security reasons.
7131
7132 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7133'tildeop' 'top' boolean (default off)
7134 global
7135 {not in Vi}
7136 When on: The tilde command "~" behaves like an operator.
7137 NOTE: This option is reset when 'compatible' is set.
7138
7139 *'timeout'* *'to'* *'notimeout'* *'noto'*
7140'timeout' 'to' boolean (default on)
7141 global
7142 *'ttimeout'* *'nottimeout'*
7143'ttimeout' boolean (default off)
7144 global
7145 {not in Vi}
7146 These two options together determine the behavior when part of a
7147 mapped key sequence or keyboard code has been received:
7148
7149 'timeout' 'ttimeout' action ~
7150 off off do not time out
7151 on on or off time out on :mappings and key codes
7152 off on time out on key codes
7153
7154 If both options are off, Vim will wait until either the complete
7155 mapping or key sequence has been received, or it is clear that there
7156 is no mapping or key sequence for the received characters. For
7157 example: if you have mapped "vl" and Vim has received 'v', the next
7158 character is needed to see if the 'v' is followed by an 'l'.
7159 When one of the options is on, Vim will wait for about 1 second for
7160 the next character to arrive. After that the already received
7161 characters are interpreted as single characters. The waiting time can
7162 be changed with the 'timeoutlen' option.
7163 On slow terminals or very busy systems timing out may cause
7164 malfunctioning cursor keys. If both options are off, Vim waits
7165 forever after an entered <Esc> if there are key codes that start
7166 with <Esc>. You will have to type <Esc> twice. If you do not have
7167 problems with key codes, but would like to have :mapped key
7168 sequences not timing out in 1 second, set the 'ttimeout' option and
7169 reset the 'timeout' option.
7170
7171 NOTE: 'ttimeout' is reset when 'compatible' is set.
7172
7173 *'timeoutlen'* *'tm'*
7174'timeoutlen' 'tm' number (default 1000)
7175 global
7176 {not in all versions of Vi}
7177 *'ttimeoutlen'* *'ttm'*
7178'ttimeoutlen' 'ttm' number (default -1)
7179 global
7180 {not in Vi}
7181 The time in milliseconds that is waited for a key code or mapped key
7182 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7183 when part of a command has been typed.
7184 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7185 different timeout value for key codes is desired set 'ttimeoutlen' to
7186 a non-negative number.
7187
7188 ttimeoutlen mapping delay key code delay ~
7189 < 0 'timeoutlen' 'timeoutlen'
7190 >= 0 'timeoutlen' 'ttimeoutlen'
7191
7192 The timeout only happens when the 'timeout' and 'ttimeout' options
7193 tell so. A useful setting would be >
7194 :set timeout timeoutlen=3000 ttimeoutlen=100
7195< (time out on mapping after three seconds, time out on key codes after
7196 a tenth of a second).
7197
7198 *'title'* *'notitle'*
7199'title' boolean (default off, on when title can be restored)
7200 global
7201 {not in Vi}
7202 {not available when compiled without the |+title|
7203 feature}
7204 When on, the title of the window will be set to the value of
7205 'titlestring' (if it is not empty), or to:
7206 filename [+=-] (path) - VIM
7207 Where:
7208 filename the name of the file being edited
7209 - indicates the file cannot be modified, 'ma' off
7210 + indicates the file was modified
7211 = indicates the file is read-only
7212 =+ indicates the file is read-only and modified
7213 (path) is the path of the file being edited
7214 - VIM the server name |v:servername| or "VIM"
7215 Only works if the terminal supports setting window titles
7216 (currently Amiga console, Win32 console, all GUI versions and
7217 terminals with a non- empty 't_ts' option - these are Unix xterm and
7218 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7219 *X11*
7220 When Vim was compiled with HAVE_X11 defined, the original title will
7221 be restored if possible. The output of ":version" will include "+X11"
7222 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7223 works for the icon name |'icon'|.
7224 But: When Vim was started with the |-X| argument, restoring the title
7225 will not work (except in the GUI).
7226 If the title cannot be restored, it is set to the value of 'titleold'.
7227 You might want to restore the title outside of Vim then.
7228 When using an xterm from a remote machine you can use this command:
7229 rsh machine_name xterm -display $DISPLAY &
7230 then the WINDOWID environment variable should be inherited and the
7231 title of the window should change back to what it should be after
7232 exiting Vim.
7233
7234 *'titlelen'*
7235'titlelen' number (default 85)
7236 global
7237 {not in Vi}
7238 {not available when compiled without the |+title|
7239 feature}
7240 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007241 title. When the title is longer, only the end of the path name is
7242 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007243 Using a percentage makes this adapt to the width of the window. But
7244 it won't work perfectly, because the actual number of characters
7245 available also depends on the font used and other things in the title
7246 bar. When 'titlelen' is zero the full path is used. Otherwise,
7247 values from 1 to 30000 percent can be used.
7248 'titlelen' is also used for the 'titlestring' option.
7249
7250 *'titleold'*
7251'titleold' string (default "Thanks for flying Vim")
7252 global
7253 {not in Vi}
7254 {only available when compiled with the |+title|
7255 feature}
7256 This option will be used for the window title when exiting Vim if the
7257 original title cannot be restored. Only happens if 'title' is on or
7258 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007259 This option cannot be set from a |modeline| or in the |sandbox|, for
7260 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007261 *'titlestring'*
7262'titlestring' string (default "")
7263 global
7264 {not in Vi}
7265 {not available when compiled without the |+title|
7266 feature}
7267 When this option is not empty, it will be used for the title of the
7268 window. This happens only when the 'title' option is on.
7269 Only works if the terminal supports setting window titles (currently
7270 Amiga console, Win32 console, all GUI versions and terminals with a
7271 non-empty 't_ts' option).
7272 When Vim was compiled with HAVE_X11 defined, the original title will
7273 be restored if possible |X11|.
7274 When this option contains printf-style '%' items, they will be
7275 expanded according to the rules used for 'statusline'.
7276 Example: >
7277 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7278 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7279< The value of 'titlelen' is used to align items in the middle or right
7280 of the available space.
7281 Some people prefer to have the file name first: >
7282 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7283< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007284 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007285 separating space only when needed.
7286 NOTE: Use of special characters in 'titlestring' may cause the display
7287 to be garbled (e.g., when it contains a CR or NL character).
7288 {not available when compiled without the |+statusline| feature}
7289
7290 *'toolbar'* *'tb'*
7291'toolbar' 'tb' string (default "icons,tooltips")
7292 global
7293 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7294 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007295 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 possible values are:
7297 icons Toolbar buttons are shown with icons.
7298 text Toolbar buttons shown with text.
7299 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007300 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 tooltips Tooltips are active for toolbar buttons.
7302 Tooltips refer to the popup help text which appears after the mouse
7303 cursor is placed over a toolbar button for a brief moment.
7304
7305 If you want the toolbar to be shown with icons as well as text, do the
7306 following: >
7307 :set tb=icons,text
7308< Motif and Athena cannot display icons and text at the same time. They
7309 will show icons if both are requested.
7310
7311 If none of the strings specified in 'toolbar' are valid or if
7312 'toolbar' is empty, this option is ignored. If you want to disable
7313 the toolbar, you need to set the 'guioptions' option. For example: >
7314 :set guioptions-=T
7315< Also see |gui-toolbar|.
7316
7317 *'toolbariconsize'* *'tbis'*
7318'toolbariconsize' 'tbis' string (default "small")
7319 global
7320 {not in Vi}
7321 {only in the GTK+ 2 GUI}
7322 Controls the size of toolbar icons. The possible values are:
7323 tiny Use tiny toolbar icons.
7324 small Use small toolbar icons (default).
7325 medium Use medium-sized toolbar icons.
7326 large Use large toolbar icons.
7327 The exact dimensions in pixels of the various icon sizes depend on
7328 the current theme. Common dimensions are large=32x32, medium=24x24,
7329 small=20x20 and tiny=16x16.
7330
7331 If 'toolbariconsize' is empty, the global default size as determined
7332 by user preferences or the current theme is used.
7333
7334 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7335'ttybuiltin' 'tbi' boolean (default on)
7336 global
7337 {not in Vi}
7338 When on, the builtin termcaps are searched before the external ones.
7339 When off the builtin termcaps are searched after the external ones.
7340 When this option is changed, you should set the 'term' option next for
7341 the change to take effect, for example: >
7342 :set notbi term=$TERM
7343< See also |termcap|.
7344 Rationale: The default for this option is "on", because the builtin
7345 termcap entries are generally better (many systems contain faulty
7346 xterm entries...).
7347
7348 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7349'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7350 sun-cmd, screen, rxvt, dtterm or
7351 iris-ansi; also on when running Vim in
7352 a DOS console)
7353 global
7354 {not in Vi}
7355 Indicates a fast terminal connection. More characters will be sent to
7356 the screen for redrawing, instead of using insert/delete line
7357 commands. Improves smoothness of redrawing when there are multiple
7358 windows and the terminal does not support a scrolling region.
7359 Also enables the extra writing of characters at the end of each screen
7360 line for lines that wrap. This helps when using copy/paste with the
7361 mouse in an xterm and other terminals.
7362
7363 *'ttymouse'* *'ttym'*
7364'ttymouse' 'ttym' string (default depends on 'term')
7365 global
7366 {not in Vi}
7367 {only in Unix and VMS, doesn't work in the GUI; not
7368 available when compiled without |+mouse|}
7369 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007370 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 *xterm-mouse*
7372 xterm xterm-like mouse handling. The mouse generates
7373 "<Esc>[Mscr", where "scr" is three bytes:
7374 "s" = button state
7375 "c" = column plus 33
7376 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007377 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007378 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007379 xterm2 Works like "xterm", but with the xterm reporting the
7380 mouse position while the mouse is dragged. This works
7381 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007382 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 work. See below for how Vim detects this
7384 automatically.
7385 *netterm-mouse*
7386 netterm NetTerm mouse handling. The mouse generates
7387 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7388 for the row and column.
7389 *dec-mouse*
7390 dec DEC terminal mouse handling. The mouse generates a
7391 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007392 This is also available for an Xterm, if it was
7393 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007394 *jsbterm-mouse*
7395 jsbterm JSB term mouse handling.
7396 *pterm-mouse*
7397 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007398 *urxvt-mouse*
7399 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400
7401 The mouse handling must be enabled at compile time |+mouse_xterm|
7402 |+mouse_dec| |+mouse_netterm|.
7403 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7404 recognized, if enabled at compile time. DEC terminal mouse codes
7405 are recognized if enabled at compile time, and 'ttymouse' is not
7406 "xterm" (because the xterm and dec mouse codes conflict).
7407 This option is automatically set to "xterm", when the 'term' option is
7408 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7409 or "xterm2" already. The main use of this option is to set it to
7410 "xterm", when the terminal name doesn't start with "xterm", but it can
7411 handle xterm mouse codes.
7412 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007413 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 feature and if |t_RV| is set to the escape sequence to request the
7415 xterm version number. Otherwise "xterm2" must be set explicitly.
7416 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7417 t_RV to an empty string: >
7418 :set t_RV=
7419<
7420 *'ttyscroll'* *'tsl'*
7421'ttyscroll' 'tsl' number (default 999)
7422 global
7423 Maximum number of lines to scroll the screen. If there are more lines
7424 to scroll the window is redrawn. For terminals where scrolling is
7425 very slow and redrawing is not slow this can be set to a small number,
7426 e.g., 3, to speed up displaying.
7427
7428 *'ttytype'* *'tty'*
7429'ttytype' 'tty' string (default from $TERM)
7430 global
7431 Alias for 'term', see above.
7432
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007433 *'undodir'* *'udir'*
7434'undodir' 'udir' string (default ".")
7435 global
7436 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007437 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007438 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007439 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007440 "." means using the directory of the file. The undo file name for
7441 "file.txt" is ".file.txt.un~".
7442 For other directories the file name is the full path of the edited
7443 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007444 When writing: The first directory that exists is used. "." always
7445 works, no directories after "." will be used for writing.
7446 When reading all entries are tried to find an undo file. The first
7447 undo file that exists is used. When it cannot be read an error is
7448 given, no further entry is used.
7449 See |undo-persistence|.
7450
7451 *'undofile'* *'udf'*
7452'undofile' 'udf' boolean (default off)
7453 local to buffer
7454 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007455 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007456 When on, Vim automatically saves undo history to an undo file when
7457 writing a buffer to a file, and restores undo history from the same
7458 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007459 The directory where the undo file is stored is specified by 'undodir'.
7460 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007461 The undo file is not read when 'undoreload' causes the buffer from
7462 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007463 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007464
Bram Moolenaar071d4272004-06-13 20:20:40 +00007465 *'undolevels'* *'ul'*
7466'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7467 Win32 and OS/2)
7468 global
7469 {not in Vi}
7470 Maximum number of changes that can be undone. Since undo information
7471 is kept in memory, higher numbers will cause more memory to be used
7472 (nevertheless, a single change can use an unlimited amount of memory).
7473 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7474 itself: >
7475 set ul=0
7476< But you can also get Vi compatibility by including the 'u' flag in
7477 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007478 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 Set to a negative number for no undo at all: >
7480 set ul=-1
7481< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007482 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007483
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007484 *'undoreload'* *'ur'*
7485'undoreload' 'ur' number (default 10000)
7486 global
7487 {not in Vi}
7488 Save the whole buffer for undo when reloading it. This applies to the
7489 ":e!" command and reloading for when the buffer changed outside of
7490 Vim. |FileChangedShell|
7491 The save only happens when this options is negative or when the number
7492 of lines is smaller than the value of this option.
7493 Set this option to zero to disable undo for a reload.
7494
7495 When saving undo for a reload, any undo file is not read.
7496
7497 Note that this causes the whole buffer to be stored in memory. Set
7498 this option to a lower value if you run out of memory.
7499
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500 *'updatecount'* *'uc'*
7501'updatecount' 'uc' number (default: 200)
7502 global
7503 {not in Vi}
7504 After typing this many characters the swap file will be written to
7505 disk. When zero, no swap file will be created at all (see chapter on
7506 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7507 Vim with the "-n" option, see |startup|. When editing in readonly
7508 mode this option will be initialized to 10000.
7509 The swapfile can be disabled per buffer with |'swapfile'|.
7510 When 'updatecount' is set from zero to non-zero, swap files are
7511 created for all buffers that have 'swapfile' set. When 'updatecount'
7512 is set to zero, existing swap files are not deleted.
7513 Also see |'swapsync'|.
7514 This option has no meaning in buffers where |'buftype'| is "nofile"
7515 or "nowrite".
7516
7517 *'updatetime'* *'ut'*
7518'updatetime' 'ut' number (default 4000)
7519 global
7520 {not in Vi}
7521 If this many milliseconds nothing is typed the swap file will be
7522 written to disk (see |crash-recovery|). Also used for the
7523 |CursorHold| autocommand event.
7524
7525 *'verbose'* *'vbs'*
7526'verbose' 'vbs' number (default 0)
7527 global
7528 {not in Vi, although some versions have a boolean
7529 verbose option}
7530 When bigger than zero, Vim will give messages about what it is doing.
7531 Currently, these messages are given:
7532 >= 1 When the viminfo file is read or written.
7533 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007534 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 >= 8 Files for which a group of autocommands is executed.
7536 >= 9 Every executed autocommand.
7537 >= 12 Every executed function.
7538 >= 13 When an exception is thrown, caught, finished, or discarded.
7539 >= 14 Anything pending in a ":finally" clause.
7540 >= 15 Every executed Ex command (truncated at 200 characters).
7541
7542 This option can also be set with the "-V" argument. See |-V|.
7543 This option is also set by the |:verbose| command.
7544
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007545 When the 'verbosefile' option is set then the verbose messages are not
7546 displayed.
7547
7548 *'verbosefile'* *'vfile'*
7549'verbosefile' 'vfile' string (default empty)
7550 global
7551 {not in Vi}
7552 When not empty all messages are written in a file with this name.
7553 When the file exists messages are appended.
7554 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007555 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007556 Setting 'verbosefile' to a new value is like making it empty first.
7557 The difference with |:redir| is that verbose messages are not
7558 displayed when 'verbosefile' is set.
7559
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 *'viewdir'* *'vdir'*
7561'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7562 "$VIM/vimfiles/view",
7563 for Unix: "~/.vim/view",
7564 for Macintosh: "$VIM:vimfiles:view"
7565 for VMS: "sys$login:vimfiles/view"
7566 for RiscOS: "Choices:vimfiles/view")
7567 global
7568 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007569 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 feature}
7571 Name of the directory where to store files for |:mkview|.
7572 This option cannot be set from a |modeline| or in the |sandbox|, for
7573 security reasons.
7574
7575 *'viewoptions'* *'vop'*
7576'viewoptions' 'vop' string (default: "folds,options,cursor")
7577 global
7578 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007579 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 feature}
7581 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007582 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 word save and restore ~
7584 cursor cursor position in file and in window
7585 folds manually created folds, opened/closed folds and local
7586 fold options
7587 options options and mappings local to a window or buffer (not
7588 global values for local options)
7589 slash backslashes in file names replaced with forward
7590 slashes
7591 unix with Unix end-of-line format (single <NL>), even when
7592 on Windows or DOS
7593
7594 "slash" and "unix" are useful on Windows when sharing view files
7595 with Unix. The Unix version of Vim cannot source dos format scripts,
7596 but the Windows version of Vim can source unix format scripts.
7597
7598 *'viminfo'* *'vi'* *E526* *E527* *E528*
7599'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007600 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7601 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7602 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 global
7604 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007605 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 feature}
7607 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007608 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 separated list of parameters, each consisting of a single character
7610 identifying the particular parameter, followed by a number or string
7611 which specifies the value of that parameter. If a particular
7612 character is left out, then the default value is used for that
7613 parameter. The following is a list of the identifying characters and
7614 the effect of their value.
7615 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007616 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007617 ! When included, save and restore global variables that start
7618 with an uppercase letter, and don't contain a lowercase
7619 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007620 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007621 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007622 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 " Maximum number of lines saved for each register. Old name of
7624 the '<' item, with the disadvantage that you need to put a
7625 backslash before the ", otherwise it will be recognized as the
7626 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007627 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 % When included, save and restore the buffer list. If Vim is
7629 started with a file name argument, the buffer list is not
7630 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007631 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 without a file name and buffers for help files are not written
7633 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007634 When followed by a number, the number specifies the maximum
7635 number of buffers that are stored. Without a number all
7636 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007637 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 ' Maximum number of previously edited files for which the marks
7639 are remembered. This parameter must always be included when
7640 'viminfo' is non-empty.
7641 Including this item also means that the |jumplist| and the
7642 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007643 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007645 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 patterns are also saved. When not included, the value of
7647 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007648 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007650 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007651 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 < Maximum number of lines saved for each register. If zero then
7653 registers are not saved. When not included, all lines are
7654 saved. '"' is the old name for this item.
7655 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007656 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007658 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007659 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 c When included, convert the text in the viminfo file from the
7661 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007662 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007663 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 f Whether file marks need to be stored. If zero, file marks ('0
7665 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007666 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007668 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 h Disable the effect of 'hlsearch' when loading the viminfo
7670 file. When not included, it depends on whether ":nohlsearch"
7671 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007672 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 n Name of the viminfo file. The name must immediately follow
7674 the 'n'. Must be the last one! If the "-i" argument was
7675 given when starting Vim, that file name overrides the one
7676 given here with 'viminfo'. Environment variables are expanded
7677 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007678 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007679 r Removable media. The argument is a string (up to the next
7680 ','). This parameter can be given several times. Each
7681 specifies the start of a path for which no marks will be
7682 stored. This is to avoid removable media. For MS-DOS you
7683 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7684 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7685 ignored. Maximum length of each 'r' argument is 50
7686 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007687 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007688 s Maximum size of an item in Kbyte. If zero then registers are
7689 not saved. Currently only applies to registers. The default
7690 "s10" will exclude registers with more than 10 Kbyte of text.
7691 Also see the '<' item above: line count limit.
7692
7693 Example: >
7694 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7695<
7696 '50 Marks will be remembered for the last 50 files you
7697 edited.
7698 <1000 Contents of registers (up to 1000 lines each) will be
7699 remembered.
7700 s100 Registers with more than 100 Kbyte text are skipped.
7701 :0 Command-line history will not be saved.
7702 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7703 no / Since '/' is not specified, the default will be used,
7704 that is, save all of the search history, and also the
7705 previous search and substitute patterns.
7706 no % The buffer list will not be saved nor read back.
7707 no h 'hlsearch' highlighting will be restored.
7708
7709 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7710 load the contents of the file, this is not done automatically.
7711
7712 This option cannot be set from a |modeline| or in the |sandbox|, for
7713 security reasons.
7714
7715 *'virtualedit'* *'ve'*
7716'virtualedit' 've' string (default "")
7717 global
7718 {not in Vi}
7719 {not available when compiled without the
7720 |+virtualedit| feature}
7721 A comma separated list of these words:
7722 block Allow virtual editing in Visual block mode.
7723 insert Allow virtual editing in Insert mode.
7724 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007725 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007726
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007728 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 of the line. Useful for selecting a rectangle in Visual mode and
7730 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007731 "onemore" is not the same, it will only allow moving the cursor just
7732 after the last character of the line. This makes some commands more
7733 consistent. Previously the cursor was always past the end of the line
7734 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007735 break some plugins or Vim scripts. For example because |l| can move
7736 the cursor after the last character. Use with care!
7737 Using the |$| command will move to the last character in the line, not
7738 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007739 It doesn't make sense to combine "all" with "onemore", but you will
7740 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007741
7742 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7743'visualbell' 'vb' boolean (default off)
7744 global
7745 {not in Vi}
7746 Use visual bell instead of beeping. The terminal code to display the
7747 visual bell is given with 't_vb'. When no beep or flash is wanted,
7748 use ":set vb t_vb=".
7749 Note: When the GUI starts, 't_vb' is reset to its default value. You
7750 might want to set it again in your |gvimrc|.
7751 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7752 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7753 where 40 is the time in msec.
7754 Does not work on the Amiga, you always get a screen flash.
7755 Also see 'errorbells'.
7756
7757 *'warn'* *'nowarn'*
7758'warn' boolean (default on)
7759 global
7760 Give a warning message when a shell command is used while the buffer
7761 has been changed.
7762
7763 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7764'weirdinvert' 'wiv' boolean (default off)
7765 global
7766 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007767 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 It is provided for backwards compatibility with version 4.x.
7769 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7770 vice versa. Has no effect when the GUI is running.
7771
7772 *'whichwrap'* *'ww'*
7773'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7774 global
7775 {not in Vi}
7776 Allow specified keys that move the cursor left/right to move to the
7777 previous/next line when the cursor is on the first/last character in
7778 the line. Concatenate characters to allow this for these keys:
7779 char key mode ~
7780 b <BS> Normal and Visual
7781 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007782 h "h" Normal and Visual (not recommended)
7783 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 < <Left> Normal and Visual
7785 > <Right> Normal and Visual
7786 ~ "~" Normal
7787 [ <Left> Insert and Replace
7788 ] <Right> Insert and Replace
7789 For example: >
7790 :set ww=<,>,[,]
7791< allows wrap only when cursor keys are used.
7792 When the movement keys are used in combination with a delete or change
7793 operator, the <EOL> also counts for a character. This makes "3h"
7794 different from "3dh" when the cursor crosses the end of a line. This
7795 is also true for "x" and "X", because they do the same as "dl" and
7796 "dh". If you use this, you may also want to use the mapping
7797 ":map <BS> X" to make backspace delete the character in front of the
7798 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007799 When 'l' is included and it is used after an operator at the end of a
7800 line then it will not move to the next line. This makes "dl", "cl",
7801 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 NOTE: This option is set to the Vi default value when 'compatible' is
7803 set and to the Vim default value when 'compatible' is reset.
7804
7805 *'wildchar'* *'wc'*
7806'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7807 global
7808 {not in Vi}
7809 Character you have to type to start wildcard expansion in the
7810 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007811 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 The character is not recognized when used inside a macro. See
7813 'wildcharm' for that.
7814 Although 'wc' is a number option, you can set it to a special key: >
7815 :set wc=<Esc>
7816< NOTE: This option is set to the Vi default value when 'compatible' is
7817 set and to the Vim default value when 'compatible' is reset.
7818
7819 *'wildcharm'* *'wcm'*
7820'wildcharm' 'wcm' number (default: none (0))
7821 global
7822 {not in Vi}
7823 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007824 recognized when used inside a macro. You can find "spare" command-line
7825 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 you'll never actually type 'wildcharm', just use it in mappings that
7827 automatically invoke completion mode, e.g.: >
7828 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007829 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830< Then after typing :ss you can use CTRL-P & CTRL-N.
7831
7832 *'wildignore'* *'wig'*
7833'wildignore' 'wig' string (default "")
7834 global
7835 {not in Vi}
7836 {not available when compiled without the |+wildignore|
7837 feature}
7838 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007839 patterns is ignored when completing file or directory names, and
7840 influences the result of |expand()|, |glob()| and |globpath()| unless
7841 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7843 Also see 'suffixes'.
7844 Example: >
7845 :set wildignore=*.o,*.obj
7846< The use of |:set+=| and |:set-=| is preferred when adding or removing
7847 a pattern from the list. This avoids problems when a future version
7848 uses another default.
7849
Bram Moolenaar94950a92010-12-02 16:01:29 +01007850
Bram Moolenaar81af9252010-12-10 20:35:50 +01007851 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007852'wildignorecase' 'wic' boolean (default off)
7853 global
7854 {not in Vi}
7855 When set case is ignored when completing file names and directories.
7856 Has no effect on systems where file name case is generally ignored.
7857 Does not apply when the shell is used to expand wildcards, which
7858 happens when there are special characters.
7859
7860
Bram Moolenaar071d4272004-06-13 20:20:40 +00007861 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7862'wildmenu' 'wmnu' boolean (default off)
7863 global
7864 {not in Vi}
7865 {not available if compiled without the |+wildmenu|
7866 feature}
7867 When 'wildmenu' is on, command-line completion operates in an enhanced
7868 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7869 the possible matches are shown just above the command line, with the
7870 first match highlighted (overwriting the status line, if there is
7871 one). Keys that show the previous/next match, such as <Tab> or
7872 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7873 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7874 specified. "longest" and "list" do not start "wildmenu" mode.
7875 If there are more matches than can fit in the line, a ">" is shown on
7876 the right and/or a "<" is shown on the left. The status line scrolls
7877 as needed.
7878 The "wildmenu" mode is abandoned when a key is hit that is not used
7879 for selecting a completion.
7880 While the "wildmenu" is active the following keys have special
7881 meanings:
7882
7883 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7884 <Down> - in filename/menu name completion: move into a
7885 subdirectory or submenu.
7886 <CR> - in menu completion, when the cursor is just after a
7887 dot: move into a submenu.
7888 <Up> - in filename/menu name completion: move up into
7889 parent directory or parent menu.
7890
7891 This makes the menus accessible from the console |console-menus|.
7892
7893 If you prefer the <Left> and <Right> keys to move the cursor instead
7894 of selecting a different match, use this: >
7895 :cnoremap <Left> <Space><BS><Left>
7896 :cnoremap <Right> <Space><BS><Right>
7897<
7898 The "WildMenu" highlighting is used for displaying the current match
7899 |hl-WildMenu|.
7900
7901 *'wildmode'* *'wim'*
7902'wildmode' 'wim' string (Vim default: "full")
7903 global
7904 {not in Vi}
7905 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007906 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007907 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 first part specifies the behavior for the first use of 'wildchar',
7909 The second part for the second use, etc.
7910 These are the possible values for each part:
7911 "" Complete only the first match.
7912 "full" Complete the next full match. After the last match,
7913 the original string is used and then the first match
7914 again.
7915 "longest" Complete till longest common string. If this doesn't
7916 result in a longer string, use the next part.
7917 "longest:full" Like "longest", but also start 'wildmenu' if it is
7918 enabled.
7919 "list" When more than one match, list all matches.
7920 "list:full" When more than one match, list all matches and
7921 complete first match.
7922 "list:longest" When more than one match, list all matches and
7923 complete till longest common string.
7924 When there is only a single match, it is fully completed in all cases.
7925
7926 Examples: >
7927 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007928< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007929 :set wildmode=longest,full
7930< Complete longest common string, then each full match >
7931 :set wildmode=list:full
7932< List all matches and complete each full match >
7933 :set wildmode=list,full
7934< List all matches without completing, then each full match >
7935 :set wildmode=longest,list
7936< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007937 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007939 *'wildoptions'* *'wop'*
7940'wildoptions' 'wop' string (default "")
7941 global
7942 {not in Vi}
7943 {not available when compiled without the |+wildignore|
7944 feature}
7945 A list of words that change how command line completion is done.
7946 Currently only one word is allowed:
7947 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007948 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007949 is displayed per line. Often used tag kinds are:
7950 d #define
7951 f function
7952 Also see |cmdline-completion|.
7953
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 *'winaltkeys'* *'wak'*
7955'winaltkeys' 'wak' string (default "menu")
7956 global
7957 {not in Vi}
7958 {only used in Win32, Motif, GTK and Photon GUI}
7959 Some GUI versions allow the access to menu entries by using the ALT
7960 key in combination with a character that appears underlined in the
7961 menu. This conflicts with the use of the ALT key for mappings and
7962 entering special characters. This option tells what to do:
7963 no Don't use ALT keys for menus. ALT key combinations can be
7964 mapped, but there is no automatic handling. This can then be
7965 done with the |:simalt| command.
7966 yes ALT key handling is done by the windowing system. ALT key
7967 combinations cannot be mapped.
7968 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007969 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 keys can be mapped.
7971 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7972 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007973 This option is not used for <F10>; on Win32 and with GTK <F10> will
7974 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007976 *'window'* *'wi'*
7977'window' 'wi' number (default screen height - 1)
7978 global
7979 Window height. Do not confuse this with the height of the Vim window,
7980 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007981 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7982 value is smaller than 'lines' minus one. The screen will scroll
7983 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007984 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7985 in a much smarter way, taking care of wrapping lines.
7986 When resizing the Vim window, the value is smaller than 1 or more than
7987 or equal to 'lines' it will be set to 'lines' minus 1.
7988 {Vi also uses the option to specify the number of displayed lines}
7989
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 *'winheight'* *'wh'* *E591*
7991'winheight' 'wh' number (default 1)
7992 global
7993 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007994 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 feature}
7996 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007997 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007998 focus goes to a window that is smaller, its size is increased, at the
7999 cost of the height of other windows.
8000 Set 'winheight' to a small number for normal editing.
8001 Set it to 999 to make the current window fill most of the screen.
8002 Other windows will be only 'winminheight' high. This has the drawback
8003 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8004 to create only two windows, set the option after startup is done,
8005 using the |VimEnter| event: >
8006 au VimEnter * set winheight=999
8007< Minimum value is 1.
8008 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 height of the current window.
8010 'winheight' applies to the current window. Use 'winminheight' to set
8011 the minimal height for other windows.
8012
8013 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8014'winfixheight' 'wfh' boolean (default off)
8015 local to window
8016 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008017 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 feature}
8019 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008020 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8021 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 The height may be changed anyway when running out of room.
8023
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008024 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8025'winfixwidth' 'wfw' boolean (default off)
8026 local to window
8027 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008028 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008029 feature}
8030 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008031 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008032 The width may be changed anyway when running out of room.
8033
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 *'winminheight'* *'wmh'*
8035'winminheight' 'wmh' number (default 1)
8036 global
8037 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008038 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 feature}
8040 The minimal height of a window, when it's not the current window.
8041 This is a hard minimum, windows will never become smaller.
8042 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8043 status bar) if necessary. They will return to at least one line when
8044 they become active (since the cursor has to have somewhere to go.)
8045 Use 'winheight' to set the minimal height of the current window.
8046 This option is only checked when making a window smaller. Don't use a
8047 large number, it will cause errors when opening more than a few
8048 windows. A value of 0 to 3 is reasonable.
8049
8050 *'winminwidth'* *'wmw'*
8051'winminwidth' 'wmw' number (default 1)
8052 global
8053 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008054 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 feature}
8056 The minimal width of a window, when it's not the current window.
8057 This is a hard minimum, windows will never become smaller.
8058 When set to zero, windows may be "squashed" to zero columns (i.e. just
8059 a vertical separator) if necessary. They will return to at least one
8060 line when they become active (since the cursor has to have somewhere
8061 to go.)
8062 Use 'winwidth' to set the minimal width of the current window.
8063 This option is only checked when making a window smaller. Don't use a
8064 large number, it will cause errors when opening more than a few
8065 windows. A value of 0 to 12 is reasonable.
8066
8067 *'winwidth'* *'wiw'* *E592*
8068'winwidth' 'wiw' number (default 20)
8069 global
8070 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008071 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 feature}
8073 Minimal number of columns for the current window. This is not a hard
8074 minimum, Vim will use fewer columns if there is not enough room. If
8075 the current window is smaller, its size is increased, at the cost of
8076 the width of other windows. Set it to 999 to make the current window
8077 always fill the screen. Set it to a small number for normal editing.
8078 The width is not adjusted after one of the commands to change the
8079 width of the current window.
8080 'winwidth' applies to the current window. Use 'winminwidth' to set
8081 the minimal width for other windows.
8082
8083 *'wrap'* *'nowrap'*
8084'wrap' boolean (default on)
8085 local to window
8086 {not in Vi}
8087 This option changes how text is displayed. It doesn't change the text
8088 in the buffer, see 'textwidth' for that.
8089 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008090 displaying continues on the next line. When off lines will not wrap
8091 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 moved to a part that is not shown, the screen will scroll
8093 horizontally.
8094 The line will be broken in the middle of a word if necessary. See
8095 'linebreak' to get the break at a word boundary.
8096 To make scrolling horizontally a bit more useful, try this: >
8097 :set sidescroll=5
8098 :set listchars+=precedes:<,extends:>
8099< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008100 This option can't be set from a |modeline| when the 'diff' option is
8101 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102
8103 *'wrapmargin'* *'wm'*
8104'wrapmargin' 'wm' number (default 0)
8105 local to buffer
8106 Number of characters from the right window border where wrapping
8107 starts. When typing text beyond this limit, an <EOL> will be inserted
8108 and inserting continues on the next line.
8109 Options that add a margin, such as 'number' and 'foldcolumn', cause
8110 the text width to be further reduced. This is Vi compatible.
8111 When 'textwidth' is non-zero, this option is not used.
8112 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8113 and less usefully}
8114
8115 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8116'wrapscan' 'ws' boolean (default on) *E384* *E385*
8117 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008118 Searches wrap around the end of the file. Also applies to |]s| and
8119 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120
8121 *'write'* *'nowrite'*
8122'write' boolean (default on)
8123 global
8124 {not in Vi}
8125 Allows writing files. When not set, writing a file is not allowed.
8126 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008127 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 argument. Filtering text is still possible, even though this requires
8129 writing a temporary file.
8130
8131 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8132'writeany' 'wa' boolean (default off)
8133 global
8134 Allows writing to any file with no need for "!" override.
8135
8136 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8137'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8138 otherwise)
8139 global
8140 {not in Vi}
8141 Make a backup before overwriting a file. The backup is removed after
8142 the file was successfully written, unless the 'backup' option is
8143 also on. Reset this option if your file system is almost full. See
8144 |backup-table| for another explanation.
8145 When the 'backupskip' pattern matches, a backup is not made anyway.
8146 NOTE: This option is set to the default value when 'compatible' is
8147 set.
8148
8149 *'writedelay'* *'wd'*
8150'writedelay' 'wd' number (default 0)
8151 global
8152 {not in Vi}
8153 The number of microseconds to wait for each character sent to the
8154 screen. When non-zero, characters are sent to the terminal one by
8155 one. For MS-DOS pcterm this does not work. For debugging purposes.
8156
8157 vim:tw=78:ts=8:ft=help:norl: