blob: 983cf5b346e62b85336b9b748b41d3715a7c23db [file] [log] [blame]
Bram Moolenaard58e9292011-02-09 17:07:58 +01001*options.txt* For Vim version 7.3. Last change: 2011 Jan 30
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 Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200276 With the "all" argument: display local values for all
277 local options.
278 Without argument: Display local values for all local
279 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200301 With the "all" argument: display global values for all
302 local options.
303 Without argument: display global values for all local
304 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
Bram Moolenaard58e9292011-02-09 17:07:58 +0100364 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000365:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
366:opt[ions] Open a window for viewing and setting all options.
367 Options are grouped by function.
368 Offers short help for each option. Hit <CR> on the
369 short help to open a help window with more help for
370 the option.
371 Modify the value of the option and hit <CR> on the
372 "set" line to set the new value. For window and
373 buffer specific options, the last accessed window is
374 used to set the option value in, unless this is a help
375 window, in which case the window below help window is
376 used (skipping the option-window).
377 {not available when compiled without the |+eval| or
378 |+autocmd| features}
379
380 *$HOME*
381Using "~" is like using "$HOME", but it is only recognized at the start of an
382option and after a space or comma.
383
384On Unix systems "~user" can be used too. It is replaced by the home directory
385of user "user". Example: >
386 :set path=~mool/include,/usr/include,.
387
388On Unix systems the form "${HOME}" can be used too. The name between {} can
389contain non-id characters then. Note that if you want to use this for the
390"gf" command, you need to add the '{' and '}' characters to 'isfname'.
391
392NOTE: expanding environment variables and "~/" is only done with the ":set"
393command, not when assigning a value to an option with ":let".
394
395
396Note the maximum length of an expanded option is limited. How much depends on
397the system, mostly it is something like 256 or 1024 characters.
398
399 *:fix* *:fixdel*
400:fix[del] Set the value of 't_kD':
401 't_kb' is 't_kD' becomes ~
402 CTRL-? CTRL-H
403 not CTRL-? CTRL-?
404
405 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
406
407 If your delete key terminal code is wrong, but the
408 code for backspace is alright, you can put this in
409 your .vimrc: >
410 :fixdel
411< This works no matter what the actual code for
412 backspace is.
413
414 If the backspace key terminal code is wrong you can
415 use this: >
416 :if &term == "termname"
417 : set t_kb=^V<BS>
418 : fixdel
419 :endif
420< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000421 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422 with your terminal name.
423
424 If your <Delete> key sends a strange key sequence (not
425 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
426 :if &term == "termname"
427 : set t_kD=^V<Delete>
428 :endif
429< Where "^V" is CTRL-V and "<Delete>" is the delete key
430 (don't type eight characters!). Replace "termname"
431 with your terminal name.
432
433 *Linux-backspace*
434 Note about Linux: By default the backspace key
435 produces CTRL-?, which is wrong. You can fix it by
436 putting this line in your rc.local: >
437 echo "keycode 14 = BackSpace" | loadkeys
438<
439 *NetBSD-backspace*
440 Note about NetBSD: If your backspace doesn't produce
441 the right code, try this: >
442 xmodmap -e "keycode 22 = BackSpace"
443< If this works, add this in your .Xmodmap file: >
444 keysym 22 = BackSpace
445< You need to restart for this to take effect.
446
447==============================================================================
4482. Automatically setting options *auto-setting*
449
450Besides changing options with the ":set" command, there are three alternatives
451to set options automatically for one or more files:
452
4531. When starting Vim initializations are read from various places. See
454 |initialization|. Most of them are performed for all editing sessions,
455 and some of them depend on the directory where Vim is started.
456 You can create an initialization file with |:mkvimrc|, |:mkview| and
457 |:mksession|.
4582. If you start editing a new file, the automatic commands are executed.
459 This can be used to set options for files matching a particular pattern and
460 many other things. See |autocommand|.
4613. If you start editing a new file, and the 'modeline' option is on, a
462 number of lines at the beginning and end of the file are checked for
463 modelines. This is explained here.
464
465 *modeline* *vim:* *vi:* *ex:* *E520*
466There are two forms of modelines. The first form:
467 [text]{white}{vi:|vim:|ex:}[white]{options}
468
469[text] any text or empty
470{white} at least one blank character (<Space> or <Tab>)
471{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
472[white] optional white space
473{options} a list of option settings, separated with white space or ':',
474 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000475 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000477Example:
478 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479
480The second form (this is compatible with some versions of Vi):
481
482 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
483
484[text] any text or empty
485{white} at least one blank character (<Space> or <Tab>)
486{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
487[white] optional white space
488se[t] the string "set " or "se " (note the space)
489{options} a list of options, separated with white space, which is the
490 argument for a ":set" command
491: a colon
492[text] any text or empty
493
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000494Example:
495 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496
497The white space before {vi:|vim:|ex:} is required. This minimizes the chance
498that a normal word like "lex:" is caught. There is one exception: "vi:" and
499"vim:" can also be at the start of the line (for compatibility with version
5003.0). Using "ex:" at the start of the line will be ignored (this could be
501short for "example:").
502
503 *modeline-local*
504The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000505buffer and window that contain the file. Although it's possible to set global
506options from a modeline, this is unusual. If you have two windows open and
507the files in it set the same global option to a different value, the result
508depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000510When editing a file that was already loaded, only the window-local options
511from the modeline are used. Thus if you manually changed a buffer-local
512option after opening the file, it won't be changed if you edit the same buffer
513in another window. But window-local options will be set.
514
Bram Moolenaar071d4272004-06-13 20:20:40 +0000515 *modeline-version*
516If the modeline is only to be used for some versions of Vim, the version
517number can be specified where "vim:" is used:
518 vim{vers}: version {vers} or later
519 vim<{vers}: version before {vers}
520 vim={vers}: version {vers}
521 vim>{vers}: version after {vers}
522{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000523For example, to use a modeline only for Vim 6.0 and later:
524 /* vim600: set foldmethod=marker: */ ~
525To use a modeline for Vim before version 5.7:
526 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527There can be no blanks between "vim" and the ":".
528
529
530The number of lines that are checked can be set with the 'modelines' option.
531If 'modeline' is off or 'modelines' is 0 no lines are checked.
532
533Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000534like:
535 /* vi:ts=4: */ ~
536will give an error message for the trailing "*/". This line is OK:
537 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539If an error is detected the rest of the line is skipped.
540
541If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000542backslash in front of the ':' will be removed. Example:
543 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544This sets the 'dir' option to "c:\tmp". Only a single backslash before the
545':' is removed. Thus to include "\:" you have to specify "\\:".
546
547No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000548might create a Trojan horse text file with modelines). And not all options
549can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000550|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000551causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
552are wrapped unexpectedly. So disable modelines before editing untrusted text.
553The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554
555Hint: If you would like to do something else than setting an option, you could
556define an autocommand that checks the file for a specific string. For
557example: >
558 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
559And define a function SetVar() that does something with the line containing
560"VAR".
561
562==============================================================================
5633. Options summary *option-summary*
564
565In the list below all the options are mentioned with their full name and with
566an abbreviation if there is one. Both forms may be used.
567
568In this document when a boolean option is "set" that means that ":set option"
569is entered. When an option is "reset", ":set nooption" is used.
570
571For some options there are two default values: The "Vim default", which is
572used when 'compatible' is not set, and the "Vi default", which is used when
573'compatible' is set.
574
575Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000576are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577different value in each window. For example the 'list' option can be set in
578one window and reset in another for the same text, giving both types of view
579at the same time. There are a few options that are specific to a certain
580file. These can have a different value for each file or buffer. For example
581the 'textwidth' option can be 78 for a normal text file and 0 for a C
582program.
583
584 global one option for all buffers and windows
585 local to window each window has its own copy of this option
586 local to buffer each buffer has its own copy of this option
587
588When creating a new window the option values from the currently active window
589are used as a default value for the window-specific options. For the
590buffer-specific options this depends on the 's' and 'S' flags in the
591'cpoptions' option. If 's' is included (which is the default) the values for
592buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593first entered. If 'S' is present the options are copied each time the buffer
594is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595present, the options are copied from the currently active buffer when the
596buffer is created.
597
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000598Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000599
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000600Not all options are supported in all versions. This depends on the supported
601features and sometimes on the system. A remark about this is in curly braces
602below. When an option is not supported it may still be set without getting an
603error, this is called a hidden option. You can't get the value of a hidden
604option though, it is not stored.
605
606To test if option "foo" can be used with ":set" use something like this: >
607 if exists('&foo')
608This also returns true for a hidden option. To test if option "foo" is really
609supported use something like this: >
610 if exists('+foo')
611<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 *E355*
613A jump table for the options with a short description can be found at |Q_op|.
614
615 *'aleph'* *'al'* *aleph* *Aleph*
616'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
617 global
618 {not in Vi}
619 {only available when compiled with the |+rightleft|
620 feature}
621 The ASCII code for the first letter of the Hebrew alphabet. The
622 routine that maps the keyboard in Hebrew mode, both in Insert mode
623 (when hkmap is set) and on the command-line (when hitting CTRL-_)
624 outputs the Hebrew characters in the range [aleph..aleph+26].
625 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
626 See |rileft.txt|.
627
628 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
629'allowrevins' 'ari' boolean (default off)
630 global
631 {not in Vi}
632 {only available when compiled with the |+rightleft|
633 feature}
634 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
635 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
636 into reverse Insert mode, and don't know how to get out. See
637 'revins'.
638 NOTE: This option is reset when 'compatible' is set.
639
640 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
641'altkeymap' 'akm' boolean (default off)
642 global
643 {not in Vi}
644 {only available when compiled with the |+farsi|
645 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000646 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000647 the keyboard map between Farsi and English, when 'allowrevins' set.
648
Bram Moolenaar582fd852005-03-28 20:58:01 +0000649 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 is useful to start the Vim in native mode i.e. English (left-to-right
651 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000652 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653
654 *'ambiwidth'* *'ambw'*
655'ambiwidth' 'ambw' string (default: "single")
656 global
657 {not in Vi}
658 {only available when compiled with the |+multi_byte|
659 feature}
660 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
661 Tells Vim what to do with characters with East Asian Width Class
662 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
663 letters, Cyrillic letters).
664
665 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000666 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667 expected by most users.
668 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200669 *E834* *E835*
670 The value "double" cannot be used if 'listchars' or 'fillchars'
671 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672
673 There are a number of CJK fonts for which the width of glyphs for
674 those characters are solely based on how many octets they take in
675 legacy/traditional CJK encodings. In those encodings, Euro,
676 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000677 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000679 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680 Vim is running inside a terminal (emulators) that uses a CJK font
681 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
682 this option should be set to "double" to match the width perceived
683 by Vim with the width of glyphs in the font. Perhaps it also has
684 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
685 when the system locale is set to one of CJK locales. See Unicode
686 Standard Annex #11 (http://www.unicode.org/reports/tr11).
687
688 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
689'antialias' 'anti' boolean (default: off)
690 global
691 {not in Vi}
692 {only available when compiled with GUI enabled
693 on Mac OS X}
694 This option only has an effect in the GUI version of Vim on Mac OS X
695 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
696 which can be easier to read at certain sizes on certain displays.
697 Setting this option can sometimes cause problems if 'guifont' is set
698 to its default (empty string).
699
700 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
701'autochdir' 'acd' boolean (default off)
702 global
703 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200704 {only available when compiled with it, use
705 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000706 When on, Vim will change the current working directory whenever you
707 open a file, switch buffers, delete a buffer or open/close a window.
708 It will change to the directory containing the file which was opened
709 or selected.
710 This option is provided for backward compatibility with the Vim
711 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000712 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713
714 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
715'arabic' 'arab' boolean (default off)
716 local to window
717 {not in Vi}
718 {only available when compiled with the |+arabic|
719 feature}
720 This option can be set to start editing Arabic text.
721 Setting this option will:
722 - Set the 'rightleft' option, unless 'termbidi' is set.
723 - Set the 'arabicshape' option, unless 'termbidi' is set.
724 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
725 between typing English and Arabic key mapping.
726 - Set the 'delcombine' option
727 Note that 'encoding' must be "utf-8" for working with Arabic text.
728
729 Resetting this option will:
730 - Reset the 'rightleft' option.
731 - Disable the use of 'keymap' (without changing its value).
732 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
733 option.
734 Also see |arabic.txt|.
735
736 *'arabicshape'* *'arshape'*
737 *'noarabicshape'* *'noarshape'*
738'arabicshape' 'arshape' boolean (default on)
739 global
740 {not in Vi}
741 {only available when compiled with the |+arabic|
742 feature}
743 When on and 'termbidi' is off, the required visual character
744 corrections that need to take place for displaying the Arabic language
745 take affect. Shaping, in essence, gets enabled; the term is a broad
746 one which encompasses:
747 a) the changing/morphing of characters based on their location
748 within a word (initial, medial, final and stand-alone).
749 b) the enabling of the ability to compose characters
750 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100751 When disabled the display shows each character's true stand-alone
752 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 Arabic is a complex language which requires other settings, for
754 further details see |arabic.txt|.
755
756 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
757'autoindent' 'ai' boolean (default off)
758 local to buffer
759 Copy indent from current line when starting a new line (typing <CR>
760 in Insert mode or when using the "o" or "O" command). If you do not
761 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000762 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
763 to another line has the same effect, unless the 'I' flag is included
764 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000765 When autoindent is on, formatting (with the "gq" command or when you
766 reach 'textwidth' in Insert mode) uses the indentation of the first
767 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 When 'smartindent' or 'cindent' is on the indent is changed in
769 a different way.
770 The 'autoindent' option is reset when the 'paste' option is set.
771 {small difference from Vi: After the indent is deleted when typing
772 <Esc> or <CR>, the cursor position when moving up or down is after the
773 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
774
775 *'autoread'* *'ar'* *'noautoread'* *'noar'*
776'autoread' 'ar' boolean (default off)
777 global or local to buffer |global-local|
778 {not in Vi}
779 When a file has been detected to have been changed outside of Vim and
780 it has not been changed inside of Vim, automatically read it again.
781 When the file has been deleted this is not done. |timestamp|
782 If this option has a local value, use this command to switch back to
783 using the global value: >
784 :set autoread<
785<
786 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
787'autowrite' 'aw' boolean (default off)
788 global
789 Write the contents of the file, if it has been modified, on each
790 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000791 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000792 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
793 Note that for some commands the 'autowrite' option is not used, see
794 'autowriteall' for that.
795
796 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
797'autowriteall' 'awa' boolean (default off)
798 global
799 {not in Vi}
800 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
801 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
802 Setting this option also implies that Vim behaves like 'autowrite' has
803 been set.
804
805 *'background'* *'bg'*
806'background' 'bg' string (default "dark" or "light")
807 global
808 {not in Vi}
809 When set to "dark", Vim will try to use colors that look good on a
810 dark background. When set to "light", Vim will try to use colors that
811 look good on a light background. Any other value is illegal.
812 Vim tries to set the default value according to the terminal used.
813 This will not always be correct.
814 Setting this option does not change the background color, it tells Vim
815 what the background color looks like. For changing the background
816 color, see |:hi-normal|.
817
818 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000819 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000820 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822 setting 'background' will cause the color scheme to be reloaded. If
823 the color scheme adjusts to the value of 'background' this will work.
824 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100825 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 When setting 'background' to the default value with: >
828 :set background&
829< Vim will guess the value. In the GUI this should work correctly,
830 in other cases Vim might not be able to guess the right value.
831
832 When starting the GUI, the default value for 'background' will be
833 "light". When the value is not set in the .gvimrc, and Vim detects
834 that the background is actually quite dark, 'background' is set to
835 "dark". But this happens only AFTER the .gvimrc file has been read
836 (because the window needs to be opened to find the actual background
837 color). To get around this, force the GUI window to be opened by
838 putting a ":gui" command in the .gvimrc file, before where the value
839 of 'background' is used (e.g., before ":syntax on").
840 Normally this option would be set in the .vimrc file. Possibly
841 depending on the terminal name. Example: >
842 :if &term == "pcterm"
843 : set background=dark
844 :endif
845< When this option is set, the default settings for the highlight groups
846 will change. To use other settings, place ":highlight" commands AFTER
847 the setting of the 'background' option.
848 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
849 to select the colors for syntax highlighting. After changing this
850 option, you must load syntax.vim again to see the result. This can be
851 done with ":syntax on".
852
853 *'backspace'* *'bs'*
854'backspace' 'bs' string (default "")
855 global
856 {not in Vi}
857 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
858 mode. This is a list of items, separated by commas. Each item allows
859 a way to backspace over something:
860 value effect ~
861 indent allow backspacing over autoindent
862 eol allow backspacing over line breaks (join lines)
863 start allow backspacing over the start of insert; CTRL-W and CTRL-U
864 stop once at the start of insert.
865
866 When the value is empty, Vi compatible backspacing is used.
867
868 For backwards compatibility with version 5.4 and earlier:
869 value effect ~
870 0 same as ":set backspace=" (Vi compatible)
871 1 same as ":set backspace=indent,eol"
872 2 same as ":set backspace=indent,eol,start"
873
874 See |:fixdel| if your <BS> or <Del> key does not do what you want.
875 NOTE: This option is set to "" when 'compatible' is set.
876
877 *'backup'* *'bk'* *'nobackup'* *'nobk'*
878'backup' 'bk' boolean (default off)
879 global
880 {not in Vi}
881 Make a backup before overwriting a file. Leave it around after the
882 file has been successfully written. If you do not want to keep the
883 backup file, but you do want a backup while the file is being
884 written, reset this option and set the 'writebackup' option (this is
885 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000886 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 |backup-table| for more explanations.
888 When the 'backupskip' pattern matches, a backup is not made anyway.
889 When 'patchmode' is set, the backup may be renamed to become the
890 oldest version of a file.
891 NOTE: This option is reset when 'compatible' is set.
892
893 *'backupcopy'* *'bkc'*
894'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
895 global
896 {not in Vi}
897 When writing a file and a backup is made, this option tells how it's
898 done. This is a comma separated list of words.
899
900 The main values are:
901 "yes" make a copy of the file and overwrite the original one
902 "no" rename the file and write a new one
903 "auto" one of the previous, what works best
904
905 Extra values that can be combined with the ones above are:
906 "breaksymlink" always break symlinks when writing
907 "breakhardlink" always break hardlinks when writing
908
909 Making a copy and overwriting the original file:
910 - Takes extra time to copy the file.
911 + When the file has special attributes, is a (hard/symbolic) link or
912 has a resource fork, all this is preserved.
913 - When the file is a link the backup will have the name of the link,
914 not of the real file.
915
916 Renaming the file and writing a new one:
917 + It's fast.
918 - Sometimes not all attributes of the file can be copied to the new
919 file.
920 - When the file is a link the new file will not be a link.
921
922 The "auto" value is the middle way: When Vim sees that renaming file
923 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000924 the file is not a link) that is used. When problems are expected, a
925 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926
927 The "breaksymlink" and "breakhardlink" values can be used in
928 combination with any of "yes", "no" and "auto". When included, they
929 force Vim to always break either symbolic or hard links by doing
930 exactly what the "no" option does, renaming the original file to
931 become the backup and writing a new file in its place. This can be
932 useful for example in source trees where all the files are symbolic or
933 hard links and any changes should stay in the local source tree, not
934 be propagated back to the original source.
935 *crontab*
936 One situation where "no" and "auto" will cause problems: A program
937 that opens a file, invokes Vim to edit that file, and then tests if
938 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000939 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 example.
941
942 When a copy is made, the original file is truncated and then filled
943 with the new text. This means that protection bits, owner and
944 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000945 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946 group of the backup is set to the group of the original file. If this
947 fails, the protection bits for the group are made the same as for
948 others.
949
950 When the file is renamed this is the other way around: The backup has
951 the same attributes of the original file, and the newly written file
952 is owned by the current user. When the file was a (hard/symbolic)
953 link, the new file will not! That's why the "auto" value doesn't
954 rename when the file is a link. The owner and group of the newly
955 written file will be set to the same ones as the original file, but
956 the system may refuse to do this. In that case the "auto" value will
957 again not rename the file.
958
959 *'backupdir'* *'bdir'*
960'backupdir' 'bdir' string (default for Amiga: ".,t:",
961 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
962 for Unix: ".,~/tmp,~/")
963 global
964 {not in Vi}
965 List of directories for the backup file, separated with commas.
966 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100967 where this is possible. The directory must exist, Vim will not
968 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 - Empty means that no backup file will be created ('patchmode' is
970 impossible!). Writing may fail because of this.
971 - A directory "." means to put the backup file in the same directory
972 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000973 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 put the backup file relative to where the edited file is. The
975 leading "." is replaced with the path name of the edited file.
976 ("." inside a directory name has no special meaning).
977 - Spaces after the comma are ignored, other spaces are considered part
978 of the directory name. To have a space at the start of a directory
979 name, precede it with a backslash.
980 - To include a comma in a directory name precede it with a backslash.
981 - A directory name may end in an '/'.
982 - Environment variables are expanded |:set_env|.
983 - Careful with '\' characters, type one before a space, type two to
984 get one in the option (see |option-backslash|), for example: >
985 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
986< - For backwards compatibility with Vim version 3.0 a '>' at the start
987 of the option is removed.
988 See also 'backup' and 'writebackup' options.
989 If you want to hide your backup files on Unix, consider this value: >
990 :set backupdir=./.backup,~/.backup,.,/tmp
991< You must create a ".backup" directory in each directory and in your
992 home directory for this to work properly.
993 The use of |:set+=| and |:set-=| is preferred when adding or removing
994 directories from the list. This avoids problems when a future version
995 uses another default.
996 This option cannot be set from a |modeline| or in the |sandbox|, for
997 security reasons.
998
999 *'backupext'* *'bex'* *E589*
1000'backupext' 'bex' string (default "~", for VMS: "_")
1001 global
1002 {not in Vi}
1003 String which is appended to a file name to make the name of the
1004 backup file. The default is quite unusual, because this avoids
1005 accidentally overwriting existing files with a backup file. You might
1006 prefer using ".bak", but make sure that you don't have files with
1007 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001008 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001010 If you like to keep a lot of backups, you could use a BufWritePre
1011 autocommand to change 'backupext' just before writing the file to
1012 include a timestamp. >
1013 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1014< Use 'backupdir' to put the backup in a different directory.
1015
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 *'backupskip'* *'bsk'*
1017'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1018 global
1019 {not in Vi}
1020 {not available when compiled without the |+wildignore|
1021 feature}
1022 A list of file patterns. When one of the patterns matches with the
1023 name of the file which is written, no backup file is created. Both
1024 the specified file name and the full path name of the file are used.
1025 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1026 Watch out for special characters, see |option-backslash|.
1027 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001028 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001029
1030 Note that environment variables are not expanded. If you want to use
1031 $HOME you must expand it explicitly, e.g.: >
1032 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1033
1034< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001035 backup would be made by renaming the original file crontab won't see
1036 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037
1038 *'balloondelay'* *'bdlay'*
1039'balloondelay' 'bdlay' number (default: 600)
1040 global
1041 {not in Vi}
1042 {only available when compiled with the |+balloon_eval|
1043 feature}
1044 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1045
1046 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1047'ballooneval' 'beval' boolean (default off)
1048 global
1049 {not in Vi}
1050 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001051 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 Switch on the |balloon-eval| functionality.
1053
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001054 *'balloonexpr'* *'bexpr'*
1055'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001056 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001057 {not in Vi}
1058 {only available when compiled with the |+balloon_eval|
1059 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001060 Expression for text to show in evaluation balloon. It is only used
1061 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001062
1063 v:beval_bufnr number of the buffer in which balloon is going to show
1064 v:beval_winnr number of the window
1065 v:beval_lnum line number
1066 v:beval_col column number (byte index)
1067 v:beval_text word under or after the mouse pointer
1068
1069 The evaluation of the expression must not have side effects!
1070 Example: >
1071 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001072 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001073 \', column ' . v:beval_col .
1074 \ ' of file ' . bufname(v:beval_bufnr) .
1075 \ ' on word "' . v:beval_text . '"'
1076 endfunction
1077 set bexpr=MyBalloonExpr()
1078 set ballooneval
1079<
1080 NOTE: The balloon is displayed only if the cursor is on a text
1081 character. If the result of evaluating 'balloonexpr' is not empty,
1082 Vim does not try to send a message to an external debugger (Netbeans
1083 or Sun Workshop).
1084
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001085 The expression may be evaluated in the |sandbox|, see
1086 |sandbox-option|.
1087
1088 It is not allowed to change text or jump to another window while
1089 evaluating 'balloonexpr' |textlock|.
1090
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001091 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001092 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001093< When they are supported "\n" characters will start a new line. If the
1094 expression evaluates to a |List| this is equal to using each List item
1095 as a string and putting "\n" in between them.
1096
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1098'binary' 'bin' boolean (default off)
1099 local to buffer
1100 {not in Vi}
1101 This option should be set before editing a binary file. You can also
1102 use the |-b| Vim argument. When this option is switched on a few
1103 options will be changed (also when it already was on):
1104 'textwidth' will be set to 0
1105 'wrapmargin' will be set to 0
1106 'modeline' will be off
1107 'expandtab' will be off
1108 Also, 'fileformat' and 'fileformats' options will not be used, the
1109 file is read and written like 'fileformat' was "unix" (a single <NL>
1110 separates lines).
1111 The 'fileencoding' and 'fileencodings' options will not be used, the
1112 file is read without conversion.
1113 NOTE: When you start editing a(nother) file while the 'bin' option is
1114 on, settings from autocommands may change the settings again (e.g.,
1115 'textwidth'), causing trouble when editing. You might want to set
1116 'bin' again when the file has been loaded.
1117 The previous values of these options are remembered and restored when
1118 'bin' is switched from on to off. Each buffer has its own set of
1119 saved option values.
1120 To edit a file with 'binary' set you can use the |++bin| argument.
1121 This avoids you have to do ":set bin", which would have effect for all
1122 files you edit.
1123 When writing a file the <EOL> for the last line is only written if
1124 there was one in the original file (normally Vim appends an <EOL> to
1125 the last line if there is none; this would make the file longer). See
1126 the 'endofline' option.
1127
1128 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1129'bioskey' 'biosk' boolean (default on)
1130 global
1131 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001132 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 better to detect CTRL-C, but only works for the console. When using a
1134 terminal over a serial port reset this option.
1135 Also see |'conskey'|.
1136
1137 *'bomb'* *'nobomb'*
1138'bomb' boolean (default off)
1139 local to buffer
1140 {not in Vi}
1141 {only available when compiled with the |+multi_byte|
1142 feature}
1143 When writing a file and the following conditions are met, a BOM (Byte
1144 Order Mark) is prepended to the file:
1145 - this option is on
1146 - the 'binary' option is off
1147 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1148 endian variants.
1149 Some applications use the BOM to recognize the encoding of the file.
1150 Often used for UCS-2 files on MS-Windows. For other applications it
1151 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001152 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1154 check for the presence of the BOM is done and 'bomb' set accordingly.
1155 Unless 'binary' is set, it is removed from the first line, so that you
1156 don't see it when editing. When you don't change the options, the BOM
1157 will be restored when writing the file.
1158
1159 *'breakat'* *'brk'*
1160'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1161 global
1162 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001163 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 feature}
1165 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001166 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1167 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168
1169 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001170'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001172 {not in Vi} {only for Motif, Athena, GTK, Mac and
1173 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001174 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001175 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001176 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001177 buffer Use the directory of the related buffer.
1178 current Use the current directory.
1179 {path} Use the specified directory
1180
1181 *'bufhidden'* *'bh'*
1182'bufhidden' 'bh' string (default: "")
1183 local to buffer
1184 {not in Vi}
1185 {not available when compiled without the |+quickfix|
1186 feature}
1187 This option specifies what happens when a buffer is no longer
1188 displayed in a window:
1189 <empty> follow the global 'hidden' option
1190 hide hide the buffer (don't unload it), also when 'hidden'
1191 is not set
1192 unload unload the buffer, also when 'hidden' is set or using
1193 |:hide|
1194 delete delete the buffer from the buffer list, also when
1195 'hidden' is set or using |:hide|, like using
1196 |:bdelete|
1197 wipe wipe out the buffer from the buffer list, also when
1198 'hidden' is set or using |:hide|, like using
1199 |:bwipeout|
1200
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001201 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1202 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 This option is used together with 'buftype' and 'swapfile' to specify
1204 special kinds of buffers. See |special-buffers|.
1205
1206 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1207'buflisted' 'bl' boolean (default: on)
1208 local to buffer
1209 {not in Vi}
1210 When this option is set, the buffer shows up in the buffer list. If
1211 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1212 This option is reset by Vim for buffers that are only used to remember
1213 a file name or marks. Vim sets it when starting to edit a buffer.
1214 But not when moving to a buffer with ":buffer".
1215
1216 *'buftype'* *'bt'* *E382*
1217'buftype' 'bt' string (default: "")
1218 local to buffer
1219 {not in Vi}
1220 {not available when compiled without the |+quickfix|
1221 feature}
1222 The value of this option specifies the type of a buffer:
1223 <empty> normal buffer
1224 nofile buffer which is not related to a file and will not be
1225 written
1226 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001227 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001228 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001229 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001230 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001231 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232 help help buffer (you are not supposed to set this
1233 manually)
1234
1235 This option is used together with 'bufhidden' and 'swapfile' to
1236 specify special kinds of buffers. See |special-buffers|.
1237
1238 Be careful with changing this option, it can have many side effects!
1239
Bram Moolenaar280f1262006-01-30 00:14:18 +00001240 A "quickfix" buffer is only used for the error list and the location
1241 list. This value is set by the |:cwindow| and |:lwindow| commands and
1242 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
1244 "nofile" and "nowrite" buffers are similar:
1245 both: The buffer is not to be written to disk, ":w" doesn't
1246 work (":w filename" does work though).
1247 both: The buffer is never considered to be |'modified'|.
1248 There is no warning when the changes will be lost, for
1249 example when you quit Vim.
1250 both: A swap file is only created when using too much memory
1251 (when 'swapfile' has been reset there is never a swap
1252 file).
1253 nofile only: The buffer name is fixed, it is not handled like a
1254 file name. It is not modified in response to a |:cd|
1255 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001256 *E676*
1257 "acwrite" implies that the buffer name is not related to a file, like
1258 "nofile", but it will be written. Thus, in contrast to "nofile" and
1259 "nowrite", ":w" does work and a modified buffer can't be abandoned
1260 without saving. For writing there must be matching |BufWriteCmd|,
1261 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262
1263 *'casemap'* *'cmp'*
1264'casemap' 'cmp' string (default: "internal,keepascii")
1265 global
1266 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001267 {only available when compiled with the |+multi_byte|
1268 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269 Specifies details about changing the case of letters. It may contain
1270 these words, separated by a comma:
1271 internal Use internal case mapping functions, the current
1272 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001273 matters when 'encoding' is a Unicode encoding,
1274 "latin1" or "iso-8859-15". When "internal" is
1275 omitted, the towupper() and towlower() system library
1276 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1278 case mapping, the current locale is not effective.
1279 This probably only matters for Turkish.
1280
1281 *'cdpath'* *'cd'* *E344* *E346*
1282'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1283 global
1284 {not in Vi}
1285 {not available when compiled without the
1286 |+file_in_path| feature}
1287 This is a list of directories which will be searched when using the
1288 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001289 for has a relative path, not an absolute part starting with "/", "./"
1290 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291 The 'cdpath' option's value has the same form and semantics as
1292 |'path'|. Also see |file-searching|.
1293 The default value is taken from $CDPATH, with a "," prepended to look
1294 in the current directory first.
1295 If the default value taken from $CDPATH is not what you want, include
1296 a modified version of the following command in your vimrc file to
1297 override it: >
1298 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1299< This option cannot be set from a |modeline| or in the |sandbox|, for
1300 security reasons.
1301 (parts of 'cdpath' can be passed to the shell to expand file names).
1302
1303 *'cedit'*
1304'cedit' string (Vi default: "", Vim default: CTRL-F)
1305 global
1306 {not in Vi}
1307 {not available when compiled without the |+vertsplit|
1308 feature}
1309 The key used in Command-line Mode to open the command-line window.
1310 The default is CTRL-F when 'compatible' is off.
1311 Only non-printable keys are allowed.
1312 The key can be specified as a single character, but it is difficult to
1313 type. The preferred way is to use the <> notation. Examples: >
1314 :set cedit=<C-Y>
1315 :set cedit=<Esc>
1316< |Nvi| also has this option, but it only uses the first character.
1317 See |cmdwin|.
1318
1319 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1320'charconvert' 'ccv' string (default "")
1321 global
1322 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001323 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 {not in Vi}
1325 An expression that is used for character encoding conversion. It is
1326 evaluated when a file that is to be read or has been written has a
1327 different encoding from what is desired.
1328 'charconvert' is not used when the internal iconv() function is
1329 supported and is able to do the conversion. Using iconv() is
1330 preferred, because it is much faster.
1331 'charconvert' is not used when reading stdin |--|, because there is no
1332 file to convert from. You will have to save the text in a file first.
1333 The expression must return zero or an empty string for success,
1334 non-zero for failure.
1335 The possible encoding names encountered are in 'encoding'.
1336 Additionally, names given in 'fileencodings' and 'fileencoding' are
1337 used.
1338 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1339 is done internally by Vim, 'charconvert' is not used for this.
1340 'charconvert' is also used to convert the viminfo file, if the 'c'
1341 flag is present in 'viminfo'. Also used for Unicode conversion.
1342 Example: >
1343 set charconvert=CharConvert()
1344 fun CharConvert()
1345 system("recode "
1346 \ . v:charconvert_from . ".." . v:charconvert_to
1347 \ . " <" . v:fname_in . " >" v:fname_out)
1348 return v:shell_error
1349 endfun
1350< The related Vim variables are:
1351 v:charconvert_from name of the current encoding
1352 v:charconvert_to name of the desired encoding
1353 v:fname_in name of the input file
1354 v:fname_out name of the output file
1355 Note that v:fname_in and v:fname_out will never be the same.
1356 Note that v:charconvert_from and v:charconvert_to may be different
1357 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1358 Encryption is not done by Vim when using 'charconvert'. If you want
1359 to encrypt the file after conversion, 'charconvert' should take care
1360 of this.
1361 This option cannot be set from a |modeline| or in the |sandbox|, for
1362 security reasons.
1363
1364 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1365'cindent' 'cin' boolean (default off)
1366 local to buffer
1367 {not in Vi}
1368 {not available when compiled without the |+cindent|
1369 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001370 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 that trigger reindenting in insert mode and 'cinoptions' to set your
1372 preferred indent style.
1373 If 'indentexpr' is not empty, it overrules 'cindent'.
1374 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1375 the "=" operator indents using this algorithm rather than calling an
1376 external program.
1377 See |C-indenting|.
1378 When you don't like the way 'cindent' works, try the 'smartindent'
1379 option or 'indentexpr'.
1380 This option is not used when 'paste' is set.
1381 NOTE: This option is reset when 'compatible' is set.
1382
1383 *'cinkeys'* *'cink'*
1384'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1385 local to buffer
1386 {not in Vi}
1387 {not available when compiled without the |+cindent|
1388 feature}
1389 A list of keys that, when typed in Insert mode, cause reindenting of
1390 the current line. Only used if 'cindent' is on and 'indentexpr' is
1391 empty.
1392 For the format of this option see |cinkeys-format|.
1393 See |C-indenting|.
1394
1395 *'cinoptions'* *'cino'*
1396'cinoptions' 'cino' string (default "")
1397 local to buffer
1398 {not in Vi}
1399 {not available when compiled without the |+cindent|
1400 feature}
1401 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1402 program. See |cinoptions-values| for the values of this option, and
1403 |C-indenting| for info on C indenting in general.
1404
1405
1406 *'cinwords'* *'cinw'*
1407'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1408 local to buffer
1409 {not in Vi}
1410 {not available when compiled without both the
1411 |+cindent| and the |+smartindent| features}
1412 These keywords start an extra indent in the next line when
1413 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1414 an appropriate place (inside {}).
1415 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1416 matter, include the keyword both the uppercase and lowercase:
1417 "if,If,IF".
1418
1419 *'clipboard'* *'cb'*
1420'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1421 for X-windows, "" otherwise)
1422 global
1423 {not in Vi}
1424 {only in GUI versions or when the |+xterm_clipboard|
1425 feature is included}
1426 This option is a list of comma separated names.
1427 These names are recognized:
1428
1429 unnamed When included, Vim will use the clipboard register '*'
1430 for all yank, delete, change and put operations which
1431 would normally go to the unnamed register. When a
1432 register is explicitly specified, it will always be
1433 used regardless of whether "unnamed" is in 'clipboard'
1434 or not. The clipboard register can always be
1435 explicitly accessed using the "* notation. Also see
1436 |gui-clipboard|.
1437
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001438 unnamedplus A variant of "unnamed" flag which uses the clipboard
1439 register '+' (|quoteplus|) instead of register '*' for
1440 all operations except yank. Yank shall copy the text
1441 into register '+' and also into '*' when "unnamed" is
1442 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001443 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001444 Availability can be checked with: >
1445 if has('unnamedplus')
1446<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 autoselect Works like the 'a' flag in 'guioptions': If present,
1448 then whenever Visual mode is started, or the Visual
1449 area extended, Vim tries to become the owner of the
1450 windowing system's global selection or put the
1451 selected text on the clipboard used by the selection
1452 register "*. See |guioptions_a| and |quotestar| for
1453 details. When the GUI is active, the 'a' flag in
1454 'guioptions' is used, when the GUI is not active, this
1455 "autoselect" flag is used.
1456 Also applies to the modeless selection.
1457
1458 autoselectml Like "autoselect", but for the modeless selection
1459 only. Compare to the 'A' flag in 'guioptions'.
1460
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001461 html When the clipboard contains HTML, use this when
1462 pasting. When putting text on the clipboard, mark it
1463 as HTML. This works to copy rendered HTML from
1464 Firefox, paste it as raw HTML in Vim, select the HTML
1465 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001466 You probably want to add this only temporarily,
1467 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001468 Only supported for GTK version 2 and later.
1469 Only available with the |+multi_byte| feature.
1470
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 exclude:{pattern}
1472 Defines a pattern that is matched against the name of
1473 the terminal 'term'. If there is a match, no
1474 connection will be made to the X server. This is
1475 useful in this situation:
1476 - Running Vim in a console.
1477 - $DISPLAY is set to start applications on another
1478 display.
1479 - You do not want to connect to the X server in the
1480 console, but do want this in a terminal emulator.
1481 To never connect to the X server use: >
1482 exclude:.*
1483< This has the same effect as using the |-X| argument.
1484 Note that when there is no connection to the X server
1485 the window title won't be restored and the clipboard
1486 cannot be accessed.
1487 The value of 'magic' is ignored, {pattern} is
1488 interpreted as if 'magic' was on.
1489 The rest of the option value will be used for
1490 {pattern}, this must be the last entry.
1491
1492 *'cmdheight'* *'ch'*
1493'cmdheight' 'ch' number (default 1)
1494 global
1495 {not in Vi}
1496 Number of screen lines to use for the command-line. Helps avoiding
1497 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001498 The value of this option is stored with the tab page, so that each tab
1499 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 *'cmdwinheight'* *'cwh'*
1502'cmdwinheight' 'cwh' number (default 7)
1503 global
1504 {not in Vi}
1505 {not available when compiled without the |+vertsplit|
1506 feature}
1507 Number of screen lines to use for the command-line window. |cmdwin|
1508
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001509 *'colorcolumn'* *'cc'*
1510'colorcolumn' 'cc' string (default "")
1511 local to window
1512 {not in Vi}
1513 {not available when compiled without the |+syntax|
1514 feature}
1515 'colorcolumn' is a comma separated list of screen columns that are
1516 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1517 text. Will make screen redrawing slower.
1518 The screen column can be an absolute number, or a number preceded with
1519 '+' or '-', which is added to or subtracted from 'textwidth'. >
1520
1521 :set cc=+1 " highlight column after 'textwidth'
1522 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1523 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1524<
1525 When 'textwidth' is zero then the items with '-' and '+' are not used.
1526 A maximum of 256 columns are highlighted.
1527
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 *'columns'* *'co'* *E594*
1529'columns' 'co' number (default 80 or terminal width)
1530 global
1531 {not in Vi}
1532 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001533 initialization and does not have to be set by hand. Also see
1534 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 When Vim is running in the GUI or in a resizable window, setting this
1536 option will cause the window size to be changed. When you only want
1537 to use the size for the GUI, put the command in your |gvimrc| file.
1538 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001539 number of columns of the display, the display may be messed up. For
1540 the GUI it is always possible and Vim limits the number of columns to
1541 what fits on the screen. You can use this command to get the widest
1542 window possible: >
1543 :set columns=9999
1544< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545
1546 *'comments'* *'com'* *E524* *E525*
1547'comments' 'com' string (default
1548 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1549 local to buffer
1550 {not in Vi}
1551 {not available when compiled without the |+comments|
1552 feature}
1553 A comma separated list of strings that can start a comment line. See
1554 |format-comments|. See |option-backslash| about using backslashes to
1555 insert a space.
1556
1557 *'commentstring'* *'cms'* *E537*
1558'commentstring' 'cms' string (default "/*%s*/")
1559 local to buffer
1560 {not in Vi}
1561 {not available when compiled without the |+folding|
1562 feature}
1563 A template for a comment. The "%s" in the value is replaced with the
1564 comment text. Currently only used to add markers for folding, see
1565 |fold-marker|.
1566
1567 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001568'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1569 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 global
1571 {not in Vi}
1572 This option has the effect of making Vim either more Vi-compatible, or
1573 make Vim behave in a more useful way.
1574 This is a special kind of option, because when it's set or reset,
1575 other options are also changed as a side effect. CAREFUL: Setting or
1576 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001577 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001578 set this option in your vimrc file, you should probably put it at the
1579 very start.
1580 By default this option is on and the Vi defaults are used for the
1581 options. This default was chosen for those people who want to use Vim
1582 just like Vi, and don't even (want to) know about the 'compatible'
1583 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001584 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001585 this option is switched off, and all options that have not been
1586 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001587 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001588 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001589 happen for the system-wide vimrc or gvimrc file, nor for a file given
1590 with the |-u| argument). Also see |compatible-default| and
1591 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 You can also set this option with the "-C" argument, and reset it with
1593 "-N". See |-C| and |-N|.
1594 Switching this option off makes the Vim defaults be used for options
1595 that have a different Vi and Vim default value. See the options
1596 marked with a '+' below. Other options are not modified.
1597 At the moment this option is set, several other options will be set
1598 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001599 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 editing.
1601 See also 'cpoptions'.
1602
1603 option + set value effect ~
1604
1605 'allowrevins' off no CTRL-_ command
1606 'backupcopy' Unix: "yes" backup file is a copy
1607 others: "auto" copy or rename backup file
1608 'backspace' "" normal backspace
1609 'backup' off no backup file
1610 'cindent' off no C code indentation
1611 'cedit' + "" no key to open the |cmdwin|
1612 'cpoptions' + (all flags) Vi-compatible flags
1613 'cscopetag' off don't use cscope for ":tag"
1614 'cscopetagorder' 0 see |cscopetagorder|
1615 'cscopeverbose' off see |cscopeverbose|
1616 'digraph' off no digraphs
1617 'esckeys' + off no <Esc>-keys in Insert mode
1618 'expandtab' off tabs not expanded to spaces
1619 'fileformats' + "" no automatic file format detection,
1620 "dos,unix" except for DOS, Windows and OS/2
1621 'formatoptions' + "vt" Vi compatible formatting
1622 'gdefault' off no default 'g' flag for ":s"
1623 'history' + 0 no commandline history
1624 'hkmap' off no Hebrew keyboard mapping
1625 'hkmapp' off no phonetic Hebrew keyboard mapping
1626 'hlsearch' off no highlighting of search matches
1627 'incsearch' off no incremental searching
1628 'indentexpr' "" no indenting by expression
1629 'insertmode' off do not start in Insert mode
1630 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1631 characters and '_'
1632 'joinspaces' on insert 2 spaces after period
1633 'modeline' + off no modelines
1634 'more' + off no pauses in listings
1635 'revins' off no reverse insert
1636 'ruler' off no ruler
1637 'scrolljump' 1 no jump scroll
1638 'scrolloff' 0 no scroll offset
1639 'shiftround' off indent not rounded to shiftwidth
1640 'shortmess' + "" no shortening of messages
1641 'showcmd' + off command characters not shown
1642 'showmode' + off current mode not shown
1643 'smartcase' off no automatic ignore case switch
1644 'smartindent' off no smart indentation
1645 'smarttab' off no smart tab size
1646 'softtabstop' 0 tabs are always 'tabstop' positions
1647 'startofline' on goto startofline with some commands
1648 'tagrelative' + off tag file names are not relative
1649 'textauto' + off no automatic textmode detection
1650 'textwidth' 0 no automatic line wrap
1651 'tildeop' off tilde is not an operator
1652 'ttimeout' off no terminal timeout
1653 'whichwrap' + "" left-right movements don't wrap
1654 'wildchar' + CTRL-E only when the current value is <Tab>
1655 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001656 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001657
1658 *'complete'* *'cpt'* *E535*
1659'complete' 'cpt' string (default: ".,w,b,u,t,i")
1660 local to buffer
1661 {not in Vi}
1662 This option specifies how keyword completion |ins-completion| works
1663 when CTRL-P or CTRL-N are used. It is also used for whole-line
1664 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1665 and the places to scan. It is a comma separated list of flags:
1666 . scan the current buffer ('wrapscan' is ignored)
1667 w scan buffers from other windows
1668 b scan other loaded buffers that are in the buffer list
1669 u scan the unloaded buffers that are in the buffer list
1670 U scan the buffers that are not in the buffer list
1671 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001672 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 k{dict} scan the file {dict}. Several "k" flags can be given,
1674 patterns are valid too. For example: >
1675 :set cpt=k/usr/dict/*,k~/spanish
1676< s scan the files given with the 'thesaurus' option
1677 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1678 are valid too.
1679 i scan current and included files
1680 d scan current and included files for defined name or macro
1681 |i_CTRL-X_CTRL-D|
1682 ] tag completion
1683 t same as "]"
1684
1685 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1686 not executed, this may lead to unexpected completions from some files
1687 (gzipped files for example). Unloaded buffers are not scanned for
1688 whole-line completion.
1689
1690 The default is ".,w,b,u,t,i", which means to scan:
1691 1. the current buffer
1692 2. buffers in other windows
1693 3. other loaded buffers
1694 4. unloaded buffers
1695 5. tags
1696 6. included files
1697
1698 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001699 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1700 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001702 *'completefunc'* *'cfu'*
1703'completefunc' 'cfu' string (default: empty)
1704 local to buffer
1705 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001706 {not available when compiled without the |+eval|
1707 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001708 This option specifies a function to be used for Insert mode completion
1709 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001710 See |complete-functions| for an explanation of how the function is
1711 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001712 This option cannot be set from a |modeline| or in the |sandbox|, for
1713 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001714
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001715 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001716'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001717 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001718 {not available when compiled without the
1719 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001720 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001721 A comma separated list of options for Insert mode completion
1722 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001723
1724 menu Use a popup menu to show the possible completions. The
1725 menu is only shown when there is more than one match and
1726 sufficient colors are available. |ins-completion-menu|
1727
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001728 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001729 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001730 match, e.g., what file it comes from.
1731
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001732 longest Only insert the longest common text of the matches. If
1733 the menu is displayed you can use CTRL-L to add more
1734 characters. Whether case is ignored depends on the kind
1735 of completion. For buffer text the 'ignorecase' option is
1736 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001737
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001738 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001739 completion in the preview window. Only works in
1740 combination with "menu" or "menuone".
1741
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001742
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001743 *'concealcursor'* *'cocu'*
1744'concealcursor' 'cocu' string (default: "")
1745 local to window
1746 {not in Vi}
1747 {not available when compiled without the |+conceal|
1748 feature}
1749 Sets the modes in which text in the cursor line can also be concealed.
1750 When the current mode is listed then concealing happens just like in
1751 other lines.
1752 n Normal mode
1753 v Visual mode
1754 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001755 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001756
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001757 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001758 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001759 are moving around text is concealed, but when starting to insert text
1760 or selecting a Visual area the concealed text is displayed, so that
1761 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001762 Keep in mind that the cursor position is not always where it's
1763 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001764
1765
1766'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001767 number (default 0)
1768 local to window
1769 {not in Vi}
1770 {not available when compiled without the |+conceal|
1771 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001772 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1773 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001774
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001775 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001776 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001777 1 Each block of concealed text is replaced with one
1778 character. If the syntax item does not have a custom
1779 replacement character defined (see |:syn-cchar|) the
1780 character defined in 'listchars' is used (default is a
1781 space).
1782 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001783 2 Concealed text is completely hidden unless it has a
1784 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001785 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001786 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001787
Bram Moolenaara7781e02010-07-19 20:13:22 +02001788 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001789 edit and copy the text. This can be changed with the 'concealcursor'
1790 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001791
Bram Moolenaar071d4272004-06-13 20:20:40 +00001792 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1793'confirm' 'cf' boolean (default off)
1794 global
1795 {not in Vi}
1796 When 'confirm' is on, certain operations that would normally
1797 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1798 instead raise a |dialog| asking if you wish to save the current
1799 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1800 If 'confirm' is off you can still activate confirmation for one
1801 command only (this is most useful in mappings) with the |:confirm|
1802 command.
1803 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1804
1805 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1806'conskey' 'consk' boolean (default off)
1807 global
1808 {not in Vi} {only for MS-DOS}
1809 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001810 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 three methods of console input are available:
1812 'conskey' 'bioskey' action ~
1813 on on or off direct console input
1814 off on BIOS
1815 off off STDIN
1816
1817 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1818'copyindent' 'ci' boolean (default off)
1819 local to buffer
1820 {not in Vi}
1821 Copy the structure of the existing lines indent when autoindenting a
1822 new line. Normally the new indent is reconstructed by a series of
1823 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1824 in which case only spaces are used). Enabling this option makes the
1825 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001826 existing line. 'expandtab' has no effect on these characters, a Tab
1827 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 line, the remaining space is filled in the normal manner.
1829 NOTE: 'copyindent' is reset when 'compatible' is set.
1830 Also see 'preserveindent'.
1831
1832 *'cpoptions'* *'cpo'*
1833'cpoptions' 'cpo' string (Vim default: "aABceFs",
1834 Vi default: all flags)
1835 global
1836 {not in Vi}
1837 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001838 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 not being vi-compatible is mostly or sometimes preferred.
1840 'cpoptions' stands for "compatible-options".
1841 Commas can be added for readability.
1842 To avoid problems with flags that are added in the future, use the
1843 "+=" and "-=" feature of ":set" |add-option-flags|.
1844 NOTE: This option is set to the Vi default value when 'compatible' is
1845 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001846 NOTE: This option is set to the POSIX default value at startup when
1847 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001848 variable exists |posix|. This means Vim tries to behave like the
1849 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850
1851 contains behavior ~
1852 *cpo-a*
1853 a When included, a ":read" command with a file name
1854 argument will set the alternate file name for the
1855 current window.
1856 *cpo-A*
1857 A When included, a ":write" command with a file name
1858 argument will set the alternate file name for the
1859 current window.
1860 *cpo-b*
1861 b "\|" in a ":map" command is recognized as the end of
1862 the map command. The '\' is included in the mapping,
1863 the text after the '|' is interpreted as the next
1864 command. Use a CTRL-V instead of a backslash to
1865 include the '|' in the mapping. Applies to all
1866 mapping, abbreviation, menu and autocmd commands.
1867 See also |map_bar|.
1868 *cpo-B*
1869 B A backslash has no special meaning in mappings,
1870 abbreviations and the "to" part of the menu commands.
1871 Remove this flag to be able to use a backslash like a
1872 CTRL-V. For example, the command ":map X \<Esc>"
1873 results in X being mapped to:
1874 'B' included: "\^[" (^[ is a real <Esc>)
1875 'B' excluded: "<Esc>" (5 characters)
1876 ('<' excluded in both cases)
1877 *cpo-c*
1878 c Searching continues at the end of any match at the
1879 cursor position, but not further than the start of the
1880 next line. When not present searching continues
1881 one character from the cursor position. With 'c'
1882 "abababababab" only gets three matches when repeating
1883 "/abab", without 'c' there are five matches.
1884 *cpo-C*
1885 C Do not concatenate sourced lines that start with a
1886 backslash. See |line-continuation|.
1887 *cpo-d*
1888 d Using "./" in the 'tags' option doesn't mean to use
1889 the tags file relative to the current file, but the
1890 tags file in the current directory.
1891 *cpo-D*
1892 D Can't use CTRL-K to enter a digraph after Normal mode
1893 commands with a character argument, like |r|, |f| and
1894 |t|.
1895 *cpo-e*
1896 e When executing a register with ":@r", always add a
1897 <CR> to the last line, also when the register is not
1898 linewise. If this flag is not present, the register
1899 is not linewise and the last line does not end in a
1900 <CR>, then the last line is put on the command-line
1901 and can be edited before hitting <CR>.
1902 *cpo-E*
1903 E It is an error when using "y", "d", "c", "g~", "gu" or
1904 "gU" on an Empty region. The operators only work when
1905 at least one character is to be operate on. Example:
1906 This makes "y0" fail in the first column.
1907 *cpo-f*
1908 f When included, a ":read" command with a file name
1909 argument will set the file name for the current buffer,
1910 if the current buffer doesn't have a file name yet.
1911 *cpo-F*
1912 F When included, a ":write" command with a file name
1913 argument will set the file name for the current
1914 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001915 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 *cpo-g*
1917 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001918 *cpo-H*
1919 H When using "I" on a line with only blanks, insert
1920 before the last blank. Without this flag insert after
1921 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 *cpo-i*
1923 i When included, interrupting the reading of a file will
1924 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001925 *cpo-I*
1926 I When moving the cursor up or down just after inserting
1927 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 *cpo-j*
1929 j When joining lines, only add two spaces after a '.',
1930 not after '!' or '?'. Also see 'joinspaces'.
1931 *cpo-J*
1932 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001933 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 white space.
1935 *cpo-k*
1936 k Disable the recognition of raw key codes in
1937 mappings, abbreviations, and the "to" part of menu
1938 commands. For example, if <Key> sends ^[OA (where ^[
1939 is <Esc>), the command ":map X ^[OA" results in X
1940 being mapped to:
1941 'k' included: "^[OA" (3 characters)
1942 'k' excluded: "<Key>" (one key code)
1943 Also see the '<' flag below.
1944 *cpo-K*
1945 K Don't wait for a key code to complete when it is
1946 halfway a mapping. This breaks mapping <F1><F1> when
1947 only part of the second <F1> has been read. It
1948 enables cancelling the mapping by typing <F1><Esc>.
1949 *cpo-l*
1950 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001951 literally, only "\]", "\^", "\-" and "\\" are special.
1952 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1954 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001955 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *cpo-L*
1957 L When the 'list' option is set, 'wrapmargin',
1958 'textwidth', 'softtabstop' and Virtual Replace mode
1959 (see |gR|) count a <Tab> as two characters, instead of
1960 the normal behavior of a <Tab>.
1961 *cpo-m*
1962 m When included, a showmatch will always wait half a
1963 second. When not included, a showmatch will wait half
1964 a second or until a character is typed. |'showmatch'|
1965 *cpo-M*
1966 M When excluded, "%" matching will take backslashes into
1967 account. Thus in "( \( )" and "\( ( \)" the outer
1968 parenthesis match. When included "%" ignores
1969 backslashes, which is Vi compatible.
1970 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001971 n When included, the column used for 'number' and
1972 'relativenumber' will also be used for text of wrapped
1973 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 *cpo-o*
1975 o Line offset to search command is not remembered for
1976 next search.
1977 *cpo-O*
1978 O Don't complain if a file is being overwritten, even
1979 when it didn't exist when editing it. This is a
1980 protection against a file unexpectedly created by
1981 someone else. Vi didn't complain about this.
1982 *cpo-p*
1983 p Vi compatible Lisp indenting. When not present, a
1984 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001985 *cpo-P*
1986 P When included, a ":write" command that appends to a
1987 file will set the file name for the current buffer, if
1988 the current buffer doesn't have a file name yet and
1989 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001990 *cpo-q*
1991 q When joining multiple lines leave the cursor at the
1992 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 *cpo-r*
1994 r Redo ("." command) uses "/" to repeat a search
1995 command, instead of the actually used search string.
1996 *cpo-R*
1997 R Remove marks from filtered lines. Without this flag
1998 marks are kept like |:keepmarks| was used.
1999 *cpo-s*
2000 s Set buffer options when entering the buffer for the
2001 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002002 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002003 set when the buffer is created.
2004 *cpo-S*
2005 S Set buffer options always when entering a buffer
2006 (except 'readonly', 'fileformat', 'filetype' and
2007 'syntax'). This is the (most) Vi compatible setting.
2008 The options are set to the values in the current
2009 buffer. When you change an option and go to another
2010 buffer, the value is copied. Effectively makes the
2011 buffer options global to all buffers.
2012
2013 's' 'S' copy buffer options
2014 no no when buffer created
2015 yes no when buffer first entered (default)
2016 X yes each time when buffer entered (vi comp.)
2017 *cpo-t*
2018 t Search pattern for the tag command is remembered for
2019 "n" command. Otherwise Vim only puts the pattern in
2020 the history for search pattern, but doesn't change the
2021 last used search pattern.
2022 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002023 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 *cpo-v*
2025 v Backspaced characters remain visible on the screen in
2026 Insert mode. Without this flag the characters are
2027 erased from the screen right away. With this flag the
2028 screen newly typed text overwrites backspaced
2029 characters.
2030 *cpo-w*
2031 w When using "cw" on a blank character, only change one
2032 character and not all blanks until the start of the
2033 next word.
2034 *cpo-W*
2035 W Don't overwrite a readonly file. When omitted, ":w!"
2036 overwrites a readonly file, if possible.
2037 *cpo-x*
2038 x <Esc> on the command-line executes the command-line.
2039 The default in Vim is to abandon the command-line,
2040 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002041 *cpo-X*
2042 X When using a count with "R" the replaced text is
2043 deleted only once. Also when repeating "R" with "."
2044 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 *cpo-y*
2046 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002047 *cpo-Z*
2048 Z When using "w!" while the 'readonly' option is set,
2049 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 *cpo-!*
2051 ! When redoing a filter command, use the last used
2052 external command, whatever it was. Otherwise the last
2053 used -filter- command is used.
2054 *cpo-$*
2055 $ When making a change to one line, don't redisplay the
2056 line, but put a '$' at the end of the changed text.
2057 The changed text will be overwritten when you type the
2058 new text. The line is redisplayed if you type any
2059 command that moves the cursor from the insertion
2060 point.
2061 *cpo-%*
2062 % Vi-compatible matching is done for the "%" command.
2063 Does not recognize "#if", "#endif", etc.
2064 Does not recognize "/*" and "*/".
2065 Parens inside single and double quotes are also
2066 counted, causing a string that contains a paren to
2067 disturb the matching. For example, in a line like
2068 "if (strcmp("foo(", s))" the first paren does not
2069 match the last one. When this flag is not included,
2070 parens inside single and double quotes are treated
2071 specially. When matching a paren outside of quotes,
2072 everything inside quotes is ignored. When matching a
2073 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002074 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002075 This flag is also used for other features, such as
2076 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002077 *cpo--*
2078 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002079 it would go above the first line or below the last
2080 line. Without it the cursor moves to the first or
2081 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002082 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002083 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002084 *cpo-+*
2085 + When included, a ":write file" command will reset the
2086 'modified' flag of the buffer, even though the buffer
2087 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002088 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 * Use ":*" in the same way as ":@". When not included,
2090 ":*" is an alias for ":'<,'>", select the Visual area.
2091 *cpo-<*
2092 < Disable the recognition of special key codes in |<>|
2093 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002094 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 ":map X <Tab>" results in X being mapped to:
2096 '<' included: "<Tab>" (5 characters)
2097 '<' excluded: "^I" (^I is a real <Tab>)
2098 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002099 *cpo->*
2100 > When appending to a register, put a line break before
2101 the appended text.
2102
2103 POSIX flags. These are not included in the Vi default value, except
2104 when $VIM_POSIX was set on startup. |posix|
2105
2106 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002107 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002108 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002109 *cpo-&*
2110 & When ":preserve" was used keep the swap file when
2111 exiting normally while this buffer is still loaded.
2112 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002113 *cpo-\*
2114 \ Backslash in a [] range in a search pattern is taken
2115 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002116 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2117 '\' excluded: "/[ \-]" finds <Space> and '-'
2118 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002119 *cpo-/*
2120 / When "%" is used as the replacement string in a |:s|
2121 command, use the previous replacement string. |:s%|
2122 *cpo-{*
2123 { The |{| and |}| commands also stop at a "{" character
2124 at the start of a line.
2125 *cpo-.*
2126 . The ":chdir" and ":cd" commands fail if the current
2127 buffer is modified, unless ! is used. Vim doesn't
2128 need this, since it remembers the full path of an
2129 opened file.
2130 *cpo-bar*
2131 | The value of the $LINES and $COLUMNS environment
2132 variables overrule the terminal size values obtained
2133 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002134
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002136 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002137'cryptmethod' string (default "zip")
2138 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002139 {not in Vi}
2140 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002141 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002142 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002143 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002144 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002145 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002146 or later, files can NOT be read by Vim 7.2 and older.
2147 This adds a "seed" to the file, every time you write
2148 the file the encrypted bytes will be different.
2149
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002150 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002151 to the detected method of the file being read. Thus if you write it
2152 without changing 'cryptmethod' the same method will be used.
2153 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002154 explicitly write it, you don't get a warning unless there are other
2155 modifications. Also see |:X|.
2156
2157 When setting the global value to an empty string, it will end up with
2158 the value "zip". When setting the local value to an empty string the
2159 buffer will use the global value.
2160
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002161 When a new encryption method is added in a later version of Vim, and
2162 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002163 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002164
2165
Bram Moolenaar071d4272004-06-13 20:20:40 +00002166 *'cscopepathcomp'* *'cspc'*
2167'cscopepathcomp' 'cspc' number (default 0)
2168 global
2169 {not available when compiled without the |+cscope|
2170 feature}
2171 {not in Vi}
2172 Determines how many components of the path to show in a list of tags.
2173 See |cscopepathcomp|.
2174
2175 *'cscopeprg'* *'csprg'*
2176'cscopeprg' 'csprg' string (default "cscope")
2177 global
2178 {not available when compiled without the |+cscope|
2179 feature}
2180 {not in Vi}
2181 Specifies the command to execute cscope. See |cscopeprg|.
2182 This option cannot be set from a |modeline| or in the |sandbox|, for
2183 security reasons.
2184
2185 *'cscopequickfix'* *'csqf'*
2186'cscopequickfix' 'csqf' string (default "")
2187 global
2188 {not available when compiled without the |+cscope|
2189 or |+quickfix| features}
2190 {not in Vi}
2191 Specifies whether to use quickfix window to show cscope results.
2192 See |cscopequickfix|.
2193
2194 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2195'cscopetag' 'cst' boolean (default off)
2196 global
2197 {not available when compiled without the |+cscope|
2198 feature}
2199 {not in Vi}
2200 Use cscope for tag commands. See |cscope-options|.
2201 NOTE: This option is reset when 'compatible' is set.
2202
2203 *'cscopetagorder'* *'csto'*
2204'cscopetagorder' 'csto' number (default 0)
2205 global
2206 {not available when compiled without the |+cscope|
2207 feature}
2208 {not in Vi}
2209 Determines the order in which ":cstag" performs a search. See
2210 |cscopetagorder|.
2211 NOTE: This option is set to 0 when 'compatible' is set.
2212
2213 *'cscopeverbose'* *'csverb'*
2214 *'nocscopeverbose'* *'nocsverb'*
2215'cscopeverbose' 'csverb' boolean (default off)
2216 global
2217 {not available when compiled without the |+cscope|
2218 feature}
2219 {not in Vi}
2220 Give messages when adding a cscope database. See |cscopeverbose|.
2221 NOTE: This option is reset when 'compatible' is set.
2222
Bram Moolenaar860cae12010-06-05 23:22:07 +02002223 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2224'cursorbind' 'crb' boolean (default off)
2225 local to window
2226 {not in Vi}
2227 {not available when compiled without the |+cursorbind|
2228 feature}
2229 When this option is set, as the cursor in the current
2230 window moves other cursorbound windows (windows that also have
2231 this option set) move their cursors to the corresponding line and
2232 column. This option is useful for viewing the
2233 differences between two versions of a file (see 'diff'); in diff mode,
2234 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002235 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002236
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002237
2238 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2239'cursorcolumn' 'cuc' boolean (default off)
2240 local to window
2241 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002242 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002243 feature}
2244 Highlight the screen column of the cursor with CursorColumn
2245 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2246 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002247 If you only want the highlighting in the current window you can use
2248 these autocommands: >
2249 au WinLeave * set nocursorline nocursorcolumn
2250 au WinEnter * set cursorline cursorcolumn
2251<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002252
2253 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2254'cursorline' 'cul' boolean (default off)
2255 local to window
2256 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002257 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002258 feature}
2259 Highlight the screen line of the cursor with CursorLine
2260 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2261 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002262 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002263 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002264
2265
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 *'debug'*
2267'debug' string (default "")
2268 global
2269 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002270 These values can be used:
2271 msg Error messages that would otherwise be omitted will be given
2272 anyway.
2273 throw Error messages that would otherwise be omitted will be given
2274 anyway and also throw an exception and set |v:errmsg|.
2275 beep A message will be given when otherwise only a beep would be
2276 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002277 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002278 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2279 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280
2281 *'define'* *'def'*
2282'define' 'def' string (default "^\s*#\s*define")
2283 global or local to buffer |global-local|
2284 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002285 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 pattern, just like for the "/" command. This option is used for the
2287 commands like "[i" and "[d" |include-search|. The 'isident' option is
2288 used to recognize the defined name after the match:
2289 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2290 See |option-backslash| about inserting backslashes to include a space
2291 or backslash.
2292 The default value is for C programs. For C++ this value would be
2293 useful, to include const type declarations: >
2294 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2295< When using the ":set" command, you need to double the backslashes!
2296
2297 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2298'delcombine' 'deco' boolean (default off)
2299 global
2300 {not in Vi}
2301 {only available when compiled with the |+multi_byte|
2302 feature}
2303 If editing Unicode and this option is set, backspace and Normal mode
2304 "x" delete each combining character on its own. When it is off (the
2305 default) the character along with its combining characters are
2306 deleted.
2307 Note: When 'delcombine' is set "xx" may work different from "2x"!
2308
2309 This is useful for Arabic, Hebrew and many other languages where one
2310 may have combining characters overtop of base characters, and want
2311 to remove only the combining ones.
2312
2313 *'dictionary'* *'dict'*
2314'dictionary' 'dict' string (default "")
2315 global or local to buffer |global-local|
2316 {not in Vi}
2317 List of file names, separated by commas, that are used to lookup words
2318 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2319 contain a list of words. This can be one word per line, or several
2320 words per line, separated by non-keyword characters (white space is
2321 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002322 When this option is empty, or an entry "spell" is present, spell
2323 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002324 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 after a comma are ignored, otherwise spaces are included in the file
2326 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002327 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 Where to find a list of words?
2329 - On FreeBSD, there is the file "/usr/share/dict/words".
2330 - In the Simtel archive, look in the "msdos/linguist" directory.
2331 - In "miscfiles" of the GNU collection.
2332 The use of |:set+=| and |:set-=| is preferred when adding or removing
2333 directories from the list. This avoids problems when a future version
2334 uses another default.
2335 Backticks cannot be used in this option for security reasons.
2336
2337 *'diff'* *'nodiff'*
2338'diff' boolean (default off)
2339 local to window
2340 {not in Vi}
2341 {not available when compiled without the |+diff|
2342 feature}
2343 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002344 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345
2346 *'dex'* *'diffexpr'*
2347'diffexpr' 'dex' string (default "")
2348 global
2349 {not in Vi}
2350 {not available when compiled without the |+diff|
2351 feature}
2352 Expression which is evaluated to obtain an ed-style diff file from two
2353 versions of a file. See |diff-diffexpr|.
2354 This option cannot be set from a |modeline| or in the |sandbox|, for
2355 security reasons.
2356
2357 *'dip'* *'diffopt'*
2358'diffopt' 'dip' string (default "filler")
2359 global
2360 {not in Vi}
2361 {not available when compiled without the |+diff|
2362 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002363 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 All are optional. Items must be separated by a comma.
2365
2366 filler Show filler lines, to keep the text
2367 synchronized with a window that has inserted
2368 lines at the same position. Mostly useful
2369 when windows are side-by-side and 'scrollbind'
2370 is set.
2371
2372 context:{n} Use a context of {n} lines between a change
2373 and a fold that contains unchanged lines.
2374 When omitted a context of six lines is used.
2375 See |fold-diff|.
2376
2377 icase Ignore changes in case of text. "a" and "A"
2378 are considered the same. Adds the "-i" flag
2379 to the "diff" command if 'diffexpr' is empty.
2380
2381 iwhite Ignore changes in amount of white space. Adds
2382 the "-b" flag to the "diff" command if
2383 'diffexpr' is empty. Check the documentation
2384 of the "diff" command for what this does
2385 exactly. It should ignore adding trailing
2386 white space, but not leading white space.
2387
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002388 horizontal Start diff mode with horizontal splits (unless
2389 explicitly specified otherwise).
2390
2391 vertical Start diff mode with vertical splits (unless
2392 explicitly specified otherwise).
2393
2394 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2395 starting diff mode. Without this 2 is used.
2396
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 Examples: >
2398
2399 :set diffopt=filler,context:4
2400 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002401 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402<
2403 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2404'digraph' 'dg' boolean (default off)
2405 global
2406 {not in Vi}
2407 {not available when compiled without the |+digraphs|
2408 feature}
2409 Enable the entering of digraphs in Insert mode with {char1} <BS>
2410 {char2}. See |digraphs|.
2411 NOTE: This option is reset when 'compatible' is set.
2412
2413 *'directory'* *'dir'*
2414'directory' 'dir' string (default for Amiga: ".,t:",
2415 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2416 for Unix: ".,~/tmp,/var/tmp,/tmp")
2417 global
2418 List of directory names for the swap file, separated with commas.
2419 - The swap file will be created in the first directory where this is
2420 possible.
2421 - Empty means that no swap file will be used (recovery is
2422 impossible!).
2423 - A directory "." means to put the swap file in the same directory as
2424 the edited file. On Unix, a dot is prepended to the file name, so
2425 it doesn't show in a directory listing. On MS-Windows the "hidden"
2426 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002427 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 put the swap file relative to where the edited file is. The leading
2429 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002430 - For Unix and Win32, if a directory ends in two path separators "//"
2431 or "\\", the swap file name will be built from the complete path to
2432 the file with all path separators substituted to percent '%' signs.
2433 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002434 On Win32, when a separating comma is following, you must use "//",
2435 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 - Spaces after the comma are ignored, other spaces are considered part
2437 of the directory name. To have a space at the start of a directory
2438 name, precede it with a backslash.
2439 - To include a comma in a directory name precede it with a backslash.
2440 - A directory name may end in an ':' or '/'.
2441 - Environment variables are expanded |:set_env|.
2442 - Careful with '\' characters, type one before a space, type two to
2443 get one in the option (see |option-backslash|), for example: >
2444 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2445< - For backwards compatibility with Vim version 3.0 a '>' at the start
2446 of the option is removed.
2447 Using "." first in the list is recommended. This means that editing
2448 the same file twice will result in a warning. Using "/tmp" on Unix is
2449 discouraged: When the system crashes you lose the swap file.
2450 "/var/tmp" is often not cleared when rebooting, thus is a better
2451 choice than "/tmp". But it can contain a lot of files, your swap
2452 files get lost in the crowd. That is why a "tmp" directory in your
2453 home directory is tried first.
2454 The use of |:set+=| and |:set-=| is preferred when adding or removing
2455 directories from the list. This avoids problems when a future version
2456 uses another default.
2457 This option cannot be set from a |modeline| or in the |sandbox|, for
2458 security reasons.
2459 {Vi: directory to put temp file in, defaults to "/tmp"}
2460
2461 *'display'* *'dy'*
2462'display' 'dy' string (default "")
2463 global
2464 {not in Vi}
2465 Change the way text is displayed. This is comma separated list of
2466 flags:
2467 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002468 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 last line that doesn't fit is replaced with "@" lines.
2470 uhex Show unprintable characters hexadecimal as <xx>
2471 instead of using ^C and ~C.
2472
2473 *'eadirection'* *'ead'*
2474'eadirection' 'ead' string (default "both")
2475 global
2476 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002477 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 feature}
2479 Tells when the 'equalalways' option applies:
2480 ver vertically, width of windows is not affected
2481 hor horizontally, height of windows is not affected
2482 both width and height of windows is affected
2483
2484 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2485'edcompatible' 'ed' boolean (default off)
2486 global
2487 Makes the 'g' and 'c' flags of the ":substitute" command to be
2488 toggled each time the flag is given. See |complex-change|. See
2489 also 'gdefault' option.
2490 Switching this option on is discouraged!
2491
2492 *'encoding'* *'enc'* *E543*
2493'encoding' 'enc' string (default: "latin1" or value from $LANG)
2494 global
2495 {only available when compiled with the |+multi_byte|
2496 feature}
2497 {not in Vi}
2498 Sets the character encoding used inside Vim. It applies to text in
2499 the buffers, registers, Strings in expressions, text stored in the
2500 viminfo file, etc. It sets the kind of characters which Vim can work
2501 with. See |encoding-names| for the possible values.
2502
2503 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002504 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002506 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507
Bram Moolenaar865242e2010-07-14 21:12:05 +02002508 This option cannot be set from a |modeline|. It would most likely
2509 corrupt the text.
2510
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2512 "utf-8". Although care has been taken to allow different values of
2513 'encoding', "utf-8" is the natural choice for the environment and
2514 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002515 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 versions, and to avoid changing the encoding of newly created files
2517 without your knowledge (in case 'fileencodings' is empty).
2518
2519 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002520 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 iconv() or as specified with 'charconvert'.
2522
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002523 If you need to know whether 'encoding' is a multi-byte encoding, you
2524 can use: >
2525 if has("multi_byte_encoding")
2526<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 Normally 'encoding' will be equal to your current locale. This will
2528 be the default if Vim recognizes your environment settings. If
2529 'encoding' is not set to the current locale, 'termencoding' must be
2530 set to convert typed and displayed text. See |encoding-table|.
2531
2532 When you set this option, it fires the |EncodingChanged| autocommand
2533 event so that you can set up fonts if necessary.
2534
2535 When the option is set, the value is converted to lowercase. Thus
2536 you can set it with uppercase values too. Underscores are translated
2537 to '-' signs.
2538 When the encoding is recognized, it is changed to the standard name.
2539 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2540 "iso-8859-2" and "utf8" becomes "utf-8".
2541
2542 Note: "latin1" is also used when the encoding could not be detected.
2543 This only works when editing files in the same encoding! When the
2544 actual character set is not latin1, make sure 'fileencoding' and
2545 'fileencodings' are empty. When conversion is needed, switch to using
2546 utf-8.
2547
2548 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2549 You don't notice this while editing, but it does matter for the
2550 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2551 setting 'encoding' to one of these values instead of utf-8 only has
2552 effect for encoding used for files when 'fileencoding' is empty.
2553
Bram Moolenaar661b1822005-07-28 22:36:45 +00002554 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2555 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556
2557 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2558'endofline' 'eol' boolean (default on)
2559 local to buffer
2560 {not in Vi}
2561 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 option is automatically set when starting to edit a new file, unless
2564 the file does not have an <EOL> for the last line in the file, in
2565 which case it is reset. Normally you don't have to set or reset this
2566 option. When 'binary' is off the value is not used when writing the
2567 file. When 'binary' is on it is used to remember the presence of a
2568 <EOL> for the last line in the file, so that when you write the file
2569 the situation from the original file can be kept. But you can change
2570 it if you want to.
2571
2572 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2573'equalalways' 'ea' boolean (default on)
2574 global
2575 {not in Vi}
2576 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002577 splitting or closing a window. This also happens the moment the
2578 option is switched on. When off, splitting a window will reduce the
2579 size of the current window and leave the other windows the same. When
2580 closing a window the extra lines are given to the window next to it
2581 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 When mixing vertically and horizontally split windows, a minimal size
2583 is computed and some windows may be larger if there is room. The
2584 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002585 Changing the height and width of a window can be avoided by setting
2586 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002587 If a window size is specified when creating a new window sizes are
2588 currently not equalized (it's complicated, but may be implemented in
2589 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590
2591 *'equalprg'* *'ep'*
2592'equalprg' 'ep' string (default "")
2593 global or local to buffer |global-local|
2594 {not in Vi}
2595 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002596 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002597 or 'indentexpr'. When Vim was compiled without internal formatting,
2598 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 about including spaces and backslashes.
2601 This option cannot be set from a |modeline| or in the |sandbox|, for
2602 security reasons.
2603
2604 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2605'errorbells' 'eb' boolean (default off)
2606 global
2607 Ring the bell (beep or screen flash) for error messages. This only
2608 makes a difference for error messages, the bell will be used always
2609 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 screen flash or do nothing.
2612
2613 *'errorfile'* *'ef'*
2614'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2615 others: "errors.err")
2616 global
2617 {not in Vi}
2618 {not available when compiled without the |+quickfix|
2619 feature}
2620 Name of the errorfile for the QuickFix mode (see |:cf|).
2621 When the "-q" command-line argument is used, 'errorfile' is set to the
2622 following argument. See |-q|.
2623 NOT used for the ":make" command. See 'makeef' for that.
2624 Environment variables are expanded |:set_env|.
2625 See |option-backslash| about including spaces and backslashes.
2626 This option cannot be set from a |modeline| or in the |sandbox|, for
2627 security reasons.
2628
2629 *'errorformat'* *'efm'*
2630'errorformat' 'efm' string (default is very long)
2631 global or local to buffer |global-local|
2632 {not in Vi}
2633 {not available when compiled without the |+quickfix|
2634 feature}
2635 Scanf-like description of the format for the lines in the error file
2636 (see |errorformat|).
2637
2638 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2639'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2640 global
2641 {not in Vi}
2642 Function keys that start with an <Esc> are recognized in Insert
2643 mode. When this option is off, the cursor and function keys cannot be
2644 used in Insert mode if they start with an <Esc>. The advantage of
2645 this is that the single <Esc> is recognized immediately, instead of
2646 after one second. Instead of resetting this option, you might want to
2647 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2648 when 'esckeys' is off, you can still map anything, but the cursor keys
2649 won't work by default.
2650 NOTE: This option is set to the Vi default value when 'compatible' is
2651 set and to the Vim default value when 'compatible' is reset.
2652
2653 *'eventignore'* *'ei'*
2654'eventignore' 'ei' string (default "")
2655 global
2656 {not in Vi}
2657 {not available when compiled without the |+autocmd|
2658 feature}
2659 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002660 When set to "all" or when "all" is one of the items, all autocommand
2661 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 Otherwise this is a comma separated list of event names. Example: >
2663 :set ei=WinEnter,WinLeave
2664<
2665 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2666'expandtab' 'et' boolean (default off)
2667 local to buffer
2668 {not in Vi}
2669 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002670 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2672 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2673 NOTE: This option is reset when 'compatible' is set.
2674
2675 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2676'exrc' 'ex' boolean (default off)
2677 global
2678 {not in Vi}
2679 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2680 directory. If you switch this option on you should also consider
2681 setting the 'secure' option (see |initialization|). Using a local
2682 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2683 also see |.vimrc| and |gui-init|.
2684 This option cannot be set from a |modeline| or in the |sandbox|, for
2685 security reasons.
2686
2687 *'fileencoding'* *'fenc'* *E213*
2688'fileencoding' 'fenc' string (default: "")
2689 local to buffer
2690 {only available when compiled with the |+multi_byte|
2691 feature}
2692 {not in Vi}
2693 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002694
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002696 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 When 'fileencoding' is empty, the same value as 'encoding' will be
2698 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002699 Conversion will also be done when 'encoding' and 'fileencoding' are
2700 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2701 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002703 'encoding' is "utf-8" or another Unicode encoding, conversion
2704 is most likely done in a way that the reverse conversion
2705 results in the same text. When 'encoding' is not "utf-8" some
2706 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002707
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 See 'encoding' for the possible values. Additionally, values may be
2709 specified that can be handled by the converter, see
2710 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002711
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 When reading a file 'fileencoding' will be set from 'fileencodings'.
2713 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002714 'fileencoding', use the |++enc| argument. One exception: when
2715 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002716 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002717
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2719 When the option is set, the value is converted to lowercase. Thus
2720 you can set it with uppercase values too. '_' characters are
2721 replaced with '-'. If a name is recognized from the list for
2722 'encoding', it is replaced by the standard name. For example
2723 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002724
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 When this option is set, after starting to edit a file, the 'modified'
2726 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002727
2728 Keep in mind that changing 'fenc' from a modeline happens
2729 AFTER the text has been read, thus it applies to when the file will be
2730 written. If you do set 'fenc' in a modeline, you might want to set
2731 'nomodified' to avoid not being able to ":q".
2732
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 This option can not be changed when 'modifiable' is off.
2734
2735 *'fe'*
2736 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002737 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 old short name was 'fe', which is no longer used.
2739
2740 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002741'fileencodings' 'fencs' string (default: "ucs-bom",
2742 "ucs-bom,utf-8,default,latin1" when
2743 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 global
2745 {only available when compiled with the |+multi_byte|
2746 feature}
2747 {not in Vi}
2748 This is a list of character encodings considered when starting to edit
2749 an existing file. When a file is read, Vim tries to use the first
2750 mentioned character encoding. If an error is detected, the next one
2751 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002752 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 an empty string, which means the value of 'encoding' is used.
2754 WARNING: Conversion can cause loss of information! When
2755 'encoding' is "utf-8" (or one of the other Unicode variants)
2756 conversion is most likely done in a way that the reverse
2757 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002758 "utf-8" some non-ASCII characters may be lost! You can use
2759 the |++bad| argument to specify what is done with characters
2760 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 For an empty file or a file with only ASCII characters most encodings
2762 will work and the first entry of 'fileencodings' will be used (except
2763 "ucs-bom", which requires the BOM to be present). If you prefer
2764 another encoding use an BufReadPost autocommand event to test if your
2765 preferred encoding is to be used. Example: >
2766 au BufReadPost * if search('\S', 'w') == 0 |
2767 \ set fenc=iso-2022-jp | endif
2768< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2769 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002770 When the |++enc| argument is used then the value of 'fileencodings' is
2771 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002772 Note that 'fileencodings' is not used for a new file, the global value
2773 of 'fileencoding' is used instead. You can set it with: >
2774 :setglobal fenc=iso-8859-2
2775< This means that a non-existing file may get a different encoding than
2776 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 The special value "ucs-bom" can be used to check for a Unicode BOM
2778 (Byte Order Mark) at the start of the file. It must not be preceded
2779 by "utf-8" or another Unicode encoding for this to work properly.
2780 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2781 because Vim cannot detect an error, thus the encoding is always
2782 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002783 The special value "default" can be used for the encoding from the
2784 environment. This is the default value for 'encoding'. It is useful
2785 when 'encoding' is set to "utf-8" and your environment uses a
2786 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002787 When 'encoding' is "utf-8" and a file contains an illegal byte
2788 sequence it won't be recognized as UTF-8. You can use the |8g8|
2789 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 WRONG VALUES: WHAT'S WRONG:
2791 latin1,utf-8 "latin1" will always be used
2792 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2793 file
2794 cp1250,latin1 "cp1250" will always be used
2795 If 'fileencodings' is empty, 'fileencoding' is not modified.
2796 See 'fileencoding' for the possible values.
2797 Setting this option does not have an effect until the next time a file
2798 is read.
2799
2800 *'fileformat'* *'ff'*
2801'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2802 Unix default: "unix",
2803 Macintosh default: "mac")
2804 local to buffer
2805 {not in Vi}
2806 This gives the <EOL> of the current buffer, which is used for
2807 reading/writing the buffer from/to a file:
2808 dos <CR> <NL>
2809 unix <NL>
2810 mac <CR>
2811 When "dos" is used, CTRL-Z at the end of a file is ignored.
2812 See |file-formats| and |file-read|.
2813 For the character encoding of the file see 'fileencoding'.
2814 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2815 works like it was set to "unix'.
2816 This option is set automatically when starting to edit a file and
2817 'fileformats' is not empty and 'binary' is off.
2818 When this option is set, after starting to edit a file, the 'modified'
2819 option is set, because the file would be different when written.
2820 This option can not be changed when 'modifiable' is off.
2821 For backwards compatibility: When this option is set to "dos",
2822 'textmode' is set, otherwise 'textmode' is reset.
2823
2824 *'fileformats'* *'ffs'*
2825'fileformats' 'ffs' string (default:
2826 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2827 Vim Unix: "unix,dos",
2828 Vim Mac: "mac,unix,dos",
2829 Vi Cygwin: "unix,dos",
2830 Vi others: "")
2831 global
2832 {not in Vi}
2833 This gives the end-of-line (<EOL>) formats that will be tried when
2834 starting to edit a new buffer and when reading a file into an existing
2835 buffer:
2836 - When empty, the format defined with 'fileformat' will be used
2837 always. It is not set automatically.
2838 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002839 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840 'fileformats' name will be used when a file is read into an existing
2841 buffer, no matter what 'fileformat' for that buffer is set to.
2842 - When more than one name is present, separated by commas, automatic
2843 <EOL> detection will be done when reading a file. When starting to
2844 edit a file, a check is done for the <EOL>:
2845 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2846 'fileformat' is set to "dos".
2847 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002848 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002850 3. If 'fileformat' has not yet been set, and if 'fileformats'
2851 includes "mac", 'fileformat' is set to "mac".
2852 This means that "mac" is only chosen when:
2853 "unix" is not present or no <NL> is found in the file, and
2854 "dos" is not present or no <CR><NL> is found in the file.
2855 Except: if "unix" was chosen, but there is a <CR> before
2856 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002857 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 4. If 'fileformat' is still not set, the first name from
2859 'fileformats' is used.
2860 When reading a file into an existing buffer, the same is done, but
2861 this happens like 'fileformat' has been set appropriately for that
2862 file only, the option is not changed.
2863 When 'binary' is set, the value of 'fileformats' is not used.
2864
Bram Moolenaar81af9252010-12-10 20:35:50 +01002865 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002866 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002867
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2869 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2870 done:
2871 - When 'fileformats' is empty, there is no automatic detection. Dos
2872 format will be used.
2873 - When 'fileformats' is set to one or more names, automatic detection
2874 is done. This is based on the first <NL> in the file: If there is a
2875 <CR> in front of it, Dos format is used, otherwise Unix format is
2876 used.
2877 Also see |file-formats|.
2878 For backwards compatibility: When this option is set to an empty
2879 string or one format (no comma is included), 'textauto' is reset,
2880 otherwise 'textauto' is set.
2881 NOTE: This option is set to the Vi default value when 'compatible' is
2882 set and to the Vim default value when 'compatible' is reset.
2883
2884 *'filetype'* *'ft'*
2885'filetype' 'ft' string (default: "")
2886 local to buffer
2887 {not in Vi}
2888 {not available when compiled without the |+autocmd|
2889 feature}
2890 When this option is set, the FileType autocommand event is triggered.
2891 All autocommands that match with the value of this option will be
2892 executed. Thus the value of 'filetype' is used in place of the file
2893 name.
2894 Otherwise this option does not always reflect the current file type.
2895 This option is normally set when the file type is detected. To enable
2896 this use the ":filetype on" command. |:filetype|
2897 Setting this option to a different value is most useful in a modeline,
2898 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002899 Example, for in an IDL file:
2900 /* vim: set filetype=idl : */ ~
2901 |FileType| |filetypes|
2902 When a dot appears in the value then this separates two filetype
2903 names. Example:
2904 /* vim: set filetype=c.doxygen : */ ~
2905 This will use the "c" filetype first, then the "doxygen" filetype.
2906 This works both for filetype plugins and for syntax files. More than
2907 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 Do not confuse this option with 'osfiletype', which is for the file
2909 type that is actually stored with the file.
2910 This option is not copied to another buffer, independent of the 's' or
2911 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002912 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913
2914 *'fillchars'* *'fcs'*
2915'fillchars' 'fcs' string (default "vert:|,fold:-")
2916 global
2917 {not in Vi}
2918 {not available when compiled without the |+windows|
2919 and |+folding| features}
2920 Characters to fill the statuslines and vertical separators.
2921 It is a comma separated list of items:
2922
2923 item default Used for ~
2924 stl:c ' ' or '^' statusline of the current window
2925 stlnc:c ' ' or '-' statusline of the non-current windows
2926 vert:c '|' vertical separators |:vsplit|
2927 fold:c '-' filling 'foldtext'
2928 diff:c '-' deleted lines of the 'diff' option
2929
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002930 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 "stlnc" the space will be used when there is highlighting, '^' or '-'
2932 otherwise.
2933
2934 Example: >
2935 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2936< This is similar to the default, except that these characters will also
2937 be used when there is highlighting.
2938
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002939 for "stl" and "stlnc" only single-byte values are supported.
2940
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941 The highlighting used for these items:
2942 item highlight group ~
2943 stl:c StatusLine |hl-StatusLine|
2944 stlnc:c StatusLineNC |hl-StatusLineNC|
2945 vert:c VertSplit |hl-VertSplit|
2946 fold:c Folded |hl-Folded|
2947 diff:c DiffDelete |hl-DiffDelete|
2948
2949 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2950'fkmap' 'fk' boolean (default off) *E198*
2951 global
2952 {not in Vi}
2953 {only available when compiled with the |+rightleft|
2954 feature}
2955 When on, the keyboard is mapped for the Farsi character set.
2956 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002957 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958
2959 *'foldclose'* *'fcl'*
2960'foldclose' 'fcl' string (default "")
2961 global
2962 {not in Vi}
2963 {not available when compiled without the |+folding|
2964 feature}
2965 When set to "all", a fold is closed when the cursor isn't in it and
2966 its level is higher than 'foldlevel'. Useful if you want folds to
2967 automatically close when moving out of them.
2968
2969 *'foldcolumn'* *'fdc'*
2970'foldcolumn' 'fdc' number (default 0)
2971 local to window
2972 {not in Vi}
2973 {not available when compiled without the |+folding|
2974 feature}
2975 When non-zero, a column with the specified width is shown at the side
2976 of the window which indicates open and closed folds. The maximum
2977 value is 12.
2978 See |folding|.
2979
2980 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2981'foldenable' 'fen' boolean (default on)
2982 local to window
2983 {not in Vi}
2984 {not available when compiled without the |+folding|
2985 feature}
2986 When off, all folds are open. This option can be used to quickly
2987 switch between showing all text unfolded and viewing the text with
2988 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002989 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 'foldenable' is off.
2991 This option is set by commands that create a new fold or close a fold.
2992 See |folding|.
2993
2994 *'foldexpr'* *'fde'*
2995'foldexpr' 'fde' string (default: "0")
2996 local to window
2997 {not in Vi}
2998 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002999 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003001 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003002
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003003 The expression may be evaluated in the |sandbox|, see
3004 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003005 This option can't be set from a |modeline| when the 'diff' option is
3006 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003007
3008 It is not allowed to change text or jump to another window while
3009 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010
3011 *'foldignore'* *'fdi'*
3012'foldignore' 'fdi' string (default: "#")
3013 local to window
3014 {not in Vi}
3015 {not available when compiled without the |+folding|
3016 feature}
3017 Used only when 'foldmethod' is "indent". Lines starting with
3018 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003019 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 The default "#" works well for C programs. See |fold-indent|.
3021
3022 *'foldlevel'* *'fdl'*
3023'foldlevel' 'fdl' number (default: 0)
3024 local to window
3025 {not in Vi}
3026 {not available when compiled without the |+folding|
3027 feature}
3028 Sets the fold level: Folds with a higher level will be closed.
3029 Setting this option to zero will close all folds. Higher numbers will
3030 close fewer folds.
3031 This option is set by commands like |zm|, |zM| and |zR|.
3032 See |fold-foldlevel|.
3033
3034 *'foldlevelstart'* *'fdls'*
3035'foldlevelstart' 'fdls' number (default: -1)
3036 global
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
3039 feature}
3040 Sets 'foldlevel' when starting to edit another buffer in a window.
3041 Useful to always start editing with all folds closed (value zero),
3042 some folds closed (one) or no folds closed (99).
3043 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003044 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 ignores this option and closes all folds.
3046 It is also done before BufReadPre autocommands, to allow an autocmd to
3047 overrule the 'foldlevel' value for specific files.
3048 When the value is negative, it is not used.
3049
3050 *'foldmarker'* *'fmr'* *E536*
3051'foldmarker' 'fmr' string (default: "{{{,}}}")
3052 local to window
3053 {not in Vi}
3054 {not available when compiled without the |+folding|
3055 feature}
3056 The start and end marker used when 'foldmethod' is "marker". There
3057 must be one comma, which separates the start and end marker. The
3058 marker is a literal string (a regular expression would be too slow).
3059 See |fold-marker|.
3060
3061 *'foldmethod'* *'fdm'*
3062'foldmethod' 'fdm' string (default: "manual")
3063 local to window
3064 {not in Vi}
3065 {not available when compiled without the |+folding|
3066 feature}
3067 The kind of folding used for the current window. Possible values:
3068 |fold-manual| manual Folds are created manually.
3069 |fold-indent| indent Lines with equal indent form a fold.
3070 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3071 |fold-marker| marker Markers are used to specify folds.
3072 |fold-syntax| syntax Syntax highlighting items specify folds.
3073 |fold-diff| diff Fold text that is not changed.
3074
3075 *'foldminlines'* *'fml'*
3076'foldminlines' 'fml' number (default: 1)
3077 local to window
3078 {not in Vi}
3079 {not available when compiled without the |+folding|
3080 feature}
3081 Sets the minimum number of screen lines for a fold to be displayed
3082 closed. Also for manually closed folds.
3083 Note that this only has an effect of what is displayed. After using
3084 "zc" to close a fold, which is displayed open because it's smaller
3085 than 'foldminlines', a following "zc" may close a containing fold.
3086
3087 *'foldnestmax'* *'fdn'*
3088'foldnestmax' 'fdn' number (default: 20)
3089 local to window
3090 {not in Vi}
3091 {not available when compiled without the |+folding|
3092 feature}
3093 Sets the maximum nesting of folds for the "indent" and "syntax"
3094 methods. This avoids that too many folds will be created. Using more
3095 than 20 doesn't work, because the internal limit is 20.
3096
3097 *'foldopen'* *'fdo'*
3098'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3099 search,tag,undo")
3100 global
3101 {not in Vi}
3102 {not available when compiled without the |+folding|
3103 feature}
3104 Specifies for which type of commands folds will be opened, if the
3105 command moves the cursor into a closed fold. It is a comma separated
3106 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003107 NOTE: When the command is part of a mapping this option is not used.
3108 Add the |zv| command to the mapping to get the same effect.
3109 (rationale: the mapping may want to control opening folds itself)
3110
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 item commands ~
3112 all any
3113 block "(", "{", "[[", "[{", etc.
3114 hor horizontal movements: "l", "w", "fx", etc.
3115 insert any command in Insert mode
3116 jump far jumps: "G", "gg", etc.
3117 mark jumping to a mark: "'m", CTRL-O, etc.
3118 percent "%"
3119 quickfix ":cn", ":crew", ":make", etc.
3120 search search for a pattern: "/", "n", "*", "gd", etc.
3121 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003122 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 tag jumping to a tag: ":ta", CTRL-T, etc.
3124 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 When a movement command is used for an operator (e.g., "dl" or "y%")
3126 this option is not used. This means the operator will include the
3127 whole closed fold.
3128 Note that vertical movements are not here, because it would make it
3129 very difficult to move onto a closed fold.
3130 In insert mode the folds containing the cursor will always be open
3131 when text is inserted.
3132 To close folds you can re-apply 'foldlevel' with the |zx| command or
3133 set the 'foldclose' option to "all".
3134
3135 *'foldtext'* *'fdt'*
3136'foldtext' 'fdt' string (default: "foldtext()")
3137 local to window
3138 {not in Vi}
3139 {not available when compiled without the |+folding|
3140 feature}
3141 An expression which is used to specify the text displayed for a closed
3142 fold. See |fold-foldtext|.
3143
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003144 The expression may be evaluated in the |sandbox|, see
3145 |sandbox-option|.
3146
3147 It is not allowed to change text or jump to another window while
3148 evaluating 'foldtext' |textlock|.
3149
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 *'formatoptions'* *'fo'*
3151'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3152 local to buffer
3153 {not in Vi}
3154 This is a sequence of letters which describes how automatic
3155 formatting is to be done. See |fo-table|. When the 'paste' option is
3156 on, no formatting is done (like 'formatoptions' is empty). Commas can
3157 be inserted for readability.
3158 To avoid problems with flags that are added in the future, use the
3159 "+=" and "-=" feature of ":set" |add-option-flags|.
3160 NOTE: This option is set to the Vi default value when 'compatible' is
3161 set and to the Vim default value when 'compatible' is reset.
3162
Bram Moolenaar86b68352004-12-27 21:59:20 +00003163 *'formatlistpat'* *'flp'*
3164'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3165 local to buffer
3166 {not in Vi}
3167 A pattern that is used to recognize a list header. This is used for
3168 the "n" flag in 'formatoptions'.
3169 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003170 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003171 while still checking more characters. There must be a character
3172 following the pattern, when it matches the whole line it is handled
3173 like there is no match.
3174 The default recognizes a number, followed by an optional punctuation
3175 character and white space.
3176
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 *'formatprg'* *'fp'*
3178'formatprg' 'fp' string (default "")
3179 global
3180 {not in Vi}
3181 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003182 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003184 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003185 If the 'formatexpr' option is not empty it will be used instead.
3186 Otherwise, if 'formatprg' option is an empty string, the internal
3187 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003188 Environment variables are expanded |:set_env|. See |option-backslash|
3189 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003190 The expression may be evaluated in the |sandbox|, see
3191 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003193 *'formatexpr'* *'fex'*
3194'formatexpr' 'fex' string (default "")
3195 local to buffer
3196 {not in Vi}
3197 {not available when compiled without the |+eval|
3198 feature}
3199 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003200 operator or automatic formatting (see 'formatoptions'). When this
3201 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003202
3203 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003204 The |v:count| variable holds the number of lines to be formatted.
3205 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003206 inserted if the expression is being evaluated due to
3207 automatic formatting. This can be empty. Don't insert
3208 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003209
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003210 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003211 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003212< This will invoke the mylang#Format() function in the
3213 autoload/mylang.vim file in 'runtimepath'. |autoload|
3214
3215 The expression is also evaluated when 'textwidth' is set and adding
3216 text beyond that limit. This happens under the same conditions as
3217 when internal formatting is used. Make sure the cursor is kept in the
3218 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003219 return "i" or "R" in this situation.
3220
3221 When the expression evaluates to non-zero Vim will fall back to using
3222 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003223
3224 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003225 |sandbox-option|. That stops the option from working, since changing
3226 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003227
3228 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003229'fsync' 'fs' boolean (default on)
3230 global
3231 {not in Vi}
3232 When on, the library function fsync() will be called after writing a
3233 file. This will flush a file to disk, ensuring that it is safely
3234 written even on filesystems which do metadata-only journaling. This
3235 will force the harddrive to spin up on Linux systems running in laptop
3236 mode, so it may be undesirable in some situations. Be warned that
3237 turning this off increases the chances of data loss after a crash. On
3238 systems without an fsync() implementation, this variable is always
3239 off.
3240 Also see 'swapsync' for controlling fsync() on swap files.
3241
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3243'gdefault' 'gd' boolean (default off)
3244 global
3245 {not in Vi}
3246 When on, the ":substitute" flag 'g' is default on. This means that
3247 all matches in a line are substituted instead of one. When a 'g' flag
3248 is given to a ":substitute" command, this will toggle the substitution
3249 of all or one match. See |complex-change|.
3250
3251 command 'gdefault' on 'gdefault' off ~
3252 :s/// subst. all subst. one
3253 :s///g subst. one subst. all
3254 :s///gg subst. all subst. one
3255
3256 NOTE: This option is reset when 'compatible' is set.
3257
3258 *'grepformat'* *'gfm'*
3259'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3260 global
3261 {not in Vi}
3262 Format to recognize for the ":grep" command output.
3263 This is a scanf-like string that uses the same format as the
3264 'errorformat' option: see |errorformat|.
3265
3266 *'grepprg'* *'gp'*
3267'grepprg' 'gp' string (default "grep -n ",
3268 Unix: "grep -n $* /dev/null",
3269 Win32: "findstr /n" or "grep -n",
3270 VMS: "SEARCH/NUMBERS ")
3271 global or local to buffer |global-local|
3272 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003273 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 and '#' characters, which are expanded like when used in a command-
3275 line. The placeholder "$*" is allowed to specify where the arguments
3276 will be included. Environment variables are expanded |:set_env|. See
3277 |option-backslash| about including spaces and backslashes.
3278 When your "grep" accepts the "-H" argument, use this to make ":grep"
3279 also work well with a single file: >
3280 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003281< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003282 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3283 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003284 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 apply equally to 'grepprg'.
3286 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3287 otherwise it's "grep -n".
3288 This option cannot be set from a |modeline| or in the |sandbox|, for
3289 security reasons.
3290
3291 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3292'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3293 ve:ver35-Cursor,
3294 o:hor50-Cursor,
3295 i-ci:ver25-Cursor/lCursor,
3296 r-cr:hor20-Cursor/lCursor,
3297 sm:block-Cursor
3298 -blinkwait175-blinkoff150-blinkon175",
3299 for MS-DOS and Win32 console:
3300 "n-v-c:block,o:hor50,i-ci:hor15,
3301 r-cr:hor30,sm:block")
3302 global
3303 {not in Vi}
3304 {only available when compiled with GUI enabled, and
3305 for MS-DOS and Win32 console}
3306 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003307 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 the height of the cursor can be changed. This can be done by
3309 specifying a block cursor, or a percentage for a vertical or
3310 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003311 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 mode-list and an argument-list:
3315 mode-list:argument-list,mode-list:argument-list,..
3316 The mode-list is a dash separated list of these modes:
3317 n Normal mode
3318 v Visual mode
3319 ve Visual mode with 'selection' "exclusive" (same as 'v',
3320 if not specified)
3321 o Operator-pending mode
3322 i Insert mode
3323 r Replace mode
3324 c Command-line Normal (append) mode
3325 ci Command-line Insert mode
3326 cr Command-line Replace mode
3327 sm showmatch in Insert mode
3328 a all modes
3329 The argument-list is a dash separated list of these arguments:
3330 hor{N} horizontal bar, {N} percent of the character height
3331 ver{N} vertical bar, {N} percent of the character width
3332 block block cursor, fills the whole character
3333 [only one of the above three should be present]
3334 blinkwait{N} *cursor-blinking*
3335 blinkon{N}
3336 blinkoff{N}
3337 blink times for cursor: blinkwait is the delay before
3338 the cursor starts blinking, blinkon is the time that
3339 the cursor is shown and blinkoff is the time that the
3340 cursor is not shown. The times are in msec. When one
3341 of the numbers is zero, there is no blinking. The
3342 default is: "blinkwait700-blinkon400-blinkoff250".
3343 These numbers are used for a missing entry. This
3344 means that blinking is enabled by default. To switch
3345 blinking off you can use "blinkon0". The cursor only
3346 blinks when Vim is waiting for input, not while
3347 executing a command.
3348 To make the cursor blink in an xterm, see
3349 |xterm-blink|.
3350 {group-name}
3351 a highlight group name, that sets the color and font
3352 for the cursor
3353 {group-name}/{group-name}
3354 Two highlight group names, the first is used when
3355 no language mappings are used, the other when they
3356 are. |language-mapping|
3357
3358 Examples of parts:
3359 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3360 block cursor with colors from the "nCursor"
3361 highlight group
3362 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3363 In Insert and Command-line Insert mode, use a
3364 30% vertical bar cursor with colors from the
3365 "iCursor" highlight group. Blink a bit
3366 faster.
3367
3368 The 'a' mode is different. It will set the given argument-list for
3369 all modes. It does not reset anything to defaults. This can be used
3370 to do a common setting for all modes. For example, to switch off
3371 blinking: "a:blinkon0"
3372
3373 Examples of cursor highlighting: >
3374 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3375 :highlight Cursor gui=NONE guifg=bg guibg=fg
3376<
3377 *'guifont'* *'gfn'*
3378 *E235* *E596* *E610* *E611*
3379'guifont' 'gfn' string (default "")
3380 global
3381 {not in Vi}
3382 {only available when compiled with GUI enabled}
3383 This is a list of fonts which will be used for the GUI version of Vim.
3384 In its simplest form the value is just one font name. When
3385 the font cannot be found you will get an error message. To try other
3386 font names a list can be specified, font names separated with commas.
3387 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003388
Bram Moolenaar05159a02005-02-26 23:04:13 +00003389 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3390 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003391
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 Spaces after a comma are ignored. To include a comma in a font name
3393 precede it with a backslash. Setting an option requires an extra
3394 backslash before a space and a backslash. See also
3395 |option-backslash|. For example: >
3396 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003397< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003399
3400 If none of the fonts can be loaded, Vim will keep the current setting.
3401 If an empty font list is given, Vim will try using other resource
3402 settings (for X, it will use the Vim.font resource), and finally it
3403 will try some builtin default which should always be there ("7x13" in
3404 the case of X). The font names given should be "normal" fonts. Vim
3405 will try to find the related bold and italic fonts.
3406
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003407 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003408 :set guifont=*
3409< will bring up a font requester, where you can pick the font you want.
3410
3411 The font name depends on the GUI used. See |setting-guifont| for a
3412 way to set 'guifont' for various systems.
3413
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 For the GTK+ 2 GUI the font name looks like this: >
3415 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003416< That's all. XLFDs are not used. For Chinese this is reported to work
3417 well: >
3418 if has("gui_gtk2")
3419 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3420 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3421 endif
3422<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003423 For Mac OSX you can use something like this: >
3424 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003425< Also see 'macatsui', it can help fix display problems.
3426 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003428 width). An exception is GTK 2: all fonts are accepted, but
3429 mono-spaced fonts look best.
3430
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 To preview a font on X11, you might be able to use the "xfontsel"
3432 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 For the Win32 GUI *E244* *E245*
3435 - takes these options in the font name:
3436 hXX - height is XX (points, can be floating-point)
3437 wXX - width is XX (points, can be floating-point)
3438 b - bold
3439 i - italic
3440 u - underline
3441 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003442 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3444 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3445 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003446 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447
3448 Use a ':' to separate the options.
3449 - A '_' can be used in the place of a space, so you don't need to use
3450 backslashes to escape the spaces.
3451 - Examples: >
3452 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3453 :set guifont=Andale_Mono:h7.5:w4.5
3454< See also |font-sizes|.
3455
3456 *'guifontset'* *'gfs'*
3457 *E250* *E252* *E234* *E597* *E598*
3458'guifontset' 'gfs' string (default "")
3459 global
3460 {not in Vi}
3461 {only available when compiled with GUI enabled and
3462 with the |+xfontset| feature}
3463 {not available in the GTK+ 2 GUI}
3464 When not empty, specifies two (or more) fonts to be used. The first
3465 one for normal English, the second one for your special language. See
3466 |xfontset|.
3467 Setting this option also means that all font names will be handled as
3468 a fontset name. Also the ones used for the "font" argument of the
3469 |:highlight| command.
3470 The fonts must match with the current locale. If fonts for the
3471 character sets that the current locale uses are not included, setting
3472 'guifontset' will fail.
3473 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3474 the comma-separated names are alternative names, one of which will be
3475 used. In 'guifontset' the whole string is one fontset name,
3476 including the commas. It is not possible to specify alternative
3477 fontset names.
3478 This example works on many X11 systems: >
3479 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3480<
3481 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3482'guifontwide' 'gfw' string (default "")
3483 global
3484 {not in Vi}
3485 {only available when compiled with GUI enabled}
3486 When not empty, specifies a comma-separated list of fonts to be used
3487 for double-width characters. The first font that can be loaded is
3488 used.
3489 Note: The size of these fonts must be exactly twice as wide as the one
3490 specified with 'guifont' and the same height.
3491
3492 All GUI versions but GTK+ 2:
3493
3494 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3495 'guifontset' is empty or invalid.
3496 When 'guifont' is set and a valid font is found in it and
3497 'guifontwide' is empty Vim will attempt to find a matching
3498 double-width font and set 'guifontwide' to it.
3499
3500 GTK+ 2 GUI only: *guifontwide_gtk2*
3501
3502 If set and valid, 'guifontwide' is always used for double width
3503 characters, even if 'encoding' is not set to "utf-8".
3504 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003505 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 font for characters not available in 'guifont'. Thus you do not need
3507 to set 'guifontwide' at all unless you want to override the choice
3508 made by Pango/Xft.
3509
3510 *'guiheadroom'* *'ghr'*
3511'guiheadroom' 'ghr' number (default 50)
3512 global
3513 {not in Vi} {only for GTK and X11 GUI}
3514 The number of pixels subtracted from the screen height when fitting
3515 the GUI window on the screen. Set this before the GUI is started,
3516 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003517 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 lines will be left for window decorations and other items on the
3519 screen. Set it to a negative value to allow windows taller than the
3520 screen.
3521
3522 *'guioptions'* *'go'*
3523'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003524 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 global
3526 {not in Vi}
3527 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003528 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 sequence of letters which describes what components and options of the
3530 GUI should be used.
3531 To avoid problems with flags that are added in the future, use the
3532 "+=" and "-=" feature of ":set" |add-option-flags|.
3533
3534 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003535 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 'a' Autoselect: If present, then whenever VISUAL mode is started,
3537 or the Visual area extended, Vim tries to become the owner of
3538 the windowing system's global selection. This means that the
3539 Visually highlighted text is available for pasting into other
3540 applications as well as into Vim itself. When the Visual mode
3541 ends, possibly due to an operation on the text, or when an
3542 application wants to paste the selection, the highlighted text
3543 is automatically yanked into the "* selection register.
3544 Thus the selection is still available for pasting into other
3545 applications after the VISUAL mode has ended.
3546 If not present, then Vim won't become the owner of the
3547 windowing system's global selection unless explicitly told to
3548 by a yank or delete operation for the "* register.
3549 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003550 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003551 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 applies to the modeless selection.
3553
3554 'guioptions' autoselect Visual autoselect modeless ~
3555 "" - -
3556 "a" yes yes
3557 "A" - yes
3558 "aA" yes yes
3559
Bram Moolenaar02467872007-05-06 13:22:01 +00003560 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 'c' Use console dialogs instead of popup dialogs for simple
3562 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003563 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003564 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003565 'guitablabel' can be used to change the text in the labels.
3566 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003567 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003568 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003569 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 'f' Foreground: Don't use fork() to detach the GUI from the shell
3571 where it was started. Use this for programs that wait for the
3572 editor to finish (e.g., an e-mail program). Alternatively you
3573 can use "gvim -f" or ":gui -f" to start the GUI in the
3574 foreground. |gui-fork|
3575 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003576 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003577 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3579 corner of the window. It's black&white on non-GTK, because of
3580 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003581 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003583 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003584 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003586 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 file is sourced the system menu has already been loaded; the
3588 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003589 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 'g' Grey menu items: Make menu items that are not active grey. If
3591 'g' is not included inactive menu items are not shown at all.
3592 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003593 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 't' Include tearoff menu items. Currently only works for Win32,
3595 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003596 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003597 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003598 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003599 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003601 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 'R' Right-hand scrollbar is present when there is a vertically
3603 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003604 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003606 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 'L' Left-hand scrollbar is present when there is a vertically
3608 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003609 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003610 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3611 the longest visible line, or on the cursor line if the 'h'
3612 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003613 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 'h' Limit horizontal scrollbar size to the length of the cursor
3615 line. Reduces computations. |gui-horiz-scroll|
3616
3617 And yes, you may even have scrollbars on the left AND the right if
3618 you really want to :-). See |gui-scrollbars| for more information.
3619
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003620 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 'v' Use a vertical button layout for dialogs. When not included,
3622 a horizontal layout is preferred, but when it doesn't fit a
3623 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003624 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 'p' Use Pointer callbacks for X11 GUI. This is required for some
3626 window managers. If the cursor is not blinking or hollow at
3627 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003628 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003630 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003631 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632
Bram Moolenaar02467872007-05-06 13:22:01 +00003633
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 *'guipty'* *'noguipty'*
3635'guipty' boolean (default on)
3636 global
3637 {not in Vi}
3638 {only available when compiled with GUI enabled}
3639 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3640 I/O to/from shell commands. See |gui-pty|.
3641
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003642 *'guitablabel'* *'gtl'*
3643'guitablabel' 'gtl' string (default empty)
3644 global
3645 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003646 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003647 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003648 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003649 pages line. When empty and when the result is empty Vim will use a
3650 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003651
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003652 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003653 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003654
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003655 Only used when the GUI tab pages line is displayed. 'e' must be
3656 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3657 used.
3658
Bram Moolenaar57657d82006-04-21 22:12:41 +00003659 *'guitabtooltip'* *'gtt'*
3660'guitabtooltip' 'gtt' string (default empty)
3661 global
3662 {not in Vi}
3663 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003664 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003665 When nonempty describes the text to use in a tooltip for the GUI tab
3666 pages line. When empty Vim will use a default tooltip.
3667 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003668 You can include a line break. Simplest method is to use |:let|: >
3669 :let &guitabtooltip = "line one\nline two"
3670<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003671
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 *'helpfile'* *'hf'*
3673'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3674 (others) "$VIMRUNTIME/doc/help.txt")
3675 global
3676 {not in Vi}
3677 Name of the main help file. All distributed help files should be
3678 placed together in one directory. Additionally, all "doc" directories
3679 in 'runtimepath' will be used.
3680 Environment variables are expanded |:set_env|. For example:
3681 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003682 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 spaces and backslashes.
3684 This option cannot be set from a |modeline| or in the |sandbox|, for
3685 security reasons.
3686
3687 *'helpheight'* *'hh'*
3688'helpheight' 'hh' number (default 20)
3689 global
3690 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003691 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 feature}
3693 Minimal initial height of the help window when it is opened with the
3694 ":help" command. The initial height of the help window is half of the
3695 current window, or (when the 'ea' option is on) the same as other
3696 windows. When the height is less than 'helpheight', the height is
3697 set to 'helpheight'. Set to zero to disable.
3698
3699 *'helplang'* *'hlg'*
3700'helplang' 'hlg' string (default: messages language or empty)
3701 global
3702 {only available when compiled with the |+multi_lang|
3703 feature}
3704 {not in Vi}
3705 Comma separated list of languages. Vim will use the first language
3706 for which the desired help can be found. The English help will always
3707 be used as a last resort. You can add "en" to prefer English over
3708 another language, but that will only find tags that exist in that
3709 language and not in the English help.
3710 Example: >
3711 :set helplang=de,it
3712< This will first search German, then Italian and finally English help
3713 files.
3714 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3715 try to find the tag in the current language before using this option.
3716 See |help-translated|.
3717
3718 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3719'hidden' 'hid' boolean (default off)
3720 global
3721 {not in Vi}
3722 When off a buffer is unloaded when it is |abandon|ed. When on a
3723 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3724 displayed in another window, it does not become hidden, of course.
3725 The commands that move through the buffer list sometimes make a buffer
3726 hidden although the 'hidden' option is off: When the buffer is
3727 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003728 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003729 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 This option is set for one command with ":hide {command}" |:hide|.
3731 WARNING: It's easy to forget that you have changes in hidden buffers.
3732 Think twice when using ":q!" or ":qa!".
3733
3734 *'highlight'* *'hl'*
3735'highlight' 'hl' string (default (as a single string):
3736 "8:SpecialKey,@:NonText,d:Directory,
3737 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3738 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003739 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3741 f:Folded,F:FoldColumn,A:DiffAdd,
3742 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003743 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003744 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003745 +:Pmenu,=:PmenuSel,
3746 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 global
3748 {not in Vi}
3749 This option can be used to set highlighting mode for various
3750 occasions. It is a comma separated list of character pairs. The
3751 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3754 |hl-NonText| @ '~' and '@' at the end of the window and
3755 characters from 'showbreak'
3756 |hl-Directory| d directories in CTRL-D listing and other special
3757 things in listings
3758 |hl-ErrorMsg| e error messages
3759 h (obsolete, ignored)
3760 |hl-IncSearch| i 'incsearch' highlighting
3761 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3762 |hl-MoreMsg| m |more-prompt|
3763 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003764 |hl-LineNr| n line number for ":number" and ":#" commands, and
3765 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 |hl-Question| r |hit-enter| prompt and yes/no questions
3767 |hl-StatusLine| s status line of current window |status-line|
3768 |hl-StatusLineNC| S status lines of not-current windows
3769 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3770 |hl-VertSplit| c column used to separate vertically split windows
3771 |hl-Visual| v Visual mode
3772 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3773 Selection" Only X11 Gui's |gui-x11| and
3774 |xterm-clipboard|.
3775 |hl-WarningMsg| w warning messages
3776 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3777 |hl-Folded| f line used for closed folds
3778 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003779 |hl-DiffAdd| A added line in diff mode
3780 |hl-DiffChange| C changed line in diff mode
3781 |hl-DiffDelete| D deleted line in diff mode
3782 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003784 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003785 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003786 |hl-SpellRare| R rare word |spell|
3787 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003788 |hl-Conceal| - the placeholders used for concealed characters
3789 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003790 |hl-Pmenu| + popup menu normal line
3791 |hl-PmenuSel| = popup menu normal line
3792 |hl-PmenuSbar| x popup menu scrollbar
3793 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794
3795 The display modes are:
3796 r reverse (termcap entry "mr" and "me")
3797 i italic (termcap entry "ZH" and "ZR")
3798 b bold (termcap entry "md" and "me")
3799 s standout (termcap entry "so" and "se")
3800 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003801 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 n no highlighting
3803 - no highlighting
3804 : use a highlight group
3805 The default is used for occasions that are not included.
3806 If you want to change what the display modes do, see |dos-colors|
3807 for an example.
3808 When using the ':' display mode, this must be followed by the name of
3809 a highlight group. A highlight group can be used to define any type
3810 of highlighting, including using color. See |:highlight| on how to
3811 define one. The default uses a different group for each occasion.
3812 See |highlight-default| for the default highlight groups.
3813
3814 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3815'hlsearch' 'hls' boolean (default off)
3816 global
3817 {not in Vi}
3818 {not available when compiled without the
3819 |+extra_search| feature}
3820 When there is a previous search pattern, highlight all its matches.
3821 The type of highlighting used can be set with the 'l' occasion in the
3822 'highlight' option. This uses the "Search" highlight group by
3823 default. Note that only the matching text is highlighted, any offsets
3824 are not applied.
3825 See also: 'incsearch' and |:match|.
3826 When you get bored looking at the highlighted matches, you can turn it
3827 off with |:nohlsearch|. As soon as you use a search command, the
3828 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003829 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 When the search pattern can match an end-of-line, Vim will try to
3831 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003832 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003833 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003834 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 NOTE: This option is reset when 'compatible' is set.
3836
3837 *'history'* *'hi'*
3838'history' 'hi' number (Vim default: 20, Vi default: 0)
3839 global
3840 {not in Vi}
3841 A history of ":" commands, and a history of previous search patterns
3842 are remembered. This option decides how many entries may be stored in
3843 each of these histories (see |cmdline-editing|).
3844 NOTE: This option is set to the Vi default value when 'compatible' is
3845 set and to the Vim default value when 'compatible' is reset.
3846
3847 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3848'hkmap' 'hk' boolean (default off)
3849 global
3850 {not in Vi}
3851 {only available when compiled with the |+rightleft|
3852 feature}
3853 When on, the keyboard is mapped for the Hebrew character set.
3854 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3855 toggle this option. See |rileft.txt|.
3856 NOTE: This option is reset when 'compatible' is set.
3857
3858 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3859'hkmapp' 'hkp' boolean (default off)
3860 global
3861 {not in Vi}
3862 {only available when compiled with the |+rightleft|
3863 feature}
3864 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3865 This is useful if you have a non-Hebrew keyboard.
3866 See |rileft.txt|.
3867 NOTE: This option is reset when 'compatible' is set.
3868
3869 *'icon'* *'noicon'*
3870'icon' boolean (default off, on when title can be restored)
3871 global
3872 {not in Vi}
3873 {not available when compiled without the |+title|
3874 feature}
3875 When on, the icon text of the window will be set to the value of
3876 'iconstring' (if it is not empty), or to the name of the file
3877 currently being edited. Only the last part of the name is used.
3878 Overridden by the 'iconstring' option.
3879 Only works if the terminal supports setting window icons (currently
3880 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3881 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3882 builtin termcap).
3883 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003884 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 X11.
3886
3887 *'iconstring'*
3888'iconstring' string (default "")
3889 global
3890 {not in Vi}
3891 {not available when compiled without the |+title|
3892 feature}
3893 When this option is not empty, it will be used for the icon text of
3894 the window. This happens only when the 'icon' option is on.
3895 Only works if the terminal supports setting window icon text
3896 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3897 Does not work for MS Windows.
3898 When Vim was compiled with HAVE_X11 defined, the original icon will be
3899 restored if possible |X11|.
3900 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003901 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 'titlestring' for example settings.
3903 {not available when compiled without the |+statusline| feature}
3904
3905 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3906'ignorecase' 'ic' boolean (default off)
3907 global
3908 Ignore case in search patterns. Also used when searching in the tags
3909 file.
3910 Also see 'smartcase'.
3911 Can be overruled by using "\c" or "\C" in the pattern, see
3912 |/ignorecase|.
3913
3914 *'imactivatekey'* *'imak'*
3915'imactivatekey' 'imak' string (default "")
3916 global
3917 {not in Vi}
3918 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003919 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 Specifies the key that your Input Method in X-Windows uses for
3921 activation. When this is specified correctly, vim can fully control
3922 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3923 You can't use this option to change the activation key, the option
3924 tells Vim what the key is.
3925 Format:
3926 [MODIFIER_FLAG-]KEY_STRING
3927
3928 These characters can be used for MODIFIER_FLAG (case is ignored):
3929 S Shift key
3930 L Lock key
3931 C Control key
3932 1 Mod1 key
3933 2 Mod2 key
3934 3 Mod3 key
3935 4 Mod4 key
3936 5 Mod5 key
3937 Combinations are allowed, for example "S-C-space" or "SC-space" are
3938 both shift+ctrl+space.
3939 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3940
3941 Example: >
3942 :set imactivatekey=S-space
3943< "S-space" means shift+space. This is the activation key for kinput2 +
3944 canna (Japanese), and ami (Korean).
3945
3946 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3947'imcmdline' 'imc' boolean (default off)
3948 global
3949 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003950 {only available when compiled with the |+xim|,
3951 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 When set the Input Method is always on when starting to edit a command
3953 line, unless entering a search pattern (see 'imsearch' for that).
3954 Setting this option is useful when your input method allows entering
3955 English characters directly, e.g., when it's used to type accented
3956 characters with dead keys.
3957
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003958 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3960 global
3961 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003962 {only available when compiled with the |+xim|,
3963 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003964 When set the Input Method is never used. This is useful to disable
3965 the IM when it doesn't work properly.
3966 Currently this option is on by default for SGI/IRIX machines. This
3967 may change in later releases.
3968
3969 *'iminsert'* *'imi'*
3970'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3971 local to buffer
3972 {not in Vi}
3973 Specifies whether :lmap or an Input Method (IM) is to be used in
3974 Insert mode. Valid values:
3975 0 :lmap is off and IM is off
3976 1 :lmap is ON and IM is off
3977 2 :lmap is off and IM is ON
3978 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3979 or |global-ime|.
3980 To always reset the option to zero when leaving Insert mode with <Esc>
3981 this can be used: >
3982 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3983< This makes :lmap and IM turn off automatically when leaving Insert
3984 mode.
3985 Note that this option changes when using CTRL-^ in Insert mode
3986 |i_CTRL-^|.
3987 The value is set to 1 when setting 'keymap' to a valid keymap name.
3988 It is also used for the argument of commands like "r" and "f".
3989 The value 0 may not work correctly with Athena and Motif with some XIM
3990 methods. Use 'imdisable' to disable XIM then.
3991
3992 *'imsearch'* *'ims'*
3993'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3994 local to buffer
3995 {not in Vi}
3996 Specifies whether :lmap or an Input Method (IM) is to be used when
3997 entering a search pattern. Valid values:
3998 -1 the value of 'iminsert' is used, makes it look like
3999 'iminsert' is also used when typing a search pattern
4000 0 :lmap is off and IM is off
4001 1 :lmap is ON and IM is off
4002 2 :lmap is off and IM is ON
4003 Note that this option changes when using CTRL-^ in Command-line mode
4004 |c_CTRL-^|.
4005 The value is set to 1 when it is not -1 and setting the 'keymap'
4006 option to a valid keymap name.
4007 The value 0 may not work correctly with Athena and Motif with some XIM
4008 methods. Use 'imdisable' to disable XIM then.
4009
4010 *'include'* *'inc'*
4011'include' 'inc' string (default "^\s*#\s*include")
4012 global or local to buffer |global-local|
4013 {not in Vi}
4014 {not available when compiled without the
4015 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004016 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 pattern, just like for the "/" command (See |pattern|). The default
4018 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004019 "]I", "[d", etc.
4020 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004021 comes after the matched pattern. But if "\zs" appears in the pattern
4022 then the text matched from "\zs" to the end, or until "\ze" if it
4023 appears, is used as the file name. Use this to include characters
4024 that are not in 'isfname', such as a space. You can then use
4025 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004026 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027
4028 *'includeexpr'* *'inex'*
4029'includeexpr' 'inex' string (default "")
4030 local to buffer
4031 {not in Vi}
4032 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004033 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004034 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004035 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 :set includeexpr=substitute(v:fname,'\\.','/','g')
4037< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004038
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004040 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 Also used for |<cfile>|.
4042
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004043 The expression may be evaluated in the |sandbox|, see
4044 |sandbox-option|.
4045
4046 It is not allowed to change text or jump to another window while
4047 evaluating 'includeexpr' |textlock|.
4048
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4050'incsearch' 'is' boolean (default off)
4051 global
4052 {not in Vi}
4053 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004054 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004055 While typing a search command, show where the pattern, as it was typed
4056 so far, matches. The matched string is highlighted. If the pattern
4057 is invalid or not found, nothing is shown. The screen will be updated
4058 often, this is only useful on fast terminals.
4059 Note that the match will be shown, but the cursor will return to its
4060 original position when no match is found and when pressing <Esc>. You
4061 still need to finish the search command with <Enter> to move the
4062 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004063 When compiled with the |+reltime| feature Vim only searches for about
4064 half a second. With a complicated pattern and/or a lot of text the
4065 match may not be found. This is to avoid that Vim hangs while you
4066 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004067 The highlighting can be set with the 'i' flag in 'highlight'.
4068 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004069 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004070 to the command line. If 'ignorecase' and 'smartcase' are set and the
4071 command line has no uppercase characters, the added character is
4072 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004073 CTRL-R CTRL-W can be used to add the word at the end of the current
4074 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 NOTE: This option is reset when 'compatible' is set.
4076
4077 *'indentexpr'* *'inde'*
4078'indentexpr' 'inde' string (default "")
4079 local to buffer
4080 {not in Vi}
4081 {not available when compiled without the |+cindent|
4082 or |+eval| features}
4083 Expression which is evaluated to obtain the proper indent for a line.
4084 It is used when a new line is created, for the |=| operator and
4085 in Insert mode as specified with the 'indentkeys' option.
4086 When this option is not empty, it overrules the 'cindent' and
4087 'smartindent' indenting.
4088 When 'paste' is set this option is not used for indenting.
4089 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004090 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 when the expression is evaluated (but it may be moved around).
4092 The expression must return the number of spaces worth of indent. It
4093 can return "-1" to keep the current indent (this means 'autoindent' is
4094 used for the indent).
4095 Functions useful for computing the indent are |indent()|, |cindent()|
4096 and |lispindent()|.
4097 The evaluation of the expression must not have side effects! It must
4098 not change the text, jump to another window, etc. Afterwards the
4099 cursor position is always restored, thus the cursor may be moved.
4100 Normally this option would be set to call a function: >
4101 :set indentexpr=GetMyIndent()
4102< Error messages will be suppressed, unless the 'debug' option contains
4103 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004104 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 NOTE: This option is made empty when 'compatible' is set.
4106
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004107 The expression may be evaluated in the |sandbox|, see
4108 |sandbox-option|.
4109
4110 It is not allowed to change text or jump to another window while
4111 evaluating 'indentexpr' |textlock|.
4112
4113
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 *'indentkeys'* *'indk'*
4115'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4116 local to buffer
4117 {not in Vi}
4118 {not available when compiled without the |+cindent|
4119 feature}
4120 A list of keys that, when typed in Insert mode, cause reindenting of
4121 the current line. Only happens if 'indentexpr' isn't empty.
4122 The format is identical to 'cinkeys', see |indentkeys-format|.
4123 See |C-indenting| and |indent-expression|.
4124
4125 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4126'infercase' 'inf' boolean (default off)
4127 local to buffer
4128 {not in Vi}
4129 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004130 'ignorecase' is also on, the case of the match is adjusted depending
4131 on the typed text. If the typed text contains a lowercase letter
4132 where the match has an upper case letter, the completed part is made
4133 lowercase. If the typed text has no lowercase letters and the match
4134 has a lowercase letter where the typed text has an uppercase letter,
4135 and there is a letter before it, the completed part is made uppercase.
4136 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137
4138 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4139'insertmode' 'im' boolean (default off)
4140 global
4141 {not in Vi}
4142 Makes Vim work in a way that Insert mode is the default mode. Useful
4143 if you want to use Vim as a modeless editor. Used for |evim|.
4144 These Insert mode commands will be useful:
4145 - Use the cursor keys to move around.
4146 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4147 this is a mapping, it is executed as if 'insertmode' was off.
4148 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004150 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4151 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152
4153 These items change when 'insertmode' is set:
4154 - when starting to edit of a file, Vim goes to Insert mode.
4155 - <Esc> in Insert mode is a no-op and beeps.
4156 - <Esc> in Normal mode makes Vim go to Insert mode.
4157 - CTRL-L in Insert mode is a command, it is not inserted.
4158 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4159 However, when <Esc> is used inside a mapping, it behaves like
4160 'insertmode' was not set. This was done to be able to use the same
4161 mappings with 'insertmode' set or not set.
4162 When executing commands with |:normal| 'insertmode' is not used.
4163
4164 NOTE: This option is reset when 'compatible' is set.
4165
4166 *'isfname'* *'isf'*
4167'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4168 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4169 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4170 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4171 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4172 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4173 global
4174 {not in Vi}
4175 The characters specified by this option are included in file names and
4176 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004177 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 Multi-byte characters 256 and above are always included, only the
4179 characters up to 255 are specified with this option.
4180 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004181 Think twice before adding white space to this option. Although a
4182 space may appear inside a file name, the effect will be that Vim
4183 doesn't know where a file name starts or ends when doing completion.
4184 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185
4186 Note that on systems using a backslash as path separator, Vim tries to
4187 do its best to make it work as you would expect. That is a bit
4188 tricky, since Vi originally used the backslash to escape special
4189 characters. Vim will not remove a backslash in front of a normal file
4190 name character on these systems, but it will on Unix and alikes. The
4191 '&' and '^' are not included by default, because these are special for
4192 cmd.exe.
4193
4194 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004195 Each part can be a single character number or a range. A range is two
4196 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004197 decimal number between 0 and 255 or the ASCII character itself (does
4198 not work for digits). Example:
4199 "_,-,128-140,#-43" (include '_' and '-' and the range
4200 128 to 140 and '#' to 43)
4201 If a part starts with '^', the following character number or range
4202 will be excluded from the option. The option is interpreted from left
4203 to right. Put the excluded character after the range where it is
4204 included. To include '^' itself use it as the last character of the
4205 option or the end of a range. Example:
4206 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4207 If the character is '@', all characters where isalpha() returns TRUE
4208 are included. Normally these are the characters a to z and A to Z,
4209 plus accented characters. To include '@' itself use "@-@". Examples:
4210 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004211 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 "a-z,A-Z,@-@" All letters plus the '@' character.
4213 A comma can be included by using it where a character number is
4214 expected. Example:
4215 "48-57,,,_" Digits, comma and underscore.
4216 A comma can be excluded by prepending a '^'. Example:
4217 " -~,^,,9" All characters from space to '~', excluding
4218 comma, plus <Tab>.
4219 See |option-backslash| about including spaces and backslashes.
4220
4221 *'isident'* *'isi'*
4222'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4223 "@,48-57,_,128-167,224-235"
4224 otherwise: "@,48-57,_,192-255")
4225 global
4226 {not in Vi}
4227 The characters given by this option are included in identifiers.
4228 Identifiers are used in recognizing environment variables and after a
4229 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004230 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 option.
4232 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004233 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4235
4236 *'iskeyword'* *'isk'*
4237'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4238 "@,48-57,_,128-167,224-235"
4239 otherwise: "@,48-57,_,192-255"
4240 Vi default: "@,48-57,_")
4241 local to buffer
4242 {not in Vi}
4243 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004244 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 'isfname' for a description of the format of this option. For C
4246 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4247 For a help file it is set to all non-blank printable characters except
4248 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4249 command).
4250 When the 'lisp' option is on the '-' character is always included.
4251 NOTE: This option is set to the Vi default value when 'compatible' is
4252 set and to the Vim default value when 'compatible' is reset.
4253
4254 *'isprint'* *'isp'*
4255'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4256 "@,~-255"; otherwise: "@,161-255")
4257 global
4258 {not in Vi}
4259 The characters given by this option are displayed directly on the
4260 screen. It is also used for "\p" in a |pattern|. The characters from
4261 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4262 even when they are not included in 'isprint' or excluded. See
4263 'isfname' for a description of the format of this option.
4264
4265 Non-printable characters are displayed with two characters:
4266 0 - 31 "^@" - "^_"
4267 32 - 126 always single characters
4268 127 "^?"
4269 128 - 159 "~@" - "~_"
4270 160 - 254 "| " - "|~"
4271 255 "~?"
4272 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4273 displayed as <xx>, with the hexadecimal value of the byte.
4274 When 'display' contains "uhex" all unprintable characters are
4275 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004276 The SpecialKey highlighting will be used for unprintable characters.
4277 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278
4279 Multi-byte characters 256 and above are always included, only the
4280 characters up to 255 are specified with this option. When a character
4281 is printable but it is not available in the current font, a
4282 replacement character will be shown.
4283 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4284 There is no option to specify these characters.
4285
4286 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4287'joinspaces' 'js' boolean (default on)
4288 global
4289 {not in Vi}
4290 Insert two spaces after a '.', '?' and '!' with a join command.
4291 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4292 Otherwise only one space is inserted.
4293 NOTE: This option is set when 'compatible' is set.
4294
4295 *'key'*
4296'key' string (default "")
4297 local to buffer
4298 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004299 {only available when compiled with the |+cryptv|
4300 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004302 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 Careful: Do not set the key value by hand, someone might see the typed
4304 key. Use the |:X| command. But you can make 'key' empty: >
4305 :set key=
4306< It is not possible to get the value of this option with ":set key" or
4307 "echo &key". This is to avoid showing it to someone who shouldn't
4308 know. It also means you cannot see it yourself once you have set it,
4309 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004310 You can use "&key" in an expression to detect whether encryption is
4311 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312
4313 *'keymap'* *'kmp'* *E544*
4314'keymap' 'kmp' string (default "")
4315 local to buffer
4316 {not in Vi}
4317 {only available when compiled with the |+keymap|
4318 feature}
4319 Name of a keyboard mapping. See |mbyte-keymap|.
4320 Setting this option to a valid keymap name has the side effect of
4321 setting 'iminsert' to one, so that the keymap becomes effective.
4322 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004323 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324
4325 *'keymodel'* *'km'*
4326'keymodel' 'km' string (default "")
4327 global
4328 {not in Vi}
4329 List of comma separated words, which enable special things that keys
4330 can do. These values can be used:
4331 startsel Using a shifted special key starts selection (either
4332 Select mode or Visual mode, depending on "key" being
4333 present in 'selectmode').
4334 stopsel Using a not-shifted special key stops selection.
4335 Special keys in this context are the cursor keys, <End>, <Home>,
4336 <PageUp> and <PageDown>.
4337 The 'keymodel' option is set by the |:behave| command.
4338
4339 *'keywordprg'* *'kp'*
4340'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4341 OS/2: "view /", VMS: "help")
4342 global or local to buffer |global-local|
4343 {not in Vi}
4344 Program to use for the |K| command. Environment variables are
4345 expanded |:set_env|. ":help" may be used to access the Vim internal
4346 help. (Note that previously setting the global option to the empty
4347 value did this, which is now deprecated.)
4348 When "man" is used, Vim will automatically translate a count for the
4349 "K" command to a section number. Also for "man -s", in which case the
4350 "-s" is removed when there is no count.
4351 See |option-backslash| about including spaces and backslashes.
4352 Example: >
4353 :set keywordprg=man\ -s
4354< This option cannot be set from a |modeline| or in the |sandbox|, for
4355 security reasons.
4356
4357 *'langmap'* *'lmap'* *E357* *E358*
4358'langmap' 'lmap' string (default "")
4359 global
4360 {not in Vi}
4361 {only available when compiled with the |+langmap|
4362 feature}
4363 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004364 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 inserted directly. When in command mode the 'langmap' option takes
4366 care of translating these special characters to the original meaning
4367 of the key. This means you don't have to change the keyboard mode to
4368 be able to execute Normal mode commands.
4369 This is the opposite of the 'keymap' option, where characters are
4370 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004372 Example (for Greek, in UTF-8): *greek* >
4373 :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 +00004374< Example (exchanges meaning of z and y for commands): >
4375 :set langmap=zy,yz,ZY,YZ
4376<
4377 The 'langmap' option is a list of parts, separated with commas. Each
4378 part can be in one of two forms:
4379 1. A list of pairs. Each pair is a "from" character immediately
4380 followed by the "to" character. Examples: "aA", "aAbBcC".
4381 2. A list of "from" characters, a semi-colon and a list of "to"
4382 characters. Example: "abc;ABC"
4383 Example: "aA,fgh;FGH,cCdDeE"
4384 Special characters need to be preceded with a backslash. These are
4385 ";", ',' and backslash itself.
4386
4387 This will allow you to activate vim actions without having to switch
4388 back and forth between the languages. Your language characters will
4389 be understood as normal vim English characters (according to the
4390 langmap mappings) in the following cases:
4391 o Normal/Visual mode (commands, buffer/register names, user mappings)
4392 o Insert/Replace Mode: Register names after CTRL-R
4393 o Insert/Replace Mode: Mappings
4394 Characters entered in Command-line mode will NOT be affected by
4395 this option. Note that this option can be changed at any time
4396 allowing to switch between mappings for different languages/encodings.
4397 Use a mapping to avoid having to type it each time!
4398
4399 *'langmenu'* *'lm'*
4400'langmenu' 'lm' string (default "")
4401 global
4402 {not in Vi}
4403 {only available when compiled with the |+menu| and
4404 |+multi_lang| features}
4405 Language to use for menu translation. Tells which file is loaded
4406 from the "lang" directory in 'runtimepath': >
4407 "lang/menu_" . &langmenu . ".vim"
4408< (without the spaces). For example, to always use the Dutch menus, no
4409 matter what $LANG is set to: >
4410 :set langmenu=nl_NL.ISO_8859-1
4411< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004412 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004413 If your $LANG is set to a non-English language but you do want to use
4414 the English menus: >
4415 :set langmenu=none
4416< This option must be set before loading menus, switching on filetype
4417 detection or syntax highlighting. Once the menus are defined setting
4418 this option has no effect. But you could do this: >
4419 :source $VIMRUNTIME/delmenu.vim
4420 :set langmenu=de_DE.ISO_8859-1
4421 :source $VIMRUNTIME/menu.vim
4422< Warning: This deletes all menus that you defined yourself!
4423
4424 *'laststatus'* *'ls'*
4425'laststatus' 'ls' number (default 1)
4426 global
4427 {not in Vi}
4428 The value of this option influences when the last window will have a
4429 status line:
4430 0: never
4431 1: only if there are at least two windows
4432 2: always
4433 The screen looks nicer with a status line if you have several
4434 windows, but it takes another screen line. |status-line|
4435
4436 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4437'lazyredraw' 'lz' boolean (default off)
4438 global
4439 {not in Vi}
4440 When this option is set, the screen will not be redrawn while
4441 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004442 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 update use |:redraw|.
4444
4445 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4446'linebreak' 'lbr' boolean (default off)
4447 local to window
4448 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004449 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 feature}
4451 If on Vim will wrap long lines at a character in 'breakat' rather
4452 than at the last character that fits on the screen. Unlike
4453 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4454 it only affects the way the file is displayed, not its contents. The
4455 value of 'showbreak' is used to put in front of wrapped lines.
4456 This option is not used when the 'wrap' option is off or 'list' is on.
4457 Note that <Tab> characters after an <EOL> are mostly not displayed
4458 with the right amount of white space.
4459
4460 *'lines'* *E593*
4461'lines' number (default 24 or terminal height)
4462 global
4463 Number of lines of the Vim window.
4464 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004465 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 When Vim is running in the GUI or in a resizable window, setting this
4467 option will cause the window size to be changed. When you only want
4468 to use the size for the GUI, put the command in your |gvimrc| file.
4469 Vim limits the number of lines to what fits on the screen. You can
4470 use this command to get the tallest window possible: >
4471 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004472< Minimum value is 2, maximum value is 1000.
4473 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 When you set this option and Vim is unable to change the physical
4475 number of lines of the display, the display may be messed up.
4476
4477 *'linespace'* *'lsp'*
4478'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4479 global
4480 {not in Vi}
4481 {only in the GUI}
4482 Number of pixel lines inserted between characters. Useful if the font
4483 uses the full character cell height, making lines touch each other.
4484 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004485 With some fonts there can be too much room between lines (to have
4486 space for ascents and descents). Then it makes sense to set
4487 'linespace' to a negative value. This may cause display problems
4488 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489
4490 *'lisp'* *'nolisp'*
4491'lisp' boolean (default off)
4492 local to buffer
4493 {not available when compiled without the |+lispindent|
4494 feature}
4495 Lisp mode: When <Enter> is typed in insert mode set the indent for
4496 the next line to Lisp standards (well, sort of). Also happens with
4497 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4498 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4499 better. Also see 'lispwords'.
4500 The '-' character is included in keyword characters. Redefines the
4501 "=" operator to use this same indentation algorithm rather than
4502 calling an external program if 'equalprg' is empty.
4503 This option is not used when 'paste' is set.
4504 {Vi: Does it a little bit differently}
4505
4506 *'lispwords'* *'lw'*
4507'lispwords' 'lw' string (default is very long)
4508 global
4509 {not in Vi}
4510 {not available when compiled without the |+lispindent|
4511 feature}
4512 Comma separated list of words that influence the Lisp indenting.
4513 |'lisp'|
4514
4515 *'list'* *'nolist'*
4516'list' boolean (default off)
4517 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004518 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4519 line. Useful to see the difference between tabs and spaces and for
4520 trailing blanks. Further changed by the 'listchars' option.
4521
4522 The cursor is displayed at the start of the space a Tab character
4523 occupies, not at the end as usual in Normal mode. To get this cursor
4524 position while displaying Tabs with spaces, use: >
4525 :set list lcs=tab\ \
4526<
4527 Note that list mode will also affect formatting (set with 'textwidth'
4528 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 changing the way tabs are displayed.
4530
4531 *'listchars'* *'lcs'*
4532'listchars' 'lcs' string (default "eol:$")
4533 global
4534 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004535 Strings to use in 'list' mode and for the |:list| command. It is a
4536 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 eol:c Character to show at the end of each line. When
4538 omitted, there is no extra character at the end of the
4539 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004540 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004542 fill the space that the tab normally occupies.
4543 "tab:>-" will show a tab that takes four spaces as
4544 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004545 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 trailing spaces are blank.
4547 extends:c Character to show in the last column, when 'wrap' is
4548 off and the line continues beyond the right of the
4549 screen.
4550 precedes:c Character to show in the first column, when 'wrap'
4551 is off and there is text preceding the character
4552 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004553 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004554 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004555 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004556 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004558 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004560 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561
4562 Examples: >
4563 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004564 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 :set lcs=extends:>,precedes:<
4566< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004567 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004568 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569
4570 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4571'loadplugins' 'lpl' boolean (default on)
4572 global
4573 {not in Vi}
4574 When on the plugin scripts are loaded when starting up |load-plugins|.
4575 This option can be reset in your |vimrc| file to disable the loading
4576 of plugins.
4577 Note that using the "-u NONE" and "--noplugin" command line arguments
4578 reset this option. |-u| |--noplugin|
4579
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004580 *'macatsui'* *'nomacatsui'*
4581'macatsui' boolean (default on)
4582 global
4583 {only available in Mac GUI version}
4584 This is a workaround for when drawing doesn't work properly. When set
4585 and compiled with multi-byte support ATSUI text drawing is used. When
4586 not set ATSUI text drawing is not used. Switch this option off when
4587 you experience drawing problems. In a future version the problems may
4588 be solved and this option becomes obsolete. Therefore use this method
4589 to unset it: >
4590 if exists('&macatsui')
4591 set nomacatsui
4592 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004593< Another option to check if you have drawing problems is
4594 'termencoding'.
4595
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 *'magic'* *'nomagic'*
4597'magic' boolean (default on)
4598 global
4599 Changes the special characters that can be used in search patterns.
4600 See |pattern|.
4601 NOTE: To avoid portability problems with using patterns, always keep
4602 this option at the default "on". Only switch it off when working with
4603 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004604 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605
4606 *'makeef'* *'mef'*
4607'makeef' 'mef' string (default: "")
4608 global
4609 {not in Vi}
4610 {not available when compiled without the |+quickfix|
4611 feature}
4612 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4613 and the |:grep| command.
4614 When it is empty, an internally generated temp file will be used.
4615 When "##" is included, it is replaced by a number to make the name
4616 unique. This makes sure that the ":make" command doesn't overwrite an
4617 existing file.
4618 NOT used for the ":cf" command. See 'errorfile' for that.
4619 Environment variables are expanded |:set_env|.
4620 See |option-backslash| about including spaces and backslashes.
4621 This option cannot be set from a |modeline| or in the |sandbox|, for
4622 security reasons.
4623
4624 *'makeprg'* *'mp'*
4625'makeprg' 'mp' string (default "make", VMS: "MMS")
4626 global or local to buffer |global-local|
4627 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004628 Program to use for the ":make" command. See |:make_makeprg|.
4629 This option may contain '%' and '#' characters, which are expanded to
4630 the current and alternate file name. |:_%| |:_#|
4631 Environment variables are expanded |:set_env|. See |option-backslash|
4632 about including spaces and backslashes.
4633 Note that a '|' must be escaped twice: once for ":set" and once for
4634 the interpretation of a command. When you use a filter called
4635 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 :set makeprg=gmake\ \\\|\ myfilter
4637< The placeholder "$*" can be given (even multiple times) to specify
4638 where the arguments will be included, for example: >
4639 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4640< This option cannot be set from a |modeline| or in the |sandbox|, for
4641 security reasons.
4642
4643 *'matchpairs'* *'mps'*
4644'matchpairs' 'mps' string (default "(:),{:},[:]")
4645 local to buffer
4646 {not in Vi}
4647 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004648 other. Currently only single byte character pairs are allowed, and
4649 they must be different. The characters must be separated by a colon.
4650 The pairs must be separated by a comma. Example for including '<' and
4651 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652 :set mps+=<:>
4653
4654< A more exotic example, to jump between the '=' and ';' in an
4655 assignment, useful for languages like C and Java: >
4656 :au FileType c,cpp,java set mps+==:;
4657
4658< For a more advanced way of using "%", see the matchit.vim plugin in
4659 the $VIMRUNTIME/macros directory. |add-local-help|
4660
4661 *'matchtime'* *'mat'*
4662'matchtime' 'mat' number (default 5)
4663 global
4664 {not in Vi}{in Nvi}
4665 Tenths of a second to show the matching paren, when 'showmatch' is
4666 set. Note that this is not in milliseconds, like other options that
4667 set a time. This is to be compatible with Nvi.
4668
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004669 *'maxcombine'* *'mco'*
4670'maxcombine' 'mco' number (default 2)
4671 global
4672 {not in Vi}
4673 {only available when compiled with the |+multi_byte|
4674 feature}
4675 The maximum number of combining characters supported for displaying.
4676 Only used when 'encoding' is "utf-8".
4677 The default is OK for most languages. Hebrew may require 4.
4678 Maximum value is 6.
4679 Even when this option is set to 2 you can still edit text with more
4680 combining characters, you just can't see them. Use |g8| or |ga|.
4681 See |mbyte-combining|.
4682
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 *'maxfuncdepth'* *'mfd'*
4684'maxfuncdepth' 'mfd' number (default 100)
4685 global
4686 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004687 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004688 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 Maximum depth of function calls for user functions. This normally
4690 catches endless recursion. When using a recursive function with
4691 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4692 more memory, there is the danger of failing when memory is exhausted.
4693 See also |:function|.
4694
4695 *'maxmapdepth'* *'mmd'* *E223*
4696'maxmapdepth' 'mmd' number (default 1000)
4697 global
4698 {not in Vi}
4699 Maximum number of times a mapping is done without resulting in a
4700 character to be used. This normally catches endless mappings, like
4701 ":map x y" with ":map y x". It still does not catch ":map g wg",
4702 because the 'w' is used before the next mapping is done. See also
4703 |key-mapping|.
4704
4705 *'maxmem'* *'mm'*
4706'maxmem' 'mm' number (default between 256 to 5120 (system
4707 dependent) or half the amount of memory
4708 available)
4709 global
4710 {not in Vi}
4711 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4712 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004713 other memory to be freed. The maximum usable value is about 2000000.
4714 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004716 *'maxmempattern'* *'mmp'*
4717'maxmempattern' 'mmp' number (default 1000)
4718 global
4719 {not in Vi}
4720 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004721 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004722 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004723 When Vim runs into the limit it gives an error message and mostly
4724 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004725 Running into the limit often means that the pattern is very
4726 inefficient or too complex. This may already happen with the pattern
4727 "\(.\)*" on a very long line. ".*" works much better.
4728 Vim may run out of memory before hitting the 'maxmempattern' limit.
4729
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 *'maxmemtot'* *'mmt'*
4731'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4732 dependent) or half the amount of memory
4733 available)
4734 global
4735 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004736 Maximum amount of memory in Kbyte to use for all buffers together.
4737 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4738 without a limit. On 64 bit machines higher values might work. But
4739 hey, do you really need more than 2 Gbyte for text editing?
4740 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741
4742 *'menuitems'* *'mis'*
4743'menuitems' 'mis' number (default 25)
4744 global
4745 {not in Vi}
4746 {not available when compiled without the |+menu|
4747 feature}
4748 Maximum number of items to use in a menu. Used for menus that are
4749 generated from a list of items, e.g., the Buffers menu. Changing this
4750 option has no direct effect, the menu must be refreshed first.
4751
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004752 *'mkspellmem'* *'msm'*
4753'mkspellmem' 'msm' string (default "460000,2000,500")
4754 global
4755 {not in Vi}
4756 {not available when compiled without the |+syntax|
4757 feature}
4758 Parameters for |:mkspell|. This tunes when to start compressing the
4759 word tree. Compression can be slow when there are many words, but
4760 it's needed to avoid running out of memory. The amount of memory used
4761 per word depends very much on how similar the words are, that's why
4762 this tuning is complicated.
4763
4764 There are three numbers, separated by commas:
4765 {start},{inc},{added}
4766
4767 For most languages the uncompressed word tree fits in memory. {start}
4768 gives the amount of memory in Kbyte that can be used before any
4769 compression is done. It should be a bit smaller than the amount of
4770 memory that is available to Vim.
4771
4772 When going over the {start} limit the {inc} number specifies the
4773 amount of memory in Kbyte that can be allocated before another
4774 compression is done. A low number means compression is done after
4775 less words are added, which is slow. A high number means more memory
4776 will be allocated.
4777
4778 After doing compression, {added} times 1024 words can be added before
4779 the {inc} limit is ignored and compression is done when any extra
4780 amount of memory is needed. A low number means there is a smaller
4781 chance of hitting the {inc} limit, less memory is used but it's
4782 slower.
4783
4784 The languages for which these numbers are important are Italian and
4785 Hungarian. The default works for when you have about 512 Mbyte. If
4786 you have 1 Gbyte you could use: >
4787 :set mkspellmem=900000,3000,800
4788< If you have less than 512 Mbyte |:mkspell| may fail for some
4789 languages, no matter what you set 'mkspellmem' to.
4790
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004792'modeline' 'ml' boolean (Vim default: on (off for root),
4793 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004794 local to buffer
4795 *'modelines'* *'mls'*
4796'modelines' 'mls' number (default 5)
4797 global
4798 {not in Vi}
4799 If 'modeline' is on 'modelines' gives the number of lines that is
4800 checked for set commands. If 'modeline' is off or 'modelines' is zero
4801 no lines are checked. See |modeline|.
4802 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4803 set and to the Vim default value when 'compatible' is reset.
4804
4805 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4806'modifiable' 'ma' boolean (default on)
4807 local to buffer
4808 {not in Vi} *E21*
4809 When off the buffer contents cannot be changed. The 'fileformat' and
4810 'fileencoding' options also can't be changed.
4811 Can be reset with the |-M| command line argument.
4812
4813 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4814'modified' 'mod' boolean (default off)
4815 local to buffer
4816 {not in Vi}
4817 When on, the buffer is considered to be modified. This option is set
4818 when:
4819 1. A change was made to the text since it was last written. Using the
4820 |undo| command to go back to the original text will reset the
4821 option. But undoing changes that were made before writing the
4822 buffer will set the option again, since the text is different from
4823 when it was written.
4824 2. 'fileformat' or 'fileencoding' is different from its original
4825 value. The original value is set when the buffer is read or
4826 written. A ":set nomodified" command also resets the original
4827 values to the current values and the 'modified' option will be
4828 reset.
4829 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4830 will be ignored.
4831
4832 *'more'* *'nomore'*
4833'more' boolean (Vim default: on, Vi default: off)
4834 global
4835 {not in Vi}
4836 When on, listings pause when the whole screen is filled. You will get
4837 the |more-prompt|. When this option is off there are no pauses, the
4838 listing continues until finished.
4839 NOTE: This option is set to the Vi default value when 'compatible' is
4840 set and to the Vim default value when 'compatible' is reset.
4841
4842 *'mouse'* *E538*
4843'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4844 global
4845 {not in Vi}
4846 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004847 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4848 sysmouse and Linux console with gpm). For using the mouse in the
4849 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 The mouse can be enabled for different modes:
4851 n Normal mode
4852 v Visual mode
4853 i Insert mode
4854 c Command-line mode
4855 h all previous modes when editing a help file
4856 a all previous modes
4857 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 Normally you would enable the mouse in all four modes with: >
4859 :set mouse=a
4860< When the mouse is not enabled, the GUI will still use the mouse for
4861 modeless selection. This doesn't move the text cursor.
4862
4863 See |mouse-using|. Also see |'clipboard'|.
4864
4865 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004866 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 the mouse buttons can still be used by keeping the shift key pressed.
4868 Also see the 'clipboard' option.
4869
4870 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4871'mousefocus' 'mousef' boolean (default off)
4872 global
4873 {not in Vi}
4874 {only works in the GUI}
4875 The window that the mouse pointer is on is automatically activated.
4876 When changing the window layout or window focus in another way, the
4877 mouse pointer is moved to the window with keyboard focus. Off is the
4878 default because it makes using the pull down menus a little goofy, as
4879 a pointer transit may activate a window unintentionally.
4880
4881 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4882'mousehide' 'mh' boolean (default on)
4883 global
4884 {not in Vi}
4885 {only works in the GUI}
4886 When on, the mouse pointer is hidden when characters are typed.
4887 The mouse pointer is restored when the mouse is moved.
4888
4889 *'mousemodel'* *'mousem'*
4890'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4891 global
4892 {not in Vi}
4893 Sets the model to use for the mouse. The name mostly specifies what
4894 the right mouse button is used for:
4895 extend Right mouse button extends a selection. This works
4896 like in an xterm.
4897 popup Right mouse button pops up a menu. The shifted left
4898 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004899 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 popup_setpos Like "popup", but the cursor will be moved to the
4901 position where the mouse was clicked, and thus the
4902 selected operation will act upon the clicked object.
4903 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004904 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 course, that right clicking outside a selection will
4906 end Visual mode.
4907 Overview of what button does what for each model:
4908 mouse extend popup(_setpos) ~
4909 left click place cursor place cursor
4910 left drag start selection start selection
4911 shift-left search word extend selection
4912 right click extend selection popup menu (place cursor)
4913 right drag extend selection -
4914 middle click paste paste
4915
4916 In the "popup" model the right mouse button produces a pop-up menu.
4917 You need to define this first, see |popup-menu|.
4918
4919 Note that you can further refine the meaning of buttons with mappings.
4920 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4921 selection (because that's handled in the GUI code directly).
4922
4923 The 'mousemodel' option is set by the |:behave| command.
4924
4925 *'mouseshape'* *'mouses'* *E547*
4926'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004927 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928 global
4929 {not in Vi}
4930 {only available when compiled with the |+mouseshape|
4931 feature}
4932 This option tells Vim what the mouse pointer should look like in
4933 different modes. The option is a comma separated list of parts, much
4934 like used for 'guicursor'. Each part consist of a mode/location-list
4935 and an argument-list:
4936 mode-list:shape,mode-list:shape,..
4937 The mode-list is a dash separated list of these modes/locations:
4938 In a normal window: ~
4939 n Normal mode
4940 v Visual mode
4941 ve Visual mode with 'selection' "exclusive" (same as 'v',
4942 if not specified)
4943 o Operator-pending mode
4944 i Insert mode
4945 r Replace mode
4946
4947 Others: ~
4948 c appending to the command-line
4949 ci inserting in the command-line
4950 cr replacing in the command-line
4951 m at the 'Hit ENTER' or 'More' prompts
4952 ml idem, but cursor in the last line
4953 e any mode, pointer below last window
4954 s any mode, pointer on a status line
4955 sd any mode, while dragging a status line
4956 vs any mode, pointer on a vertical separator line
4957 vd any mode, while dragging a vertical separator line
4958 a everywhere
4959
4960 The shape is one of the following:
4961 avail name looks like ~
4962 w x arrow Normal mouse pointer
4963 w x blank no pointer at all (use with care!)
4964 w x beam I-beam
4965 w x updown up-down sizing arrows
4966 w x leftright left-right sizing arrows
4967 w x busy The system's usual busy pointer
4968 w x no The system's usual 'no input' pointer
4969 x udsizing indicates up-down resizing
4970 x lrsizing indicates left-right resizing
4971 x crosshair like a big thin +
4972 x hand1 black hand
4973 x hand2 white hand
4974 x pencil what you write with
4975 x question big ?
4976 x rightup-arrow arrow pointing right-up
4977 w x up-arrow arrow pointing up
4978 x <number> any X11 pointer number (see X11/cursorfont.h)
4979
4980 The "avail" column contains a 'w' if the shape is available for Win32,
4981 x for X11.
4982 Any modes not specified or shapes not available use the normal mouse
4983 pointer.
4984
4985 Example: >
4986 :set mouseshape=s:udsizing,m:no
4987< will make the mouse turn to a sizing arrow over the status lines and
4988 indicate no input when the hit-enter prompt is displayed (since
4989 clicking the mouse has no effect in this state.)
4990
4991 *'mousetime'* *'mouset'*
4992'mousetime' 'mouset' number (default 500)
4993 global
4994 {not in Vi}
4995 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4996 time in msec between two mouse clicks for the second click to be
4997 recognized as a multi click.
4998
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004999 *'mzquantum'* *'mzq'*
5000'mzquantum' 'mzq' number (default 100)
5001 global
5002 {not in Vi}
5003 {not available when compiled without the |+mzscheme|
5004 feature}
5005 The number of milliseconds between polls for MzScheme threads.
5006 Negative or zero value means no thread scheduling.
5007
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 *'nrformats'* *'nf'*
5009'nrformats' 'nf' string (default "octal,hex")
5010 local to buffer
5011 {not in Vi}
5012 This defines what bases Vim will consider for numbers when using the
5013 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5014 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005015 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005017 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005018 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005020 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 considered to be hexadecimal. Example: Using CTRL-X on
5022 "0x100" results in "0x0ff".
5023 Numbers which simply begin with a digit in the range 1-9 are always
5024 considered decimal. This also happens for numbers that are not
5025 recognized as octal or hex.
5026
5027 *'number'* *'nu'* *'nonumber'* *'nonu'*
5028'number' 'nu' boolean (default off)
5029 local to window
5030 Print the line number in front of each line. When the 'n' option is
5031 excluded from 'cpoptions' a wrapped line will not use the column of
5032 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005033 The 'numberwidth' option can be used to set the room used for the line
5034 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 When a long, wrapped line doesn't start with the first character, '-'
5036 characters are put before the number.
5037 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005038 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005040 *'numberwidth'* *'nuw'*
5041'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5042 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005043 {not in Vi}
5044 {only available when compiled with the |+linebreak|
5045 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005046 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005047 when the 'number' or 'relativenumber' option is set or printing lines
5048 with a line number. Since one space is always between the number and
5049 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005050 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005051 fit the highest line number in the buffer respectively the number of
5052 rows in the window, depending on whether 'number' or 'relativenumber'
5053 is set. Thus with the Vim default of 4 there is room for a line number
5054 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005055 The minimum value is 1, the maximum value is 10.
5056 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5057
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005058 *'omnifunc'* *'ofu'*
5059'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005060 local to buffer
5061 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005062 {not available when compiled without the |+eval|
5063 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005064 This option specifies a function to be used for Insert mode omni
5065 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005066 See |complete-functions| for an explanation of how the function is
5067 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005068 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005069 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005070
5071
Bram Moolenaar02467872007-05-06 13:22:01 +00005072 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005073'opendevice' 'odev' boolean (default off)
5074 global
5075 {not in Vi}
5076 {only for MS-DOS, MS-Windows and OS/2}
5077 Enable reading and writing from devices. This may get Vim stuck on a
5078 device that can be opened but doesn't actually do the I/O. Therefore
5079 it is off by default.
5080 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5081 result in editing a device.
5082
5083
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005084 *'operatorfunc'* *'opfunc'*
5085'operatorfunc' 'opfunc' string (default: empty)
5086 global
5087 {not in Vi}
5088 This option specifies a function to be called by the |g@| operator.
5089 See |:map-operator| for more info and an example.
5090
5091 This option cannot be set from a |modeline| or in the |sandbox|, for
5092 security reasons.
5093
5094
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 *'osfiletype'* *'oft'* *E366*
5096'osfiletype' 'oft' string (RISC-OS default: "Text",
5097 others default: "")
5098 local to buffer
5099 {not in Vi}
5100 {only available when compiled with the |+osfiletype|
5101 feature}
5102 Some operating systems store extra information about files besides
5103 name, datestamp and permissions. This option contains the extra
5104 information, the nature of which will vary between systems.
5105 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005106 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 It can affect the pattern matching of the automatic commands.
5108 |autocmd-osfiletypes|
5109
5110 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005111'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005112 global
5113 Specifies the nroff macros that separate paragraphs. These are pairs
5114 of two letters (see |object-motions|).
5115
5116 *'paste'* *'nopaste'*
5117'paste' boolean (default off)
5118 global
5119 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005120 Put Vim in Paste mode. This is useful if you want to cut or copy
5121 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 unexpected effects.
5123 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005124 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 knows about pasting and will mostly do the right thing without 'paste'
5126 being set. The same is true for a terminal where Vim handles the
5127 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005128 This option is reset when starting the GUI. Thus if you set it in
5129 your .vimrc it will work in a terminal, but not in the GUI. Setting
5130 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5131 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 When the 'paste' option is switched on (also when it was already on):
5133 - mapping in Insert mode and Command-line mode is disabled
5134 - abbreviations are disabled
5135 - 'textwidth' is set to 0
5136 - 'wrapmargin' is set to 0
5137 - 'autoindent' is reset
5138 - 'smartindent' is reset
5139 - 'softtabstop' is set to 0
5140 - 'revins' is reset
5141 - 'ruler' is reset
5142 - 'showmatch' is reset
5143 - 'formatoptions' is used like it is empty
5144 These options keep their value, but their effect is disabled:
5145 - 'lisp'
5146 - 'indentexpr'
5147 - 'cindent'
5148 NOTE: When you start editing another file while the 'paste' option is
5149 on, settings from the modelines or autocommands may change the
5150 settings again, causing trouble when pasting text. You might want to
5151 set the 'paste' option again.
5152 When the 'paste' option is reset the mentioned options are restored to
5153 the value before the moment 'paste' was switched from off to on.
5154 Resetting 'paste' before ever setting it does not have any effect.
5155 Since mapping doesn't work while 'paste' is active, you need to use
5156 the 'pastetoggle' option to toggle the 'paste' option with some key.
5157
5158 *'pastetoggle'* *'pt'*
5159'pastetoggle' 'pt' string (default "")
5160 global
5161 {not in Vi}
5162 When non-empty, specifies the key sequence that toggles the 'paste'
5163 option. This is like specifying a mapping: >
5164 :map {keys} :set invpaste<CR>
5165< Where {keys} is the value of 'pastetoggle'.
5166 The difference is that it will work even when 'paste' is set.
5167 'pastetoggle' works in Insert mode and Normal mode, but not in
5168 Command-line mode.
5169 Mappings are checked first, thus overrule 'pastetoggle'. However,
5170 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5171 this: >
5172 :map <F10> :set paste<CR>
5173 :map <F11> :set nopaste<CR>
5174 :imap <F10> <C-O>:set paste<CR>
5175 :imap <F11> <nop>
5176 :set pastetoggle=<F11>
5177< This will make <F10> start paste mode and <F11> stop paste mode.
5178 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5179 mode everything is inserted literally, except the 'pastetoggle' key
5180 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005181 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183 *'pex'* *'patchexpr'*
5184'patchexpr' 'pex' string (default "")
5185 global
5186 {not in Vi}
5187 {not available when compiled without the |+diff|
5188 feature}
5189 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005190 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191
5192 *'patchmode'* *'pm'* *E206*
5193'patchmode' 'pm' string (default "")
5194 global
5195 {not in Vi}
5196 When non-empty the oldest version of a file is kept. This can be used
5197 to keep the original version of a file if you are changing files in a
5198 source distribution. Only the first time that a file is written a
5199 copy of the original file will be kept. The name of the copy is the
5200 name of the original file with the string in the 'patchmode' option
5201 appended. This option should start with a dot. Use a string like
5202 ".org". 'backupdir' must not be empty for this to work (Detail: The
5203 backup file is renamed to the patchmode file after the new file has
5204 been successfully written, that's why it must be possible to write a
5205 backup file). If there was no file to be backed up, an empty file is
5206 created.
5207 When the 'backupskip' pattern matches, a patchmode file is not made.
5208 Using 'patchmode' for compressed files appends the extension at the
5209 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5210 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005211 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212
5213 *'path'* *'pa'* *E343* *E345* *E347*
5214'path' 'pa' string (default on Unix: ".,/usr/include,,"
5215 on OS/2: ".,/emx/include,,"
5216 other systems: ".,,")
5217 global or local to buffer |global-local|
5218 {not in Vi}
5219 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005220 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5221 provided that the file being searched for has a relative path (not
5222 starting with "/", "./" or "../"). The directories in the 'path'
5223 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 - Use commas to separate directory names: >
5225 :set path=.,/usr/local/include,/usr/include
5226< - Spaces can also be used to separate directory names (for backwards
5227 compatibility with version 3.0). To have a space in a directory
5228 name, precede it with an extra backslash, and escape the space: >
5229 :set path=.,/dir/with\\\ space
5230< - To include a comma in a directory name precede it with an extra
5231 backslash: >
5232 :set path=.,/dir/with\\,comma
5233< - To search relative to the directory of the current file, use: >
5234 :set path=.
5235< - To search in the current directory use an empty string between two
5236 commas: >
5237 :set path=,,
5238< - A directory name may end in a ':' or '/'.
5239 - Environment variables are expanded |:set_env|.
5240 - When using |netrw.vim| URLs can be used. For example, adding
5241 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005242 - Search upwards and downwards in a directory tree using "*", "**" and
5243 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 {not available when compiled without the |+path_extra| feature}
5245 - Careful with '\' characters, type two to get one in the option: >
5246 :set path=.,c:\\include
5247< Or just use '/' instead: >
5248 :set path=.,c:/include
5249< Don't forget "." or files won't even be found in the same directory as
5250 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005251 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 it is something like 256 or 1024 characters.
5253 You can check if all the include files are found, using the value of
5254 'path', see |:checkpath|.
5255 The use of |:set+=| and |:set-=| is preferred when adding or removing
5256 directories from the list. This avoids problems when a future version
5257 uses another default. To remove the current directory use: >
5258 :set path-=
5259< To add the current directory use: >
5260 :set path+=
5261< To use an environment variable, you probably need to replace the
5262 separator. Here is an example to append $INCL, in which directory
5263 names are separated with a semi-colon: >
5264 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5265< Replace the ';' with a ':' or whatever separator is used. Note that
5266 this doesn't work when $INCL contains a comma or white space.
5267
5268 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5269'preserveindent' 'pi' boolean (default off)
5270 local to buffer
5271 {not in Vi}
5272 When changing the indent of the current line, preserve as much of the
5273 indent structure as possible. Normally the indent is replaced by a
5274 series of tabs followed by spaces as required (unless |'expandtab'| is
5275 enabled, in which case only spaces are used). Enabling this option
5276 means the indent will preserve as many existing characters as possible
5277 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005278 'expandtab' does not apply to the preserved white space, a Tab remains
5279 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 NOTE: When using ">>" multiple times the resulting indent is a mix of
5281 tabs and spaces. You might not like this.
5282 NOTE: 'preserveindent' is reset when 'compatible' is set.
5283 Also see 'copyindent'.
5284 Use |:retab| to clean up white space.
5285
5286 *'previewheight'* *'pvh'*
5287'previewheight' 'pvh' number (default 12)
5288 global
5289 {not in Vi}
5290 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005291 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005292 Default height for a preview window. Used for |:ptag| and associated
5293 commands. Used for |CTRL-W_}| when no count is given.
5294
5295 *'previewwindow'* *'nopreviewwindow'*
5296 *'pvw'* *'nopvw'* *E590*
5297'previewwindow' 'pvw' boolean (default off)
5298 local to window
5299 {not in Vi}
5300 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005301 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005302 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 set. It's normally not set directly, but by using one of the commands
5304 |:ptag|, |:pedit|, etc.
5305
5306 *'printdevice'* *'pdev'*
5307'printdevice' 'pdev' string (default empty)
5308 global
5309 {not in Vi}
5310 {only available when compiled with the |+printer|
5311 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005312 The name of the printer to be used for |:hardcopy|.
5313 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005314 This option cannot be set from a |modeline| or in the |sandbox|, for
5315 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
Bram Moolenaar8299df92004-07-10 09:47:34 +00005317 *'printencoding'* *'penc'*
5318'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319 global
5320 {not in Vi}
5321 {only available when compiled with the |+printer|
5322 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005323 Sets the character encoding used when printing.
5324 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'printexpr'* *'pexpr'*
5327'printexpr' 'pexpr' String (default: see below)
5328 global
5329 {not in Vi}
5330 {only available when compiled with the |+printer|
5331 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005332 Expression used to print the PostScript produced with |:hardcopy|.
5333 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005334
Bram Moolenaar8299df92004-07-10 09:47:34 +00005335 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336'printfont' 'pfn' string (default "courier")
5337 global
5338 {not in Vi}
5339 {only available when compiled with the |+printer|
5340 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005341 The name of the font that will be used for |:hardcopy|.
5342 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343
5344 *'printheader'* *'pheader'*
5345'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5346 global
5347 {not in Vi}
5348 {only available when compiled with the |+printer|
5349 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005350 The format of the header produced in |:hardcopy| output.
5351 See |pheader-option|.
5352
5353 *'printmbcharset'* *'pmbcs'*
5354'printmbcharset' 'pmbcs' string (default "")
5355 global
5356 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005357 {only available when compiled with the |+printer|,
5358 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005359 The CJK character set to be used for CJK output from |:hardcopy|.
5360 See |pmbcs-option|.
5361
5362 *'printmbfont'* *'pmbfn'*
5363'printmbfont' 'pmbfn' string (default "")
5364 global
5365 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005366 {only available when compiled with the |+printer|,
5367 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005368 List of font names to be used for CJK output from |:hardcopy|.
5369 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370
5371 *'printoptions'* *'popt'*
5372'printoptions' 'popt' string (default "")
5373 global
5374 {not in Vi}
5375 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005376 List of items that control the format of the output of |:hardcopy|.
5377 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005379 *'prompt'* *'noprompt'*
5380'prompt' boolean (default on)
5381 global
5382 When on a ":" prompt is used in Ex mode.
5383
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005384 *'pumheight'* *'ph'*
5385'pumheight' 'ph' number (default 0)
5386 global
5387 {not available when compiled without the
5388 |+insert_expand| feature}
5389 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005390 Determines the maximum number of items to show in the popup menu for
5391 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005392 |ins-completion-menu|.
5393
5394
Bram Moolenaar677ee682005-01-27 14:41:15 +00005395 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005396'quoteescape' 'qe' string (default "\")
5397 local to buffer
5398 {not in Vi}
5399 The characters that are used to escape quotes in a string. Used for
5400 objects like a', a" and a` |a'|.
5401 When one of the characters in this option is found inside a string,
5402 the following character will be skipped. The default value makes the
5403 text "foo\"bar\\" considered to be one string.
5404
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5406'readonly' 'ro' boolean (default off)
5407 local to buffer
5408 If on, writes fail unless you use a '!'. Protects you from
5409 accidentally overwriting a file. Default on when Vim is started
5410 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005411 When using ":w!" the 'readonly' option is reset for the current
5412 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005414 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005416 *'redrawtime'* *'rdt'*
5417'redrawtime' 'rdt' number (default 2000)
5418 global
5419 {not in Vi}
5420 {only available when compiled with the |+reltime|
5421 feature}
5422 The time in milliseconds for redrawing the display. This applies to
5423 searching for patterns for 'hlsearch' and |:match| highlighting.
5424 When redrawing takes more than this many milliseconds no further
5425 matches will be highlighted. This is used to avoid that Vim hangs
5426 when using a very complicated pattern.
5427
Bram Moolenaar64486672010-05-16 15:46:46 +02005428 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5429'relativenumber' 'rnu' boolean (default off)
5430 local to window
5431 {not in Vi}
5432 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005433 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005434 precede some vertical motion commands (e.g. j k + -) with, without
5435 having to calculate it yourself. Especially useful in combination with
5436 other commands (e.g. y d c < > gq gw =).
5437 When the 'n' option is excluded from 'cpoptions' a wrapped
5438 line will not use the column of line numbers (this is the default when
5439 'compatible' isn't set).
5440 The 'numberwidth' option can be used to set the room used for the line
5441 number.
5442 When a long, wrapped line doesn't start with the first character, '-'
5443 characters are put before the number.
5444 See |hl-LineNr| for the highlighting used for the number.
5445 When setting this option, 'number' is reset.
5446
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 *'remap'* *'noremap'*
5448'remap' boolean (default on)
5449 global
5450 Allows for mappings to work recursively. If you do not want this for
5451 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005452 NOTE: To avoid portability problems with Vim scripts, always keep
5453 this option at the default "on". Only switch it off when working with
5454 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
5456 *'report'*
5457'report' number (default 2)
5458 global
5459 Threshold for reporting number of lines changed. When the number of
5460 changed lines is more than 'report' a message will be given for most
5461 ":" commands. If you want it always, set 'report' to 0.
5462 For the ":substitute" command the number of substitutions is used
5463 instead of the number of lines.
5464
5465 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5466'restorescreen' 'rs' boolean (default on)
5467 global
5468 {not in Vi} {only in Windows 95/NT console version}
5469 When set, the screen contents is restored when exiting Vim. This also
5470 happens when executing external commands.
5471
5472 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5473 options in your .vimrc. To disable restoring:
5474 set t_ti= t_te=
5475 To enable restoring (for an xterm):
5476 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5477 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5478
5479 *'revins'* *'ri'* *'norevins'* *'nori'*
5480'revins' 'ri' boolean (default off)
5481 global
5482 {not in Vi}
5483 {only available when compiled with the |+rightleft|
5484 feature}
5485 Inserting characters in Insert mode will work backwards. See "typing
5486 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5487 command in Insert mode, when 'allowrevins' is set.
5488 NOTE: This option is reset when 'compatible' or 'paste' is set.
5489
5490 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5491'rightleft' 'rl' boolean (default off)
5492 local to window
5493 {not in Vi}
5494 {only available when compiled with the |+rightleft|
5495 feature}
5496 When on, display orientation becomes right-to-left, i.e., characters
5497 that are stored in the file appear from the right to the left.
5498 Using this option, it is possible to edit files for languages that
5499 are written from the right to the left such as Hebrew and Arabic.
5500 This option is per window, so it is possible to edit mixed files
5501 simultaneously, or to view the same file in both ways (this is
5502 useful whenever you have a mixed text file with both right-to-left
5503 and left-to-right strings so that both sets are displayed properly
5504 in different windows). Also see |rileft.txt|.
5505
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005506 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507'rightleftcmd' 'rlc' string (default "search")
5508 local to window
5509 {not in Vi}
5510 {only available when compiled with the |+rightleft|
5511 feature}
5512 Each word in this option enables the command line editing to work in
5513 right-to-left mode for a group of commands:
5514
5515 search "/" and "?" commands
5516
5517 This is useful for languages such as Hebrew, Arabic and Farsi.
5518 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5519
5520 *'ruler'* *'ru'* *'noruler'* *'noru'*
5521'ruler' 'ru' boolean (default off)
5522 global
5523 {not in Vi}
5524 {not available when compiled without the
5525 |+cmdline_info| feature}
5526 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005527 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 text in the file is shown on the far right:
5529 Top first line is visible
5530 Bot last line is visible
5531 All first and last line are visible
5532 45% relative position in the file
5533 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005534 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005536 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 this option takes precedence over 'ruler' and 'rulerformat'
5538 If the number of characters displayed is different from the number of
5539 bytes in the text (e.g., for a TAB or a multi-byte character), both
5540 the text column (byte number) and the screen column are shown,
5541 separated with a dash.
5542 For an empty line "0-1" is shown.
5543 For an empty buffer the line number will also be zero: "0,0-1".
5544 This option is reset when the 'paste' option is set.
5545 If you don't want to see the ruler all the time but want to know where
5546 you are, use "g CTRL-G" |g_CTRL-G|.
5547 NOTE: This option is reset when 'compatible' is set.
5548
5549 *'rulerformat'* *'ruf'*
5550'rulerformat' 'ruf' string (default empty)
5551 global
5552 {not in Vi}
5553 {not available when compiled without the |+statusline|
5554 feature}
5555 When this option is not empty, it determines the content of the ruler
5556 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005557 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558 The default ruler width is 17 characters. To make the ruler 15
5559 characters wide, put "%15(" at the start and "%)" at the end.
5560 Example: >
5561 :set rulerformat=%15(%c%V\ %p%%%)
5562<
5563 *'runtimepath'* *'rtp'* *vimfiles*
5564'runtimepath' 'rtp' string (default:
5565 Unix: "$HOME/.vim,
5566 $VIM/vimfiles,
5567 $VIMRUNTIME,
5568 $VIM/vimfiles/after,
5569 $HOME/.vim/after"
5570 Amiga: "home:vimfiles,
5571 $VIM/vimfiles,
5572 $VIMRUNTIME,
5573 $VIM/vimfiles/after,
5574 home:vimfiles/after"
5575 PC, OS/2: "$HOME/vimfiles,
5576 $VIM/vimfiles,
5577 $VIMRUNTIME,
5578 $VIM/vimfiles/after,
5579 $HOME/vimfiles/after"
5580 Macintosh: "$VIM:vimfiles,
5581 $VIMRUNTIME,
5582 $VIM:vimfiles:after"
5583 RISC-OS: "Choices:vimfiles,
5584 $VIMRUNTIME,
5585 Choices:vimfiles/after"
5586 VMS: "sys$login:vimfiles,
5587 $VIM/vimfiles,
5588 $VIMRUNTIME,
5589 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005590 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 global
5592 {not in Vi}
5593 This is a list of directories which will be searched for runtime
5594 files:
5595 filetype.vim filetypes by file name |new-filetype|
5596 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005597 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 colors/ color scheme files |:colorscheme|
5599 compiler/ compiler files |:compiler|
5600 doc/ documentation |write-local-help|
5601 ftplugin/ filetype plugins |write-filetype-plugin|
5602 indent/ indent scripts |indent-expression|
5603 keymap/ key mapping files |mbyte-keymap|
5604 lang/ menu translations |:menutrans|
5605 menu.vim GUI menus |menu.vim|
5606 plugin/ plugin scripts |write-plugin|
5607 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005608 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 syntax/ syntax files |mysyntaxfile|
5610 tutor/ files for vimtutor |tutor|
5611
5612 And any other file searched for with the |:runtime| command.
5613
5614 The defaults for most systems are setup to search five locations:
5615 1. In your home directory, for your personal preferences.
5616 2. In a system-wide Vim directory, for preferences from the system
5617 administrator.
5618 3. In $VIMRUNTIME, for files distributed with Vim.
5619 *after-directory*
5620 4. In the "after" directory in the system-wide Vim directory. This is
5621 for the system administrator to overrule or add to the distributed
5622 defaults (rarely needed)
5623 5. In the "after" directory in your home directory. This is for
5624 personal preferences to overrule or add to the distributed defaults
5625 or system-wide settings (rarely needed).
5626
5627 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5628 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005629 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630 wildcards.
5631 See |:runtime|.
5632 Example: >
5633 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5634< This will use the directory "~/vimruntime" first (containing your
5635 personal Vim runtime files), then "/mygroup/vim" (shared between a
5636 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5637 files).
5638 You probably should always include $VIMRUNTIME somewhere, to use the
5639 distributed runtime files. You can put a directory before $VIMRUNTIME
5640 to find files which replace a distributed runtime files. You can put
5641 a directory after $VIMRUNTIME to find files which add to distributed
5642 runtime files.
5643 This option cannot be set from a |modeline| or in the |sandbox|, for
5644 security reasons.
5645
5646 *'scroll'* *'scr'*
5647'scroll' 'scr' number (default: half the window height)
5648 local to window
5649 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5650 set to half the number of lines in the window when the window size
5651 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005652 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5654 the number of screen lines instead of file lines, makes a difference
5655 when lines wrap}
5656
5657 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5658'scrollbind' 'scb' boolean (default off)
5659 local to window
5660 {not in Vi}
5661 {not available when compiled without the |+scrollbind|
5662 feature}
5663 See also |scroll-binding|. When this option is set, the current
5664 window scrolls as other scrollbind windows (windows that also have
5665 this option set) scroll. This option is useful for viewing the
5666 differences between two versions of a file, see 'diff'.
5667 See |'scrollopt'| for options that determine how this option should be
5668 interpreted.
5669 This option is mostly reset when splitting a window to edit another
5670 file. This means that ":split | edit file" results in two windows
5671 with scroll-binding, but ":split file" does not.
5672
5673 *'scrolljump'* *'sj'*
5674'scrolljump' 'sj' number (default 1)
5675 global
5676 {not in Vi}
5677 Minimal number of lines to scroll when the cursor gets off the
5678 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5679 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005680 When set to a negative number from -1 to -100 this is used as the
5681 percentage of the window height. Thus -50 scrolls half the window
5682 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 NOTE: This option is set to 1 when 'compatible' is set.
5684
5685 *'scrolloff'* *'so'*
5686'scrolloff' 'so' number (default 0)
5687 global
5688 {not in Vi}
5689 Minimal number of screen lines to keep above and below the cursor.
5690 This will make some context visible around where you are working. If
5691 you set it to a very large value (999) the cursor line will always be
5692 in the middle of the window (except at the start or end of the file or
5693 when long lines wrap).
5694 For scrolling horizontally see 'sidescrolloff'.
5695 NOTE: This option is set to 0 when 'compatible' is set.
5696
5697 *'scrollopt'* *'sbo'*
5698'scrollopt' 'sbo' string (default "ver,jump")
5699 global
5700 {not available when compiled without the |+scrollbind|
5701 feature}
5702 {not in Vi}
5703 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005704 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5705 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 The following words are available:
5707 ver Bind vertical scrolling for 'scrollbind' windows
5708 hor Bind horizontal scrolling for 'scrollbind' windows
5709 jump Applies to the offset between two windows for vertical
5710 scrolling. This offset is the difference in the first
5711 displayed line of the bound windows. When moving
5712 around in a window, another 'scrollbind' window may
5713 reach a position before the start or after the end of
5714 the buffer. The offset is not changed though, when
5715 moving back the 'scrollbind' window will try to scroll
5716 to the desired position when possible.
5717 When now making that window the current one, two
5718 things can be done with the relative offset:
5719 1. When "jump" is not included, the relative offset is
5720 adjusted for the scroll position in the new current
5721 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005722 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 2. When "jump" is included, the other windows are
5724 scrolled to keep the same relative offset. When
5725 going back to the other window, it still uses the
5726 same relative offset.
5727 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005728 When 'diff' mode is active there always is vertical scroll binding,
5729 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730
5731 *'sections'* *'sect'*
5732'sections' 'sect' string (default "SHNHH HUnhsh")
5733 global
5734 Specifies the nroff macros that separate sections. These are pairs of
5735 two letters (See |object-motions|). The default makes a section start
5736 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5737
5738 *'secure'* *'nosecure'* *E523*
5739'secure' boolean (default off)
5740 global
5741 {not in Vi}
5742 When on, ":autocmd", shell and write commands are not allowed in
5743 ".vimrc" and ".exrc" in the current directory and map commands are
5744 displayed. Switch it off only if you know that you will not run into
5745 problems, or when the 'exrc' option is off. On Unix this option is
5746 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005747 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 'secure' at the end of your ~/.vimrc then.
5749 This option cannot be set from a |modeline| or in the |sandbox|, for
5750 security reasons.
5751
5752 *'selection'* *'sel'*
5753'selection' 'sel' string (default "inclusive")
5754 global
5755 {not in Vi}
5756 This option defines the behavior of the selection. It is only used
5757 in Visual and Select mode.
5758 Possible values:
5759 value past line inclusive ~
5760 old no yes
5761 inclusive yes yes
5762 exclusive yes no
5763 "past line" means that the cursor is allowed to be positioned one
5764 character past the line.
5765 "inclusive" means that the last character of the selection is included
5766 in an operation. For example, when "x" is used to delete the
5767 selection.
5768 Note that when "exclusive" is used and selecting from the end
5769 backwards, you cannot include the last character of a line, when
5770 starting in Normal mode and 'virtualedit' empty.
5771
5772 The 'selection' option is set by the |:behave| command.
5773
5774 *'selectmode'* *'slm'*
5775'selectmode' 'slm' string (default "")
5776 global
5777 {not in Vi}
5778 This is a comma separated list of words, which specifies when to start
5779 Select mode instead of Visual mode, when a selection is started.
5780 Possible values:
5781 mouse when using the mouse
5782 key when using shifted special keys
5783 cmd when using "v", "V" or CTRL-V
5784 See |Select-mode|.
5785 The 'selectmode' option is set by the |:behave| command.
5786
5787 *'sessionoptions'* *'ssop'*
5788'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005789 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 global
5791 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005792 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 feature}
5794 Changes the effect of the |:mksession| command. It is a comma
5795 separated list of words. Each word enables saving and restoring
5796 something:
5797 word save and restore ~
5798 blank empty windows
5799 buffers hidden and unloaded buffers, not just those in windows
5800 curdir the current directory
5801 folds manually created folds, opened/closed folds and local
5802 fold options
5803 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005804 and contain at least one lowercase letter. Only
5805 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005806 help the help window
5807 localoptions options and mappings local to a window or buffer (not
5808 global values for local options)
5809 options all options and mappings (also global values for local
5810 options)
5811 resize size of the Vim window: 'lines' and 'columns'
5812 sesdir the directory in which the session file is located
5813 will become the current directory (useful with
5814 projects accessed over a network from different
5815 systems)
5816 slash backslashes in file names replaced with forward
5817 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005818 tabpages all tab pages; without this only the current tab page
5819 is restored, so that you can make a session for each
5820 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005821 unix with Unix end-of-line format (single <NL>), even when
5822 on Windows or DOS
5823 winpos position of the whole Vim window
5824 winsize window sizes
5825
5826 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005827 When neither "curdir" nor "sesdir" is included, file names are stored
5828 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005829 "slash" and "unix" are useful on Windows when sharing session files
5830 with Unix. The Unix version of Vim cannot source dos format scripts,
5831 but the Windows version of Vim can source unix format scripts.
5832
5833 *'shell'* *'sh'* *E91*
5834'shell' 'sh' string (default $SHELL or "sh",
5835 MS-DOS and Win32: "command.com" or
5836 "cmd.exe", OS/2: "cmd")
5837 global
5838 Name of the shell to use for ! and :! commands. When changing the
5839 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5840 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005841 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005842 See |option-backslash| about including spaces and backslashes.
5843 Environment variables are expanded |:set_env|.
5844 If the name of the shell contains a space, you might need to enclose
5845 it in quotes. Example: >
5846 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5847< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005848 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 "-f" is not inside the quotes, because it is not part of the command
5850 name. And Vim automagically recognizes the backslashes that are path
5851 separators.
5852 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5853 variable to change the way external commands are executed. See the
5854 libc.inf file of DJGPP.
5855 Under MS-Windows, when the executable ends in ".com" it must be
5856 included. Thus setting the shell to "command.com" or "4dos.com"
5857 works, but "command" and "4dos" do not work for all commands (e.g.,
5858 filtering).
5859 For unknown reasons, when using "4dos.com" the current directory is
5860 changed to "C:\". To avoid this set 'shell' like this: >
5861 :set shell=command.com\ /c\ 4dos
5862< This option cannot be set from a |modeline| or in the |sandbox|, for
5863 security reasons.
5864
5865 *'shellcmdflag'* *'shcf'*
5866'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5867 does not contain "sh" somewhere: "/c")
5868 global
5869 {not in Vi}
5870 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5871 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5872 systems, the default is set according to the value of 'shell', to
5873 reduce the need to set this option by the user. It's not used for
5874 OS/2 (EMX figures this out itself). See |option-backslash| about
5875 including spaces and backslashes. See |dos-shell|.
5876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
5878
5879 *'shellpipe'* *'sp'*
5880'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5881 global
5882 {not in Vi}
5883 {not available when compiled without the |+quickfix|
5884 feature}
5885 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005886 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 including spaces and backslashes.
5888 The name of the temporary file can be represented by "%s" if necessary
5889 (the file name is appended automatically if no %s appears in the value
5890 of this option).
5891 For the Amiga and MS-DOS the default is ">". The output is directly
5892 saved in a file and not echoed to the screen.
5893 For Unix the default it "| tee". The stdout of the compiler is saved
5894 in a file and echoed to the screen. If the 'shell' option is "csh" or
5895 "tcsh" after initializations, the default becomes "|& tee". If the
5896 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005897 "2>&1| tee". This means that stderr is also included. Before using
5898 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 The initialization of this option is done after reading the ".vimrc"
5900 and the other initializations, so that when the 'shell' option is set
5901 there, the 'shellpipe' option changes automatically, unless it was
5902 explicitly set before.
5903 When 'shellpipe' is set to an empty string, no redirection of the
5904 ":make" output will be done. This is useful if you use a 'makeprg'
5905 that writes to 'makeef' by itself. If you want no piping, but do
5906 want to include the 'makeef', set 'shellpipe' to a single space.
5907 Don't forget to precede the space with a backslash: ":set sp=\ ".
5908 In the future pipes may be used for filtering and this option will
5909 become obsolete (at least for Unix).
5910 This option cannot be set from a |modeline| or in the |sandbox|, for
5911 security reasons.
5912
5913 *'shellquote'* *'shq'*
5914'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5915 contains "sh" somewhere: "\"")
5916 global
5917 {not in Vi}
5918 Quoting character(s), put around the command passed to the shell, for
5919 the "!" and ":!" commands. The redirection is kept outside of the
5920 quoting. See 'shellxquote' to include the redirection. It's
5921 probably not useful to set both options.
5922 This is an empty string by default. Only known to be useful for
5923 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5924 or bash, where it should be "\"". The default is adjusted according
5925 the value of 'shell', to reduce the need to set this option by the
5926 user. See |dos-shell|.
5927 This option cannot be set from a |modeline| or in the |sandbox|, for
5928 security reasons.
5929
5930 *'shellredir'* *'srr'*
5931'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5932 global
5933 {not in Vi}
5934 String to be used to put the output of a filter command in a temporary
5935 file. See also |:!|. See |option-backslash| about including spaces
5936 and backslashes.
5937 The name of the temporary file can be represented by "%s" if necessary
5938 (the file name is appended automatically if no %s appears in the value
5939 of this option).
5940 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5941 or "zsh" during initializations, the default becomes ">&". If the
5942 'shell' option is "sh", "ksh" or "bash" the default becomes
5943 ">%s 2>&1". This means that stderr is also included.
5944 For Win32, the Unix checks are done and additionally "cmd" is checked
5945 for, which makes the default ">%s 2>&1". Also, the same names with
5946 ".exe" appended are checked for.
5947 The initialization of this option is done after reading the ".vimrc"
5948 and the other initializations, so that when the 'shell' option is set
5949 there, the 'shellredir' option changes automatically unless it was
5950 explicitly set before.
5951 In the future pipes may be used for filtering and this option will
5952 become obsolete (at least for Unix).
5953 This option cannot be set from a |modeline| or in the |sandbox|, for
5954 security reasons.
5955
5956 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5957'shellslash' 'ssl' boolean (default off)
5958 global
5959 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5960 When set, a forward slash is used when expanding file names. This is
5961 useful when a Unix-like shell is used instead of command.com or
5962 cmd.exe. Backward slashes can still be typed, but they are changed to
5963 forward slashes by Vim.
5964 Note that setting or resetting this option has no effect for some
5965 existing file names, thus this option needs to be set before opening
5966 any file for best results. This might change in the future.
5967 'shellslash' only works when a backslash can be used as a path
5968 separator. To test if this is so use: >
5969 if exists('+shellslash')
5970<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005971 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5972'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5973 global
5974 {not in Vi}
5975 When on, use temp files for shell commands. When off use a pipe.
5976 When using a pipe is not possible temp files are used anyway.
5977 Currently a pipe is only supported on Unix. You can check it with: >
5978 :if has("filterpipe")
5979< The advantage of using a pipe is that nobody can read the temp file
5980 and the 'shell' command does not need to support redirection.
5981 The advantage of using a temp file is that the file type and encoding
5982 can be detected.
5983 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5984 |FilterWritePost| autocommands event are not triggered when
5985 'shelltemp' is off.
5986
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 *'shelltype'* *'st'*
5988'shelltype' 'st' number (default 0)
5989 global
5990 {not in Vi} {only for the Amiga}
5991 On the Amiga this option influences the way how the commands work
5992 which use a shell.
5993 0 and 1: always use the shell
5994 2 and 3: use the shell only to filter lines
5995 4 and 5: use shell only for ':sh' command
5996 When not using the shell, the command is executed directly.
5997
5998 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5999 1 and 3: use "shell cmd" to start external commands
6000
6001 *'shellxquote'* *'sxq'*
6002'shellxquote' 'sxq' string (default: "";
6003 for Win32, when 'shell' contains "sh"
6004 somewhere: "\""
6005 for Unix, when using system(): "\"")
6006 global
6007 {not in Vi}
6008 Quoting character(s), put around the command passed to the shell, for
6009 the "!" and ":!" commands. Includes the redirection. See
6010 'shellquote' to exclude the redirection. It's probably not useful
6011 to set both options.
6012 This is an empty string by default. Known to be useful for
6013 third-party shells when using the Win32 version, such as the MKS Korn
6014 Shell or bash, where it should be "\"". The default is adjusted
6015 according the value of 'shell', to reduce the need to set this option
6016 by the user. See |dos-shell|.
6017 This option cannot be set from a |modeline| or in the |sandbox|, for
6018 security reasons.
6019
6020 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6021'shiftround' 'sr' boolean (default off)
6022 global
6023 {not in Vi}
6024 Round indent to multiple of 'shiftwidth'. Applies to > and <
6025 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6026 a multiple of 'shiftwidth' (this is Vi compatible).
6027 NOTE: This option is reset when 'compatible' is set.
6028
6029 *'shiftwidth'* *'sw'*
6030'shiftwidth' 'sw' number (default 8)
6031 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006032 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 |'cindent'|, |>>|, |<<|, etc.
6034
6035 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006036'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6037 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 global
6039 {not in Vi}
6040 This option helps to avoid all the |hit-enter| prompts caused by file
6041 messages, for example with CTRL-G, and to avoid some other messages.
6042 It is a list of flags:
6043 flag meaning when present ~
6044 f use "(3 of 5)" instead of "(file 3 of 5)"
6045 i use "[noeol]" instead of "[Incomplete last line]"
6046 l use "999L, 888C" instead of "999 lines, 888 characters"
6047 m use "[+]" instead of "[Modified]"
6048 n use "[New]" instead of "[New File]"
6049 r use "[RO]" instead of "[readonly]"
6050 w use "[w]" instead of "written" for file write message
6051 and "[a]" instead of "appended" for ':w >> file' command
6052 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6053 "[unix format]" and "[mac]" instead of "[mac format]".
6054 a all of the above abbreviations
6055
6056 o overwrite message for writing a file with subsequent message
6057 for reading a file (useful for ":wn" or when 'autowrite' on)
6058 O message for reading a file overwrites any previous message.
6059 Also for quickfix message (e.g., ":cn").
6060 s don't give "search hit BOTTOM, continuing at TOP" or "search
6061 hit TOP, continuing at BOTTOM" messages
6062 t truncate file message at the start if it is too long to fit
6063 on the command-line, "<" will appear in the left most column.
6064 Ignored in Ex mode.
6065 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006066 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006067 Ignored in Ex mode.
6068 W don't give "written" or "[w]" when writing a file
6069 A don't give the "ATTENTION" message when an existing swap file
6070 is found.
6071 I don't give the intro message when starting Vim |:intro|.
6072
6073 This gives you the opportunity to avoid that a change between buffers
6074 requires you to hit <Enter>, but still gives as useful a message as
6075 possible for the space available. To get the whole message that you
6076 would have got with 'shm' empty, use ":file!"
6077 Useful values:
6078 shm= No abbreviation of message.
6079 shm=a Abbreviation, but no loss of information.
6080 shm=at Abbreviation, and truncate message when necessary.
6081
6082 NOTE: This option is set to the Vi default value when 'compatible' is
6083 set and to the Vim default value when 'compatible' is reset.
6084
6085 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6086'shortname' 'sn' boolean (default off)
6087 local to buffer
6088 {not in Vi, not in MS-DOS versions}
6089 Filenames are assumed to be 8 characters plus one extension of 3
6090 characters. Multiple dots in file names are not allowed. When this
6091 option is on, dots in file names are replaced with underscores when
6092 adding an extension (".~" or ".swp"). This option is not available
6093 for MS-DOS, because then it would always be on. This option is useful
6094 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6095 or crossdos. When running the Win32 GUI version under Win32s, this
6096 option is always on by default.
6097
6098 *'showbreak'* *'sbr'* *E595*
6099'showbreak' 'sbr' string (default "")
6100 global
6101 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006102 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 feature}
6104 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006105 values are "> " or "+++ ": >
6106 :set showbreak=>\
6107< Note the backslash to escape the trailing space. It's easier like
6108 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006109 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006110< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 comma (in a future version the comma might be used to separate the
6112 part that is shown at the end and at the start of a line).
6113 The characters are highlighted according to the '@' flag in
6114 'highlight'.
6115 Note that tabs after the showbreak will be displayed differently.
6116 If you want the 'showbreak' to appear in between line numbers, add the
6117 "n" flag to 'cpoptions'.
6118
6119 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6120'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6121 off)
6122 global
6123 {not in Vi}
6124 {not available when compiled without the
6125 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006126 Show (partial) command in the last line of the screen. Set this
6127 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 In Visual mode the size of the selected area is shown:
6129 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006130 If the number of bytes is different it is also displayed: "2-6"
6131 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006133 - When selecting a block, the size in screen characters:
6134 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 NOTE: This option is set to the Vi default value when 'compatible' is
6136 set and to the Vim default value when 'compatible' is reset.
6137
6138 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6139'showfulltag' 'sft' boolean (default off)
6140 global
6141 {not in Vi}
6142 When completing a word in insert mode (see |ins-completion|) from the
6143 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006144 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 matched a C function, you can see a template for what arguments are
6146 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006147 Note that this doesn't work well together with having "longest" in
6148 'completeopt', because the completion from the search pattern may not
6149 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150
6151 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6152'showmatch' 'sm' boolean (default off)
6153 global
6154 When a bracket is inserted, briefly jump to the matching one. The
6155 jump is only done if the match can be seen on the screen. The time to
6156 show the match can be set with 'matchtime'.
6157 A Beep is given if there is no match (no matter if the match can be
6158 seen or not). This option is reset when the 'paste' option is set.
6159 When the 'm' flag is not included in 'cpoptions', typing a character
6160 will immediately move the cursor back to where it belongs.
6161 See the "sm" field in 'guicursor' for setting the cursor shape and
6162 blinking when showing the match.
6163 The 'matchpairs' option can be used to specify the characters to show
6164 matches for. 'rightleft' and 'revins' are used to look for opposite
6165 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006166 Also see the matchparen plugin for highlighting the match when moving
6167 around |pi_paren.txt|.
6168 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006169
6170 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6171'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6172 global
6173 If in Insert, Replace or Visual mode put a message on the last line.
6174 Use the 'M' flag in 'highlight' to set the type of highlighting for
6175 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006176 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006177 doesn't mean XIM is really active, especially when 'imactivatekey' is
6178 not set.
6179 NOTE: This option is set to the Vi default value when 'compatible' is
6180 set and to the Vim default value when 'compatible' is reset.
6181
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006182 *'showtabline'* *'stal'*
6183'showtabline' 'stal' number (default 1)
6184 global
6185 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006186 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006187 feature}
6188 The value of this option specifies when the line with tab page labels
6189 will be displayed:
6190 0: never
6191 1: only if there are at least two tab pages
6192 2: always
6193 This is both for the GUI and non-GUI implementation of the tab pages
6194 line.
6195 See |tab-page| for more information about tab pages.
6196
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 *'sidescroll'* *'ss'*
6198'sidescroll' 'ss' number (default 0)
6199 global
6200 {not in Vi}
6201 The minimal number of columns to scroll horizontally. Used only when
6202 the 'wrap' option is off and the cursor is moved off of the screen.
6203 When it is zero the cursor will be put in the middle of the screen.
6204 When using a slow terminal set it to a large number or 0. When using
6205 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6206 commands.
6207
6208 *'sidescrolloff'* *'siso'*
6209'sidescrolloff' 'siso' number (default 0)
6210 global
6211 {not in Vi}
6212 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006213 right of the cursor if 'nowrap' is set. Setting this option to a
6214 value greater than 0 while having |'sidescroll'| also at a non-zero
6215 value makes some context visible in the line you are scrolling in
6216 horizontally (except at beginning of the line). Setting this option
6217 to a large value (like 999) has the effect of keeping the cursor
6218 horizontally centered in the window, as long as one does not come too
6219 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 NOTE: This option is set to 0 when 'compatible' is set.
6221
6222 Example: Try this together with 'sidescroll' and 'listchars' as
6223 in the following example to never allow the cursor to move
6224 onto the "extends" character:
6225
6226 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6227 :set sidescrolloff=1
6228
6229
6230 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6231'smartcase' 'scs' boolean (default off)
6232 global
6233 {not in Vi}
6234 Override the 'ignorecase' option if the search pattern contains upper
6235 case characters. Only used when the search pattern is typed and
6236 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006237 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6239 recalling the search pattern from history and hitting <Enter>.
6240 NOTE: This option is reset when 'compatible' is set.
6241
6242 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6243'smartindent' 'si' boolean (default off)
6244 local to buffer
6245 {not in Vi}
6246 {not available when compiled without the
6247 |+smartindent| feature}
6248 Do smart autoindenting when starting a new line. Works for C-like
6249 programs, but can also be used for other languages. 'cindent' does
6250 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006251 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006252 setting 'si' has no effect. 'indentexpr' is a more advanced
6253 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 Normally 'autoindent' should also be on when using 'smartindent'.
6255 An indent is automatically inserted:
6256 - After a line ending in '{'.
6257 - After a line starting with a keyword from 'cinwords'.
6258 - Before a line starting with '}' (only with the "O" command).
6259 When typing '}' as the first character in a new line, that line is
6260 given the same indent as the matching '{'.
6261 When typing '#' as the first character in a new line, the indent for
6262 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006263 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6265 When using the ">>" command, lines starting with '#' are not shifted
6266 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006267 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 is set smart indenting is disabled.
6269
6270 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6271'smarttab' 'sta' boolean (default off)
6272 global
6273 {not in Vi}
6274 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006275 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6276 <BS> will delete a 'shiftwidth' worth of space at the start of the
6277 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006278 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006279 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6280 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006281 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006283 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 NOTE: This option is reset when 'compatible' is set.
6285
6286 *'softtabstop'* *'sts'*
6287'softtabstop' 'sts' number (default 0)
6288 local to buffer
6289 {not in Vi}
6290 Number of spaces that a <Tab> counts for while performing editing
6291 operations, like inserting a <Tab> or using <BS>. It "feels" like
6292 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6293 used. This is useful to keep the 'ts' setting at its standard value
6294 of 8, while being able to edit like it is set to 'sts'. However,
6295 commands like "x" still work on the actual characters.
6296 When 'sts' is zero, this feature is off.
6297 'softtabstop' is set to 0 when the 'paste' option is set.
6298 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6299 spaces is minimized by using <Tab>s.
6300 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6301 set.
6302 NOTE: This option is set to 0 when 'compatible' is set.
6303
Bram Moolenaar217ad922005-03-20 22:37:15 +00006304 *'spell'* *'nospell'*
6305'spell' boolean (default off)
6306 local to window
6307 {not in Vi}
6308 {not available when compiled without the |+syntax|
6309 feature}
6310 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006311 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006312
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006313 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006314'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006315 local to buffer
6316 {not in Vi}
6317 {not available when compiled without the |+syntax|
6318 feature}
6319 Pattern to locate the end of a sentence. The following word will be
6320 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006321 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006322 When this check is not wanted make this option empty.
6323 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006324 Be careful with special characters, see |option-backslash| about
6325 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006326 To set this option automatically depending on the language, see
6327 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006328
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006329 *'spellfile'* *'spf'*
6330'spellfile' 'spf' string (default empty)
6331 local to buffer
6332 {not in Vi}
6333 {not available when compiled without the |+syntax|
6334 feature}
6335 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006336 commands. It must end in ".{encoding}.add". You need to include the
6337 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006338 *E765*
6339 It may also be a comma separated list of names. A count before the
6340 |zg| and |zw| commands can be used to access each. This allows using
6341 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006342 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006343 you: Using the first directory in 'runtimepath' that is writable. If
6344 there is no "spell" directory yet it will be created. For the file
6345 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006346 ignoring the region.
6347 The resulting ".spl" file will be used for spell checking, it does not
6348 have to appear in 'spelllang'.
6349 Normally one file is used for all regions, but you can add the region
6350 name if you want to. However, it will then only be used when
6351 'spellfile' is set to it, for entries in 'spelllang' only files
6352 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006353 This option cannot be set from a |modeline| or in the |sandbox|, for
6354 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006355
Bram Moolenaar217ad922005-03-20 22:37:15 +00006356 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006357'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006358 local to buffer
6359 {not in Vi}
6360 {not available when compiled without the |+syntax|
6361 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006362 A comma separated list of word list names. When the 'spell' option is
6363 on spellchecking will be done for these languages. Example: >
6364 set spelllang=en_us,nl,medical
6365< This means US English, Dutch and medical words are recognized. Words
6366 that are not recognized will be highlighted.
6367 The word list name must not include a comma or dot. Using a dash is
6368 recommended to separate the two letter language name from a
6369 specification. Thus "en-rare" is used for rare English words.
6370 A region name must come last and have the form "_xx", where "xx" is
6371 the two-letter, lower case region name. You can use more than one
6372 region by listing them: "en_us,en_ca" supports both US and Canadian
6373 English, but not words specific for Australia, New Zealand or Great
6374 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006375 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006376 As a special case the name of a .spl file can be given as-is. The
6377 first "_xx" in the name is removed and used as the region name
6378 (_xx is an underscore, two letters and followed by a non-letter).
6379 This is mainly for testing purposes. You must make sure the correct
6380 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006381 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006382 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6383 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006384 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006385
Bram Moolenaar98692072006-02-04 00:57:42 +00006386 If the |spellfile.vim| plugin is active and you use a language name
6387 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6388 will ask you if you want to download the file.
6389
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006390 After this option has been set successfully, Vim will source the files
6391 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006392 up to the first comma, dot or underscore.
6393 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006394
6395
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006396 *'spellsuggest'* *'sps'*
6397'spellsuggest' 'sps' string (default "best")
6398 global
6399 {not in Vi}
6400 {not available when compiled without the |+syntax|
6401 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006402 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006403 the |spellsuggest()| function. This is a comma-separated list of
6404 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006405
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006406 best Internal method that works best for English. Finds
6407 changes like "fast" and uses a bit of sound-a-like
6408 scoring to improve the ordering.
6409
6410 double Internal method that uses two methods and mixes the
6411 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006412 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006413 word. That only works when the language specifies
6414 sound folding. Can be slow and doesn't always give
6415 better results.
6416
6417 fast Internal method that only checks for simple changes:
6418 character inserts/deletes/swaps. Works well for
6419 simple typing mistakes.
6420
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006421 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006422 Not used for |spellsuggest()|. The number of
6423 suggestions is never more than the value of 'lines'
6424 minus two.
6425
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006426 file:{filename} Read file {filename}, which must have two columns,
6427 separated by a slash. The first column contains the
6428 bad word, the second column the suggested good word.
6429 Example:
6430 theribal/terrible ~
6431 Use this for common mistakes that do not appear at the
6432 top of the suggestion list with the internal methods.
6433 Lines without a slash are ignored, use this for
6434 comments.
6435 The file is used for all languages.
6436
6437 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6438 trouble with spaces. |v:val| holds the badly spelled
6439 word. The expression must evaluate to a List of
6440 Lists, each with a suggestion and a score.
6441 Example:
6442 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006443 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006444 internal methods use. A lower score is better.
6445 This may invoke |spellsuggest()| if you temporarily
6446 set 'spellsuggest' to exclude the "expr:" part.
6447 Errors are silently ignored, unless you set the
6448 'verbose' option to a non-zero value.
6449
6450 Only one of "best", "double" or "fast" may be used. The others may
6451 appear several times in any order. Example: >
6452 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6453<
6454 This option cannot be set from a |modeline| or in the |sandbox|, for
6455 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006456
6457
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6459'splitbelow' 'sb' boolean (default off)
6460 global
6461 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006462 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 feature}
6464 When on, splitting a window will put the new window below the current
6465 one. |:split|
6466
6467 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6468'splitright' 'spr' boolean (default off)
6469 global
6470 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006471 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 feature}
6473 When on, splitting a window will put the new window right of the
6474 current one. |:vsplit|
6475
6476 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6477'startofline' 'sol' boolean (default on)
6478 global
6479 {not in Vi}
6480 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006481 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006482 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006483 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 with a linewise operator, with "%" with a count and to buffer changing
6485 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6486 only has a line number, e.g., ":25" or ":+".
6487 In case of buffer changing commands the cursor is placed at the column
6488 where it was the last time the buffer was edited.
6489 NOTE: This option is set when 'compatible' is set.
6490
6491 *'statusline'* *'stl'* *E540* *E541* *E542*
6492'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006493 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006494 {not in Vi}
6495 {not available when compiled without the |+statusline|
6496 feature}
6497 When nonempty, this option determines the content of the status line.
6498 Also see |status-line|.
6499
6500 The option consists of printf style '%' items interspersed with
6501 normal text. Each status line item is of the form:
6502 %-0{minwid}.{maxwid}{item}
6503 All fields except the {item} is optional. A single percent sign can
6504 be given as "%%". Up to 80 items can be specified.
6505
Bram Moolenaar238a5642006-02-21 22:12:05 +00006506 When the option starts with "%!" then it is used as an expression,
6507 evaluated and the result is used as the option value. Example: >
6508 :set statusline=%!MyStatusLine()
6509< The result can contain %{} items that will be evaluated too.
6510
6511 When there is error while evaluating the option then it will be made
6512 empty to avoid further errors. Otherwise screen updating would loop.
6513
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 Note that the only effect of 'ruler' when this option is set (and
6515 'laststatus' is 2) is controlling the output of |CTRL-G|.
6516
6517 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006518 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006520 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 minwid Minimum width of the item, padding as set by '-' & '0'.
6522 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 on the left for text items. Numeric items will be
6525 shifted down to maxwid-2 digits followed by '>'number
6526 where number is the amount of missing digits, much like
6527 an exponential notation.
6528 item A one letter code as described below.
6529
6530 Following is a description of the possible statusline items. The
6531 second character in "item" is the type:
6532 N for number
6533 S for string
6534 F for flags as described below
6535 - not applicable
6536
6537 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006538 f S Path to the file in the buffer, as typed or relative to current
6539 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 F S Full path to the file in the buffer.
6541 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006542 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006544 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006546 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006548 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006550 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6552 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006553 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6555 being used: "<keymap>"
6556 n N Buffer number.
6557 b N Value of byte under cursor.
6558 B N As above, in hexadecimal.
6559 o N Byte number in file of byte under cursor, first byte is 1.
6560 Mnemonic: Offset from start of file (with one added)
6561 {not available when compiled without |+byte_offset| feature}
6562 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006563 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 l N Line number.
6565 L N Number of lines in buffer.
6566 c N Column number.
6567 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006568 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569 p N Percentage through file in lines as in |CTRL-G|.
6570 P S Percentage through file of displayed window. This is like the
6571 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006572 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006574 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006575 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 ( - Start of item group. Can be used for setting the width and
6577 alignment of a section. Must be followed by %) somewhere.
6578 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006579 T N For 'tabline': start of tab page N label. Use %T after the last
6580 label. This information is used for mouse clicks.
6581 X N For 'tabline': start of close tab N label. Use %X after the
6582 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6583 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 < - Where to truncate line if too long. Default is at the start.
6585 No width fields allowed.
6586 = - Separation point between left and right aligned items.
6587 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006588 # - Set highlight group. The name must follow and then a # again.
6589 Thus use %#HLname# for highlight group HLname. The same
6590 highlighting is used, also for the statusline of non-current
6591 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006593 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 The difference between User{N} and StatusLine will be applied
6595 to StatusLineNC for the statusline of non-current windows.
6596 The number N must be between 1 and 9. See |hl-User1..9|
6597
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006598 When displaying a flag, Vim removes the leading comma, if any, when
6599 that flag comes right after plaintext. This will make a nice display
6600 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601
Bram Moolenaar582fd852005-03-28 20:58:01 +00006602 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603 not set) and a minwid is not set for the group, the whole group will
6604 become empty. This will make a group like the following disappear
6605 completely from the statusline when none of the flags are set. >
6606 :set statusline=...%(\ [%M%R%H]%)...
6607<
6608 Beware that an expression is evaluated each and every time the status
6609 line is displayed. The current buffer and current window will be set
6610 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006611 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006613 real current buffer.
6614
6615 The 'statusline' option may be evaluated in the |sandbox|, see
6616 |sandbox-option|.
6617
6618 It is not allowed to change text or jump to another window while
6619 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620
6621 If the statusline is not updated when you want it (e.g., after setting
6622 a variable that's used in an expression), you can force an update by
6623 setting an option without changing its value. Example: >
6624 :let &ro = &ro
6625
6626< A result of all digits is regarded a number for display purposes.
6627 Otherwise the result is taken as flag text and applied to the rules
6628 described above.
6629
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006630 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6632 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6633
6634 Examples:
6635 Emulate standard status line with 'ruler' set >
6636 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6637< Similar, but add ASCII value of char under the cursor (like "ga") >
6638 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6639< Display byte count and byte value, modified flag in red. >
6640 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6641 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6642< Display a ,GZ flag if a compressed file is loaded >
6643 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6644< In the |:autocmd|'s: >
6645 :let b:gzflag = 1
6646< And: >
6647 :unlet b:gzflag
6648< And define this function: >
6649 :function VarExists(var, val)
6650 : if exists(a:var) | return a:val | else | return '' | endif
6651 :endfunction
6652<
6653 *'suffixes'* *'su'*
6654'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6655 global
6656 {not in Vi}
6657 Files with these suffixes get a lower priority when multiple files
6658 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006659 suffixes. Spaces after the comma are ignored. A dot is also seen as
6660 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 separator, precede it with a backslash (see |option-backslash| about
6662 including spaces and backslashes).
6663 See 'wildignore' for completely ignoring files.
6664 The use of |:set+=| and |:set-=| is preferred when adding or removing
6665 suffixes from the list. This avoids problems when a future version
6666 uses another default.
6667
6668 *'suffixesadd'* *'sua'*
6669'suffixesadd' 'sua' string (default "")
6670 local to buffer
6671 {not in Vi}
6672 {not available when compiled without the
6673 |+file_in_path| feature}
6674 Comma separated list of suffixes, which are used when searching for a
6675 file for the "gf", "[I", etc. commands. Example: >
6676 :set suffixesadd=.java
6677<
6678 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6679'swapfile' 'swf' boolean (default on)
6680 local to buffer
6681 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006682 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 swapfile is not wanted for a specific buffer. For example, with
6684 confidential information that even root must not be able to access.
6685 Careful: All text will be in memory:
6686 - Don't use this for big files.
6687 - Recovery will be impossible!
6688 A swapfile will only be present when |'updatecount'| is non-zero and
6689 'swapfile' is set.
6690 When 'swapfile' is reset, the swap file for the current buffer is
6691 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6692 non-zero, a swap file is immediately created.
6693 Also see |swap-file| and |'swapsync'|.
6694
6695 This option is used together with 'bufhidden' and 'buftype' to
6696 specify special kinds of buffers. See |special-buffers|.
6697
6698 *'swapsync'* *'sws'*
6699'swapsync' 'sws' string (default "fsync")
6700 global
6701 {not in Vi}
6702 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006703 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 When this option is empty parts of the swap file may be in memory and
6705 not written to disk. When the system crashes you may lose more work.
6706 On Unix the system does a sync now and then without Vim asking for it,
6707 so the disadvantage of setting this option off is small. On some
6708 systems the swap file will not be written at all. For a unix system
6709 setting it to "sync" will use the sync() call instead of the default
6710 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006711 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712
6713 *'switchbuf'* *'swb'*
6714'switchbuf' 'swb' string (default "")
6715 global
6716 {not in Vi}
6717 This option controls the behavior when switching between buffers.
6718 Possible values (comma separated list):
6719 useopen If included, jump to the first open window that
6720 contains the specified buffer (if there is one).
6721 Otherwise: Do not examine other windows.
6722 This setting is checked with |quickfix| commands, when
6723 jumping to errors (":cc", ":cn", "cp", etc.). It is
6724 also used in all buffer related split commands, for
6725 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006726 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006727 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006729 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006731 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006732 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006734 *'synmaxcol'* *'smc'*
6735'synmaxcol' 'smc' number (default 3000)
6736 local to buffer
6737 {not in Vi}
6738 {not available when compiled without the |+syntax|
6739 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006740 Maximum column in which to search for syntax items. In long lines the
6741 text after this column is not highlighted and following lines may not
6742 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006743 This helps to avoid very slow redrawing for an XML file that is one
6744 long line.
6745 Set to zero to remove the limit.
6746
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 *'syntax'* *'syn'*
6748'syntax' 'syn' string (default empty)
6749 local to buffer
6750 {not in Vi}
6751 {not available when compiled without the |+syntax|
6752 feature}
6753 When this option is set, the syntax with this name is loaded, unless
6754 syntax highlighting has been switched off with ":syntax off".
6755 Otherwise this option does not always reflect the current syntax (the
6756 b:current_syntax variable does).
6757 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006758 not automatically recognized. Example, in an IDL file:
6759 /* vim: set syntax=idl : */ ~
6760 When a dot appears in the value then this separates two filetype
6761 names. Example:
6762 /* vim: set syntax=c.doxygen : */ ~
6763 This will use the "c" syntax first, then the "doxygen" syntax.
6764 Note that the second one must be prepared to be loaded as an addition,
6765 otherwise it will be skipped. More than one dot may appear.
6766 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 :set syntax=OFF
6768< To switch syntax highlighting on according to the current value of the
6769 'filetype' option: >
6770 :set syntax=ON
6771< What actually happens when setting the 'syntax' option is that the
6772 Syntax autocommand event is triggered with the value as argument.
6773 This option is not copied to another buffer, independent of the 's' or
6774 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006775 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006777 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006778'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006779 global
6780 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006781 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006782 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006783 When nonempty, this option determines the content of the tab pages
6784 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006785 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006786
6787 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006788 option and only when there is no GUI tab line. When 'e' is in
6789 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006790 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006791
6792 The value is evaluated like with 'statusline'. You can use
6793 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006794 the text to be displayed. Use "%1T" for the first label, "%2T" for
6795 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006796
6797 Keep in mind that only one of the tab pages is the current one, others
6798 are invisible and you can't jump to their windows.
6799
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006800
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006801 *'tabpagemax'* *'tpm'*
6802'tabpagemax' 'tpm' number (default 10)
6803 global
6804 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006805 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006806 feature}
6807 Maximum number of tab pages to be opened by the |-p| command line
6808 argument or the ":tab all" command. |tabpage|
6809
6810
6811 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812'tabstop' 'ts' number (default 8)
6813 local to buffer
6814 Number of spaces that a <Tab> in the file counts for. Also see
6815 |:retab| command, and 'softtabstop' option.
6816
6817 Note: Setting 'tabstop' to any other value than 8 can make your file
6818 appear wrong in many places (e.g., when printing it).
6819
6820 There are four main ways to use tabs in Vim:
6821 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6822 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006823 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 behave like a tab appears every 4 (or 3) characters.
6825 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6826 'expandtab'. This way you will always insert spaces. The
6827 formatting will never be messed up when 'tabstop' is changed.
6828 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006829 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006830 works when using Vim to edit the file.
6831 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6832 'noexpandtab'. This should then work (for initial indents only)
6833 for any tabstop setting that people use. It might be nice to have
6834 tabs after the first non-blank inserted as spaces if you do this
6835 though. Otherwise aligned comments will be wrong when 'tabstop' is
6836 changed.
6837
6838 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6839'tagbsearch' 'tbs' boolean (default on)
6840 global
6841 {not in Vi}
6842 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006843 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 searching makes searching for a tag a LOT faster, but a linear search
6845 will find more tags if the tags file wasn't properly sorted.
6846 Vim normally assumes that your tags files are sorted, or indicate that
6847 they are not sorted. Only when this is not the case does the
6848 'tagbsearch' option need to be switched off.
6849
6850 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006851 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852 certain files, or retry all files with a linear search. When
6853 'tagbsearch' is off, only a linear search is done.
6854
6855 Linear searching is done anyway, for one file, when Vim finds a line
6856 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006857 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858< [The whitespace before and after the '0' must be a single <Tab>]
6859
6860 When a binary search was done and no match was found in any of the
6861 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6862 instead of a normal tag name, a retry is done with a linear search.
6863 Tags in unsorted tags files, and matches with different case will only
6864 be found in the retry.
6865
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006866 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 linear search can be avoided for the 'ignorecase' case. Use a value
6868 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6869 case-fold sorted with the -f switch to "sort" in most unices, as in
6870 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006871 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6872 for this as well. Note that case must be folded to uppercase for this
6873 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006874
6875 When 'tagbsearch' is off, tags searching is slower when a full match
6876 exists, but faster when no full match exists. Tags in unsorted tags
6877 files may only be found with 'tagbsearch' off.
6878 When the tags file is not sorted, or sorted in a wrong way (not on
6879 ASCII byte value), 'tagbsearch' should be off, or the line given above
6880 must be included in the tags file.
6881 This option doesn't affect commands that find all matching tags (e.g.,
6882 command-line completion and ":help").
6883 {Vi: always uses binary search in some versions}
6884
6885 *'taglength'* *'tl'*
6886'taglength' 'tl' number (default 0)
6887 global
6888 If non-zero, tags are significant up to this number of characters.
6889
6890 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6891'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6892 global
6893 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006894 If on and using a tags file in another directory, file names in that
6895 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006896 NOTE: This option is set to the Vi default value when 'compatible' is
6897 set and to the Vim default value when 'compatible' is reset.
6898
6899 *'tags'* *'tag'* *E433*
6900'tags' 'tag' string (default "./tags,tags", when compiled with
6901 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6902 global or local to buffer |global-local|
6903 Filenames for the tag command, separated by spaces or commas. To
6904 include a space or comma in a file name, precede it with a backslash
6905 (see |option-backslash| about including spaces and backslashes).
6906 When a file name starts with "./", the '.' is replaced with the path
6907 of the current file. But only when the 'd' flag is not included in
6908 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6909 |tags-option|.
6910 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006911 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6912 find all files named "tags" below "/lib". The filename itself cannot
6913 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6914 files called "tags?". {not available when compiled without the
6915 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006916 The |tagfiles()| function can be used to get a list of the file names
6917 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6919 files are also supported. They are automatically recognized. The
6920 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6921 differences are ignored (MS-Windows). |emacs-tags|
6922 The use of |:set+=| and |:set-=| is preferred when adding or removing
6923 file names from the list. This avoids problems when a future version
6924 uses another default.
6925 {Vi: default is "tags /usr/lib/tags"}
6926
6927 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6928'tagstack' 'tgst' boolean (default on)
6929 global
6930 {not in all versions of Vi}
6931 When on, the |tagstack| is used normally. When off, a ":tag" or
6932 ":tselect" command with an argument will not push the tag onto the
6933 tagstack. A following ":tag" without an argument, a ":pop" command or
6934 any other command that uses the tagstack will use the unmodified
6935 tagstack, but does change the pointer to the active entry.
6936 Resetting this option is useful when using a ":tag" command in a
6937 mapping which should not change the tagstack.
6938
6939 *'term'* *E529* *E530* *E531*
6940'term' string (default is $TERM, if that fails:
6941 in the GUI: "builtin_gui"
6942 on Amiga: "amiga"
6943 on BeOS: "beos-ansi"
6944 on Mac: "mac-ansi"
6945 on MiNT: "vt52"
6946 on MS-DOS: "pcterm"
6947 on OS/2: "os2ansi"
6948 on Unix: "ansi"
6949 on VMS: "ansi"
6950 on Win 32: "win32")
6951 global
6952 Name of the terminal. Used for choosing the terminal control
6953 characters. Environment variables are expanded |:set_env|.
6954 For example: >
6955 :set term=$TERM
6956< See |termcap|.
6957
6958 *'termbidi'* *'tbidi'*
6959 *'notermbidi'* *'notbidi'*
6960'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6961 global
6962 {not in Vi}
6963 {only available when compiled with the |+arabic|
6964 feature}
6965 The terminal is in charge of Bi-directionality of text (as specified
6966 by Unicode). The terminal is also expected to do the required shaping
6967 that some languages (such as Arabic) require.
6968 Setting this option implies that 'rightleft' will not be set when
6969 'arabic' is set and the value of 'arabicshape' will be ignored.
6970 Note that setting 'termbidi' has the immediate effect that
6971 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6972 This option is reset when the GUI is started.
6973 For further details see |arabic.txt|.
6974
6975 *'termencoding'* *'tenc'*
6976'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6977 Macintosh GUI: "macroman")
6978 global
6979 {only available when compiled with the |+multi_byte|
6980 feature}
6981 {not in Vi}
6982 Encoding used for the terminal. This specifies what character
6983 encoding the keyboard produces and the display will understand. For
6984 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006985 display). Except for the Mac when 'macatsui' is off, then
6986 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006987 In the Win32 console version the default value is the console codepage
6988 when it differs from the ANSI codepage.
6989 *E617*
6990 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6991 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6992 Any attempts to set a different value will be rejected, and an error
6993 message is shown.
6994 For the Win32 GUI 'termencoding' is not used for typed characters,
6995 because the Win32 system always passes Unicode characters.
6996 When empty, the same encoding is used as for the 'encoding' option.
6997 This is the normal value.
6998 Not all combinations for 'termencoding' and 'encoding' are valid. See
6999 |encoding-table|.
7000 The value for this option must be supported by internal conversions or
7001 iconv(). When this is not possible no conversion will be done and you
7002 will probably experience problems with non-ASCII characters.
7003 Example: You are working with the locale set to euc-jp (Japanese) and
7004 want to edit a UTF-8 file: >
7005 :let &termencoding = &encoding
7006 :set encoding=utf-8
7007< You need to do this when your system has no locale support for UTF-8.
7008
7009 *'terse'* *'noterse'*
7010'terse' boolean (default off)
7011 global
7012 When set: Add 's' flag to 'shortmess' option (this makes the message
7013 for a search that hits the start or end of the file not being
7014 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7015 shortens a lot of messages}
7016
7017 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7018'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7019 global
7020 {not in Vi}
7021 This option is obsolete. Use 'fileformats'.
7022 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7023 set to the default value for the current system. When 'textauto' is
7024 reset, 'fileformats' is made empty.
7025 NOTE: This option is set to the Vi default value when 'compatible' is
7026 set and to the Vim default value when 'compatible' is reset.
7027
7028 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7029'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7030 others: default off)
7031 local to buffer
7032 {not in Vi}
7033 This option is obsolete. Use 'fileformat'.
7034 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7035 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7036 "unix".
7037
7038 *'textwidth'* *'tw'*
7039'textwidth' 'tw' number (default 0)
7040 local to buffer
7041 {not in Vi}
7042 Maximum width of text that is being inserted. A longer line will be
7043 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007044 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7045 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007047 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007048 NOTE: This option is set to 0 when 'compatible' is set.
7049
7050 *'thesaurus'* *'tsr'*
7051'thesaurus' 'tsr' string (default "")
7052 global or local to buffer |global-local|
7053 {not in Vi}
7054 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007055 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007056 the file should contain words with similar meaning, separated by
7057 non-keyword characters (white space is preferred). Maximum line
7058 length is 510 bytes.
7059 To obtain a file to be used here, check out the wordlist FAQ at
7060 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007061 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007062 after a comma are ignored, otherwise spaces are included in the file
7063 name. See |option-backslash| about using backslashes.
7064 The use of |:set+=| and |:set-=| is preferred when adding or removing
7065 directories from the list. This avoids problems when a future version
7066 uses another default.
7067 Backticks cannot be used in this option for security reasons.
7068
7069 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7070'tildeop' 'top' boolean (default off)
7071 global
7072 {not in Vi}
7073 When on: The tilde command "~" behaves like an operator.
7074 NOTE: This option is reset when 'compatible' is set.
7075
7076 *'timeout'* *'to'* *'notimeout'* *'noto'*
7077'timeout' 'to' boolean (default on)
7078 global
7079 *'ttimeout'* *'nottimeout'*
7080'ttimeout' boolean (default off)
7081 global
7082 {not in Vi}
7083 These two options together determine the behavior when part of a
7084 mapped key sequence or keyboard code has been received:
7085
7086 'timeout' 'ttimeout' action ~
7087 off off do not time out
7088 on on or off time out on :mappings and key codes
7089 off on time out on key codes
7090
7091 If both options are off, Vim will wait until either the complete
7092 mapping or key sequence has been received, or it is clear that there
7093 is no mapping or key sequence for the received characters. For
7094 example: if you have mapped "vl" and Vim has received 'v', the next
7095 character is needed to see if the 'v' is followed by an 'l'.
7096 When one of the options is on, Vim will wait for about 1 second for
7097 the next character to arrive. After that the already received
7098 characters are interpreted as single characters. The waiting time can
7099 be changed with the 'timeoutlen' option.
7100 On slow terminals or very busy systems timing out may cause
7101 malfunctioning cursor keys. If both options are off, Vim waits
7102 forever after an entered <Esc> if there are key codes that start
7103 with <Esc>. You will have to type <Esc> twice. If you do not have
7104 problems with key codes, but would like to have :mapped key
7105 sequences not timing out in 1 second, set the 'ttimeout' option and
7106 reset the 'timeout' option.
7107
7108 NOTE: 'ttimeout' is reset when 'compatible' is set.
7109
7110 *'timeoutlen'* *'tm'*
7111'timeoutlen' 'tm' number (default 1000)
7112 global
7113 {not in all versions of Vi}
7114 *'ttimeoutlen'* *'ttm'*
7115'ttimeoutlen' 'ttm' number (default -1)
7116 global
7117 {not in Vi}
7118 The time in milliseconds that is waited for a key code or mapped key
7119 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7120 when part of a command has been typed.
7121 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7122 different timeout value for key codes is desired set 'ttimeoutlen' to
7123 a non-negative number.
7124
7125 ttimeoutlen mapping delay key code delay ~
7126 < 0 'timeoutlen' 'timeoutlen'
7127 >= 0 'timeoutlen' 'ttimeoutlen'
7128
7129 The timeout only happens when the 'timeout' and 'ttimeout' options
7130 tell so. A useful setting would be >
7131 :set timeout timeoutlen=3000 ttimeoutlen=100
7132< (time out on mapping after three seconds, time out on key codes after
7133 a tenth of a second).
7134
7135 *'title'* *'notitle'*
7136'title' boolean (default off, on when title can be restored)
7137 global
7138 {not in Vi}
7139 {not available when compiled without the |+title|
7140 feature}
7141 When on, the title of the window will be set to the value of
7142 'titlestring' (if it is not empty), or to:
7143 filename [+=-] (path) - VIM
7144 Where:
7145 filename the name of the file being edited
7146 - indicates the file cannot be modified, 'ma' off
7147 + indicates the file was modified
7148 = indicates the file is read-only
7149 =+ indicates the file is read-only and modified
7150 (path) is the path of the file being edited
7151 - VIM the server name |v:servername| or "VIM"
7152 Only works if the terminal supports setting window titles
7153 (currently Amiga console, Win32 console, all GUI versions and
7154 terminals with a non- empty 't_ts' option - these are Unix xterm and
7155 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7156 *X11*
7157 When Vim was compiled with HAVE_X11 defined, the original title will
7158 be restored if possible. The output of ":version" will include "+X11"
7159 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7160 works for the icon name |'icon'|.
7161 But: When Vim was started with the |-X| argument, restoring the title
7162 will not work (except in the GUI).
7163 If the title cannot be restored, it is set to the value of 'titleold'.
7164 You might want to restore the title outside of Vim then.
7165 When using an xterm from a remote machine you can use this command:
7166 rsh machine_name xterm -display $DISPLAY &
7167 then the WINDOWID environment variable should be inherited and the
7168 title of the window should change back to what it should be after
7169 exiting Vim.
7170
7171 *'titlelen'*
7172'titlelen' number (default 85)
7173 global
7174 {not in Vi}
7175 {not available when compiled without the |+title|
7176 feature}
7177 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007178 title. When the title is longer, only the end of the path name is
7179 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 Using a percentage makes this adapt to the width of the window. But
7181 it won't work perfectly, because the actual number of characters
7182 available also depends on the font used and other things in the title
7183 bar. When 'titlelen' is zero the full path is used. Otherwise,
7184 values from 1 to 30000 percent can be used.
7185 'titlelen' is also used for the 'titlestring' option.
7186
7187 *'titleold'*
7188'titleold' string (default "Thanks for flying Vim")
7189 global
7190 {not in Vi}
7191 {only available when compiled with the |+title|
7192 feature}
7193 This option will be used for the window title when exiting Vim if the
7194 original title cannot be restored. Only happens if 'title' is on or
7195 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007196 This option cannot be set from a |modeline| or in the |sandbox|, for
7197 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 *'titlestring'*
7199'titlestring' string (default "")
7200 global
7201 {not in Vi}
7202 {not available when compiled without the |+title|
7203 feature}
7204 When this option is not empty, it will be used for the title of the
7205 window. This happens only when the 'title' option is on.
7206 Only works if the terminal supports setting window titles (currently
7207 Amiga console, Win32 console, all GUI versions and terminals with a
7208 non-empty 't_ts' option).
7209 When Vim was compiled with HAVE_X11 defined, the original title will
7210 be restored if possible |X11|.
7211 When this option contains printf-style '%' items, they will be
7212 expanded according to the rules used for 'statusline'.
7213 Example: >
7214 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7215 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7216< The value of 'titlelen' is used to align items in the middle or right
7217 of the available space.
7218 Some people prefer to have the file name first: >
7219 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7220< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007221 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 separating space only when needed.
7223 NOTE: Use of special characters in 'titlestring' may cause the display
7224 to be garbled (e.g., when it contains a CR or NL character).
7225 {not available when compiled without the |+statusline| feature}
7226
7227 *'toolbar'* *'tb'*
7228'toolbar' 'tb' string (default "icons,tooltips")
7229 global
7230 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7231 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007232 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007233 possible values are:
7234 icons Toolbar buttons are shown with icons.
7235 text Toolbar buttons shown with text.
7236 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007237 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 tooltips Tooltips are active for toolbar buttons.
7239 Tooltips refer to the popup help text which appears after the mouse
7240 cursor is placed over a toolbar button for a brief moment.
7241
7242 If you want the toolbar to be shown with icons as well as text, do the
7243 following: >
7244 :set tb=icons,text
7245< Motif and Athena cannot display icons and text at the same time. They
7246 will show icons if both are requested.
7247
7248 If none of the strings specified in 'toolbar' are valid or if
7249 'toolbar' is empty, this option is ignored. If you want to disable
7250 the toolbar, you need to set the 'guioptions' option. For example: >
7251 :set guioptions-=T
7252< Also see |gui-toolbar|.
7253
7254 *'toolbariconsize'* *'tbis'*
7255'toolbariconsize' 'tbis' string (default "small")
7256 global
7257 {not in Vi}
7258 {only in the GTK+ 2 GUI}
7259 Controls the size of toolbar icons. The possible values are:
7260 tiny Use tiny toolbar icons.
7261 small Use small toolbar icons (default).
7262 medium Use medium-sized toolbar icons.
7263 large Use large toolbar icons.
7264 The exact dimensions in pixels of the various icon sizes depend on
7265 the current theme. Common dimensions are large=32x32, medium=24x24,
7266 small=20x20 and tiny=16x16.
7267
7268 If 'toolbariconsize' is empty, the global default size as determined
7269 by user preferences or the current theme is used.
7270
7271 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7272'ttybuiltin' 'tbi' boolean (default on)
7273 global
7274 {not in Vi}
7275 When on, the builtin termcaps are searched before the external ones.
7276 When off the builtin termcaps are searched after the external ones.
7277 When this option is changed, you should set the 'term' option next for
7278 the change to take effect, for example: >
7279 :set notbi term=$TERM
7280< See also |termcap|.
7281 Rationale: The default for this option is "on", because the builtin
7282 termcap entries are generally better (many systems contain faulty
7283 xterm entries...).
7284
7285 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7286'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7287 sun-cmd, screen, rxvt, dtterm or
7288 iris-ansi; also on when running Vim in
7289 a DOS console)
7290 global
7291 {not in Vi}
7292 Indicates a fast terminal connection. More characters will be sent to
7293 the screen for redrawing, instead of using insert/delete line
7294 commands. Improves smoothness of redrawing when there are multiple
7295 windows and the terminal does not support a scrolling region.
7296 Also enables the extra writing of characters at the end of each screen
7297 line for lines that wrap. This helps when using copy/paste with the
7298 mouse in an xterm and other terminals.
7299
7300 *'ttymouse'* *'ttym'*
7301'ttymouse' 'ttym' string (default depends on 'term')
7302 global
7303 {not in Vi}
7304 {only in Unix and VMS, doesn't work in the GUI; not
7305 available when compiled without |+mouse|}
7306 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007307 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 *xterm-mouse*
7309 xterm xterm-like mouse handling. The mouse generates
7310 "<Esc>[Mscr", where "scr" is three bytes:
7311 "s" = button state
7312 "c" = column plus 33
7313 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007314 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007315 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 xterm2 Works like "xterm", but with the xterm reporting the
7317 mouse position while the mouse is dragged. This works
7318 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007319 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 work. See below for how Vim detects this
7321 automatically.
7322 *netterm-mouse*
7323 netterm NetTerm mouse handling. The mouse generates
7324 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7325 for the row and column.
7326 *dec-mouse*
7327 dec DEC terminal mouse handling. The mouse generates a
7328 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007329 This is also available for an Xterm, if it was
7330 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007331 *jsbterm-mouse*
7332 jsbterm JSB term mouse handling.
7333 *pterm-mouse*
7334 pterm QNX pterm mouse handling.
7335
7336 The mouse handling must be enabled at compile time |+mouse_xterm|
7337 |+mouse_dec| |+mouse_netterm|.
7338 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7339 recognized, if enabled at compile time. DEC terminal mouse codes
7340 are recognized if enabled at compile time, and 'ttymouse' is not
7341 "xterm" (because the xterm and dec mouse codes conflict).
7342 This option is automatically set to "xterm", when the 'term' option is
7343 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7344 or "xterm2" already. The main use of this option is to set it to
7345 "xterm", when the terminal name doesn't start with "xterm", but it can
7346 handle xterm mouse codes.
7347 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007348 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 feature and if |t_RV| is set to the escape sequence to request the
7350 xterm version number. Otherwise "xterm2" must be set explicitly.
7351 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7352 t_RV to an empty string: >
7353 :set t_RV=
7354<
7355 *'ttyscroll'* *'tsl'*
7356'ttyscroll' 'tsl' number (default 999)
7357 global
7358 Maximum number of lines to scroll the screen. If there are more lines
7359 to scroll the window is redrawn. For terminals where scrolling is
7360 very slow and redrawing is not slow this can be set to a small number,
7361 e.g., 3, to speed up displaying.
7362
7363 *'ttytype'* *'tty'*
7364'ttytype' 'tty' string (default from $TERM)
7365 global
7366 Alias for 'term', see above.
7367
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007368 *'undodir'* *'udir'*
7369'undodir' 'udir' string (default ".")
7370 global
7371 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007372 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007373 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007374 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007375 "." means using the directory of the file. The undo file name for
7376 "file.txt" is ".file.txt.un~".
7377 For other directories the file name is the full path of the edited
7378 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007379 When writing: The first directory that exists is used. "." always
7380 works, no directories after "." will be used for writing.
7381 When reading all entries are tried to find an undo file. The first
7382 undo file that exists is used. When it cannot be read an error is
7383 given, no further entry is used.
7384 See |undo-persistence|.
7385
7386 *'undofile'* *'udf'*
7387'undofile' 'udf' boolean (default off)
7388 local to buffer
7389 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007390 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007391 When on, Vim automatically saves undo history to an undo file when
7392 writing a buffer to a file, and restores undo history from the same
7393 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007394 The directory where the undo file is stored is specified by 'undodir'.
7395 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007396 The undo file is not read when 'undoreload' causes the buffer from
7397 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007398 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007399
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 *'undolevels'* *'ul'*
7401'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7402 Win32 and OS/2)
7403 global
7404 {not in Vi}
7405 Maximum number of changes that can be undone. Since undo information
7406 is kept in memory, higher numbers will cause more memory to be used
7407 (nevertheless, a single change can use an unlimited amount of memory).
7408 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7409 itself: >
7410 set ul=0
7411< But you can also get Vi compatibility by including the 'u' flag in
7412 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007413 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007414 Set to a negative number for no undo at all: >
7415 set ul=-1
7416< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007417 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007419 *'undoreload'* *'ur'*
7420'undoreload' 'ur' number (default 10000)
7421 global
7422 {not in Vi}
7423 Save the whole buffer for undo when reloading it. This applies to the
7424 ":e!" command and reloading for when the buffer changed outside of
7425 Vim. |FileChangedShell|
7426 The save only happens when this options is negative or when the number
7427 of lines is smaller than the value of this option.
7428 Set this option to zero to disable undo for a reload.
7429
7430 When saving undo for a reload, any undo file is not read.
7431
7432 Note that this causes the whole buffer to be stored in memory. Set
7433 this option to a lower value if you run out of memory.
7434
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *'updatecount'* *'uc'*
7436'updatecount' 'uc' number (default: 200)
7437 global
7438 {not in Vi}
7439 After typing this many characters the swap file will be written to
7440 disk. When zero, no swap file will be created at all (see chapter on
7441 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7442 Vim with the "-n" option, see |startup|. When editing in readonly
7443 mode this option will be initialized to 10000.
7444 The swapfile can be disabled per buffer with |'swapfile'|.
7445 When 'updatecount' is set from zero to non-zero, swap files are
7446 created for all buffers that have 'swapfile' set. When 'updatecount'
7447 is set to zero, existing swap files are not deleted.
7448 Also see |'swapsync'|.
7449 This option has no meaning in buffers where |'buftype'| is "nofile"
7450 or "nowrite".
7451
7452 *'updatetime'* *'ut'*
7453'updatetime' 'ut' number (default 4000)
7454 global
7455 {not in Vi}
7456 If this many milliseconds nothing is typed the swap file will be
7457 written to disk (see |crash-recovery|). Also used for the
7458 |CursorHold| autocommand event.
7459
7460 *'verbose'* *'vbs'*
7461'verbose' 'vbs' number (default 0)
7462 global
7463 {not in Vi, although some versions have a boolean
7464 verbose option}
7465 When bigger than zero, Vim will give messages about what it is doing.
7466 Currently, these messages are given:
7467 >= 1 When the viminfo file is read or written.
7468 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007469 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 >= 8 Files for which a group of autocommands is executed.
7471 >= 9 Every executed autocommand.
7472 >= 12 Every executed function.
7473 >= 13 When an exception is thrown, caught, finished, or discarded.
7474 >= 14 Anything pending in a ":finally" clause.
7475 >= 15 Every executed Ex command (truncated at 200 characters).
7476
7477 This option can also be set with the "-V" argument. See |-V|.
7478 This option is also set by the |:verbose| command.
7479
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007480 When the 'verbosefile' option is set then the verbose messages are not
7481 displayed.
7482
7483 *'verbosefile'* *'vfile'*
7484'verbosefile' 'vfile' string (default empty)
7485 global
7486 {not in Vi}
7487 When not empty all messages are written in a file with this name.
7488 When the file exists messages are appended.
7489 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007490 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007491 Setting 'verbosefile' to a new value is like making it empty first.
7492 The difference with |:redir| is that verbose messages are not
7493 displayed when 'verbosefile' is set.
7494
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 *'viewdir'* *'vdir'*
7496'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7497 "$VIM/vimfiles/view",
7498 for Unix: "~/.vim/view",
7499 for Macintosh: "$VIM:vimfiles:view"
7500 for VMS: "sys$login:vimfiles/view"
7501 for RiscOS: "Choices:vimfiles/view")
7502 global
7503 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007504 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 feature}
7506 Name of the directory where to store files for |:mkview|.
7507 This option cannot be set from a |modeline| or in the |sandbox|, for
7508 security reasons.
7509
7510 *'viewoptions'* *'vop'*
7511'viewoptions' 'vop' string (default: "folds,options,cursor")
7512 global
7513 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007514 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 feature}
7516 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007517 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007518 word save and restore ~
7519 cursor cursor position in file and in window
7520 folds manually created folds, opened/closed folds and local
7521 fold options
7522 options options and mappings local to a window or buffer (not
7523 global values for local options)
7524 slash backslashes in file names replaced with forward
7525 slashes
7526 unix with Unix end-of-line format (single <NL>), even when
7527 on Windows or DOS
7528
7529 "slash" and "unix" are useful on Windows when sharing view files
7530 with Unix. The Unix version of Vim cannot source dos format scripts,
7531 but the Windows version of Vim can source unix format scripts.
7532
7533 *'viminfo'* *'vi'* *E526* *E527* *E528*
7534'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007535 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7536 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7537 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 global
7539 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007540 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 feature}
7542 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007543 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 separated list of parameters, each consisting of a single character
7545 identifying the particular parameter, followed by a number or string
7546 which specifies the value of that parameter. If a particular
7547 character is left out, then the default value is used for that
7548 parameter. The following is a list of the identifying characters and
7549 the effect of their value.
7550 CHAR VALUE ~
7551 ! When included, save and restore global variables that start
7552 with an uppercase letter, and don't contain a lowercase
7553 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007554 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007555 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007556 " Maximum number of lines saved for each register. Old name of
7557 the '<' item, with the disadvantage that you need to put a
7558 backslash before the ", otherwise it will be recognized as the
7559 start of a comment!
7560 % When included, save and restore the buffer list. If Vim is
7561 started with a file name argument, the buffer list is not
7562 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007563 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 without a file name and buffers for help files are not written
7565 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007566 When followed by a number, the number specifies the maximum
7567 number of buffers that are stored. Without a number all
7568 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 ' Maximum number of previously edited files for which the marks
7570 are remembered. This parameter must always be included when
7571 'viminfo' is non-empty.
7572 Including this item also means that the |jumplist| and the
7573 |changelist| are stored in the viminfo file.
7574 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007575 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 patterns are also saved. When not included, the value of
7577 'history' is used.
7578 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007579 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007580 < Maximum number of lines saved for each register. If zero then
7581 registers are not saved. When not included, all lines are
7582 saved. '"' is the old name for this item.
7583 Also see the 's' item below: limit specified in Kbyte.
7584 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007585 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 c When included, convert the text in the viminfo file from the
7587 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007588 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 f Whether file marks need to be stored. If zero, file marks ('0
7590 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007591 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 cursor position (when exiting or when doing ":wviminfo").
7593 h Disable the effect of 'hlsearch' when loading the viminfo
7594 file. When not included, it depends on whether ":nohlsearch"
7595 has been used since the last search command.
7596 n Name of the viminfo file. The name must immediately follow
7597 the 'n'. Must be the last one! If the "-i" argument was
7598 given when starting Vim, that file name overrides the one
7599 given here with 'viminfo'. Environment variables are expanded
7600 when opening the file, not when setting the option.
7601 r Removable media. The argument is a string (up to the next
7602 ','). This parameter can be given several times. Each
7603 specifies the start of a path for which no marks will be
7604 stored. This is to avoid removable media. For MS-DOS you
7605 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7606 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7607 ignored. Maximum length of each 'r' argument is 50
7608 characters.
7609 s Maximum size of an item in Kbyte. If zero then registers are
7610 not saved. Currently only applies to registers. The default
7611 "s10" will exclude registers with more than 10 Kbyte of text.
7612 Also see the '<' item above: line count limit.
7613
7614 Example: >
7615 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7616<
7617 '50 Marks will be remembered for the last 50 files you
7618 edited.
7619 <1000 Contents of registers (up to 1000 lines each) will be
7620 remembered.
7621 s100 Registers with more than 100 Kbyte text are skipped.
7622 :0 Command-line history will not be saved.
7623 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7624 no / Since '/' is not specified, the default will be used,
7625 that is, save all of the search history, and also the
7626 previous search and substitute patterns.
7627 no % The buffer list will not be saved nor read back.
7628 no h 'hlsearch' highlighting will be restored.
7629
7630 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7631 load the contents of the file, this is not done automatically.
7632
7633 This option cannot be set from a |modeline| or in the |sandbox|, for
7634 security reasons.
7635
7636 *'virtualedit'* *'ve'*
7637'virtualedit' 've' string (default "")
7638 global
7639 {not in Vi}
7640 {not available when compiled without the
7641 |+virtualedit| feature}
7642 A comma separated list of these words:
7643 block Allow virtual editing in Visual block mode.
7644 insert Allow virtual editing in Insert mode.
7645 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007646 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007647
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007649 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 of the line. Useful for selecting a rectangle in Visual mode and
7651 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007652 "onemore" is not the same, it will only allow moving the cursor just
7653 after the last character of the line. This makes some commands more
7654 consistent. Previously the cursor was always past the end of the line
7655 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007656 break some plugins or Vim scripts. For example because |l| can move
7657 the cursor after the last character. Use with care!
7658 Using the |$| command will move to the last character in the line, not
7659 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007660 It doesn't make sense to combine "all" with "onemore", but you will
7661 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662
7663 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7664'visualbell' 'vb' boolean (default off)
7665 global
7666 {not in Vi}
7667 Use visual bell instead of beeping. The terminal code to display the
7668 visual bell is given with 't_vb'. When no beep or flash is wanted,
7669 use ":set vb t_vb=".
7670 Note: When the GUI starts, 't_vb' is reset to its default value. You
7671 might want to set it again in your |gvimrc|.
7672 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7673 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7674 where 40 is the time in msec.
7675 Does not work on the Amiga, you always get a screen flash.
7676 Also see 'errorbells'.
7677
7678 *'warn'* *'nowarn'*
7679'warn' boolean (default on)
7680 global
7681 Give a warning message when a shell command is used while the buffer
7682 has been changed.
7683
7684 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7685'weirdinvert' 'wiv' boolean (default off)
7686 global
7687 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007688 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 It is provided for backwards compatibility with version 4.x.
7690 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7691 vice versa. Has no effect when the GUI is running.
7692
7693 *'whichwrap'* *'ww'*
7694'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7695 global
7696 {not in Vi}
7697 Allow specified keys that move the cursor left/right to move to the
7698 previous/next line when the cursor is on the first/last character in
7699 the line. Concatenate characters to allow this for these keys:
7700 char key mode ~
7701 b <BS> Normal and Visual
7702 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007703 h "h" Normal and Visual (not recommended)
7704 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 < <Left> Normal and Visual
7706 > <Right> Normal and Visual
7707 ~ "~" Normal
7708 [ <Left> Insert and Replace
7709 ] <Right> Insert and Replace
7710 For example: >
7711 :set ww=<,>,[,]
7712< allows wrap only when cursor keys are used.
7713 When the movement keys are used in combination with a delete or change
7714 operator, the <EOL> also counts for a character. This makes "3h"
7715 different from "3dh" when the cursor crosses the end of a line. This
7716 is also true for "x" and "X", because they do the same as "dl" and
7717 "dh". If you use this, you may also want to use the mapping
7718 ":map <BS> X" to make backspace delete the character in front of the
7719 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007720 When 'l' is included and it is used after an operator at the end of a
7721 line then it will not move to the next line. This makes "dl", "cl",
7722 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007723 NOTE: This option is set to the Vi default value when 'compatible' is
7724 set and to the Vim default value when 'compatible' is reset.
7725
7726 *'wildchar'* *'wc'*
7727'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7728 global
7729 {not in Vi}
7730 Character you have to type to start wildcard expansion in the
7731 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007732 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733 The character is not recognized when used inside a macro. See
7734 'wildcharm' for that.
7735 Although 'wc' is a number option, you can set it to a special key: >
7736 :set wc=<Esc>
7737< NOTE: This option is set to the Vi default value when 'compatible' is
7738 set and to the Vim default value when 'compatible' is reset.
7739
7740 *'wildcharm'* *'wcm'*
7741'wildcharm' 'wcm' number (default: none (0))
7742 global
7743 {not in Vi}
7744 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007745 recognized when used inside a macro. You can find "spare" command-line
7746 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 you'll never actually type 'wildcharm', just use it in mappings that
7748 automatically invoke completion mode, e.g.: >
7749 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007750 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007751< Then after typing :ss you can use CTRL-P & CTRL-N.
7752
7753 *'wildignore'* *'wig'*
7754'wildignore' 'wig' string (default "")
7755 global
7756 {not in Vi}
7757 {not available when compiled without the |+wildignore|
7758 feature}
7759 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007760 patterns is ignored when completing file or directory names, and
7761 influences the result of |expand()|, |glob()| and |globpath()| unless
7762 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007763 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7764 Also see 'suffixes'.
7765 Example: >
7766 :set wildignore=*.o,*.obj
7767< The use of |:set+=| and |:set-=| is preferred when adding or removing
7768 a pattern from the list. This avoids problems when a future version
7769 uses another default.
7770
Bram Moolenaar94950a92010-12-02 16:01:29 +01007771
Bram Moolenaar81af9252010-12-10 20:35:50 +01007772 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007773'wildignorecase' 'wic' boolean (default off)
7774 global
7775 {not in Vi}
7776 When set case is ignored when completing file names and directories.
7777 Has no effect on systems where file name case is generally ignored.
7778 Does not apply when the shell is used to expand wildcards, which
7779 happens when there are special characters.
7780
7781
Bram Moolenaar071d4272004-06-13 20:20:40 +00007782 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7783'wildmenu' 'wmnu' boolean (default off)
7784 global
7785 {not in Vi}
7786 {not available if compiled without the |+wildmenu|
7787 feature}
7788 When 'wildmenu' is on, command-line completion operates in an enhanced
7789 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7790 the possible matches are shown just above the command line, with the
7791 first match highlighted (overwriting the status line, if there is
7792 one). Keys that show the previous/next match, such as <Tab> or
7793 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7794 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7795 specified. "longest" and "list" do not start "wildmenu" mode.
7796 If there are more matches than can fit in the line, a ">" is shown on
7797 the right and/or a "<" is shown on the left. The status line scrolls
7798 as needed.
7799 The "wildmenu" mode is abandoned when a key is hit that is not used
7800 for selecting a completion.
7801 While the "wildmenu" is active the following keys have special
7802 meanings:
7803
7804 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7805 <Down> - in filename/menu name completion: move into a
7806 subdirectory or submenu.
7807 <CR> - in menu completion, when the cursor is just after a
7808 dot: move into a submenu.
7809 <Up> - in filename/menu name completion: move up into
7810 parent directory or parent menu.
7811
7812 This makes the menus accessible from the console |console-menus|.
7813
7814 If you prefer the <Left> and <Right> keys to move the cursor instead
7815 of selecting a different match, use this: >
7816 :cnoremap <Left> <Space><BS><Left>
7817 :cnoremap <Right> <Space><BS><Right>
7818<
7819 The "WildMenu" highlighting is used for displaying the current match
7820 |hl-WildMenu|.
7821
7822 *'wildmode'* *'wim'*
7823'wildmode' 'wim' string (Vim default: "full")
7824 global
7825 {not in Vi}
7826 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007827 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007828 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 first part specifies the behavior for the first use of 'wildchar',
7830 The second part for the second use, etc.
7831 These are the possible values for each part:
7832 "" Complete only the first match.
7833 "full" Complete the next full match. After the last match,
7834 the original string is used and then the first match
7835 again.
7836 "longest" Complete till longest common string. If this doesn't
7837 result in a longer string, use the next part.
7838 "longest:full" Like "longest", but also start 'wildmenu' if it is
7839 enabled.
7840 "list" When more than one match, list all matches.
7841 "list:full" When more than one match, list all matches and
7842 complete first match.
7843 "list:longest" When more than one match, list all matches and
7844 complete till longest common string.
7845 When there is only a single match, it is fully completed in all cases.
7846
7847 Examples: >
7848 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007849< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 :set wildmode=longest,full
7851< Complete longest common string, then each full match >
7852 :set wildmode=list:full
7853< List all matches and complete each full match >
7854 :set wildmode=list,full
7855< List all matches without completing, then each full match >
7856 :set wildmode=longest,list
7857< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007858 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007860 *'wildoptions'* *'wop'*
7861'wildoptions' 'wop' string (default "")
7862 global
7863 {not in Vi}
7864 {not available when compiled without the |+wildignore|
7865 feature}
7866 A list of words that change how command line completion is done.
7867 Currently only one word is allowed:
7868 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007869 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007870 is displayed per line. Often used tag kinds are:
7871 d #define
7872 f function
7873 Also see |cmdline-completion|.
7874
Bram Moolenaar071d4272004-06-13 20:20:40 +00007875 *'winaltkeys'* *'wak'*
7876'winaltkeys' 'wak' string (default "menu")
7877 global
7878 {not in Vi}
7879 {only used in Win32, Motif, GTK and Photon GUI}
7880 Some GUI versions allow the access to menu entries by using the ALT
7881 key in combination with a character that appears underlined in the
7882 menu. This conflicts with the use of the ALT key for mappings and
7883 entering special characters. This option tells what to do:
7884 no Don't use ALT keys for menus. ALT key combinations can be
7885 mapped, but there is no automatic handling. This can then be
7886 done with the |:simalt| command.
7887 yes ALT key handling is done by the windowing system. ALT key
7888 combinations cannot be mapped.
7889 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007890 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007891 keys can be mapped.
7892 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7893 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007894 This option is not used for <F10>; on Win32 and with GTK <F10> will
7895 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007896
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007897 *'window'* *'wi'*
7898'window' 'wi' number (default screen height - 1)
7899 global
7900 Window height. Do not confuse this with the height of the Vim window,
7901 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007902 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7903 value is smaller than 'lines' minus one. The screen will scroll
7904 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007905 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7906 in a much smarter way, taking care of wrapping lines.
7907 When resizing the Vim window, the value is smaller than 1 or more than
7908 or equal to 'lines' it will be set to 'lines' minus 1.
7909 {Vi also uses the option to specify the number of displayed lines}
7910
Bram Moolenaar071d4272004-06-13 20:20:40 +00007911 *'winheight'* *'wh'* *E591*
7912'winheight' 'wh' number (default 1)
7913 global
7914 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007915 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 feature}
7917 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007918 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007919 focus goes to a window that is smaller, its size is increased, at the
7920 cost of the height of other windows.
7921 Set 'winheight' to a small number for normal editing.
7922 Set it to 999 to make the current window fill most of the screen.
7923 Other windows will be only 'winminheight' high. This has the drawback
7924 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7925 to create only two windows, set the option after startup is done,
7926 using the |VimEnter| event: >
7927 au VimEnter * set winheight=999
7928< Minimum value is 1.
7929 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007930 height of the current window.
7931 'winheight' applies to the current window. Use 'winminheight' to set
7932 the minimal height for other windows.
7933
7934 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7935'winfixheight' 'wfh' boolean (default off)
7936 local to window
7937 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007938 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 feature}
7940 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007941 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7942 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 The height may be changed anyway when running out of room.
7944
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007945 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7946'winfixwidth' 'wfw' boolean (default off)
7947 local to window
7948 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007949 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007950 feature}
7951 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007952 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007953 The width may be changed anyway when running out of room.
7954
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955 *'winminheight'* *'wmh'*
7956'winminheight' 'wmh' number (default 1)
7957 global
7958 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007959 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 feature}
7961 The minimal height of a window, when it's not the current window.
7962 This is a hard minimum, windows will never become smaller.
7963 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7964 status bar) if necessary. They will return to at least one line when
7965 they become active (since the cursor has to have somewhere to go.)
7966 Use 'winheight' to set the minimal height of the current window.
7967 This option is only checked when making a window smaller. Don't use a
7968 large number, it will cause errors when opening more than a few
7969 windows. A value of 0 to 3 is reasonable.
7970
7971 *'winminwidth'* *'wmw'*
7972'winminwidth' 'wmw' number (default 1)
7973 global
7974 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007975 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 feature}
7977 The minimal width of a window, when it's not the current window.
7978 This is a hard minimum, windows will never become smaller.
7979 When set to zero, windows may be "squashed" to zero columns (i.e. just
7980 a vertical separator) if necessary. They will return to at least one
7981 line when they become active (since the cursor has to have somewhere
7982 to go.)
7983 Use 'winwidth' to set the minimal width of the current window.
7984 This option is only checked when making a window smaller. Don't use a
7985 large number, it will cause errors when opening more than a few
7986 windows. A value of 0 to 12 is reasonable.
7987
7988 *'winwidth'* *'wiw'* *E592*
7989'winwidth' 'wiw' number (default 20)
7990 global
7991 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007992 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 feature}
7994 Minimal number of columns for the current window. This is not a hard
7995 minimum, Vim will use fewer columns if there is not enough room. If
7996 the current window is smaller, its size is increased, at the cost of
7997 the width of other windows. Set it to 999 to make the current window
7998 always fill the screen. Set it to a small number for normal editing.
7999 The width is not adjusted after one of the commands to change the
8000 width of the current window.
8001 'winwidth' applies to the current window. Use 'winminwidth' to set
8002 the minimal width for other windows.
8003
8004 *'wrap'* *'nowrap'*
8005'wrap' boolean (default on)
8006 local to window
8007 {not in Vi}
8008 This option changes how text is displayed. It doesn't change the text
8009 in the buffer, see 'textwidth' for that.
8010 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008011 displaying continues on the next line. When off lines will not wrap
8012 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 moved to a part that is not shown, the screen will scroll
8014 horizontally.
8015 The line will be broken in the middle of a word if necessary. See
8016 'linebreak' to get the break at a word boundary.
8017 To make scrolling horizontally a bit more useful, try this: >
8018 :set sidescroll=5
8019 :set listchars+=precedes:<,extends:>
8020< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008021 This option can't be set from a |modeline| when the 'diff' option is
8022 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023
8024 *'wrapmargin'* *'wm'*
8025'wrapmargin' 'wm' number (default 0)
8026 local to buffer
8027 Number of characters from the right window border where wrapping
8028 starts. When typing text beyond this limit, an <EOL> will be inserted
8029 and inserting continues on the next line.
8030 Options that add a margin, such as 'number' and 'foldcolumn', cause
8031 the text width to be further reduced. This is Vi compatible.
8032 When 'textwidth' is non-zero, this option is not used.
8033 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8034 and less usefully}
8035
8036 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8037'wrapscan' 'ws' boolean (default on) *E384* *E385*
8038 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008039 Searches wrap around the end of the file. Also applies to |]s| and
8040 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041
8042 *'write'* *'nowrite'*
8043'write' boolean (default on)
8044 global
8045 {not in Vi}
8046 Allows writing files. When not set, writing a file is not allowed.
8047 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008048 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 argument. Filtering text is still possible, even though this requires
8050 writing a temporary file.
8051
8052 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8053'writeany' 'wa' boolean (default off)
8054 global
8055 Allows writing to any file with no need for "!" override.
8056
8057 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8058'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8059 otherwise)
8060 global
8061 {not in Vi}
8062 Make a backup before overwriting a file. The backup is removed after
8063 the file was successfully written, unless the 'backup' option is
8064 also on. Reset this option if your file system is almost full. See
8065 |backup-table| for another explanation.
8066 When the 'backupskip' pattern matches, a backup is not made anyway.
8067 NOTE: This option is set to the default value when 'compatible' is
8068 set.
8069
8070 *'writedelay'* *'wd'*
8071'writedelay' 'wd' number (default 0)
8072 global
8073 {not in Vi}
8074 The number of microseconds to wait for each character sent to the
8075 screen. When non-zero, characters are sent to the terminal one by
8076 one. For MS-DOS pcterm this does not work. For debugging purposes.
8077
8078 vim:tw=78:ts=8:ft=help:norl: