blob: 63efd1c24b9e04c6163d8fc4413f823765d20ba1 [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*options.txt* For Vim version 7.3a. Last change: 2010 May 13
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 Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
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.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 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.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {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
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
1172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001453 You probably want to add this only temporarily,
1454 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001455 Only supported for GTK version 2 and later.
1456 Only available with the |+multi_byte| feature.
1457
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 exclude:{pattern}
1459 Defines a pattern that is matched against the name of
1460 the terminal 'term'. If there is a match, no
1461 connection will be made to the X server. This is
1462 useful in this situation:
1463 - Running Vim in a console.
1464 - $DISPLAY is set to start applications on another
1465 display.
1466 - You do not want to connect to the X server in the
1467 console, but do want this in a terminal emulator.
1468 To never connect to the X server use: >
1469 exclude:.*
1470< This has the same effect as using the |-X| argument.
1471 Note that when there is no connection to the X server
1472 the window title won't be restored and the clipboard
1473 cannot be accessed.
1474 The value of 'magic' is ignored, {pattern} is
1475 interpreted as if 'magic' was on.
1476 The rest of the option value will be used for
1477 {pattern}, this must be the last entry.
1478
1479 *'cmdheight'* *'ch'*
1480'cmdheight' 'ch' number (default 1)
1481 global
1482 {not in Vi}
1483 Number of screen lines to use for the command-line. Helps avoiding
1484 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001485 The value of this option is stored with the tab page, so that each tab
1486 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001487
1488 *'cmdwinheight'* *'cwh'*
1489'cmdwinheight' 'cwh' number (default 7)
1490 global
1491 {not in Vi}
1492 {not available when compiled without the |+vertsplit|
1493 feature}
1494 Number of screen lines to use for the command-line window. |cmdwin|
1495
1496 *'columns'* *'co'* *E594*
1497'columns' 'co' number (default 80 or terminal width)
1498 global
1499 {not in Vi}
1500 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001501 initialization and does not have to be set by hand. Also see
1502 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 When Vim is running in the GUI or in a resizable window, setting this
1504 option will cause the window size to be changed. When you only want
1505 to use the size for the GUI, put the command in your |gvimrc| file.
1506 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001507 number of columns of the display, the display may be messed up. For
1508 the GUI it is always possible and Vim limits the number of columns to
1509 what fits on the screen. You can use this command to get the widest
1510 window possible: >
1511 :set columns=9999
1512< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513
1514 *'comments'* *'com'* *E524* *E525*
1515'comments' 'com' string (default
1516 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1517 local to buffer
1518 {not in Vi}
1519 {not available when compiled without the |+comments|
1520 feature}
1521 A comma separated list of strings that can start a comment line. See
1522 |format-comments|. See |option-backslash| about using backslashes to
1523 insert a space.
1524
1525 *'commentstring'* *'cms'* *E537*
1526'commentstring' 'cms' string (default "/*%s*/")
1527 local to buffer
1528 {not in Vi}
1529 {not available when compiled without the |+folding|
1530 feature}
1531 A template for a comment. The "%s" in the value is replaced with the
1532 comment text. Currently only used to add markers for folding, see
1533 |fold-marker|.
1534
1535 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001536'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1537 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 global
1539 {not in Vi}
1540 This option has the effect of making Vim either more Vi-compatible, or
1541 make Vim behave in a more useful way.
1542 This is a special kind of option, because when it's set or reset,
1543 other options are also changed as a side effect. CAREFUL: Setting or
1544 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001545 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546 set this option in your vimrc file, you should probably put it at the
1547 very start.
1548 By default this option is on and the Vi defaults are used for the
1549 options. This default was chosen for those people who want to use Vim
1550 just like Vi, and don't even (want to) know about the 'compatible'
1551 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001552 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001553 this option is switched off, and all options that have not been
1554 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001555 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001556 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001557 happen for the system-wide vimrc or gvimrc file, nor for a file given
1558 with the |-u| argument). Also see |compatible-default| and
1559 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 You can also set this option with the "-C" argument, and reset it with
1561 "-N". See |-C| and |-N|.
1562 Switching this option off makes the Vim defaults be used for options
1563 that have a different Vi and Vim default value. See the options
1564 marked with a '+' below. Other options are not modified.
1565 At the moment this option is set, several other options will be set
1566 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 editing.
1569 See also 'cpoptions'.
1570
1571 option + set value effect ~
1572
1573 'allowrevins' off no CTRL-_ command
1574 'backupcopy' Unix: "yes" backup file is a copy
1575 others: "auto" copy or rename backup file
1576 'backspace' "" normal backspace
1577 'backup' off no backup file
1578 'cindent' off no C code indentation
1579 'cedit' + "" no key to open the |cmdwin|
1580 'cpoptions' + (all flags) Vi-compatible flags
1581 'cscopetag' off don't use cscope for ":tag"
1582 'cscopetagorder' 0 see |cscopetagorder|
1583 'cscopeverbose' off see |cscopeverbose|
1584 'digraph' off no digraphs
1585 'esckeys' + off no <Esc>-keys in Insert mode
1586 'expandtab' off tabs not expanded to spaces
1587 'fileformats' + "" no automatic file format detection,
1588 "dos,unix" except for DOS, Windows and OS/2
1589 'formatoptions' + "vt" Vi compatible formatting
1590 'gdefault' off no default 'g' flag for ":s"
1591 'history' + 0 no commandline history
1592 'hkmap' off no Hebrew keyboard mapping
1593 'hkmapp' off no phonetic Hebrew keyboard mapping
1594 'hlsearch' off no highlighting of search matches
1595 'incsearch' off no incremental searching
1596 'indentexpr' "" no indenting by expression
1597 'insertmode' off do not start in Insert mode
1598 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1599 characters and '_'
1600 'joinspaces' on insert 2 spaces after period
1601 'modeline' + off no modelines
1602 'more' + off no pauses in listings
1603 'revins' off no reverse insert
1604 'ruler' off no ruler
1605 'scrolljump' 1 no jump scroll
1606 'scrolloff' 0 no scroll offset
1607 'shiftround' off indent not rounded to shiftwidth
1608 'shortmess' + "" no shortening of messages
1609 'showcmd' + off command characters not shown
1610 'showmode' + off current mode not shown
1611 'smartcase' off no automatic ignore case switch
1612 'smartindent' off no smart indentation
1613 'smarttab' off no smart tab size
1614 'softtabstop' 0 tabs are always 'tabstop' positions
1615 'startofline' on goto startofline with some commands
1616 'tagrelative' + off tag file names are not relative
1617 'textauto' + off no automatic textmode detection
1618 'textwidth' 0 no automatic line wrap
1619 'tildeop' off tilde is not an operator
1620 'ttimeout' off no terminal timeout
1621 'whichwrap' + "" left-right movements don't wrap
1622 'wildchar' + CTRL-E only when the current value is <Tab>
1623 use CTRL-E for cmdline completion
1624 'writebackup' on or off depends on +writebackup feature
1625
1626 *'complete'* *'cpt'* *E535*
1627'complete' 'cpt' string (default: ".,w,b,u,t,i")
1628 local to buffer
1629 {not in Vi}
1630 This option specifies how keyword completion |ins-completion| works
1631 when CTRL-P or CTRL-N are used. It is also used for whole-line
1632 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1633 and the places to scan. It is a comma separated list of flags:
1634 . scan the current buffer ('wrapscan' is ignored)
1635 w scan buffers from other windows
1636 b scan other loaded buffers that are in the buffer list
1637 u scan the unloaded buffers that are in the buffer list
1638 U scan the buffers that are not in the buffer list
1639 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001640 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 k{dict} scan the file {dict}. Several "k" flags can be given,
1642 patterns are valid too. For example: >
1643 :set cpt=k/usr/dict/*,k~/spanish
1644< s scan the files given with the 'thesaurus' option
1645 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1646 are valid too.
1647 i scan current and included files
1648 d scan current and included files for defined name or macro
1649 |i_CTRL-X_CTRL-D|
1650 ] tag completion
1651 t same as "]"
1652
1653 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1654 not executed, this may lead to unexpected completions from some files
1655 (gzipped files for example). Unloaded buffers are not scanned for
1656 whole-line completion.
1657
1658 The default is ".,w,b,u,t,i", which means to scan:
1659 1. the current buffer
1660 2. buffers in other windows
1661 3. other loaded buffers
1662 4. unloaded buffers
1663 5. tags
1664 6. included files
1665
1666 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001667 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1668 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001669
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001670 *'completefunc'* *'cfu'*
1671'completefunc' 'cfu' string (default: empty)
1672 local to buffer
1673 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001674 {not available when compiled without the +eval
1675 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001676 This option specifies a function to be used for Insert mode completion
1677 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001678 See |complete-functions| for an explanation of how the function is
1679 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001680
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001681
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001683'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001684 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001685 {not available when compiled without the
1686 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001687 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001688 A comma separated list of options for Insert mode completion
1689 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001690
1691 menu Use a popup menu to show the possible completions. The
1692 menu is only shown when there is more than one match and
1693 sufficient colors are available. |ins-completion-menu|
1694
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001696 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001697 match, e.g., what file it comes from.
1698
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001699 longest Only insert the longest common text of the matches. If
1700 the menu is displayed you can use CTRL-L to add more
1701 characters. Whether case is ignored depends on the kind
1702 of completion. For buffer text the 'ignorecase' option is
1703 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001704
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001706 completion in the preview window. Only works in
1707 combination with "menu" or "menuone".
1708
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001709
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1711'confirm' 'cf' boolean (default off)
1712 global
1713 {not in Vi}
1714 When 'confirm' is on, certain operations that would normally
1715 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1716 instead raise a |dialog| asking if you wish to save the current
1717 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1718 If 'confirm' is off you can still activate confirmation for one
1719 command only (this is most useful in mappings) with the |:confirm|
1720 command.
1721 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1722
1723 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1724'conskey' 'consk' boolean (default off)
1725 global
1726 {not in Vi} {only for MS-DOS}
1727 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001728 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 three methods of console input are available:
1730 'conskey' 'bioskey' action ~
1731 on on or off direct console input
1732 off on BIOS
1733 off off STDIN
1734
1735 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1736'copyindent' 'ci' boolean (default off)
1737 local to buffer
1738 {not in Vi}
1739 Copy the structure of the existing lines indent when autoindenting a
1740 new line. Normally the new indent is reconstructed by a series of
1741 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1742 in which case only spaces are used). Enabling this option makes the
1743 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001744 existing line. 'expandtab' has no effect on these characters, a Tab
1745 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 line, the remaining space is filled in the normal manner.
1747 NOTE: 'copyindent' is reset when 'compatible' is set.
1748 Also see 'preserveindent'.
1749
1750 *'cpoptions'* *'cpo'*
1751'cpoptions' 'cpo' string (Vim default: "aABceFs",
1752 Vi default: all flags)
1753 global
1754 {not in Vi}
1755 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001756 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 not being vi-compatible is mostly or sometimes preferred.
1758 'cpoptions' stands for "compatible-options".
1759 Commas can be added for readability.
1760 To avoid problems with flags that are added in the future, use the
1761 "+=" and "-=" feature of ":set" |add-option-flags|.
1762 NOTE: This option is set to the Vi default value when 'compatible' is
1763 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001764 NOTE: This option is set to the POSIX default value at startup when
1765 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001766 variable exists |posix|. This means Vim tries to behave like the
1767 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768
1769 contains behavior ~
1770 *cpo-a*
1771 a When included, a ":read" command with a file name
1772 argument will set the alternate file name for the
1773 current window.
1774 *cpo-A*
1775 A When included, a ":write" command with a file name
1776 argument will set the alternate file name for the
1777 current window.
1778 *cpo-b*
1779 b "\|" in a ":map" command is recognized as the end of
1780 the map command. The '\' is included in the mapping,
1781 the text after the '|' is interpreted as the next
1782 command. Use a CTRL-V instead of a backslash to
1783 include the '|' in the mapping. Applies to all
1784 mapping, abbreviation, menu and autocmd commands.
1785 See also |map_bar|.
1786 *cpo-B*
1787 B A backslash has no special meaning in mappings,
1788 abbreviations and the "to" part of the menu commands.
1789 Remove this flag to be able to use a backslash like a
1790 CTRL-V. For example, the command ":map X \<Esc>"
1791 results in X being mapped to:
1792 'B' included: "\^[" (^[ is a real <Esc>)
1793 'B' excluded: "<Esc>" (5 characters)
1794 ('<' excluded in both cases)
1795 *cpo-c*
1796 c Searching continues at the end of any match at the
1797 cursor position, but not further than the start of the
1798 next line. When not present searching continues
1799 one character from the cursor position. With 'c'
1800 "abababababab" only gets three matches when repeating
1801 "/abab", without 'c' there are five matches.
1802 *cpo-C*
1803 C Do not concatenate sourced lines that start with a
1804 backslash. See |line-continuation|.
1805 *cpo-d*
1806 d Using "./" in the 'tags' option doesn't mean to use
1807 the tags file relative to the current file, but the
1808 tags file in the current directory.
1809 *cpo-D*
1810 D Can't use CTRL-K to enter a digraph after Normal mode
1811 commands with a character argument, like |r|, |f| and
1812 |t|.
1813 *cpo-e*
1814 e When executing a register with ":@r", always add a
1815 <CR> to the last line, also when the register is not
1816 linewise. If this flag is not present, the register
1817 is not linewise and the last line does not end in a
1818 <CR>, then the last line is put on the command-line
1819 and can be edited before hitting <CR>.
1820 *cpo-E*
1821 E It is an error when using "y", "d", "c", "g~", "gu" or
1822 "gU" on an Empty region. The operators only work when
1823 at least one character is to be operate on. Example:
1824 This makes "y0" fail in the first column.
1825 *cpo-f*
1826 f When included, a ":read" command with a file name
1827 argument will set the file name for the current buffer,
1828 if the current buffer doesn't have a file name yet.
1829 *cpo-F*
1830 F When included, a ":write" command with a file name
1831 argument will set the file name for the current
1832 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001833 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001834 *cpo-g*
1835 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001836 *cpo-H*
1837 H When using "I" on a line with only blanks, insert
1838 before the last blank. Without this flag insert after
1839 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 *cpo-i*
1841 i When included, interrupting the reading of a file will
1842 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001843 *cpo-I*
1844 I When moving the cursor up or down just after inserting
1845 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 *cpo-j*
1847 j When joining lines, only add two spaces after a '.',
1848 not after '!' or '?'. Also see 'joinspaces'.
1849 *cpo-J*
1850 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001851 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001852 white space.
1853 *cpo-k*
1854 k Disable the recognition of raw key codes in
1855 mappings, abbreviations, and the "to" part of menu
1856 commands. For example, if <Key> sends ^[OA (where ^[
1857 is <Esc>), the command ":map X ^[OA" results in X
1858 being mapped to:
1859 'k' included: "^[OA" (3 characters)
1860 'k' excluded: "<Key>" (one key code)
1861 Also see the '<' flag below.
1862 *cpo-K*
1863 K Don't wait for a key code to complete when it is
1864 halfway a mapping. This breaks mapping <F1><F1> when
1865 only part of the second <F1> has been read. It
1866 enables cancelling the mapping by typing <F1><Esc>.
1867 *cpo-l*
1868 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001869 literally, only "\]", "\^", "\-" and "\\" are special.
1870 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1872 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001873 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 *cpo-L*
1875 L When the 'list' option is set, 'wrapmargin',
1876 'textwidth', 'softtabstop' and Virtual Replace mode
1877 (see |gR|) count a <Tab> as two characters, instead of
1878 the normal behavior of a <Tab>.
1879 *cpo-m*
1880 m When included, a showmatch will always wait half a
1881 second. When not included, a showmatch will wait half
1882 a second or until a character is typed. |'showmatch'|
1883 *cpo-M*
1884 M When excluded, "%" matching will take backslashes into
1885 account. Thus in "( \( )" and "\( ( \)" the outer
1886 parenthesis match. When included "%" ignores
1887 backslashes, which is Vi compatible.
1888 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001889 n When included, the column used for 'number' and
1890 'relativenumber' will also be used for text of wrapped
1891 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 *cpo-o*
1893 o Line offset to search command is not remembered for
1894 next search.
1895 *cpo-O*
1896 O Don't complain if a file is being overwritten, even
1897 when it didn't exist when editing it. This is a
1898 protection against a file unexpectedly created by
1899 someone else. Vi didn't complain about this.
1900 *cpo-p*
1901 p Vi compatible Lisp indenting. When not present, a
1902 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001903 *cpo-P*
1904 P When included, a ":write" command that appends to a
1905 file will set the file name for the current buffer, if
1906 the current buffer doesn't have a file name yet and
1907 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001908 *cpo-q*
1909 q When joining multiple lines leave the cursor at the
1910 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 *cpo-r*
1912 r Redo ("." command) uses "/" to repeat a search
1913 command, instead of the actually used search string.
1914 *cpo-R*
1915 R Remove marks from filtered lines. Without this flag
1916 marks are kept like |:keepmarks| was used.
1917 *cpo-s*
1918 s Set buffer options when entering the buffer for the
1919 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001920 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 set when the buffer is created.
1922 *cpo-S*
1923 S Set buffer options always when entering a buffer
1924 (except 'readonly', 'fileformat', 'filetype' and
1925 'syntax'). This is the (most) Vi compatible setting.
1926 The options are set to the values in the current
1927 buffer. When you change an option and go to another
1928 buffer, the value is copied. Effectively makes the
1929 buffer options global to all buffers.
1930
1931 's' 'S' copy buffer options
1932 no no when buffer created
1933 yes no when buffer first entered (default)
1934 X yes each time when buffer entered (vi comp.)
1935 *cpo-t*
1936 t Search pattern for the tag command is remembered for
1937 "n" command. Otherwise Vim only puts the pattern in
1938 the history for search pattern, but doesn't change the
1939 last used search pattern.
1940 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001941 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 *cpo-v*
1943 v Backspaced characters remain visible on the screen in
1944 Insert mode. Without this flag the characters are
1945 erased from the screen right away. With this flag the
1946 screen newly typed text overwrites backspaced
1947 characters.
1948 *cpo-w*
1949 w When using "cw" on a blank character, only change one
1950 character and not all blanks until the start of the
1951 next word.
1952 *cpo-W*
1953 W Don't overwrite a readonly file. When omitted, ":w!"
1954 overwrites a readonly file, if possible.
1955 *cpo-x*
1956 x <Esc> on the command-line executes the command-line.
1957 The default in Vim is to abandon the command-line,
1958 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001959 *cpo-X*
1960 X When using a count with "R" the replaced text is
1961 deleted only once. Also when repeating "R" with "."
1962 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 *cpo-y*
1964 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001965 *cpo-Z*
1966 Z When using "w!" while the 'readonly' option is set,
1967 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 *cpo-!*
1969 ! When redoing a filter command, use the last used
1970 external command, whatever it was. Otherwise the last
1971 used -filter- command is used.
1972 *cpo-$*
1973 $ When making a change to one line, don't redisplay the
1974 line, but put a '$' at the end of the changed text.
1975 The changed text will be overwritten when you type the
1976 new text. The line is redisplayed if you type any
1977 command that moves the cursor from the insertion
1978 point.
1979 *cpo-%*
1980 % Vi-compatible matching is done for the "%" command.
1981 Does not recognize "#if", "#endif", etc.
1982 Does not recognize "/*" and "*/".
1983 Parens inside single and double quotes are also
1984 counted, causing a string that contains a paren to
1985 disturb the matching. For example, in a line like
1986 "if (strcmp("foo(", s))" the first paren does not
1987 match the last one. When this flag is not included,
1988 parens inside single and double quotes are treated
1989 specially. When matching a paren outside of quotes,
1990 everything inside quotes is ignored. When matching a
1991 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001992 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001993 This flag is also used for other features, such as
1994 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001995 *cpo--*
1996 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001997 it would go above the first line or below the last
1998 line. Without it the cursor moves to the first or
1999 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002000 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002001 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002002 *cpo-+*
2003 + When included, a ":write file" command will reset the
2004 'modified' flag of the buffer, even though the buffer
2005 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002006 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 * Use ":*" in the same way as ":@". When not included,
2008 ":*" is an alias for ":'<,'>", select the Visual area.
2009 *cpo-<*
2010 < Disable the recognition of special key codes in |<>|
2011 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002012 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 ":map X <Tab>" results in X being mapped to:
2014 '<' included: "<Tab>" (5 characters)
2015 '<' excluded: "^I" (^I is a real <Tab>)
2016 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002017 *cpo->*
2018 > When appending to a register, put a line break before
2019 the appended text.
2020
2021 POSIX flags. These are not included in the Vi default value, except
2022 when $VIM_POSIX was set on startup. |posix|
2023
2024 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002025 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002026 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002027 *cpo-&*
2028 & When ":preserve" was used keep the swap file when
2029 exiting normally while this buffer is still loaded.
2030 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002031 *cpo-\*
2032 \ Backslash in a [] range in a search pattern is taken
2033 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002034 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2035 '\' excluded: "/[ \-]" finds <Space> and '-'
2036 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002037 *cpo-/*
2038 / When "%" is used as the replacement string in a |:s|
2039 command, use the previous replacement string. |:s%|
2040 *cpo-{*
2041 { The |{| and |}| commands also stop at a "{" character
2042 at the start of a line.
2043 *cpo-.*
2044 . The ":chdir" and ":cd" commands fail if the current
2045 buffer is modified, unless ! is used. Vim doesn't
2046 need this, since it remembers the full path of an
2047 opened file.
2048 *cpo-bar*
2049 | The value of the $LINES and $COLUMNS environment
2050 variables overrule the terminal size values obtained
2051 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002052
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002054 *'cryptmethod'* *'cm'*
2055'cryptmethod' number (default 0)
2056 local to buffer
2057 {not in Vi}
2058 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002059 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002060 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002061 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002062 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002063 1 Blowfish method. Strong encryption. Requires Vim 7.3
2064 or later, files can NOT be read by Vim 7.2 and older.
2065 This adds a "seed" to the file, every time you write
2066 the file the encrypted bytes will be different.
2067
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002068 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002069 to the detected method of the file being read. Thus if you write it
2070 without changing 'cryptmethod' the same method will be used.
2071 Changing 'cryptmethod' does not mark the file as modified, you have to
2072 explicitly write it when not making modifications.
2073 Also see |:X|.
2074 When a new encryption method is added in a later version of Vim, and
2075 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002076
2077
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 *'cscopepathcomp'* *'cspc'*
2079'cscopepathcomp' 'cspc' number (default 0)
2080 global
2081 {not available when compiled without the |+cscope|
2082 feature}
2083 {not in Vi}
2084 Determines how many components of the path to show in a list of tags.
2085 See |cscopepathcomp|.
2086
2087 *'cscopeprg'* *'csprg'*
2088'cscopeprg' 'csprg' string (default "cscope")
2089 global
2090 {not available when compiled without the |+cscope|
2091 feature}
2092 {not in Vi}
2093 Specifies the command to execute cscope. See |cscopeprg|.
2094 This option cannot be set from a |modeline| or in the |sandbox|, for
2095 security reasons.
2096
2097 *'cscopequickfix'* *'csqf'*
2098'cscopequickfix' 'csqf' string (default "")
2099 global
2100 {not available when compiled without the |+cscope|
2101 or |+quickfix| features}
2102 {not in Vi}
2103 Specifies whether to use quickfix window to show cscope results.
2104 See |cscopequickfix|.
2105
2106 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2107'cscopetag' 'cst' boolean (default off)
2108 global
2109 {not available when compiled without the |+cscope|
2110 feature}
2111 {not in Vi}
2112 Use cscope for tag commands. See |cscope-options|.
2113 NOTE: This option is reset when 'compatible' is set.
2114
2115 *'cscopetagorder'* *'csto'*
2116'cscopetagorder' 'csto' number (default 0)
2117 global
2118 {not available when compiled without the |+cscope|
2119 feature}
2120 {not in Vi}
2121 Determines the order in which ":cstag" performs a search. See
2122 |cscopetagorder|.
2123 NOTE: This option is set to 0 when 'compatible' is set.
2124
2125 *'cscopeverbose'* *'csverb'*
2126 *'nocscopeverbose'* *'nocsverb'*
2127'cscopeverbose' 'csverb' boolean (default off)
2128 global
2129 {not available when compiled without the |+cscope|
2130 feature}
2131 {not in Vi}
2132 Give messages when adding a cscope database. See |cscopeverbose|.
2133 NOTE: This option is reset when 'compatible' is set.
2134
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002135
2136 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2137'cursorcolumn' 'cuc' boolean (default off)
2138 local to window
2139 {not in Vi}
2140 {not available when compiled without the |+syntax|
2141 feature}
2142 Highlight the screen column of the cursor with CursorColumn
2143 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2144 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002145 If you only want the highlighting in the current window you can use
2146 these autocommands: >
2147 au WinLeave * set nocursorline nocursorcolumn
2148 au WinEnter * set cursorline cursorcolumn
2149<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002150
2151 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2152'cursorline' 'cul' boolean (default off)
2153 local to window
2154 {not in Vi}
2155 {not available when compiled without the |+syntax|
2156 feature}
2157 Highlight the screen line of the cursor with CursorLine
2158 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2159 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002160 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002161 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002162
2163
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 *'debug'*
2165'debug' string (default "")
2166 global
2167 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002168 These values can be used:
2169 msg Error messages that would otherwise be omitted will be given
2170 anyway.
2171 throw Error messages that would otherwise be omitted will be given
2172 anyway and also throw an exception and set |v:errmsg|.
2173 beep A message will be given when otherwise only a beep would be
2174 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002175 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002176 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2177 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
2179 *'define'* *'def'*
2180'define' 'def' string (default "^\s*#\s*define")
2181 global or local to buffer |global-local|
2182 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002183 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 pattern, just like for the "/" command. This option is used for the
2185 commands like "[i" and "[d" |include-search|. The 'isident' option is
2186 used to recognize the defined name after the match:
2187 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2188 See |option-backslash| about inserting backslashes to include a space
2189 or backslash.
2190 The default value is for C programs. For C++ this value would be
2191 useful, to include const type declarations: >
2192 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2193< When using the ":set" command, you need to double the backslashes!
2194
2195 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2196'delcombine' 'deco' boolean (default off)
2197 global
2198 {not in Vi}
2199 {only available when compiled with the |+multi_byte|
2200 feature}
2201 If editing Unicode and this option is set, backspace and Normal mode
2202 "x" delete each combining character on its own. When it is off (the
2203 default) the character along with its combining characters are
2204 deleted.
2205 Note: When 'delcombine' is set "xx" may work different from "2x"!
2206
2207 This is useful for Arabic, Hebrew and many other languages where one
2208 may have combining characters overtop of base characters, and want
2209 to remove only the combining ones.
2210
2211 *'dictionary'* *'dict'*
2212'dictionary' 'dict' string (default "")
2213 global or local to buffer |global-local|
2214 {not in Vi}
2215 List of file names, separated by commas, that are used to lookup words
2216 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2217 contain a list of words. This can be one word per line, or several
2218 words per line, separated by non-keyword characters (white space is
2219 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002220 When this option is empty, or an entry "spell" is present, spell
2221 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002222 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 after a comma are ignored, otherwise spaces are included in the file
2224 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002225 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 Where to find a list of words?
2227 - On FreeBSD, there is the file "/usr/share/dict/words".
2228 - In the Simtel archive, look in the "msdos/linguist" directory.
2229 - In "miscfiles" of the GNU collection.
2230 The use of |:set+=| and |:set-=| is preferred when adding or removing
2231 directories from the list. This avoids problems when a future version
2232 uses another default.
2233 Backticks cannot be used in this option for security reasons.
2234
2235 *'diff'* *'nodiff'*
2236'diff' boolean (default off)
2237 local to window
2238 {not in Vi}
2239 {not available when compiled without the |+diff|
2240 feature}
2241 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002242 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243
2244 *'dex'* *'diffexpr'*
2245'diffexpr' 'dex' string (default "")
2246 global
2247 {not in Vi}
2248 {not available when compiled without the |+diff|
2249 feature}
2250 Expression which is evaluated to obtain an ed-style diff file from two
2251 versions of a file. See |diff-diffexpr|.
2252 This option cannot be set from a |modeline| or in the |sandbox|, for
2253 security reasons.
2254
2255 *'dip'* *'diffopt'*
2256'diffopt' 'dip' string (default "filler")
2257 global
2258 {not in Vi}
2259 {not available when compiled without the |+diff|
2260 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002261 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262 All are optional. Items must be separated by a comma.
2263
2264 filler Show filler lines, to keep the text
2265 synchronized with a window that has inserted
2266 lines at the same position. Mostly useful
2267 when windows are side-by-side and 'scrollbind'
2268 is set.
2269
2270 context:{n} Use a context of {n} lines between a change
2271 and a fold that contains unchanged lines.
2272 When omitted a context of six lines is used.
2273 See |fold-diff|.
2274
2275 icase Ignore changes in case of text. "a" and "A"
2276 are considered the same. Adds the "-i" flag
2277 to the "diff" command if 'diffexpr' is empty.
2278
2279 iwhite Ignore changes in amount of white space. Adds
2280 the "-b" flag to the "diff" command if
2281 'diffexpr' is empty. Check the documentation
2282 of the "diff" command for what this does
2283 exactly. It should ignore adding trailing
2284 white space, but not leading white space.
2285
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002286 horizontal Start diff mode with horizontal splits (unless
2287 explicitly specified otherwise).
2288
2289 vertical Start diff mode with vertical splits (unless
2290 explicitly specified otherwise).
2291
2292 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2293 starting diff mode. Without this 2 is used.
2294
Bram Moolenaar071d4272004-06-13 20:20:40 +00002295 Examples: >
2296
2297 :set diffopt=filler,context:4
2298 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002299 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300<
2301 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2302'digraph' 'dg' boolean (default off)
2303 global
2304 {not in Vi}
2305 {not available when compiled without the |+digraphs|
2306 feature}
2307 Enable the entering of digraphs in Insert mode with {char1} <BS>
2308 {char2}. See |digraphs|.
2309 NOTE: This option is reset when 'compatible' is set.
2310
2311 *'directory'* *'dir'*
2312'directory' 'dir' string (default for Amiga: ".,t:",
2313 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2314 for Unix: ".,~/tmp,/var/tmp,/tmp")
2315 global
2316 List of directory names for the swap file, separated with commas.
2317 - The swap file will be created in the first directory where this is
2318 possible.
2319 - Empty means that no swap file will be used (recovery is
2320 impossible!).
2321 - A directory "." means to put the swap file in the same directory as
2322 the edited file. On Unix, a dot is prepended to the file name, so
2323 it doesn't show in a directory listing. On MS-Windows the "hidden"
2324 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002325 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 put the swap file relative to where the edited file is. The leading
2327 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002328 - For Unix and Win32, if a directory ends in two path separators "//"
2329 or "\\", the swap file name will be built from the complete path to
2330 the file with all path separators substituted to percent '%' signs.
2331 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002332 On Win32, when a separating comma is following, you must use "//",
2333 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 - Spaces after the comma are ignored, other spaces are considered part
2335 of the directory name. To have a space at the start of a directory
2336 name, precede it with a backslash.
2337 - To include a comma in a directory name precede it with a backslash.
2338 - A directory name may end in an ':' or '/'.
2339 - Environment variables are expanded |:set_env|.
2340 - Careful with '\' characters, type one before a space, type two to
2341 get one in the option (see |option-backslash|), for example: >
2342 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2343< - For backwards compatibility with Vim version 3.0 a '>' at the start
2344 of the option is removed.
2345 Using "." first in the list is recommended. This means that editing
2346 the same file twice will result in a warning. Using "/tmp" on Unix is
2347 discouraged: When the system crashes you lose the swap file.
2348 "/var/tmp" is often not cleared when rebooting, thus is a better
2349 choice than "/tmp". But it can contain a lot of files, your swap
2350 files get lost in the crowd. That is why a "tmp" directory in your
2351 home directory is tried first.
2352 The use of |:set+=| and |:set-=| is preferred when adding or removing
2353 directories from the list. This avoids problems when a future version
2354 uses another default.
2355 This option cannot be set from a |modeline| or in the |sandbox|, for
2356 security reasons.
2357 {Vi: directory to put temp file in, defaults to "/tmp"}
2358
2359 *'display'* *'dy'*
2360'display' 'dy' string (default "")
2361 global
2362 {not in Vi}
2363 Change the way text is displayed. This is comma separated list of
2364 flags:
2365 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002366 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 last line that doesn't fit is replaced with "@" lines.
2368 uhex Show unprintable characters hexadecimal as <xx>
2369 instead of using ^C and ~C.
2370
2371 *'eadirection'* *'ead'*
2372'eadirection' 'ead' string (default "both")
2373 global
2374 {not in Vi}
2375 {not available when compiled without the +vertsplit
2376 feature}
2377 Tells when the 'equalalways' option applies:
2378 ver vertically, width of windows is not affected
2379 hor horizontally, height of windows is not affected
2380 both width and height of windows is affected
2381
2382 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2383'edcompatible' 'ed' boolean (default off)
2384 global
2385 Makes the 'g' and 'c' flags of the ":substitute" command to be
2386 toggled each time the flag is given. See |complex-change|. See
2387 also 'gdefault' option.
2388 Switching this option on is discouraged!
2389
2390 *'encoding'* *'enc'* *E543*
2391'encoding' 'enc' string (default: "latin1" or value from $LANG)
2392 global
2393 {only available when compiled with the |+multi_byte|
2394 feature}
2395 {not in Vi}
2396 Sets the character encoding used inside Vim. It applies to text in
2397 the buffers, registers, Strings in expressions, text stored in the
2398 viminfo file, etc. It sets the kind of characters which Vim can work
2399 with. See |encoding-names| for the possible values.
2400
2401 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002402 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002404 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405
2406 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2407 "utf-8". Although care has been taken to allow different values of
2408 'encoding', "utf-8" is the natural choice for the environment and
2409 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 versions, and to avoid changing the encoding of newly created files
2412 without your knowledge (in case 'fileencodings' is empty).
2413
2414 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002415 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 iconv() or as specified with 'charconvert'.
2417
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002418 If you need to know whether 'encoding' is a multi-byte encoding, you
2419 can use: >
2420 if has("multi_byte_encoding")
2421<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 Normally 'encoding' will be equal to your current locale. This will
2423 be the default if Vim recognizes your environment settings. If
2424 'encoding' is not set to the current locale, 'termencoding' must be
2425 set to convert typed and displayed text. See |encoding-table|.
2426
2427 When you set this option, it fires the |EncodingChanged| autocommand
2428 event so that you can set up fonts if necessary.
2429
2430 When the option is set, the value is converted to lowercase. Thus
2431 you can set it with uppercase values too. Underscores are translated
2432 to '-' signs.
2433 When the encoding is recognized, it is changed to the standard name.
2434 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2435 "iso-8859-2" and "utf8" becomes "utf-8".
2436
2437 Note: "latin1" is also used when the encoding could not be detected.
2438 This only works when editing files in the same encoding! When the
2439 actual character set is not latin1, make sure 'fileencoding' and
2440 'fileencodings' are empty. When conversion is needed, switch to using
2441 utf-8.
2442
2443 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2444 You don't notice this while editing, but it does matter for the
2445 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2446 setting 'encoding' to one of these values instead of utf-8 only has
2447 effect for encoding used for files when 'fileencoding' is empty.
2448
Bram Moolenaar661b1822005-07-28 22:36:45 +00002449 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2450 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451
2452 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2453'endofline' 'eol' boolean (default on)
2454 local to buffer
2455 {not in Vi}
2456 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 option is automatically set when starting to edit a new file, unless
2459 the file does not have an <EOL> for the last line in the file, in
2460 which case it is reset. Normally you don't have to set or reset this
2461 option. When 'binary' is off the value is not used when writing the
2462 file. When 'binary' is on it is used to remember the presence of a
2463 <EOL> for the last line in the file, so that when you write the file
2464 the situation from the original file can be kept. But you can change
2465 it if you want to.
2466
2467 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2468'equalalways' 'ea' boolean (default on)
2469 global
2470 {not in Vi}
2471 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002472 splitting or closing a window. This also happens the moment the
2473 option is switched on. When off, splitting a window will reduce the
2474 size of the current window and leave the other windows the same. When
2475 closing a window the extra lines are given to the window next to it
2476 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 When mixing vertically and horizontally split windows, a minimal size
2478 is computed and some windows may be larger if there is room. The
2479 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002480 Changing the height and width of a window can be avoided by setting
2481 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002482 If a window size is specified when creating a new window sizes are
2483 currently not equalized (it's complicated, but may be implemented in
2484 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485
2486 *'equalprg'* *'ep'*
2487'equalprg' 'ep' string (default "")
2488 global or local to buffer |global-local|
2489 {not in Vi}
2490 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002491 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002492 or 'indentexpr'. When Vim was compiled without internal formatting,
2493 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002494 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 about including spaces and backslashes.
2496 This option cannot be set from a |modeline| or in the |sandbox|, for
2497 security reasons.
2498
2499 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2500'errorbells' 'eb' boolean (default off)
2501 global
2502 Ring the bell (beep or screen flash) for error messages. This only
2503 makes a difference for error messages, the bell will be used always
2504 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002505 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 screen flash or do nothing.
2507
2508 *'errorfile'* *'ef'*
2509'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2510 others: "errors.err")
2511 global
2512 {not in Vi}
2513 {not available when compiled without the |+quickfix|
2514 feature}
2515 Name of the errorfile for the QuickFix mode (see |:cf|).
2516 When the "-q" command-line argument is used, 'errorfile' is set to the
2517 following argument. See |-q|.
2518 NOT used for the ":make" command. See 'makeef' for that.
2519 Environment variables are expanded |:set_env|.
2520 See |option-backslash| about including spaces and backslashes.
2521 This option cannot be set from a |modeline| or in the |sandbox|, for
2522 security reasons.
2523
2524 *'errorformat'* *'efm'*
2525'errorformat' 'efm' string (default is very long)
2526 global or local to buffer |global-local|
2527 {not in Vi}
2528 {not available when compiled without the |+quickfix|
2529 feature}
2530 Scanf-like description of the format for the lines in the error file
2531 (see |errorformat|).
2532
2533 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2534'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2535 global
2536 {not in Vi}
2537 Function keys that start with an <Esc> are recognized in Insert
2538 mode. When this option is off, the cursor and function keys cannot be
2539 used in Insert mode if they start with an <Esc>. The advantage of
2540 this is that the single <Esc> is recognized immediately, instead of
2541 after one second. Instead of resetting this option, you might want to
2542 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2543 when 'esckeys' is off, you can still map anything, but the cursor keys
2544 won't work by default.
2545 NOTE: This option is set to the Vi default value when 'compatible' is
2546 set and to the Vim default value when 'compatible' is reset.
2547
2548 *'eventignore'* *'ei'*
2549'eventignore' 'ei' string (default "")
2550 global
2551 {not in Vi}
2552 {not available when compiled without the |+autocmd|
2553 feature}
2554 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002555 When set to "all" or when "all" is one of the items, all autocommand
2556 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 Otherwise this is a comma separated list of event names. Example: >
2558 :set ei=WinEnter,WinLeave
2559<
2560 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2561'expandtab' 'et' boolean (default off)
2562 local to buffer
2563 {not in Vi}
2564 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002565 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2567 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2568 NOTE: This option is reset when 'compatible' is set.
2569
2570 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2571'exrc' 'ex' boolean (default off)
2572 global
2573 {not in Vi}
2574 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2575 directory. If you switch this option on you should also consider
2576 setting the 'secure' option (see |initialization|). Using a local
2577 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2578 also see |.vimrc| and |gui-init|.
2579 This option cannot be set from a |modeline| or in the |sandbox|, for
2580 security reasons.
2581
2582 *'fileencoding'* *'fenc'* *E213*
2583'fileencoding' 'fenc' string (default: "")
2584 local to buffer
2585 {only available when compiled with the |+multi_byte|
2586 feature}
2587 {not in Vi}
2588 Sets the character encoding for the file of this buffer.
2589 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002590 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 When 'fileencoding' is empty, the same value as 'encoding' will be
2592 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002593 Conversion will also be done when 'encoding' and 'fileencoding' are
2594 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2595 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002597 'encoding' is "utf-8" or another Unicode encoding, conversion
2598 is most likely done in a way that the reverse conversion
2599 results in the same text. When 'encoding' is not "utf-8" some
2600 characters may be lost!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 See 'encoding' for the possible values. Additionally, values may be
2602 specified that can be handled by the converter, see
2603 |mbyte-conversion|.
2604 When reading a file 'fileencoding' will be set from 'fileencodings'.
2605 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002606 'fileencoding', use the |++enc| argument. One exception: when
2607 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002608 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2610 When the option is set, the value is converted to lowercase. Thus
2611 you can set it with uppercase values too. '_' characters are
2612 replaced with '-'. If a name is recognized from the list for
2613 'encoding', it is replaced by the standard name. For example
2614 "ISO8859-2" becomes "iso-8859-2".
2615 When this option is set, after starting to edit a file, the 'modified'
2616 option is set, because the file would be different when written.
2617 If you do this in a modeline, you might want to set 'nomodified' to
2618 avoid this.
2619 This option can not be changed when 'modifiable' is off.
2620
2621 *'fe'*
2622 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002623 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 old short name was 'fe', which is no longer used.
2625
2626 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002627'fileencodings' 'fencs' string (default: "ucs-bom",
2628 "ucs-bom,utf-8,default,latin1" when
2629 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002630 global
2631 {only available when compiled with the |+multi_byte|
2632 feature}
2633 {not in Vi}
2634 This is a list of character encodings considered when starting to edit
2635 an existing file. When a file is read, Vim tries to use the first
2636 mentioned character encoding. If an error is detected, the next one
2637 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002638 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 an empty string, which means the value of 'encoding' is used.
2640 WARNING: Conversion can cause loss of information! When
2641 'encoding' is "utf-8" (or one of the other Unicode variants)
2642 conversion is most likely done in a way that the reverse
2643 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002644 "utf-8" some non-ASCII characters may be lost! You can use
2645 the |++bad| argument to specify what is done with characters
2646 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002647 For an empty file or a file with only ASCII characters most encodings
2648 will work and the first entry of 'fileencodings' will be used (except
2649 "ucs-bom", which requires the BOM to be present). If you prefer
2650 another encoding use an BufReadPost autocommand event to test if your
2651 preferred encoding is to be used. Example: >
2652 au BufReadPost * if search('\S', 'w') == 0 |
2653 \ set fenc=iso-2022-jp | endif
2654< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2655 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002656 When the |++enc| argument is used then the value of 'fileencodings' is
2657 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002658 Note that 'fileencodings' is not used for a new file, the global value
2659 of 'fileencoding' is used instead. You can set it with: >
2660 :setglobal fenc=iso-8859-2
2661< This means that a non-existing file may get a different encoding than
2662 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663 The special value "ucs-bom" can be used to check for a Unicode BOM
2664 (Byte Order Mark) at the start of the file. It must not be preceded
2665 by "utf-8" or another Unicode encoding for this to work properly.
2666 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2667 because Vim cannot detect an error, thus the encoding is always
2668 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002669 The special value "default" can be used for the encoding from the
2670 environment. This is the default value for 'encoding'. It is useful
2671 when 'encoding' is set to "utf-8" and your environment uses a
2672 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002673 When 'encoding' is "utf-8" and a file contains an illegal byte
2674 sequence it won't be recognized as UTF-8. You can use the |8g8|
2675 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676 WRONG VALUES: WHAT'S WRONG:
2677 latin1,utf-8 "latin1" will always be used
2678 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2679 file
2680 cp1250,latin1 "cp1250" will always be used
2681 If 'fileencodings' is empty, 'fileencoding' is not modified.
2682 See 'fileencoding' for the possible values.
2683 Setting this option does not have an effect until the next time a file
2684 is read.
2685
2686 *'fileformat'* *'ff'*
2687'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2688 Unix default: "unix",
2689 Macintosh default: "mac")
2690 local to buffer
2691 {not in Vi}
2692 This gives the <EOL> of the current buffer, which is used for
2693 reading/writing the buffer from/to a file:
2694 dos <CR> <NL>
2695 unix <NL>
2696 mac <CR>
2697 When "dos" is used, CTRL-Z at the end of a file is ignored.
2698 See |file-formats| and |file-read|.
2699 For the character encoding of the file see 'fileencoding'.
2700 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2701 works like it was set to "unix'.
2702 This option is set automatically when starting to edit a file and
2703 'fileformats' is not empty and 'binary' is off.
2704 When this option is set, after starting to edit a file, the 'modified'
2705 option is set, because the file would be different when written.
2706 This option can not be changed when 'modifiable' is off.
2707 For backwards compatibility: When this option is set to "dos",
2708 'textmode' is set, otherwise 'textmode' is reset.
2709
2710 *'fileformats'* *'ffs'*
2711'fileformats' 'ffs' string (default:
2712 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2713 Vim Unix: "unix,dos",
2714 Vim Mac: "mac,unix,dos",
2715 Vi Cygwin: "unix,dos",
2716 Vi others: "")
2717 global
2718 {not in Vi}
2719 This gives the end-of-line (<EOL>) formats that will be tried when
2720 starting to edit a new buffer and when reading a file into an existing
2721 buffer:
2722 - When empty, the format defined with 'fileformat' will be used
2723 always. It is not set automatically.
2724 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002725 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 'fileformats' name will be used when a file is read into an existing
2727 buffer, no matter what 'fileformat' for that buffer is set to.
2728 - When more than one name is present, separated by commas, automatic
2729 <EOL> detection will be done when reading a file. When starting to
2730 edit a file, a check is done for the <EOL>:
2731 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2732 'fileformat' is set to "dos".
2733 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002734 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 preceding <CR>, "unix" is preferred over "dos".
2736 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2737 This means that "mac" is only chosen when "unix" is not present,
2738 or when no <NL> is found in the file, and when "dos" is not
2739 present, or no <CR><NL> is present in the file.
2740 Also if "unix" was first chosen, but the first <CR> is before
2741 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2742 the file, then 'fileformat' is set to "mac".
2743 4. If 'fileformat' is still not set, the first name from
2744 'fileformats' is used.
2745 When reading a file into an existing buffer, the same is done, but
2746 this happens like 'fileformat' has been set appropriately for that
2747 file only, the option is not changed.
2748 When 'binary' is set, the value of 'fileformats' is not used.
2749
2750 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2751 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2752 done:
2753 - When 'fileformats' is empty, there is no automatic detection. Dos
2754 format will be used.
2755 - When 'fileformats' is set to one or more names, automatic detection
2756 is done. This is based on the first <NL> in the file: If there is a
2757 <CR> in front of it, Dos format is used, otherwise Unix format is
2758 used.
2759 Also see |file-formats|.
2760 For backwards compatibility: When this option is set to an empty
2761 string or one format (no comma is included), 'textauto' is reset,
2762 otherwise 'textauto' is set.
2763 NOTE: This option is set to the Vi default value when 'compatible' is
2764 set and to the Vim default value when 'compatible' is reset.
2765
2766 *'filetype'* *'ft'*
2767'filetype' 'ft' string (default: "")
2768 local to buffer
2769 {not in Vi}
2770 {not available when compiled without the |+autocmd|
2771 feature}
2772 When this option is set, the FileType autocommand event is triggered.
2773 All autocommands that match with the value of this option will be
2774 executed. Thus the value of 'filetype' is used in place of the file
2775 name.
2776 Otherwise this option does not always reflect the current file type.
2777 This option is normally set when the file type is detected. To enable
2778 this use the ":filetype on" command. |:filetype|
2779 Setting this option to a different value is most useful in a modeline,
2780 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002781 Example, for in an IDL file:
2782 /* vim: set filetype=idl : */ ~
2783 |FileType| |filetypes|
2784 When a dot appears in the value then this separates two filetype
2785 names. Example:
2786 /* vim: set filetype=c.doxygen : */ ~
2787 This will use the "c" filetype first, then the "doxygen" filetype.
2788 This works both for filetype plugins and for syntax files. More than
2789 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 Do not confuse this option with 'osfiletype', which is for the file
2791 type that is actually stored with the file.
2792 This option is not copied to another buffer, independent of the 's' or
2793 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002794 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
2796 *'fillchars'* *'fcs'*
2797'fillchars' 'fcs' string (default "vert:|,fold:-")
2798 global
2799 {not in Vi}
2800 {not available when compiled without the |+windows|
2801 and |+folding| features}
2802 Characters to fill the statuslines and vertical separators.
2803 It is a comma separated list of items:
2804
2805 item default Used for ~
2806 stl:c ' ' or '^' statusline of the current window
2807 stlnc:c ' ' or '-' statusline of the non-current windows
2808 vert:c '|' vertical separators |:vsplit|
2809 fold:c '-' filling 'foldtext'
2810 diff:c '-' deleted lines of the 'diff' option
2811
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002812 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 "stlnc" the space will be used when there is highlighting, '^' or '-'
2814 otherwise.
2815
2816 Example: >
2817 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2818< This is similar to the default, except that these characters will also
2819 be used when there is highlighting.
2820
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002821 for "stl" and "stlnc" only single-byte values are supported.
2822
Bram Moolenaar071d4272004-06-13 20:20:40 +00002823 The highlighting used for these items:
2824 item highlight group ~
2825 stl:c StatusLine |hl-StatusLine|
2826 stlnc:c StatusLineNC |hl-StatusLineNC|
2827 vert:c VertSplit |hl-VertSplit|
2828 fold:c Folded |hl-Folded|
2829 diff:c DiffDelete |hl-DiffDelete|
2830
2831 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2832'fkmap' 'fk' boolean (default off) *E198*
2833 global
2834 {not in Vi}
2835 {only available when compiled with the |+rightleft|
2836 feature}
2837 When on, the keyboard is mapped for the Farsi character set.
2838 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002839 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
2841 *'foldclose'* *'fcl'*
2842'foldclose' 'fcl' string (default "")
2843 global
2844 {not in Vi}
2845 {not available when compiled without the |+folding|
2846 feature}
2847 When set to "all", a fold is closed when the cursor isn't in it and
2848 its level is higher than 'foldlevel'. Useful if you want folds to
2849 automatically close when moving out of them.
2850
2851 *'foldcolumn'* *'fdc'*
2852'foldcolumn' 'fdc' number (default 0)
2853 local to window
2854 {not in Vi}
2855 {not available when compiled without the |+folding|
2856 feature}
2857 When non-zero, a column with the specified width is shown at the side
2858 of the window which indicates open and closed folds. The maximum
2859 value is 12.
2860 See |folding|.
2861
2862 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2863'foldenable' 'fen' boolean (default on)
2864 local to window
2865 {not in Vi}
2866 {not available when compiled without the |+folding|
2867 feature}
2868 When off, all folds are open. This option can be used to quickly
2869 switch between showing all text unfolded and viewing the text with
2870 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002871 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 'foldenable' is off.
2873 This option is set by commands that create a new fold or close a fold.
2874 See |folding|.
2875
2876 *'foldexpr'* *'fde'*
2877'foldexpr' 'fde' string (default: "0")
2878 local to window
2879 {not in Vi}
2880 {not available when compiled without the |+folding|
2881 or |+eval| feature}
2882 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002883 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002884
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002885 The expression may be evaluated in the |sandbox|, see
2886 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002887 This option can't be set from a |modeline| when the 'diff' option is
2888 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002889
2890 It is not allowed to change text or jump to another window while
2891 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892
2893 *'foldignore'* *'fdi'*
2894'foldignore' 'fdi' string (default: "#")
2895 local to window
2896 {not in Vi}
2897 {not available when compiled without the |+folding|
2898 feature}
2899 Used only when 'foldmethod' is "indent". Lines starting with
2900 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 The default "#" works well for C programs. See |fold-indent|.
2903
2904 *'foldlevel'* *'fdl'*
2905'foldlevel' 'fdl' number (default: 0)
2906 local to window
2907 {not in Vi}
2908 {not available when compiled without the |+folding|
2909 feature}
2910 Sets the fold level: Folds with a higher level will be closed.
2911 Setting this option to zero will close all folds. Higher numbers will
2912 close fewer folds.
2913 This option is set by commands like |zm|, |zM| and |zR|.
2914 See |fold-foldlevel|.
2915
2916 *'foldlevelstart'* *'fdls'*
2917'foldlevelstart' 'fdls' number (default: -1)
2918 global
2919 {not in Vi}
2920 {not available when compiled without the |+folding|
2921 feature}
2922 Sets 'foldlevel' when starting to edit another buffer in a window.
2923 Useful to always start editing with all folds closed (value zero),
2924 some folds closed (one) or no folds closed (99).
2925 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002926 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 ignores this option and closes all folds.
2928 It is also done before BufReadPre autocommands, to allow an autocmd to
2929 overrule the 'foldlevel' value for specific files.
2930 When the value is negative, it is not used.
2931
2932 *'foldmarker'* *'fmr'* *E536*
2933'foldmarker' 'fmr' string (default: "{{{,}}}")
2934 local to window
2935 {not in Vi}
2936 {not available when compiled without the |+folding|
2937 feature}
2938 The start and end marker used when 'foldmethod' is "marker". There
2939 must be one comma, which separates the start and end marker. The
2940 marker is a literal string (a regular expression would be too slow).
2941 See |fold-marker|.
2942
2943 *'foldmethod'* *'fdm'*
2944'foldmethod' 'fdm' string (default: "manual")
2945 local to window
2946 {not in Vi}
2947 {not available when compiled without the |+folding|
2948 feature}
2949 The kind of folding used for the current window. Possible values:
2950 |fold-manual| manual Folds are created manually.
2951 |fold-indent| indent Lines with equal indent form a fold.
2952 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2953 |fold-marker| marker Markers are used to specify folds.
2954 |fold-syntax| syntax Syntax highlighting items specify folds.
2955 |fold-diff| diff Fold text that is not changed.
2956
2957 *'foldminlines'* *'fml'*
2958'foldminlines' 'fml' number (default: 1)
2959 local to window
2960 {not in Vi}
2961 {not available when compiled without the |+folding|
2962 feature}
2963 Sets the minimum number of screen lines for a fold to be displayed
2964 closed. Also for manually closed folds.
2965 Note that this only has an effect of what is displayed. After using
2966 "zc" to close a fold, which is displayed open because it's smaller
2967 than 'foldminlines', a following "zc" may close a containing fold.
2968
2969 *'foldnestmax'* *'fdn'*
2970'foldnestmax' 'fdn' number (default: 20)
2971 local to window
2972 {not in Vi}
2973 {not available when compiled without the |+folding|
2974 feature}
2975 Sets the maximum nesting of folds for the "indent" and "syntax"
2976 methods. This avoids that too many folds will be created. Using more
2977 than 20 doesn't work, because the internal limit is 20.
2978
2979 *'foldopen'* *'fdo'*
2980'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2981 search,tag,undo")
2982 global
2983 {not in Vi}
2984 {not available when compiled without the |+folding|
2985 feature}
2986 Specifies for which type of commands folds will be opened, if the
2987 command moves the cursor into a closed fold. It is a comma separated
2988 list of items.
2989 item commands ~
2990 all any
2991 block "(", "{", "[[", "[{", etc.
2992 hor horizontal movements: "l", "w", "fx", etc.
2993 insert any command in Insert mode
2994 jump far jumps: "G", "gg", etc.
2995 mark jumping to a mark: "'m", CTRL-O, etc.
2996 percent "%"
2997 quickfix ":cn", ":crew", ":make", etc.
2998 search search for a pattern: "/", "n", "*", "gd", etc.
2999 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003000 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 tag jumping to a tag: ":ta", CTRL-T, etc.
3002 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 the |zv| command to the mapping to get the same effect.
3005 When a movement command is used for an operator (e.g., "dl" or "y%")
3006 this option is not used. This means the operator will include the
3007 whole closed fold.
3008 Note that vertical movements are not here, because it would make it
3009 very difficult to move onto a closed fold.
3010 In insert mode the folds containing the cursor will always be open
3011 when text is inserted.
3012 To close folds you can re-apply 'foldlevel' with the |zx| command or
3013 set the 'foldclose' option to "all".
3014
3015 *'foldtext'* *'fdt'*
3016'foldtext' 'fdt' string (default: "foldtext()")
3017 local to window
3018 {not in Vi}
3019 {not available when compiled without the |+folding|
3020 feature}
3021 An expression which is used to specify the text displayed for a closed
3022 fold. See |fold-foldtext|.
3023
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003024 The expression may be evaluated in the |sandbox|, see
3025 |sandbox-option|.
3026
3027 It is not allowed to change text or jump to another window while
3028 evaluating 'foldtext' |textlock|.
3029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 *'formatoptions'* *'fo'*
3031'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3032 local to buffer
3033 {not in Vi}
3034 This is a sequence of letters which describes how automatic
3035 formatting is to be done. See |fo-table|. When the 'paste' option is
3036 on, no formatting is done (like 'formatoptions' is empty). Commas can
3037 be inserted for readability.
3038 To avoid problems with flags that are added in the future, use the
3039 "+=" and "-=" feature of ":set" |add-option-flags|.
3040 NOTE: This option is set to the Vi default value when 'compatible' is
3041 set and to the Vim default value when 'compatible' is reset.
3042
Bram Moolenaar86b68352004-12-27 21:59:20 +00003043 *'formatlistpat'* *'flp'*
3044'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3045 local to buffer
3046 {not in Vi}
3047 A pattern that is used to recognize a list header. This is used for
3048 the "n" flag in 'formatoptions'.
3049 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003050 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003051 while still checking more characters. There must be a character
3052 following the pattern, when it matches the whole line it is handled
3053 like there is no match.
3054 The default recognizes a number, followed by an optional punctuation
3055 character and white space.
3056
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 *'formatprg'* *'fp'*
3058'formatprg' 'fp' string (default "")
3059 global
3060 {not in Vi}
3061 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003062 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003064 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003065 If the 'formatexpr' option is not empty it will be used instead.
3066 Otherwise, if 'formatprg' option is an empty string, the internal
3067 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003068 Environment variables are expanded |:set_env|. See |option-backslash|
3069 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003070 The expression may be evaluated in the |sandbox|, see
3071 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003073 *'formatexpr'* *'fex'*
3074'formatexpr' 'fex' string (default "")
3075 local to buffer
3076 {not in Vi}
3077 {not available when compiled without the |+eval|
3078 feature}
3079 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003080 operator. When this option is empty 'formatprg' is used.
3081
3082 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003083 The |v:count| variable holds the number of lines to be formatted.
3084 The |v:char| variable holds the character that is going to be
3085 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003086
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003087 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003088 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003089< This will invoke the mylang#Format() function in the
3090 autoload/mylang.vim file in 'runtimepath'. |autoload|
3091
3092 The expression is also evaluated when 'textwidth' is set and adding
3093 text beyond that limit. This happens under the same conditions as
3094 when internal formatting is used. Make sure the cursor is kept in the
3095 same spot relative to the text then! The |mode()| function will
3096 return "i" or "R" in this situation. When the function returns
3097 non-zero Vim will fall back to using the internal format mechanism.
3098
3099 The expression may be evaluated in the |sandbox|, see
3100 |sandbox-option|.
3101
3102 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003103'fsync' 'fs' boolean (default on)
3104 global
3105 {not in Vi}
3106 When on, the library function fsync() will be called after writing a
3107 file. This will flush a file to disk, ensuring that it is safely
3108 written even on filesystems which do metadata-only journaling. This
3109 will force the harddrive to spin up on Linux systems running in laptop
3110 mode, so it may be undesirable in some situations. Be warned that
3111 turning this off increases the chances of data loss after a crash. On
3112 systems without an fsync() implementation, this variable is always
3113 off.
3114 Also see 'swapsync' for controlling fsync() on swap files.
3115
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3117'gdefault' 'gd' boolean (default off)
3118 global
3119 {not in Vi}
3120 When on, the ":substitute" flag 'g' is default on. This means that
3121 all matches in a line are substituted instead of one. When a 'g' flag
3122 is given to a ":substitute" command, this will toggle the substitution
3123 of all or one match. See |complex-change|.
3124
3125 command 'gdefault' on 'gdefault' off ~
3126 :s/// subst. all subst. one
3127 :s///g subst. one subst. all
3128 :s///gg subst. all subst. one
3129
3130 NOTE: This option is reset when 'compatible' is set.
3131
3132 *'grepformat'* *'gfm'*
3133'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3134 global
3135 {not in Vi}
3136 Format to recognize for the ":grep" command output.
3137 This is a scanf-like string that uses the same format as the
3138 'errorformat' option: see |errorformat|.
3139
3140 *'grepprg'* *'gp'*
3141'grepprg' 'gp' string (default "grep -n ",
3142 Unix: "grep -n $* /dev/null",
3143 Win32: "findstr /n" or "grep -n",
3144 VMS: "SEARCH/NUMBERS ")
3145 global or local to buffer |global-local|
3146 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003147 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 and '#' characters, which are expanded like when used in a command-
3149 line. The placeholder "$*" is allowed to specify where the arguments
3150 will be included. Environment variables are expanded |:set_env|. See
3151 |option-backslash| about including spaces and backslashes.
3152 When your "grep" accepts the "-H" argument, use this to make ":grep"
3153 also work well with a single file: >
3154 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003155< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003156 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3157 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003158 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 apply equally to 'grepprg'.
3160 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3161 otherwise it's "grep -n".
3162 This option cannot be set from a |modeline| or in the |sandbox|, for
3163 security reasons.
3164
3165 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3166'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3167 ve:ver35-Cursor,
3168 o:hor50-Cursor,
3169 i-ci:ver25-Cursor/lCursor,
3170 r-cr:hor20-Cursor/lCursor,
3171 sm:block-Cursor
3172 -blinkwait175-blinkoff150-blinkon175",
3173 for MS-DOS and Win32 console:
3174 "n-v-c:block,o:hor50,i-ci:hor15,
3175 r-cr:hor30,sm:block")
3176 global
3177 {not in Vi}
3178 {only available when compiled with GUI enabled, and
3179 for MS-DOS and Win32 console}
3180 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003181 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 the height of the cursor can be changed. This can be done by
3183 specifying a block cursor, or a percentage for a vertical or
3184 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003185 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 mode-list and an argument-list:
3189 mode-list:argument-list,mode-list:argument-list,..
3190 The mode-list is a dash separated list of these modes:
3191 n Normal mode
3192 v Visual mode
3193 ve Visual mode with 'selection' "exclusive" (same as 'v',
3194 if not specified)
3195 o Operator-pending mode
3196 i Insert mode
3197 r Replace mode
3198 c Command-line Normal (append) mode
3199 ci Command-line Insert mode
3200 cr Command-line Replace mode
3201 sm showmatch in Insert mode
3202 a all modes
3203 The argument-list is a dash separated list of these arguments:
3204 hor{N} horizontal bar, {N} percent of the character height
3205 ver{N} vertical bar, {N} percent of the character width
3206 block block cursor, fills the whole character
3207 [only one of the above three should be present]
3208 blinkwait{N} *cursor-blinking*
3209 blinkon{N}
3210 blinkoff{N}
3211 blink times for cursor: blinkwait is the delay before
3212 the cursor starts blinking, blinkon is the time that
3213 the cursor is shown and blinkoff is the time that the
3214 cursor is not shown. The times are in msec. When one
3215 of the numbers is zero, there is no blinking. The
3216 default is: "blinkwait700-blinkon400-blinkoff250".
3217 These numbers are used for a missing entry. This
3218 means that blinking is enabled by default. To switch
3219 blinking off you can use "blinkon0". The cursor only
3220 blinks when Vim is waiting for input, not while
3221 executing a command.
3222 To make the cursor blink in an xterm, see
3223 |xterm-blink|.
3224 {group-name}
3225 a highlight group name, that sets the color and font
3226 for the cursor
3227 {group-name}/{group-name}
3228 Two highlight group names, the first is used when
3229 no language mappings are used, the other when they
3230 are. |language-mapping|
3231
3232 Examples of parts:
3233 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3234 block cursor with colors from the "nCursor"
3235 highlight group
3236 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3237 In Insert and Command-line Insert mode, use a
3238 30% vertical bar cursor with colors from the
3239 "iCursor" highlight group. Blink a bit
3240 faster.
3241
3242 The 'a' mode is different. It will set the given argument-list for
3243 all modes. It does not reset anything to defaults. This can be used
3244 to do a common setting for all modes. For example, to switch off
3245 blinking: "a:blinkon0"
3246
3247 Examples of cursor highlighting: >
3248 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3249 :highlight Cursor gui=NONE guifg=bg guibg=fg
3250<
3251 *'guifont'* *'gfn'*
3252 *E235* *E596* *E610* *E611*
3253'guifont' 'gfn' string (default "")
3254 global
3255 {not in Vi}
3256 {only available when compiled with GUI enabled}
3257 This is a list of fonts which will be used for the GUI version of Vim.
3258 In its simplest form the value is just one font name. When
3259 the font cannot be found you will get an error message. To try other
3260 font names a list can be specified, font names separated with commas.
3261 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003262
Bram Moolenaar05159a02005-02-26 23:04:13 +00003263 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3264 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003265
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 Spaces after a comma are ignored. To include a comma in a font name
3267 precede it with a backslash. Setting an option requires an extra
3268 backslash before a space and a backslash. See also
3269 |option-backslash|. For example: >
3270 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003271< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003273
3274 If none of the fonts can be loaded, Vim will keep the current setting.
3275 If an empty font list is given, Vim will try using other resource
3276 settings (for X, it will use the Vim.font resource), and finally it
3277 will try some builtin default which should always be there ("7x13" in
3278 the case of X). The font names given should be "normal" fonts. Vim
3279 will try to find the related bold and italic fonts.
3280
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003281 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003282 :set guifont=*
3283< will bring up a font requester, where you can pick the font you want.
3284
3285 The font name depends on the GUI used. See |setting-guifont| for a
3286 way to set 'guifont' for various systems.
3287
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 For the GTK+ 2 GUI the font name looks like this: >
3289 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290< That's all. XLFDs are not used. For Chinese this is reported to work
3291 well: >
3292 if has("gui_gtk2")
3293 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3294 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3295 endif
3296<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003297 For Mac OSX you can use something like this: >
3298 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003299< Also see 'macatsui', it can help fix display problems.
3300 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003302 width). An exception is GTK 2: all fonts are accepted, but
3303 mono-spaced fonts look best.
3304
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 To preview a font on X11, you might be able to use the "xfontsel"
3306 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003307
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 For the Win32 GUI *E244* *E245*
3309 - takes these options in the font name:
3310 hXX - height is XX (points, can be floating-point)
3311 wXX - width is XX (points, can be floating-point)
3312 b - bold
3313 i - italic
3314 u - underline
3315 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003316 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003317 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3318 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3319 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003320 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321
3322 Use a ':' to separate the options.
3323 - A '_' can be used in the place of a space, so you don't need to use
3324 backslashes to escape the spaces.
3325 - Examples: >
3326 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3327 :set guifont=Andale_Mono:h7.5:w4.5
3328< See also |font-sizes|.
3329
3330 *'guifontset'* *'gfs'*
3331 *E250* *E252* *E234* *E597* *E598*
3332'guifontset' 'gfs' string (default "")
3333 global
3334 {not in Vi}
3335 {only available when compiled with GUI enabled and
3336 with the |+xfontset| feature}
3337 {not available in the GTK+ 2 GUI}
3338 When not empty, specifies two (or more) fonts to be used. The first
3339 one for normal English, the second one for your special language. See
3340 |xfontset|.
3341 Setting this option also means that all font names will be handled as
3342 a fontset name. Also the ones used for the "font" argument of the
3343 |:highlight| command.
3344 The fonts must match with the current locale. If fonts for the
3345 character sets that the current locale uses are not included, setting
3346 'guifontset' will fail.
3347 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3348 the comma-separated names are alternative names, one of which will be
3349 used. In 'guifontset' the whole string is one fontset name,
3350 including the commas. It is not possible to specify alternative
3351 fontset names.
3352 This example works on many X11 systems: >
3353 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3354<
3355 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3356'guifontwide' 'gfw' string (default "")
3357 global
3358 {not in Vi}
3359 {only available when compiled with GUI enabled}
3360 When not empty, specifies a comma-separated list of fonts to be used
3361 for double-width characters. The first font that can be loaded is
3362 used.
3363 Note: The size of these fonts must be exactly twice as wide as the one
3364 specified with 'guifont' and the same height.
3365
3366 All GUI versions but GTK+ 2:
3367
3368 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3369 'guifontset' is empty or invalid.
3370 When 'guifont' is set and a valid font is found in it and
3371 'guifontwide' is empty Vim will attempt to find a matching
3372 double-width font and set 'guifontwide' to it.
3373
3374 GTK+ 2 GUI only: *guifontwide_gtk2*
3375
3376 If set and valid, 'guifontwide' is always used for double width
3377 characters, even if 'encoding' is not set to "utf-8".
3378 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003379 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 font for characters not available in 'guifont'. Thus you do not need
3381 to set 'guifontwide' at all unless you want to override the choice
3382 made by Pango/Xft.
3383
3384 *'guiheadroom'* *'ghr'*
3385'guiheadroom' 'ghr' number (default 50)
3386 global
3387 {not in Vi} {only for GTK and X11 GUI}
3388 The number of pixels subtracted from the screen height when fitting
3389 the GUI window on the screen. Set this before the GUI is started,
3390 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003391 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 lines will be left for window decorations and other items on the
3393 screen. Set it to a negative value to allow windows taller than the
3394 screen.
3395
3396 *'guioptions'* *'go'*
3397'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003398 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 global
3400 {not in Vi}
3401 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003402 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 sequence of letters which describes what components and options of the
3404 GUI should be used.
3405 To avoid problems with flags that are added in the future, use the
3406 "+=" and "-=" feature of ":set" |add-option-flags|.
3407
3408 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003409 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 'a' Autoselect: If present, then whenever VISUAL mode is started,
3411 or the Visual area extended, Vim tries to become the owner of
3412 the windowing system's global selection. This means that the
3413 Visually highlighted text is available for pasting into other
3414 applications as well as into Vim itself. When the Visual mode
3415 ends, possibly due to an operation on the text, or when an
3416 application wants to paste the selection, the highlighted text
3417 is automatically yanked into the "* selection register.
3418 Thus the selection is still available for pasting into other
3419 applications after the VISUAL mode has ended.
3420 If not present, then Vim won't become the owner of the
3421 windowing system's global selection unless explicitly told to
3422 by a yank or delete operation for the "* register.
3423 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003424 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003425 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 applies to the modeless selection.
3427
3428 'guioptions' autoselect Visual autoselect modeless ~
3429 "" - -
3430 "a" yes yes
3431 "A" - yes
3432 "aA" yes yes
3433
Bram Moolenaar02467872007-05-06 13:22:01 +00003434 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 'c' Use console dialogs instead of popup dialogs for simple
3436 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003437 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003438 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003439 'guitablabel' can be used to change the text in the labels.
3440 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003441 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003442 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003443 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 'f' Foreground: Don't use fork() to detach the GUI from the shell
3445 where it was started. Use this for programs that wait for the
3446 editor to finish (e.g., an e-mail program). Alternatively you
3447 can use "gvim -f" or ":gui -f" to start the GUI in the
3448 foreground. |gui-fork|
3449 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003450 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003451 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3453 corner of the window. It's black&white on non-GTK, because of
3454 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003455 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003457 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003458 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003460 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 file is sourced the system menu has already been loaded; the
3462 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003463 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 'g' Grey menu items: Make menu items that are not active grey. If
3465 'g' is not included inactive menu items are not shown at all.
3466 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003467 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468 't' Include tearoff menu items. Currently only works for Win32,
3469 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003470 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003471 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003472 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003473 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003475 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 'R' Right-hand scrollbar is present when there is a vertically
3477 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003478 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003480 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 'L' Left-hand scrollbar is present when there is a vertically
3482 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003483 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3485 the longest visible line, or on the cursor line if the 'h'
3486 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003487 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003488 'h' Limit horizontal scrollbar size to the length of the cursor
3489 line. Reduces computations. |gui-horiz-scroll|
3490
3491 And yes, you may even have scrollbars on the left AND the right if
3492 you really want to :-). See |gui-scrollbars| for more information.
3493
Bram Moolenaar02467872007-05-06 13:22:01 +00003494 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 'v' Use a vertical button layout for dialogs. When not included,
3496 a horizontal layout is preferred, but when it doesn't fit a
3497 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003498 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 'p' Use Pointer callbacks for X11 GUI. This is required for some
3500 window managers. If the cursor is not blinking or hollow at
3501 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003502 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003504 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003505 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506
Bram Moolenaar02467872007-05-06 13:22:01 +00003507
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 *'guipty'* *'noguipty'*
3509'guipty' boolean (default on)
3510 global
3511 {not in Vi}
3512 {only available when compiled with GUI enabled}
3513 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3514 I/O to/from shell commands. See |gui-pty|.
3515
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003516 *'guitablabel'* *'gtl'*
3517'guitablabel' 'gtl' string (default empty)
3518 global
3519 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003520 {only available when compiled with GUI enabled and
3521 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003522 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003523 pages line. When empty and when the result is empty Vim will use a
3524 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003525
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003526 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003527 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003528
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003529 Only used when the GUI tab pages line is displayed. 'e' must be
3530 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3531 used.
3532
Bram Moolenaar57657d82006-04-21 22:12:41 +00003533 *'guitabtooltip'* *'gtt'*
3534'guitabtooltip' 'gtt' string (default empty)
3535 global
3536 {not in Vi}
3537 {only available when compiled with GUI enabled and
3538 with the +windows feature}
3539 When nonempty describes the text to use in a tooltip for the GUI tab
3540 pages line. When empty Vim will use a default tooltip.
3541 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003542 You can include a line break. Simplest method is to use |:let|: >
3543 :let &guitabtooltip = "line one\nline two"
3544<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003545
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 *'helpfile'* *'hf'*
3547'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3548 (others) "$VIMRUNTIME/doc/help.txt")
3549 global
3550 {not in Vi}
3551 Name of the main help file. All distributed help files should be
3552 placed together in one directory. Additionally, all "doc" directories
3553 in 'runtimepath' will be used.
3554 Environment variables are expanded |:set_env|. For example:
3555 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003556 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 spaces and backslashes.
3558 This option cannot be set from a |modeline| or in the |sandbox|, for
3559 security reasons.
3560
3561 *'helpheight'* *'hh'*
3562'helpheight' 'hh' number (default 20)
3563 global
3564 {not in Vi}
3565 {not available when compiled without the +windows
3566 feature}
3567 Minimal initial height of the help window when it is opened with the
3568 ":help" command. The initial height of the help window is half of the
3569 current window, or (when the 'ea' option is on) the same as other
3570 windows. When the height is less than 'helpheight', the height is
3571 set to 'helpheight'. Set to zero to disable.
3572
3573 *'helplang'* *'hlg'*
3574'helplang' 'hlg' string (default: messages language or empty)
3575 global
3576 {only available when compiled with the |+multi_lang|
3577 feature}
3578 {not in Vi}
3579 Comma separated list of languages. Vim will use the first language
3580 for which the desired help can be found. The English help will always
3581 be used as a last resort. You can add "en" to prefer English over
3582 another language, but that will only find tags that exist in that
3583 language and not in the English help.
3584 Example: >
3585 :set helplang=de,it
3586< This will first search German, then Italian and finally English help
3587 files.
3588 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3589 try to find the tag in the current language before using this option.
3590 See |help-translated|.
3591
3592 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3593'hidden' 'hid' boolean (default off)
3594 global
3595 {not in Vi}
3596 When off a buffer is unloaded when it is |abandon|ed. When on a
3597 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3598 displayed in another window, it does not become hidden, of course.
3599 The commands that move through the buffer list sometimes make a buffer
3600 hidden although the 'hidden' option is off: When the buffer is
3601 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003602 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003603 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 This option is set for one command with ":hide {command}" |:hide|.
3605 WARNING: It's easy to forget that you have changes in hidden buffers.
3606 Think twice when using ":q!" or ":qa!".
3607
3608 *'highlight'* *'hl'*
3609'highlight' 'hl' string (default (as a single string):
3610 "8:SpecialKey,@:NonText,d:Directory,
3611 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3612 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003613 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3615 f:Folded,F:FoldColumn,A:DiffAdd,
3616 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003617 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003618 R:SpellRare,L:SpellLocal,
3619 +:Pmenu,=:PmenuSel,
3620 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 global
3622 {not in Vi}
3623 This option can be used to set highlighting mode for various
3624 occasions. It is a comma separated list of character pairs. The
3625 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3628 |hl-NonText| @ '~' and '@' at the end of the window and
3629 characters from 'showbreak'
3630 |hl-Directory| d directories in CTRL-D listing and other special
3631 things in listings
3632 |hl-ErrorMsg| e error messages
3633 h (obsolete, ignored)
3634 |hl-IncSearch| i 'incsearch' highlighting
3635 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3636 |hl-MoreMsg| m |more-prompt|
3637 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003638 |hl-LineNr| n line number for ":number" and ":#" commands, and
3639 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 |hl-Question| r |hit-enter| prompt and yes/no questions
3641 |hl-StatusLine| s status line of current window |status-line|
3642 |hl-StatusLineNC| S status lines of not-current windows
3643 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3644 |hl-VertSplit| c column used to separate vertically split windows
3645 |hl-Visual| v Visual mode
3646 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3647 Selection" Only X11 Gui's |gui-x11| and
3648 |xterm-clipboard|.
3649 |hl-WarningMsg| w warning messages
3650 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3651 |hl-Folded| f line used for closed folds
3652 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003653 |hl-DiffAdd| A added line in diff mode
3654 |hl-DiffChange| C changed line in diff mode
3655 |hl-DiffDelete| D deleted line in diff mode
3656 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003658 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003659 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003660 |hl-SpellRare| R rare word |spell|
3661 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003662 |hl-Pmenu| + popup menu normal line
3663 |hl-PmenuSel| = popup menu normal line
3664 |hl-PmenuSbar| x popup menu scrollbar
3665 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666
3667 The display modes are:
3668 r reverse (termcap entry "mr" and "me")
3669 i italic (termcap entry "ZH" and "ZR")
3670 b bold (termcap entry "md" and "me")
3671 s standout (termcap entry "so" and "se")
3672 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003673 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 n no highlighting
3675 - no highlighting
3676 : use a highlight group
3677 The default is used for occasions that are not included.
3678 If you want to change what the display modes do, see |dos-colors|
3679 for an example.
3680 When using the ':' display mode, this must be followed by the name of
3681 a highlight group. A highlight group can be used to define any type
3682 of highlighting, including using color. See |:highlight| on how to
3683 define one. The default uses a different group for each occasion.
3684 See |highlight-default| for the default highlight groups.
3685
3686 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3687'hlsearch' 'hls' boolean (default off)
3688 global
3689 {not in Vi}
3690 {not available when compiled without the
3691 |+extra_search| feature}
3692 When there is a previous search pattern, highlight all its matches.
3693 The type of highlighting used can be set with the 'l' occasion in the
3694 'highlight' option. This uses the "Search" highlight group by
3695 default. Note that only the matching text is highlighted, any offsets
3696 are not applied.
3697 See also: 'incsearch' and |:match|.
3698 When you get bored looking at the highlighted matches, you can turn it
3699 off with |:nohlsearch|. As soon as you use a search command, the
3700 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003701 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 When the search pattern can match an end-of-line, Vim will try to
3703 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003704 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003706 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 NOTE: This option is reset when 'compatible' is set.
3708
3709 *'history'* *'hi'*
3710'history' 'hi' number (Vim default: 20, Vi default: 0)
3711 global
3712 {not in Vi}
3713 A history of ":" commands, and a history of previous search patterns
3714 are remembered. This option decides how many entries may be stored in
3715 each of these histories (see |cmdline-editing|).
3716 NOTE: This option is set to the Vi default value when 'compatible' is
3717 set and to the Vim default value when 'compatible' is reset.
3718
3719 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3720'hkmap' 'hk' boolean (default off)
3721 global
3722 {not in Vi}
3723 {only available when compiled with the |+rightleft|
3724 feature}
3725 When on, the keyboard is mapped for the Hebrew character set.
3726 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3727 toggle this option. See |rileft.txt|.
3728 NOTE: This option is reset when 'compatible' is set.
3729
3730 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3731'hkmapp' 'hkp' boolean (default off)
3732 global
3733 {not in Vi}
3734 {only available when compiled with the |+rightleft|
3735 feature}
3736 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3737 This is useful if you have a non-Hebrew keyboard.
3738 See |rileft.txt|.
3739 NOTE: This option is reset when 'compatible' is set.
3740
3741 *'icon'* *'noicon'*
3742'icon' boolean (default off, on when title can be restored)
3743 global
3744 {not in Vi}
3745 {not available when compiled without the |+title|
3746 feature}
3747 When on, the icon text of the window will be set to the value of
3748 'iconstring' (if it is not empty), or to the name of the file
3749 currently being edited. Only the last part of the name is used.
3750 Overridden by the 'iconstring' option.
3751 Only works if the terminal supports setting window icons (currently
3752 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3753 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3754 builtin termcap).
3755 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003756 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 X11.
3758
3759 *'iconstring'*
3760'iconstring' string (default "")
3761 global
3762 {not in Vi}
3763 {not available when compiled without the |+title|
3764 feature}
3765 When this option is not empty, it will be used for the icon text of
3766 the window. This happens only when the 'icon' option is on.
3767 Only works if the terminal supports setting window icon text
3768 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3769 Does not work for MS Windows.
3770 When Vim was compiled with HAVE_X11 defined, the original icon will be
3771 restored if possible |X11|.
3772 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003773 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 'titlestring' for example settings.
3775 {not available when compiled without the |+statusline| feature}
3776
3777 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3778'ignorecase' 'ic' boolean (default off)
3779 global
3780 Ignore case in search patterns. Also used when searching in the tags
3781 file.
3782 Also see 'smartcase'.
3783 Can be overruled by using "\c" or "\C" in the pattern, see
3784 |/ignorecase|.
3785
3786 *'imactivatekey'* *'imak'*
3787'imactivatekey' 'imak' string (default "")
3788 global
3789 {not in Vi}
3790 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003791 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 Specifies the key that your Input Method in X-Windows uses for
3793 activation. When this is specified correctly, vim can fully control
3794 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3795 You can't use this option to change the activation key, the option
3796 tells Vim what the key is.
3797 Format:
3798 [MODIFIER_FLAG-]KEY_STRING
3799
3800 These characters can be used for MODIFIER_FLAG (case is ignored):
3801 S Shift key
3802 L Lock key
3803 C Control key
3804 1 Mod1 key
3805 2 Mod2 key
3806 3 Mod3 key
3807 4 Mod4 key
3808 5 Mod5 key
3809 Combinations are allowed, for example "S-C-space" or "SC-space" are
3810 both shift+ctrl+space.
3811 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3812
3813 Example: >
3814 :set imactivatekey=S-space
3815< "S-space" means shift+space. This is the activation key for kinput2 +
3816 canna (Japanese), and ami (Korean).
3817
3818 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3819'imcmdline' 'imc' boolean (default off)
3820 global
3821 {not in Vi}
3822 {only available when compiled with the |+xim|
3823 |+multi_byte_ime| or |global-ime| feature}
3824 When set the Input Method is always on when starting to edit a command
3825 line, unless entering a search pattern (see 'imsearch' for that).
3826 Setting this option is useful when your input method allows entering
3827 English characters directly, e.g., when it's used to type accented
3828 characters with dead keys.
3829
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003830 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003831'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3832 global
3833 {not in Vi}
3834 {only available when compiled with the |+xim|
3835 |+multi_byte_ime| or |global-ime| feature}
3836 When set the Input Method is never used. This is useful to disable
3837 the IM when it doesn't work properly.
3838 Currently this option is on by default for SGI/IRIX machines. This
3839 may change in later releases.
3840
3841 *'iminsert'* *'imi'*
3842'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3843 local to buffer
3844 {not in Vi}
3845 Specifies whether :lmap or an Input Method (IM) is to be used in
3846 Insert mode. Valid values:
3847 0 :lmap is off and IM is off
3848 1 :lmap is ON and IM is off
3849 2 :lmap is off and IM is ON
3850 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3851 or |global-ime|.
3852 To always reset the option to zero when leaving Insert mode with <Esc>
3853 this can be used: >
3854 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3855< This makes :lmap and IM turn off automatically when leaving Insert
3856 mode.
3857 Note that this option changes when using CTRL-^ in Insert mode
3858 |i_CTRL-^|.
3859 The value is set to 1 when setting 'keymap' to a valid keymap name.
3860 It is also used for the argument of commands like "r" and "f".
3861 The value 0 may not work correctly with Athena and Motif with some XIM
3862 methods. Use 'imdisable' to disable XIM then.
3863
3864 *'imsearch'* *'ims'*
3865'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3866 local to buffer
3867 {not in Vi}
3868 Specifies whether :lmap or an Input Method (IM) is to be used when
3869 entering a search pattern. Valid values:
3870 -1 the value of 'iminsert' is used, makes it look like
3871 'iminsert' is also used when typing a search pattern
3872 0 :lmap is off and IM is off
3873 1 :lmap is ON and IM is off
3874 2 :lmap is off and IM is ON
3875 Note that this option changes when using CTRL-^ in Command-line mode
3876 |c_CTRL-^|.
3877 The value is set to 1 when it is not -1 and setting the 'keymap'
3878 option to a valid keymap name.
3879 The value 0 may not work correctly with Athena and Motif with some XIM
3880 methods. Use 'imdisable' to disable XIM then.
3881
3882 *'include'* *'inc'*
3883'include' 'inc' string (default "^\s*#\s*include")
3884 global or local to buffer |global-local|
3885 {not in Vi}
3886 {not available when compiled without the
3887 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003888 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 pattern, just like for the "/" command (See |pattern|). The default
3890 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003891 "]I", "[d", etc.
3892 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003893 comes after the matched pattern. But if "\zs" appears in the pattern
3894 then the text matched from "\zs" to the end, or until "\ze" if it
3895 appears, is used as the file name. Use this to include characters
3896 that are not in 'isfname', such as a space. You can then use
3897 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003898 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899
3900 *'includeexpr'* *'inex'*
3901'includeexpr' 'inex' string (default "")
3902 local to buffer
3903 {not in Vi}
3904 {not available when compiled without the
3905 |+find_in_path| or |+eval| feature}
3906 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003907 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 :set includeexpr=substitute(v:fname,'\\.','/','g')
3909< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003910
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003912 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 Also used for |<cfile>|.
3914
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003915 The expression may be evaluated in the |sandbox|, see
3916 |sandbox-option|.
3917
3918 It is not allowed to change text or jump to another window while
3919 evaluating 'includeexpr' |textlock|.
3920
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3922'incsearch' 'is' boolean (default off)
3923 global
3924 {not in Vi}
3925 {not available when compiled without the
3926 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003927 While typing a search command, show where the pattern, as it was typed
3928 so far, matches. The matched string is highlighted. If the pattern
3929 is invalid or not found, nothing is shown. The screen will be updated
3930 often, this is only useful on fast terminals.
3931 Note that the match will be shown, but the cursor will return to its
3932 original position when no match is found and when pressing <Esc>. You
3933 still need to finish the search command with <Enter> to move the
3934 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003935 When compiled with the |+reltime| feature Vim only searches for about
3936 half a second. With a complicated pattern and/or a lot of text the
3937 match may not be found. This is to avoid that Vim hangs while you
3938 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003939 The highlighting can be set with the 'i' flag in 'highlight'.
3940 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003941 CTRL-L can be used to add one character from after the current match
3942 to the command line.
3943 CTRL-R CTRL-W can be used to add the word at the end of the current
3944 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 NOTE: This option is reset when 'compatible' is set.
3946
3947 *'indentexpr'* *'inde'*
3948'indentexpr' 'inde' string (default "")
3949 local to buffer
3950 {not in Vi}
3951 {not available when compiled without the |+cindent|
3952 or |+eval| features}
3953 Expression which is evaluated to obtain the proper indent for a line.
3954 It is used when a new line is created, for the |=| operator and
3955 in Insert mode as specified with the 'indentkeys' option.
3956 When this option is not empty, it overrules the 'cindent' and
3957 'smartindent' indenting.
3958 When 'paste' is set this option is not used for indenting.
3959 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003960 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 when the expression is evaluated (but it may be moved around).
3962 The expression must return the number of spaces worth of indent. It
3963 can return "-1" to keep the current indent (this means 'autoindent' is
3964 used for the indent).
3965 Functions useful for computing the indent are |indent()|, |cindent()|
3966 and |lispindent()|.
3967 The evaluation of the expression must not have side effects! It must
3968 not change the text, jump to another window, etc. Afterwards the
3969 cursor position is always restored, thus the cursor may be moved.
3970 Normally this option would be set to call a function: >
3971 :set indentexpr=GetMyIndent()
3972< Error messages will be suppressed, unless the 'debug' option contains
3973 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003974 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 NOTE: This option is made empty when 'compatible' is set.
3976
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003977 The expression may be evaluated in the |sandbox|, see
3978 |sandbox-option|.
3979
3980 It is not allowed to change text or jump to another window while
3981 evaluating 'indentexpr' |textlock|.
3982
3983
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 *'indentkeys'* *'indk'*
3985'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3986 local to buffer
3987 {not in Vi}
3988 {not available when compiled without the |+cindent|
3989 feature}
3990 A list of keys that, when typed in Insert mode, cause reindenting of
3991 the current line. Only happens if 'indentexpr' isn't empty.
3992 The format is identical to 'cinkeys', see |indentkeys-format|.
3993 See |C-indenting| and |indent-expression|.
3994
3995 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3996'infercase' 'inf' boolean (default off)
3997 local to buffer
3998 {not in Vi}
3999 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004000 'ignorecase' is also on, the case of the match is adjusted depending
4001 on the typed text. If the typed text contains a lowercase letter
4002 where the match has an upper case letter, the completed part is made
4003 lowercase. If the typed text has no lowercase letters and the match
4004 has a lowercase letter where the typed text has an uppercase letter,
4005 and there is a letter before it, the completed part is made uppercase.
4006 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007
4008 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4009'insertmode' 'im' boolean (default off)
4010 global
4011 {not in Vi}
4012 Makes Vim work in a way that Insert mode is the default mode. Useful
4013 if you want to use Vim as a modeless editor. Used for |evim|.
4014 These Insert mode commands will be useful:
4015 - Use the cursor keys to move around.
4016 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4017 this is a mapping, it is executed as if 'insertmode' was off.
4018 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004020 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4021 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022
4023 These items change when 'insertmode' is set:
4024 - when starting to edit of a file, Vim goes to Insert mode.
4025 - <Esc> in Insert mode is a no-op and beeps.
4026 - <Esc> in Normal mode makes Vim go to Insert mode.
4027 - CTRL-L in Insert mode is a command, it is not inserted.
4028 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4029 However, when <Esc> is used inside a mapping, it behaves like
4030 'insertmode' was not set. This was done to be able to use the same
4031 mappings with 'insertmode' set or not set.
4032 When executing commands with |:normal| 'insertmode' is not used.
4033
4034 NOTE: This option is reset when 'compatible' is set.
4035
4036 *'isfname'* *'isf'*
4037'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4038 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4039 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4040 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4041 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4042 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4043 global
4044 {not in Vi}
4045 The characters specified by this option are included in file names and
4046 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004047 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 Multi-byte characters 256 and above are always included, only the
4049 characters up to 255 are specified with this option.
4050 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004051 Think twice before adding white space to this option. Although a
4052 space may appear inside a file name, the effect will be that Vim
4053 doesn't know where a file name starts or ends when doing completion.
4054 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055
4056 Note that on systems using a backslash as path separator, Vim tries to
4057 do its best to make it work as you would expect. That is a bit
4058 tricky, since Vi originally used the backslash to escape special
4059 characters. Vim will not remove a backslash in front of a normal file
4060 name character on these systems, but it will on Unix and alikes. The
4061 '&' and '^' are not included by default, because these are special for
4062 cmd.exe.
4063
4064 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 Each part can be a single character number or a range. A range is two
4066 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 decimal number between 0 and 255 or the ASCII character itself (does
4068 not work for digits). Example:
4069 "_,-,128-140,#-43" (include '_' and '-' and the range
4070 128 to 140 and '#' to 43)
4071 If a part starts with '^', the following character number or range
4072 will be excluded from the option. The option is interpreted from left
4073 to right. Put the excluded character after the range where it is
4074 included. To include '^' itself use it as the last character of the
4075 option or the end of a range. Example:
4076 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4077 If the character is '@', all characters where isalpha() returns TRUE
4078 are included. Normally these are the characters a to z and A to Z,
4079 plus accented characters. To include '@' itself use "@-@". Examples:
4080 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004081 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 "a-z,A-Z,@-@" All letters plus the '@' character.
4083 A comma can be included by using it where a character number is
4084 expected. Example:
4085 "48-57,,,_" Digits, comma and underscore.
4086 A comma can be excluded by prepending a '^'. Example:
4087 " -~,^,,9" All characters from space to '~', excluding
4088 comma, plus <Tab>.
4089 See |option-backslash| about including spaces and backslashes.
4090
4091 *'isident'* *'isi'*
4092'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4093 "@,48-57,_,128-167,224-235"
4094 otherwise: "@,48-57,_,192-255")
4095 global
4096 {not in Vi}
4097 The characters given by this option are included in identifiers.
4098 Identifiers are used in recognizing environment variables and after a
4099 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004100 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 option.
4102 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4105
4106 *'iskeyword'* *'isk'*
4107'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4108 "@,48-57,_,128-167,224-235"
4109 otherwise: "@,48-57,_,192-255"
4110 Vi default: "@,48-57,_")
4111 local to buffer
4112 {not in Vi}
4113 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004114 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 'isfname' for a description of the format of this option. For C
4116 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4117 For a help file it is set to all non-blank printable characters except
4118 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4119 command).
4120 When the 'lisp' option is on the '-' character is always included.
4121 NOTE: This option is set to the Vi default value when 'compatible' is
4122 set and to the Vim default value when 'compatible' is reset.
4123
4124 *'isprint'* *'isp'*
4125'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4126 "@,~-255"; otherwise: "@,161-255")
4127 global
4128 {not in Vi}
4129 The characters given by this option are displayed directly on the
4130 screen. It is also used for "\p" in a |pattern|. The characters from
4131 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4132 even when they are not included in 'isprint' or excluded. See
4133 'isfname' for a description of the format of this option.
4134
4135 Non-printable characters are displayed with two characters:
4136 0 - 31 "^@" - "^_"
4137 32 - 126 always single characters
4138 127 "^?"
4139 128 - 159 "~@" - "~_"
4140 160 - 254 "| " - "|~"
4141 255 "~?"
4142 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4143 displayed as <xx>, with the hexadecimal value of the byte.
4144 When 'display' contains "uhex" all unprintable characters are
4145 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004146 The SpecialKey highlighting will be used for unprintable characters.
4147 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148
4149 Multi-byte characters 256 and above are always included, only the
4150 characters up to 255 are specified with this option. When a character
4151 is printable but it is not available in the current font, a
4152 replacement character will be shown.
4153 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4154 There is no option to specify these characters.
4155
4156 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4157'joinspaces' 'js' boolean (default on)
4158 global
4159 {not in Vi}
4160 Insert two spaces after a '.', '?' and '!' with a join command.
4161 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4162 Otherwise only one space is inserted.
4163 NOTE: This option is set when 'compatible' is set.
4164
4165 *'key'*
4166'key' string (default "")
4167 local to buffer
4168 {not in Vi}
4169 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004170 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 Careful: Do not set the key value by hand, someone might see the typed
4172 key. Use the |:X| command. But you can make 'key' empty: >
4173 :set key=
4174< It is not possible to get the value of this option with ":set key" or
4175 "echo &key". This is to avoid showing it to someone who shouldn't
4176 know. It also means you cannot see it yourself once you have set it,
4177 be careful not to make a typing error!
4178
4179 *'keymap'* *'kmp'* *E544*
4180'keymap' 'kmp' string (default "")
4181 local to buffer
4182 {not in Vi}
4183 {only available when compiled with the |+keymap|
4184 feature}
4185 Name of a keyboard mapping. See |mbyte-keymap|.
4186 Setting this option to a valid keymap name has the side effect of
4187 setting 'iminsert' to one, so that the keymap becomes effective.
4188 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004189 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004190
4191 *'keymodel'* *'km'*
4192'keymodel' 'km' string (default "")
4193 global
4194 {not in Vi}
4195 List of comma separated words, which enable special things that keys
4196 can do. These values can be used:
4197 startsel Using a shifted special key starts selection (either
4198 Select mode or Visual mode, depending on "key" being
4199 present in 'selectmode').
4200 stopsel Using a not-shifted special key stops selection.
4201 Special keys in this context are the cursor keys, <End>, <Home>,
4202 <PageUp> and <PageDown>.
4203 The 'keymodel' option is set by the |:behave| command.
4204
4205 *'keywordprg'* *'kp'*
4206'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4207 OS/2: "view /", VMS: "help")
4208 global or local to buffer |global-local|
4209 {not in Vi}
4210 Program to use for the |K| command. Environment variables are
4211 expanded |:set_env|. ":help" may be used to access the Vim internal
4212 help. (Note that previously setting the global option to the empty
4213 value did this, which is now deprecated.)
4214 When "man" is used, Vim will automatically translate a count for the
4215 "K" command to a section number. Also for "man -s", in which case the
4216 "-s" is removed when there is no count.
4217 See |option-backslash| about including spaces and backslashes.
4218 Example: >
4219 :set keywordprg=man\ -s
4220< This option cannot be set from a |modeline| or in the |sandbox|, for
4221 security reasons.
4222
4223 *'langmap'* *'lmap'* *E357* *E358*
4224'langmap' 'lmap' string (default "")
4225 global
4226 {not in Vi}
4227 {only available when compiled with the |+langmap|
4228 feature}
4229 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004230 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 inserted directly. When in command mode the 'langmap' option takes
4232 care of translating these special characters to the original meaning
4233 of the key. This means you don't have to change the keyboard mode to
4234 be able to execute Normal mode commands.
4235 This is the opposite of the 'keymap' option, where characters are
4236 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004238 Example (for Greek, in UTF-8): *greek* >
4239 :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 +00004240< Example (exchanges meaning of z and y for commands): >
4241 :set langmap=zy,yz,ZY,YZ
4242<
4243 The 'langmap' option is a list of parts, separated with commas. Each
4244 part can be in one of two forms:
4245 1. A list of pairs. Each pair is a "from" character immediately
4246 followed by the "to" character. Examples: "aA", "aAbBcC".
4247 2. A list of "from" characters, a semi-colon and a list of "to"
4248 characters. Example: "abc;ABC"
4249 Example: "aA,fgh;FGH,cCdDeE"
4250 Special characters need to be preceded with a backslash. These are
4251 ";", ',' and backslash itself.
4252
4253 This will allow you to activate vim actions without having to switch
4254 back and forth between the languages. Your language characters will
4255 be understood as normal vim English characters (according to the
4256 langmap mappings) in the following cases:
4257 o Normal/Visual mode (commands, buffer/register names, user mappings)
4258 o Insert/Replace Mode: Register names after CTRL-R
4259 o Insert/Replace Mode: Mappings
4260 Characters entered in Command-line mode will NOT be affected by
4261 this option. Note that this option can be changed at any time
4262 allowing to switch between mappings for different languages/encodings.
4263 Use a mapping to avoid having to type it each time!
4264
4265 *'langmenu'* *'lm'*
4266'langmenu' 'lm' string (default "")
4267 global
4268 {not in Vi}
4269 {only available when compiled with the |+menu| and
4270 |+multi_lang| features}
4271 Language to use for menu translation. Tells which file is loaded
4272 from the "lang" directory in 'runtimepath': >
4273 "lang/menu_" . &langmenu . ".vim"
4274< (without the spaces). For example, to always use the Dutch menus, no
4275 matter what $LANG is set to: >
4276 :set langmenu=nl_NL.ISO_8859-1
4277< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004278 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 If your $LANG is set to a non-English language but you do want to use
4280 the English menus: >
4281 :set langmenu=none
4282< This option must be set before loading menus, switching on filetype
4283 detection or syntax highlighting. Once the menus are defined setting
4284 this option has no effect. But you could do this: >
4285 :source $VIMRUNTIME/delmenu.vim
4286 :set langmenu=de_DE.ISO_8859-1
4287 :source $VIMRUNTIME/menu.vim
4288< Warning: This deletes all menus that you defined yourself!
4289
4290 *'laststatus'* *'ls'*
4291'laststatus' 'ls' number (default 1)
4292 global
4293 {not in Vi}
4294 The value of this option influences when the last window will have a
4295 status line:
4296 0: never
4297 1: only if there are at least two windows
4298 2: always
4299 The screen looks nicer with a status line if you have several
4300 windows, but it takes another screen line. |status-line|
4301
4302 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4303'lazyredraw' 'lz' boolean (default off)
4304 global
4305 {not in Vi}
4306 When this option is set, the screen will not be redrawn while
4307 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004308 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 update use |:redraw|.
4310
4311 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4312'linebreak' 'lbr' boolean (default off)
4313 local to window
4314 {not in Vi}
4315 {not available when compiled without the |+linebreak|
4316 feature}
4317 If on Vim will wrap long lines at a character in 'breakat' rather
4318 than at the last character that fits on the screen. Unlike
4319 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4320 it only affects the way the file is displayed, not its contents. The
4321 value of 'showbreak' is used to put in front of wrapped lines.
4322 This option is not used when the 'wrap' option is off or 'list' is on.
4323 Note that <Tab> characters after an <EOL> are mostly not displayed
4324 with the right amount of white space.
4325
4326 *'lines'* *E593*
4327'lines' number (default 24 or terminal height)
4328 global
4329 Number of lines of the Vim window.
4330 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004331 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 When Vim is running in the GUI or in a resizable window, setting this
4333 option will cause the window size to be changed. When you only want
4334 to use the size for the GUI, put the command in your |gvimrc| file.
4335 Vim limits the number of lines to what fits on the screen. You can
4336 use this command to get the tallest window possible: >
4337 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004338< Minimum value is 2, maximum value is 1000.
4339 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 When you set this option and Vim is unable to change the physical
4341 number of lines of the display, the display may be messed up.
4342
4343 *'linespace'* *'lsp'*
4344'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4345 global
4346 {not in Vi}
4347 {only in the GUI}
4348 Number of pixel lines inserted between characters. Useful if the font
4349 uses the full character cell height, making lines touch each other.
4350 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004351 With some fonts there can be too much room between lines (to have
4352 space for ascents and descents). Then it makes sense to set
4353 'linespace' to a negative value. This may cause display problems
4354 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355
4356 *'lisp'* *'nolisp'*
4357'lisp' boolean (default off)
4358 local to buffer
4359 {not available when compiled without the |+lispindent|
4360 feature}
4361 Lisp mode: When <Enter> is typed in insert mode set the indent for
4362 the next line to Lisp standards (well, sort of). Also happens with
4363 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4364 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4365 better. Also see 'lispwords'.
4366 The '-' character is included in keyword characters. Redefines the
4367 "=" operator to use this same indentation algorithm rather than
4368 calling an external program if 'equalprg' is empty.
4369 This option is not used when 'paste' is set.
4370 {Vi: Does it a little bit differently}
4371
4372 *'lispwords'* *'lw'*
4373'lispwords' 'lw' string (default is very long)
4374 global
4375 {not in Vi}
4376 {not available when compiled without the |+lispindent|
4377 feature}
4378 Comma separated list of words that influence the Lisp indenting.
4379 |'lisp'|
4380
4381 *'list'* *'nolist'*
4382'list' boolean (default off)
4383 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004384 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4385 line. Useful to see the difference between tabs and spaces and for
4386 trailing blanks. Further changed by the 'listchars' option.
4387
4388 The cursor is displayed at the start of the space a Tab character
4389 occupies, not at the end as usual in Normal mode. To get this cursor
4390 position while displaying Tabs with spaces, use: >
4391 :set list lcs=tab\ \
4392<
4393 Note that list mode will also affect formatting (set with 'textwidth'
4394 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 changing the way tabs are displayed.
4396
4397 *'listchars'* *'lcs'*
4398'listchars' 'lcs' string (default "eol:$")
4399 global
4400 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004401 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 settings.
4403 eol:c Character to show at the end of each line. When
4404 omitted, there is no extra character at the end of the
4405 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004406 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004408 fill the space that the tab normally occupies.
4409 "tab:>-" will show a tab that takes four spaces as
4410 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004411 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 trailing spaces are blank.
4413 extends:c Character to show in the last column, when 'wrap' is
4414 off and the line continues beyond the right of the
4415 screen.
4416 precedes:c Character to show in the first column, when 'wrap'
4417 is off and there is text preceding the character
4418 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004419 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004420 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004422 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004424 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425
4426 Examples: >
4427 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004428 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429 :set lcs=extends:>,precedes:<
4430< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004431 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004432 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433
4434 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4435'loadplugins' 'lpl' boolean (default on)
4436 global
4437 {not in Vi}
4438 When on the plugin scripts are loaded when starting up |load-plugins|.
4439 This option can be reset in your |vimrc| file to disable the loading
4440 of plugins.
4441 Note that using the "-u NONE" and "--noplugin" command line arguments
4442 reset this option. |-u| |--noplugin|
4443
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004444 *'macatsui'* *'nomacatsui'*
4445'macatsui' boolean (default on)
4446 global
4447 {only available in Mac GUI version}
4448 This is a workaround for when drawing doesn't work properly. When set
4449 and compiled with multi-byte support ATSUI text drawing is used. When
4450 not set ATSUI text drawing is not used. Switch this option off when
4451 you experience drawing problems. In a future version the problems may
4452 be solved and this option becomes obsolete. Therefore use this method
4453 to unset it: >
4454 if exists('&macatsui')
4455 set nomacatsui
4456 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004457< Another option to check if you have drawing problems is
4458 'termencoding'.
4459
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 *'magic'* *'nomagic'*
4461'magic' boolean (default on)
4462 global
4463 Changes the special characters that can be used in search patterns.
4464 See |pattern|.
4465 NOTE: To avoid portability problems with using patterns, always keep
4466 this option at the default "on". Only switch it off when working with
4467 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004468 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469
4470 *'makeef'* *'mef'*
4471'makeef' 'mef' string (default: "")
4472 global
4473 {not in Vi}
4474 {not available when compiled without the |+quickfix|
4475 feature}
4476 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4477 and the |:grep| command.
4478 When it is empty, an internally generated temp file will be used.
4479 When "##" is included, it is replaced by a number to make the name
4480 unique. This makes sure that the ":make" command doesn't overwrite an
4481 existing file.
4482 NOT used for the ":cf" command. See 'errorfile' for that.
4483 Environment variables are expanded |:set_env|.
4484 See |option-backslash| about including spaces and backslashes.
4485 This option cannot be set from a |modeline| or in the |sandbox|, for
4486 security reasons.
4487
4488 *'makeprg'* *'mp'*
4489'makeprg' 'mp' string (default "make", VMS: "MMS")
4490 global or local to buffer |global-local|
4491 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004492 Program to use for the ":make" command. See |:make_makeprg|.
4493 This option may contain '%' and '#' characters, which are expanded to
4494 the current and alternate file name. |:_%| |:_#|
4495 Environment variables are expanded |:set_env|. See |option-backslash|
4496 about including spaces and backslashes.
4497 Note that a '|' must be escaped twice: once for ":set" and once for
4498 the interpretation of a command. When you use a filter called
4499 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 :set makeprg=gmake\ \\\|\ myfilter
4501< The placeholder "$*" can be given (even multiple times) to specify
4502 where the arguments will be included, for example: >
4503 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4504< This option cannot be set from a |modeline| or in the |sandbox|, for
4505 security reasons.
4506
4507 *'matchpairs'* *'mps'*
4508'matchpairs' 'mps' string (default "(:),{:},[:]")
4509 local to buffer
4510 {not in Vi}
4511 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004512 other. Currently only single byte character pairs are allowed, and
4513 they must be different. The characters must be separated by a colon.
4514 The pairs must be separated by a comma. Example for including '<' and
4515 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 :set mps+=<:>
4517
4518< A more exotic example, to jump between the '=' and ';' in an
4519 assignment, useful for languages like C and Java: >
4520 :au FileType c,cpp,java set mps+==:;
4521
4522< For a more advanced way of using "%", see the matchit.vim plugin in
4523 the $VIMRUNTIME/macros directory. |add-local-help|
4524
4525 *'matchtime'* *'mat'*
4526'matchtime' 'mat' number (default 5)
4527 global
4528 {not in Vi}{in Nvi}
4529 Tenths of a second to show the matching paren, when 'showmatch' is
4530 set. Note that this is not in milliseconds, like other options that
4531 set a time. This is to be compatible with Nvi.
4532
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004533 *'maxcombine'* *'mco'*
4534'maxcombine' 'mco' number (default 2)
4535 global
4536 {not in Vi}
4537 {only available when compiled with the |+multi_byte|
4538 feature}
4539 The maximum number of combining characters supported for displaying.
4540 Only used when 'encoding' is "utf-8".
4541 The default is OK for most languages. Hebrew may require 4.
4542 Maximum value is 6.
4543 Even when this option is set to 2 you can still edit text with more
4544 combining characters, you just can't see them. Use |g8| or |ga|.
4545 See |mbyte-combining|.
4546
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 *'maxfuncdepth'* *'mfd'*
4548'maxfuncdepth' 'mfd' number (default 100)
4549 global
4550 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004551 {not available when compiled without the +eval
4552 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 Maximum depth of function calls for user functions. This normally
4554 catches endless recursion. When using a recursive function with
4555 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4556 more memory, there is the danger of failing when memory is exhausted.
4557 See also |:function|.
4558
4559 *'maxmapdepth'* *'mmd'* *E223*
4560'maxmapdepth' 'mmd' number (default 1000)
4561 global
4562 {not in Vi}
4563 Maximum number of times a mapping is done without resulting in a
4564 character to be used. This normally catches endless mappings, like
4565 ":map x y" with ":map y x". It still does not catch ":map g wg",
4566 because the 'w' is used before the next mapping is done. See also
4567 |key-mapping|.
4568
4569 *'maxmem'* *'mm'*
4570'maxmem' 'mm' number (default between 256 to 5120 (system
4571 dependent) or half the amount of memory
4572 available)
4573 global
4574 {not in Vi}
4575 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4576 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004577 other memory to be freed. The maximum usable value is about 2000000.
4578 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004580 *'maxmempattern'* *'mmp'*
4581'maxmempattern' 'mmp' number (default 1000)
4582 global
4583 {not in Vi}
4584 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004585 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004586 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004587 When Vim runs into the limit it gives an error message and mostly
4588 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004589 Running into the limit often means that the pattern is very
4590 inefficient or too complex. This may already happen with the pattern
4591 "\(.\)*" on a very long line. ".*" works much better.
4592 Vim may run out of memory before hitting the 'maxmempattern' limit.
4593
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 *'maxmemtot'* *'mmt'*
4595'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4596 dependent) or half the amount of memory
4597 available)
4598 global
4599 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004600 Maximum amount of memory in Kbyte to use for all buffers together.
4601 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4602 without a limit. On 64 bit machines higher values might work. But
4603 hey, do you really need more than 2 Gbyte for text editing?
4604 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605
4606 *'menuitems'* *'mis'*
4607'menuitems' 'mis' number (default 25)
4608 global
4609 {not in Vi}
4610 {not available when compiled without the |+menu|
4611 feature}
4612 Maximum number of items to use in a menu. Used for menus that are
4613 generated from a list of items, e.g., the Buffers menu. Changing this
4614 option has no direct effect, the menu must be refreshed first.
4615
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004616 *'mkspellmem'* *'msm'*
4617'mkspellmem' 'msm' string (default "460000,2000,500")
4618 global
4619 {not in Vi}
4620 {not available when compiled without the |+syntax|
4621 feature}
4622 Parameters for |:mkspell|. This tunes when to start compressing the
4623 word tree. Compression can be slow when there are many words, but
4624 it's needed to avoid running out of memory. The amount of memory used
4625 per word depends very much on how similar the words are, that's why
4626 this tuning is complicated.
4627
4628 There are three numbers, separated by commas:
4629 {start},{inc},{added}
4630
4631 For most languages the uncompressed word tree fits in memory. {start}
4632 gives the amount of memory in Kbyte that can be used before any
4633 compression is done. It should be a bit smaller than the amount of
4634 memory that is available to Vim.
4635
4636 When going over the {start} limit the {inc} number specifies the
4637 amount of memory in Kbyte that can be allocated before another
4638 compression is done. A low number means compression is done after
4639 less words are added, which is slow. A high number means more memory
4640 will be allocated.
4641
4642 After doing compression, {added} times 1024 words can be added before
4643 the {inc} limit is ignored and compression is done when any extra
4644 amount of memory is needed. A low number means there is a smaller
4645 chance of hitting the {inc} limit, less memory is used but it's
4646 slower.
4647
4648 The languages for which these numbers are important are Italian and
4649 Hungarian. The default works for when you have about 512 Mbyte. If
4650 you have 1 Gbyte you could use: >
4651 :set mkspellmem=900000,3000,800
4652< If you have less than 512 Mbyte |:mkspell| may fail for some
4653 languages, no matter what you set 'mkspellmem' to.
4654
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004656'modeline' 'ml' boolean (Vim default: on (off for root),
4657 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 local to buffer
4659 *'modelines'* *'mls'*
4660'modelines' 'mls' number (default 5)
4661 global
4662 {not in Vi}
4663 If 'modeline' is on 'modelines' gives the number of lines that is
4664 checked for set commands. If 'modeline' is off or 'modelines' is zero
4665 no lines are checked. See |modeline|.
4666 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4667 set and to the Vim default value when 'compatible' is reset.
4668
4669 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4670'modifiable' 'ma' boolean (default on)
4671 local to buffer
4672 {not in Vi} *E21*
4673 When off the buffer contents cannot be changed. The 'fileformat' and
4674 'fileencoding' options also can't be changed.
4675 Can be reset with the |-M| command line argument.
4676
4677 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4678'modified' 'mod' boolean (default off)
4679 local to buffer
4680 {not in Vi}
4681 When on, the buffer is considered to be modified. This option is set
4682 when:
4683 1. A change was made to the text since it was last written. Using the
4684 |undo| command to go back to the original text will reset the
4685 option. But undoing changes that were made before writing the
4686 buffer will set the option again, since the text is different from
4687 when it was written.
4688 2. 'fileformat' or 'fileencoding' is different from its original
4689 value. The original value is set when the buffer is read or
4690 written. A ":set nomodified" command also resets the original
4691 values to the current values and the 'modified' option will be
4692 reset.
4693 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4694 will be ignored.
4695
4696 *'more'* *'nomore'*
4697'more' boolean (Vim default: on, Vi default: off)
4698 global
4699 {not in Vi}
4700 When on, listings pause when the whole screen is filled. You will get
4701 the |more-prompt|. When this option is off there are no pauses, the
4702 listing continues until finished.
4703 NOTE: This option is set to the Vi default value when 'compatible' is
4704 set and to the Vim default value when 'compatible' is reset.
4705
4706 *'mouse'* *E538*
4707'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4708 global
4709 {not in Vi}
4710 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004711 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4712 sysmouse and Linux console with gpm). For using the mouse in the
4713 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 The mouse can be enabled for different modes:
4715 n Normal mode
4716 v Visual mode
4717 i Insert mode
4718 c Command-line mode
4719 h all previous modes when editing a help file
4720 a all previous modes
4721 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 Normally you would enable the mouse in all four modes with: >
4723 :set mouse=a
4724< When the mouse is not enabled, the GUI will still use the mouse for
4725 modeless selection. This doesn't move the text cursor.
4726
4727 See |mouse-using|. Also see |'clipboard'|.
4728
4729 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004730 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 the mouse buttons can still be used by keeping the shift key pressed.
4732 Also see the 'clipboard' option.
4733
4734 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4735'mousefocus' 'mousef' boolean (default off)
4736 global
4737 {not in Vi}
4738 {only works in the GUI}
4739 The window that the mouse pointer is on is automatically activated.
4740 When changing the window layout or window focus in another way, the
4741 mouse pointer is moved to the window with keyboard focus. Off is the
4742 default because it makes using the pull down menus a little goofy, as
4743 a pointer transit may activate a window unintentionally.
4744
4745 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4746'mousehide' 'mh' boolean (default on)
4747 global
4748 {not in Vi}
4749 {only works in the GUI}
4750 When on, the mouse pointer is hidden when characters are typed.
4751 The mouse pointer is restored when the mouse is moved.
4752
4753 *'mousemodel'* *'mousem'*
4754'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4755 global
4756 {not in Vi}
4757 Sets the model to use for the mouse. The name mostly specifies what
4758 the right mouse button is used for:
4759 extend Right mouse button extends a selection. This works
4760 like in an xterm.
4761 popup Right mouse button pops up a menu. The shifted left
4762 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004763 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 popup_setpos Like "popup", but the cursor will be moved to the
4765 position where the mouse was clicked, and thus the
4766 selected operation will act upon the clicked object.
4767 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004768 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 course, that right clicking outside a selection will
4770 end Visual mode.
4771 Overview of what button does what for each model:
4772 mouse extend popup(_setpos) ~
4773 left click place cursor place cursor
4774 left drag start selection start selection
4775 shift-left search word extend selection
4776 right click extend selection popup menu (place cursor)
4777 right drag extend selection -
4778 middle click paste paste
4779
4780 In the "popup" model the right mouse button produces a pop-up menu.
4781 You need to define this first, see |popup-menu|.
4782
4783 Note that you can further refine the meaning of buttons with mappings.
4784 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4785 selection (because that's handled in the GUI code directly).
4786
4787 The 'mousemodel' option is set by the |:behave| command.
4788
4789 *'mouseshape'* *'mouses'* *E547*
4790'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004791 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792 global
4793 {not in Vi}
4794 {only available when compiled with the |+mouseshape|
4795 feature}
4796 This option tells Vim what the mouse pointer should look like in
4797 different modes. The option is a comma separated list of parts, much
4798 like used for 'guicursor'. Each part consist of a mode/location-list
4799 and an argument-list:
4800 mode-list:shape,mode-list:shape,..
4801 The mode-list is a dash separated list of these modes/locations:
4802 In a normal window: ~
4803 n Normal mode
4804 v Visual mode
4805 ve Visual mode with 'selection' "exclusive" (same as 'v',
4806 if not specified)
4807 o Operator-pending mode
4808 i Insert mode
4809 r Replace mode
4810
4811 Others: ~
4812 c appending to the command-line
4813 ci inserting in the command-line
4814 cr replacing in the command-line
4815 m at the 'Hit ENTER' or 'More' prompts
4816 ml idem, but cursor in the last line
4817 e any mode, pointer below last window
4818 s any mode, pointer on a status line
4819 sd any mode, while dragging a status line
4820 vs any mode, pointer on a vertical separator line
4821 vd any mode, while dragging a vertical separator line
4822 a everywhere
4823
4824 The shape is one of the following:
4825 avail name looks like ~
4826 w x arrow Normal mouse pointer
4827 w x blank no pointer at all (use with care!)
4828 w x beam I-beam
4829 w x updown up-down sizing arrows
4830 w x leftright left-right sizing arrows
4831 w x busy The system's usual busy pointer
4832 w x no The system's usual 'no input' pointer
4833 x udsizing indicates up-down resizing
4834 x lrsizing indicates left-right resizing
4835 x crosshair like a big thin +
4836 x hand1 black hand
4837 x hand2 white hand
4838 x pencil what you write with
4839 x question big ?
4840 x rightup-arrow arrow pointing right-up
4841 w x up-arrow arrow pointing up
4842 x <number> any X11 pointer number (see X11/cursorfont.h)
4843
4844 The "avail" column contains a 'w' if the shape is available for Win32,
4845 x for X11.
4846 Any modes not specified or shapes not available use the normal mouse
4847 pointer.
4848
4849 Example: >
4850 :set mouseshape=s:udsizing,m:no
4851< will make the mouse turn to a sizing arrow over the status lines and
4852 indicate no input when the hit-enter prompt is displayed (since
4853 clicking the mouse has no effect in this state.)
4854
4855 *'mousetime'* *'mouset'*
4856'mousetime' 'mouset' number (default 500)
4857 global
4858 {not in Vi}
4859 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4860 time in msec between two mouse clicks for the second click to be
4861 recognized as a multi click.
4862
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004863 *'mzquantum'* *'mzq'*
4864'mzquantum' 'mzq' number (default 100)
4865 global
4866 {not in Vi}
4867 {not available when compiled without the |+mzscheme|
4868 feature}
4869 The number of milliseconds between polls for MzScheme threads.
4870 Negative or zero value means no thread scheduling.
4871
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 *'nrformats'* *'nf'*
4873'nrformats' 'nf' string (default "octal,hex")
4874 local to buffer
4875 {not in Vi}
4876 This defines what bases Vim will consider for numbers when using the
4877 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4878 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004879 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 incremented or decremented. This is useful for a list with a
4881 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004882 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004884 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 considered to be hexadecimal. Example: Using CTRL-X on
4886 "0x100" results in "0x0ff".
4887 Numbers which simply begin with a digit in the range 1-9 are always
4888 considered decimal. This also happens for numbers that are not
4889 recognized as octal or hex.
4890
4891 *'number'* *'nu'* *'nonumber'* *'nonu'*
4892'number' 'nu' boolean (default off)
4893 local to window
4894 Print the line number in front of each line. When the 'n' option is
4895 excluded from 'cpoptions' a wrapped line will not use the column of
4896 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004897 The 'numberwidth' option can be used to set the room used for the line
4898 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 When a long, wrapped line doesn't start with the first character, '-'
4900 characters are put before the number.
4901 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004902 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004903
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004904 *'numberwidth'* *'nuw'*
4905'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4906 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004907 {not in Vi}
4908 {only available when compiled with the |+linebreak|
4909 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004910 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004911 when the 'number' or 'relativenumber' option is set or printing lines
4912 with a line number. Since one space is always between the number and
4913 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004914 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004915 fit the highest line number in the buffer respectively the number of
4916 rows in the window, depending on whether 'number' or 'relativenumber'
4917 is set. Thus with the Vim default of 4 there is room for a line number
4918 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004919 The minimum value is 1, the maximum value is 10.
4920 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4921
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004922 *'omnifunc'* *'ofu'*
4923'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004924 local to buffer
4925 {not in Vi}
4926 {not available when compiled without the +eval
4927 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004928 This option specifies a function to be used for Insert mode omni
4929 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004930 See |complete-functions| for an explanation of how the function is
4931 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004932 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004933 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004934
4935
Bram Moolenaar02467872007-05-06 13:22:01 +00004936 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004937'opendevice' 'odev' boolean (default off)
4938 global
4939 {not in Vi}
4940 {only for MS-DOS, MS-Windows and OS/2}
4941 Enable reading and writing from devices. This may get Vim stuck on a
4942 device that can be opened but doesn't actually do the I/O. Therefore
4943 it is off by default.
4944 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4945 result in editing a device.
4946
4947
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004948 *'operatorfunc'* *'opfunc'*
4949'operatorfunc' 'opfunc' string (default: empty)
4950 global
4951 {not in Vi}
4952 This option specifies a function to be called by the |g@| operator.
4953 See |:map-operator| for more info and an example.
4954
4955 This option cannot be set from a |modeline| or in the |sandbox|, for
4956 security reasons.
4957
4958
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 *'osfiletype'* *'oft'* *E366*
4960'osfiletype' 'oft' string (RISC-OS default: "Text",
4961 others default: "")
4962 local to buffer
4963 {not in Vi}
4964 {only available when compiled with the |+osfiletype|
4965 feature}
4966 Some operating systems store extra information about files besides
4967 name, datestamp and permissions. This option contains the extra
4968 information, the nature of which will vary between systems.
4969 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00004970 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004971 It can affect the pattern matching of the automatic commands.
4972 |autocmd-osfiletypes|
4973
4974 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004975'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 global
4977 Specifies the nroff macros that separate paragraphs. These are pairs
4978 of two letters (see |object-motions|).
4979
4980 *'paste'* *'nopaste'*
4981'paste' boolean (default off)
4982 global
4983 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004984 Put Vim in Paste mode. This is useful if you want to cut or copy
4985 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 unexpected effects.
4987 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004988 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 knows about pasting and will mostly do the right thing without 'paste'
4990 being set. The same is true for a terminal where Vim handles the
4991 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004992 This option is reset when starting the GUI. Thus if you set it in
4993 your .vimrc it will work in a terminal, but not in the GUI. Setting
4994 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4995 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 When the 'paste' option is switched on (also when it was already on):
4997 - mapping in Insert mode and Command-line mode is disabled
4998 - abbreviations are disabled
4999 - 'textwidth' is set to 0
5000 - 'wrapmargin' is set to 0
5001 - 'autoindent' is reset
5002 - 'smartindent' is reset
5003 - 'softtabstop' is set to 0
5004 - 'revins' is reset
5005 - 'ruler' is reset
5006 - 'showmatch' is reset
5007 - 'formatoptions' is used like it is empty
5008 These options keep their value, but their effect is disabled:
5009 - 'lisp'
5010 - 'indentexpr'
5011 - 'cindent'
5012 NOTE: When you start editing another file while the 'paste' option is
5013 on, settings from the modelines or autocommands may change the
5014 settings again, causing trouble when pasting text. You might want to
5015 set the 'paste' option again.
5016 When the 'paste' option is reset the mentioned options are restored to
5017 the value before the moment 'paste' was switched from off to on.
5018 Resetting 'paste' before ever setting it does not have any effect.
5019 Since mapping doesn't work while 'paste' is active, you need to use
5020 the 'pastetoggle' option to toggle the 'paste' option with some key.
5021
5022 *'pastetoggle'* *'pt'*
5023'pastetoggle' 'pt' string (default "")
5024 global
5025 {not in Vi}
5026 When non-empty, specifies the key sequence that toggles the 'paste'
5027 option. This is like specifying a mapping: >
5028 :map {keys} :set invpaste<CR>
5029< Where {keys} is the value of 'pastetoggle'.
5030 The difference is that it will work even when 'paste' is set.
5031 'pastetoggle' works in Insert mode and Normal mode, but not in
5032 Command-line mode.
5033 Mappings are checked first, thus overrule 'pastetoggle'. However,
5034 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5035 this: >
5036 :map <F10> :set paste<CR>
5037 :map <F11> :set nopaste<CR>
5038 :imap <F10> <C-O>:set paste<CR>
5039 :imap <F11> <nop>
5040 :set pastetoggle=<F11>
5041< This will make <F10> start paste mode and <F11> stop paste mode.
5042 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5043 mode everything is inserted literally, except the 'pastetoggle' key
5044 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005045 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046
5047 *'pex'* *'patchexpr'*
5048'patchexpr' 'pex' string (default "")
5049 global
5050 {not in Vi}
5051 {not available when compiled without the |+diff|
5052 feature}
5053 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005054 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055
5056 *'patchmode'* *'pm'* *E206*
5057'patchmode' 'pm' string (default "")
5058 global
5059 {not in Vi}
5060 When non-empty the oldest version of a file is kept. This can be used
5061 to keep the original version of a file if you are changing files in a
5062 source distribution. Only the first time that a file is written a
5063 copy of the original file will be kept. The name of the copy is the
5064 name of the original file with the string in the 'patchmode' option
5065 appended. This option should start with a dot. Use a string like
5066 ".org". 'backupdir' must not be empty for this to work (Detail: The
5067 backup file is renamed to the patchmode file after the new file has
5068 been successfully written, that's why it must be possible to write a
5069 backup file). If there was no file to be backed up, an empty file is
5070 created.
5071 When the 'backupskip' pattern matches, a patchmode file is not made.
5072 Using 'patchmode' for compressed files appends the extension at the
5073 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5074 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005075 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076
5077 *'path'* *'pa'* *E343* *E345* *E347*
5078'path' 'pa' string (default on Unix: ".,/usr/include,,"
5079 on OS/2: ".,/emx/include,,"
5080 other systems: ".,,")
5081 global or local to buffer |global-local|
5082 {not in Vi}
5083 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005084 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5085 provided that the file being searched for has a relative path (not
5086 starting with "/", "./" or "../"). The directories in the 'path'
5087 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 - Use commas to separate directory names: >
5089 :set path=.,/usr/local/include,/usr/include
5090< - Spaces can also be used to separate directory names (for backwards
5091 compatibility with version 3.0). To have a space in a directory
5092 name, precede it with an extra backslash, and escape the space: >
5093 :set path=.,/dir/with\\\ space
5094< - To include a comma in a directory name precede it with an extra
5095 backslash: >
5096 :set path=.,/dir/with\\,comma
5097< - To search relative to the directory of the current file, use: >
5098 :set path=.
5099< - To search in the current directory use an empty string between two
5100 commas: >
5101 :set path=,,
5102< - A directory name may end in a ':' or '/'.
5103 - Environment variables are expanded |:set_env|.
5104 - When using |netrw.vim| URLs can be used. For example, adding
5105 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005106 - Search upwards and downwards in a directory tree using "*", "**" and
5107 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 {not available when compiled without the |+path_extra| feature}
5109 - Careful with '\' characters, type two to get one in the option: >
5110 :set path=.,c:\\include
5111< Or just use '/' instead: >
5112 :set path=.,c:/include
5113< Don't forget "." or files won't even be found in the same directory as
5114 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005115 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 it is something like 256 or 1024 characters.
5117 You can check if all the include files are found, using the value of
5118 'path', see |:checkpath|.
5119 The use of |:set+=| and |:set-=| is preferred when adding or removing
5120 directories from the list. This avoids problems when a future version
5121 uses another default. To remove the current directory use: >
5122 :set path-=
5123< To add the current directory use: >
5124 :set path+=
5125< To use an environment variable, you probably need to replace the
5126 separator. Here is an example to append $INCL, in which directory
5127 names are separated with a semi-colon: >
5128 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5129< Replace the ';' with a ':' or whatever separator is used. Note that
5130 this doesn't work when $INCL contains a comma or white space.
5131
5132 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5133'preserveindent' 'pi' boolean (default off)
5134 local to buffer
5135 {not in Vi}
5136 When changing the indent of the current line, preserve as much of the
5137 indent structure as possible. Normally the indent is replaced by a
5138 series of tabs followed by spaces as required (unless |'expandtab'| is
5139 enabled, in which case only spaces are used). Enabling this option
5140 means the indent will preserve as many existing characters as possible
5141 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005142 'expandtab' does not apply to the preserved white space, a Tab remains
5143 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 NOTE: When using ">>" multiple times the resulting indent is a mix of
5145 tabs and spaces. You might not like this.
5146 NOTE: 'preserveindent' is reset when 'compatible' is set.
5147 Also see 'copyindent'.
5148 Use |:retab| to clean up white space.
5149
5150 *'previewheight'* *'pvh'*
5151'previewheight' 'pvh' number (default 12)
5152 global
5153 {not in Vi}
5154 {not available when compiled without the |+windows| or
5155 |+quickfix| feature}
5156 Default height for a preview window. Used for |:ptag| and associated
5157 commands. Used for |CTRL-W_}| when no count is given.
5158
5159 *'previewwindow'* *'nopreviewwindow'*
5160 *'pvw'* *'nopvw'* *E590*
5161'previewwindow' 'pvw' boolean (default off)
5162 local to window
5163 {not in Vi}
5164 {not available when compiled without the |+windows| or
5165 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005166 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167 set. It's normally not set directly, but by using one of the commands
5168 |:ptag|, |:pedit|, etc.
5169
5170 *'printdevice'* *'pdev'*
5171'printdevice' 'pdev' string (default empty)
5172 global
5173 {not in Vi}
5174 {only available when compiled with the |+printer|
5175 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005176 The name of the printer to be used for |:hardcopy|.
5177 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005178 This option cannot be set from a |modeline| or in the |sandbox|, for
5179 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180
Bram Moolenaar8299df92004-07-10 09:47:34 +00005181 *'printencoding'* *'penc'*
5182'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 global
5184 {not in Vi}
5185 {only available when compiled with the |+printer|
5186 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005187 Sets the character encoding used when printing.
5188 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189
5190 *'printexpr'* *'pexpr'*
5191'printexpr' 'pexpr' String (default: see below)
5192 global
5193 {not in Vi}
5194 {only available when compiled with the |+printer|
5195 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005196 Expression used to print the PostScript produced with |:hardcopy|.
5197 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198
Bram Moolenaar8299df92004-07-10 09:47:34 +00005199 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200'printfont' 'pfn' string (default "courier")
5201 global
5202 {not in Vi}
5203 {only available when compiled with the |+printer|
5204 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005205 The name of the font that will be used for |:hardcopy|.
5206 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207
5208 *'printheader'* *'pheader'*
5209'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5210 global
5211 {not in Vi}
5212 {only available when compiled with the |+printer|
5213 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005214 The format of the header produced in |:hardcopy| output.
5215 See |pheader-option|.
5216
5217 *'printmbcharset'* *'pmbcs'*
5218'printmbcharset' 'pmbcs' string (default "")
5219 global
5220 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005221 {only available when compiled with the |+printer|,
5222 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005223 The CJK character set to be used for CJK output from |:hardcopy|.
5224 See |pmbcs-option|.
5225
5226 *'printmbfont'* *'pmbfn'*
5227'printmbfont' 'pmbfn' string (default "")
5228 global
5229 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005230 {only available when compiled with the |+printer|,
5231 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005232 List of font names to be used for CJK output from |:hardcopy|.
5233 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234
5235 *'printoptions'* *'popt'*
5236'printoptions' 'popt' string (default "")
5237 global
5238 {not in Vi}
5239 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005240 List of items that control the format of the output of |:hardcopy|.
5241 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005243 *'prompt'* *'noprompt'*
5244'prompt' boolean (default on)
5245 global
5246 When on a ":" prompt is used in Ex mode.
5247
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005248 *'pumheight'* *'ph'*
5249'pumheight' 'ph' number (default 0)
5250 global
5251 {not available when compiled without the
5252 |+insert_expand| feature}
5253 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005254 Determines the maximum number of items to show in the popup menu for
5255 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005256 |ins-completion-menu|.
5257
5258
Bram Moolenaar677ee682005-01-27 14:41:15 +00005259 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005260'quoteescape' 'qe' string (default "\")
5261 local to buffer
5262 {not in Vi}
5263 The characters that are used to escape quotes in a string. Used for
5264 objects like a', a" and a` |a'|.
5265 When one of the characters in this option is found inside a string,
5266 the following character will be skipped. The default value makes the
5267 text "foo\"bar\\" considered to be one string.
5268
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5270'readonly' 'ro' boolean (default off)
5271 local to buffer
5272 If on, writes fail unless you use a '!'. Protects you from
5273 accidentally overwriting a file. Default on when Vim is started
5274 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005275 When using ":w!" the 'readonly' option is reset for the current
5276 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005278 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005279
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005280 *'redrawtime'* *'rdt'*
5281'redrawtime' 'rdt' number (default 2000)
5282 global
5283 {not in Vi}
5284 {only available when compiled with the |+reltime|
5285 feature}
5286 The time in milliseconds for redrawing the display. This applies to
5287 searching for patterns for 'hlsearch' and |:match| highlighting.
5288 When redrawing takes more than this many milliseconds no further
5289 matches will be highlighted. This is used to avoid that Vim hangs
5290 when using a very complicated pattern.
5291
Bram Moolenaar64486672010-05-16 15:46:46 +02005292 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5293'relativenumber' 'rnu' boolean (default off)
5294 local to window
5295 {not in Vi}
5296 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005297 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005298 precede some vertical motion commands (e.g. j k + -) with, without
5299 having to calculate it yourself. Especially useful in combination with
5300 other commands (e.g. y d c < > gq gw =).
5301 When the 'n' option is excluded from 'cpoptions' a wrapped
5302 line will not use the column of line numbers (this is the default when
5303 'compatible' isn't set).
5304 The 'numberwidth' option can be used to set the room used for the line
5305 number.
5306 When a long, wrapped line doesn't start with the first character, '-'
5307 characters are put before the number.
5308 See |hl-LineNr| for the highlighting used for the number.
5309 When setting this option, 'number' is reset.
5310
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 *'remap'* *'noremap'*
5312'remap' boolean (default on)
5313 global
5314 Allows for mappings to work recursively. If you do not want this for
5315 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005316 NOTE: To avoid portability problems with Vim scripts, always keep
5317 this option at the default "on". Only switch it off when working with
5318 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005319
5320 *'report'*
5321'report' number (default 2)
5322 global
5323 Threshold for reporting number of lines changed. When the number of
5324 changed lines is more than 'report' a message will be given for most
5325 ":" commands. If you want it always, set 'report' to 0.
5326 For the ":substitute" command the number of substitutions is used
5327 instead of the number of lines.
5328
5329 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5330'restorescreen' 'rs' boolean (default on)
5331 global
5332 {not in Vi} {only in Windows 95/NT console version}
5333 When set, the screen contents is restored when exiting Vim. This also
5334 happens when executing external commands.
5335
5336 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5337 options in your .vimrc. To disable restoring:
5338 set t_ti= t_te=
5339 To enable restoring (for an xterm):
5340 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5341 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5342
5343 *'revins'* *'ri'* *'norevins'* *'nori'*
5344'revins' 'ri' boolean (default off)
5345 global
5346 {not in Vi}
5347 {only available when compiled with the |+rightleft|
5348 feature}
5349 Inserting characters in Insert mode will work backwards. See "typing
5350 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5351 command in Insert mode, when 'allowrevins' is set.
5352 NOTE: This option is reset when 'compatible' or 'paste' is set.
5353
5354 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5355'rightleft' 'rl' boolean (default off)
5356 local to window
5357 {not in Vi}
5358 {only available when compiled with the |+rightleft|
5359 feature}
5360 When on, display orientation becomes right-to-left, i.e., characters
5361 that are stored in the file appear from the right to the left.
5362 Using this option, it is possible to edit files for languages that
5363 are written from the right to the left such as Hebrew and Arabic.
5364 This option is per window, so it is possible to edit mixed files
5365 simultaneously, or to view the same file in both ways (this is
5366 useful whenever you have a mixed text file with both right-to-left
5367 and left-to-right strings so that both sets are displayed properly
5368 in different windows). Also see |rileft.txt|.
5369
5370 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5371'rightleftcmd' 'rlc' string (default "search")
5372 local to window
5373 {not in Vi}
5374 {only available when compiled with the |+rightleft|
5375 feature}
5376 Each word in this option enables the command line editing to work in
5377 right-to-left mode for a group of commands:
5378
5379 search "/" and "?" commands
5380
5381 This is useful for languages such as Hebrew, Arabic and Farsi.
5382 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5383
5384 *'ruler'* *'ru'* *'noruler'* *'noru'*
5385'ruler' 'ru' boolean (default off)
5386 global
5387 {not in Vi}
5388 {not available when compiled without the
5389 |+cmdline_info| feature}
5390 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005391 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 text in the file is shown on the far right:
5393 Top first line is visible
5394 Bot last line is visible
5395 All first and last line are visible
5396 45% relative position in the file
5397 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005398 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005400 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 this option takes precedence over 'ruler' and 'rulerformat'
5402 If the number of characters displayed is different from the number of
5403 bytes in the text (e.g., for a TAB or a multi-byte character), both
5404 the text column (byte number) and the screen column are shown,
5405 separated with a dash.
5406 For an empty line "0-1" is shown.
5407 For an empty buffer the line number will also be zero: "0,0-1".
5408 This option is reset when the 'paste' option is set.
5409 If you don't want to see the ruler all the time but want to know where
5410 you are, use "g CTRL-G" |g_CTRL-G|.
5411 NOTE: This option is reset when 'compatible' is set.
5412
5413 *'rulerformat'* *'ruf'*
5414'rulerformat' 'ruf' string (default empty)
5415 global
5416 {not in Vi}
5417 {not available when compiled without the |+statusline|
5418 feature}
5419 When this option is not empty, it determines the content of the ruler
5420 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005421 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 The default ruler width is 17 characters. To make the ruler 15
5423 characters wide, put "%15(" at the start and "%)" at the end.
5424 Example: >
5425 :set rulerformat=%15(%c%V\ %p%%%)
5426<
5427 *'runtimepath'* *'rtp'* *vimfiles*
5428'runtimepath' 'rtp' string (default:
5429 Unix: "$HOME/.vim,
5430 $VIM/vimfiles,
5431 $VIMRUNTIME,
5432 $VIM/vimfiles/after,
5433 $HOME/.vim/after"
5434 Amiga: "home:vimfiles,
5435 $VIM/vimfiles,
5436 $VIMRUNTIME,
5437 $VIM/vimfiles/after,
5438 home:vimfiles/after"
5439 PC, OS/2: "$HOME/vimfiles,
5440 $VIM/vimfiles,
5441 $VIMRUNTIME,
5442 $VIM/vimfiles/after,
5443 $HOME/vimfiles/after"
5444 Macintosh: "$VIM:vimfiles,
5445 $VIMRUNTIME,
5446 $VIM:vimfiles:after"
5447 RISC-OS: "Choices:vimfiles,
5448 $VIMRUNTIME,
5449 Choices:vimfiles/after"
5450 VMS: "sys$login:vimfiles,
5451 $VIM/vimfiles,
5452 $VIMRUNTIME,
5453 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005454 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455 global
5456 {not in Vi}
5457 This is a list of directories which will be searched for runtime
5458 files:
5459 filetype.vim filetypes by file name |new-filetype|
5460 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005461 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462 colors/ color scheme files |:colorscheme|
5463 compiler/ compiler files |:compiler|
5464 doc/ documentation |write-local-help|
5465 ftplugin/ filetype plugins |write-filetype-plugin|
5466 indent/ indent scripts |indent-expression|
5467 keymap/ key mapping files |mbyte-keymap|
5468 lang/ menu translations |:menutrans|
5469 menu.vim GUI menus |menu.vim|
5470 plugin/ plugin scripts |write-plugin|
5471 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005472 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473 syntax/ syntax files |mysyntaxfile|
5474 tutor/ files for vimtutor |tutor|
5475
5476 And any other file searched for with the |:runtime| command.
5477
5478 The defaults for most systems are setup to search five locations:
5479 1. In your home directory, for your personal preferences.
5480 2. In a system-wide Vim directory, for preferences from the system
5481 administrator.
5482 3. In $VIMRUNTIME, for files distributed with Vim.
5483 *after-directory*
5484 4. In the "after" directory in the system-wide Vim directory. This is
5485 for the system administrator to overrule or add to the distributed
5486 defaults (rarely needed)
5487 5. In the "after" directory in your home directory. This is for
5488 personal preferences to overrule or add to the distributed defaults
5489 or system-wide settings (rarely needed).
5490
5491 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5492 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005493 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 wildcards.
5495 See |:runtime|.
5496 Example: >
5497 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5498< This will use the directory "~/vimruntime" first (containing your
5499 personal Vim runtime files), then "/mygroup/vim" (shared between a
5500 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5501 files).
5502 You probably should always include $VIMRUNTIME somewhere, to use the
5503 distributed runtime files. You can put a directory before $VIMRUNTIME
5504 to find files which replace a distributed runtime files. You can put
5505 a directory after $VIMRUNTIME to find files which add to distributed
5506 runtime files.
5507 This option cannot be set from a |modeline| or in the |sandbox|, for
5508 security reasons.
5509
5510 *'scroll'* *'scr'*
5511'scroll' 'scr' number (default: half the window height)
5512 local to window
5513 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5514 set to half the number of lines in the window when the window size
5515 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005516 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5518 the number of screen lines instead of file lines, makes a difference
5519 when lines wrap}
5520
5521 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5522'scrollbind' 'scb' boolean (default off)
5523 local to window
5524 {not in Vi}
5525 {not available when compiled without the |+scrollbind|
5526 feature}
5527 See also |scroll-binding|. When this option is set, the current
5528 window scrolls as other scrollbind windows (windows that also have
5529 this option set) scroll. This option is useful for viewing the
5530 differences between two versions of a file, see 'diff'.
5531 See |'scrollopt'| for options that determine how this option should be
5532 interpreted.
5533 This option is mostly reset when splitting a window to edit another
5534 file. This means that ":split | edit file" results in two windows
5535 with scroll-binding, but ":split file" does not.
5536
5537 *'scrolljump'* *'sj'*
5538'scrolljump' 'sj' number (default 1)
5539 global
5540 {not in Vi}
5541 Minimal number of lines to scroll when the cursor gets off the
5542 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5543 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005544 When set to a negative number from -1 to -100 this is used as the
5545 percentage of the window height. Thus -50 scrolls half the window
5546 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 NOTE: This option is set to 1 when 'compatible' is set.
5548
5549 *'scrolloff'* *'so'*
5550'scrolloff' 'so' number (default 0)
5551 global
5552 {not in Vi}
5553 Minimal number of screen lines to keep above and below the cursor.
5554 This will make some context visible around where you are working. If
5555 you set it to a very large value (999) the cursor line will always be
5556 in the middle of the window (except at the start or end of the file or
5557 when long lines wrap).
5558 For scrolling horizontally see 'sidescrolloff'.
5559 NOTE: This option is set to 0 when 'compatible' is set.
5560
5561 *'scrollopt'* *'sbo'*
5562'scrollopt' 'sbo' string (default "ver,jump")
5563 global
5564 {not available when compiled without the |+scrollbind|
5565 feature}
5566 {not in Vi}
5567 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005568 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5569 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570 The following words are available:
5571 ver Bind vertical scrolling for 'scrollbind' windows
5572 hor Bind horizontal scrolling for 'scrollbind' windows
5573 jump Applies to the offset between two windows for vertical
5574 scrolling. This offset is the difference in the first
5575 displayed line of the bound windows. When moving
5576 around in a window, another 'scrollbind' window may
5577 reach a position before the start or after the end of
5578 the buffer. The offset is not changed though, when
5579 moving back the 'scrollbind' window will try to scroll
5580 to the desired position when possible.
5581 When now making that window the current one, two
5582 things can be done with the relative offset:
5583 1. When "jump" is not included, the relative offset is
5584 adjusted for the scroll position in the new current
5585 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005586 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 2. When "jump" is included, the other windows are
5588 scrolled to keep the same relative offset. When
5589 going back to the other window, it still uses the
5590 same relative offset.
5591 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005592 When 'diff' mode is active there always is vertical scroll binding,
5593 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594
5595 *'sections'* *'sect'*
5596'sections' 'sect' string (default "SHNHH HUnhsh")
5597 global
5598 Specifies the nroff macros that separate sections. These are pairs of
5599 two letters (See |object-motions|). The default makes a section start
5600 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5601
5602 *'secure'* *'nosecure'* *E523*
5603'secure' boolean (default off)
5604 global
5605 {not in Vi}
5606 When on, ":autocmd", shell and write commands are not allowed in
5607 ".vimrc" and ".exrc" in the current directory and map commands are
5608 displayed. Switch it off only if you know that you will not run into
5609 problems, or when the 'exrc' option is off. On Unix this option is
5610 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005611 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 'secure' at the end of your ~/.vimrc then.
5613 This option cannot be set from a |modeline| or in the |sandbox|, for
5614 security reasons.
5615
5616 *'selection'* *'sel'*
5617'selection' 'sel' string (default "inclusive")
5618 global
5619 {not in Vi}
5620 This option defines the behavior of the selection. It is only used
5621 in Visual and Select mode.
5622 Possible values:
5623 value past line inclusive ~
5624 old no yes
5625 inclusive yes yes
5626 exclusive yes no
5627 "past line" means that the cursor is allowed to be positioned one
5628 character past the line.
5629 "inclusive" means that the last character of the selection is included
5630 in an operation. For example, when "x" is used to delete the
5631 selection.
5632 Note that when "exclusive" is used and selecting from the end
5633 backwards, you cannot include the last character of a line, when
5634 starting in Normal mode and 'virtualedit' empty.
5635
5636 The 'selection' option is set by the |:behave| command.
5637
5638 *'selectmode'* *'slm'*
5639'selectmode' 'slm' string (default "")
5640 global
5641 {not in Vi}
5642 This is a comma separated list of words, which specifies when to start
5643 Select mode instead of Visual mode, when a selection is started.
5644 Possible values:
5645 mouse when using the mouse
5646 key when using shifted special keys
5647 cmd when using "v", "V" or CTRL-V
5648 See |Select-mode|.
5649 The 'selectmode' option is set by the |:behave| command.
5650
5651 *'sessionoptions'* *'ssop'*
5652'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005653 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 global
5655 {not in Vi}
5656 {not available when compiled without the +mksession
5657 feature}
5658 Changes the effect of the |:mksession| command. It is a comma
5659 separated list of words. Each word enables saving and restoring
5660 something:
5661 word save and restore ~
5662 blank empty windows
5663 buffers hidden and unloaded buffers, not just those in windows
5664 curdir the current directory
5665 folds manually created folds, opened/closed folds and local
5666 fold options
5667 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005668 and contain at least one lowercase letter. Only
5669 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 help the help window
5671 localoptions options and mappings local to a window or buffer (not
5672 global values for local options)
5673 options all options and mappings (also global values for local
5674 options)
5675 resize size of the Vim window: 'lines' and 'columns'
5676 sesdir the directory in which the session file is located
5677 will become the current directory (useful with
5678 projects accessed over a network from different
5679 systems)
5680 slash backslashes in file names replaced with forward
5681 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005682 tabpages all tab pages; without this only the current tab page
5683 is restored, so that you can make a session for each
5684 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 unix with Unix end-of-line format (single <NL>), even when
5686 on Windows or DOS
5687 winpos position of the whole Vim window
5688 winsize window sizes
5689
5690 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005691 When neither "curdir" nor "sesdir" is included, file names are stored
5692 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 "slash" and "unix" are useful on Windows when sharing session files
5694 with Unix. The Unix version of Vim cannot source dos format scripts,
5695 but the Windows version of Vim can source unix format scripts.
5696
5697 *'shell'* *'sh'* *E91*
5698'shell' 'sh' string (default $SHELL or "sh",
5699 MS-DOS and Win32: "command.com" or
5700 "cmd.exe", OS/2: "cmd")
5701 global
5702 Name of the shell to use for ! and :! commands. When changing the
5703 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5704 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005705 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 See |option-backslash| about including spaces and backslashes.
5707 Environment variables are expanded |:set_env|.
5708 If the name of the shell contains a space, you might need to enclose
5709 it in quotes. Example: >
5710 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5711< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005712 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 "-f" is not inside the quotes, because it is not part of the command
5714 name. And Vim automagically recognizes the backslashes that are path
5715 separators.
5716 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5717 variable to change the way external commands are executed. See the
5718 libc.inf file of DJGPP.
5719 Under MS-Windows, when the executable ends in ".com" it must be
5720 included. Thus setting the shell to "command.com" or "4dos.com"
5721 works, but "command" and "4dos" do not work for all commands (e.g.,
5722 filtering).
5723 For unknown reasons, when using "4dos.com" the current directory is
5724 changed to "C:\". To avoid this set 'shell' like this: >
5725 :set shell=command.com\ /c\ 4dos
5726< This option cannot be set from a |modeline| or in the |sandbox|, for
5727 security reasons.
5728
5729 *'shellcmdflag'* *'shcf'*
5730'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5731 does not contain "sh" somewhere: "/c")
5732 global
5733 {not in Vi}
5734 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5735 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5736 systems, the default is set according to the value of 'shell', to
5737 reduce the need to set this option by the user. It's not used for
5738 OS/2 (EMX figures this out itself). See |option-backslash| about
5739 including spaces and backslashes. See |dos-shell|.
5740 This option cannot be set from a |modeline| or in the |sandbox|, for
5741 security reasons.
5742
5743 *'shellpipe'* *'sp'*
5744'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5745 global
5746 {not in Vi}
5747 {not available when compiled without the |+quickfix|
5748 feature}
5749 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005750 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 including spaces and backslashes.
5752 The name of the temporary file can be represented by "%s" if necessary
5753 (the file name is appended automatically if no %s appears in the value
5754 of this option).
5755 For the Amiga and MS-DOS the default is ">". The output is directly
5756 saved in a file and not echoed to the screen.
5757 For Unix the default it "| tee". The stdout of the compiler is saved
5758 in a file and echoed to the screen. If the 'shell' option is "csh" or
5759 "tcsh" after initializations, the default becomes "|& tee". If the
5760 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005761 "2>&1| tee". This means that stderr is also included. Before using
5762 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 The initialization of this option is done after reading the ".vimrc"
5764 and the other initializations, so that when the 'shell' option is set
5765 there, the 'shellpipe' option changes automatically, unless it was
5766 explicitly set before.
5767 When 'shellpipe' is set to an empty string, no redirection of the
5768 ":make" output will be done. This is useful if you use a 'makeprg'
5769 that writes to 'makeef' by itself. If you want no piping, but do
5770 want to include the 'makeef', set 'shellpipe' to a single space.
5771 Don't forget to precede the space with a backslash: ":set sp=\ ".
5772 In the future pipes may be used for filtering and this option will
5773 become obsolete (at least for Unix).
5774 This option cannot be set from a |modeline| or in the |sandbox|, for
5775 security reasons.
5776
5777 *'shellquote'* *'shq'*
5778'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5779 contains "sh" somewhere: "\"")
5780 global
5781 {not in Vi}
5782 Quoting character(s), put around the command passed to the shell, for
5783 the "!" and ":!" commands. The redirection is kept outside of the
5784 quoting. See 'shellxquote' to include the redirection. It's
5785 probably not useful to set both options.
5786 This is an empty string by default. Only known to be useful for
5787 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5788 or bash, where it should be "\"". The default is adjusted according
5789 the value of 'shell', to reduce the need to set this option by the
5790 user. See |dos-shell|.
5791 This option cannot be set from a |modeline| or in the |sandbox|, for
5792 security reasons.
5793
5794 *'shellredir'* *'srr'*
5795'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5796 global
5797 {not in Vi}
5798 String to be used to put the output of a filter command in a temporary
5799 file. See also |:!|. See |option-backslash| about including spaces
5800 and backslashes.
5801 The name of the temporary file can be represented by "%s" if necessary
5802 (the file name is appended automatically if no %s appears in the value
5803 of this option).
5804 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5805 or "zsh" during initializations, the default becomes ">&". If the
5806 'shell' option is "sh", "ksh" or "bash" the default becomes
5807 ">%s 2>&1". This means that stderr is also included.
5808 For Win32, the Unix checks are done and additionally "cmd" is checked
5809 for, which makes the default ">%s 2>&1". Also, the same names with
5810 ".exe" appended are checked for.
5811 The initialization of this option is done after reading the ".vimrc"
5812 and the other initializations, so that when the 'shell' option is set
5813 there, the 'shellredir' option changes automatically unless it was
5814 explicitly set before.
5815 In the future pipes may be used for filtering and this option will
5816 become obsolete (at least for Unix).
5817 This option cannot be set from a |modeline| or in the |sandbox|, for
5818 security reasons.
5819
5820 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5821'shellslash' 'ssl' boolean (default off)
5822 global
5823 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5824 When set, a forward slash is used when expanding file names. This is
5825 useful when a Unix-like shell is used instead of command.com or
5826 cmd.exe. Backward slashes can still be typed, but they are changed to
5827 forward slashes by Vim.
5828 Note that setting or resetting this option has no effect for some
5829 existing file names, thus this option needs to be set before opening
5830 any file for best results. This might change in the future.
5831 'shellslash' only works when a backslash can be used as a path
5832 separator. To test if this is so use: >
5833 if exists('+shellslash')
5834<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005835 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5836'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5837 global
5838 {not in Vi}
5839 When on, use temp files for shell commands. When off use a pipe.
5840 When using a pipe is not possible temp files are used anyway.
5841 Currently a pipe is only supported on Unix. You can check it with: >
5842 :if has("filterpipe")
5843< The advantage of using a pipe is that nobody can read the temp file
5844 and the 'shell' command does not need to support redirection.
5845 The advantage of using a temp file is that the file type and encoding
5846 can be detected.
5847 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5848 |FilterWritePost| autocommands event are not triggered when
5849 'shelltemp' is off.
5850
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 *'shelltype'* *'st'*
5852'shelltype' 'st' number (default 0)
5853 global
5854 {not in Vi} {only for the Amiga}
5855 On the Amiga this option influences the way how the commands work
5856 which use a shell.
5857 0 and 1: always use the shell
5858 2 and 3: use the shell only to filter lines
5859 4 and 5: use shell only for ':sh' command
5860 When not using the shell, the command is executed directly.
5861
5862 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5863 1 and 3: use "shell cmd" to start external commands
5864
5865 *'shellxquote'* *'sxq'*
5866'shellxquote' 'sxq' string (default: "";
5867 for Win32, when 'shell' contains "sh"
5868 somewhere: "\""
5869 for Unix, when using system(): "\"")
5870 global
5871 {not in Vi}
5872 Quoting character(s), put around the command passed to the shell, for
5873 the "!" and ":!" commands. Includes the redirection. See
5874 'shellquote' to exclude the redirection. It's probably not useful
5875 to set both options.
5876 This is an empty string by default. Known to be useful for
5877 third-party shells when using the Win32 version, such as the MKS Korn
5878 Shell or bash, where it should be "\"". The default is adjusted
5879 according the value of 'shell', to reduce the need to set this option
5880 by the user. See |dos-shell|.
5881 This option cannot be set from a |modeline| or in the |sandbox|, for
5882 security reasons.
5883
5884 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5885'shiftround' 'sr' boolean (default off)
5886 global
5887 {not in Vi}
5888 Round indent to multiple of 'shiftwidth'. Applies to > and <
5889 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5890 a multiple of 'shiftwidth' (this is Vi compatible).
5891 NOTE: This option is reset when 'compatible' is set.
5892
5893 *'shiftwidth'* *'sw'*
5894'shiftwidth' 'sw' number (default 8)
5895 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005896 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 |'cindent'|, |>>|, |<<|, etc.
5898
5899 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005900'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5901 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005902 global
5903 {not in Vi}
5904 This option helps to avoid all the |hit-enter| prompts caused by file
5905 messages, for example with CTRL-G, and to avoid some other messages.
5906 It is a list of flags:
5907 flag meaning when present ~
5908 f use "(3 of 5)" instead of "(file 3 of 5)"
5909 i use "[noeol]" instead of "[Incomplete last line]"
5910 l use "999L, 888C" instead of "999 lines, 888 characters"
5911 m use "[+]" instead of "[Modified]"
5912 n use "[New]" instead of "[New File]"
5913 r use "[RO]" instead of "[readonly]"
5914 w use "[w]" instead of "written" for file write message
5915 and "[a]" instead of "appended" for ':w >> file' command
5916 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5917 "[unix format]" and "[mac]" instead of "[mac format]".
5918 a all of the above abbreviations
5919
5920 o overwrite message for writing a file with subsequent message
5921 for reading a file (useful for ":wn" or when 'autowrite' on)
5922 O message for reading a file overwrites any previous message.
5923 Also for quickfix message (e.g., ":cn").
5924 s don't give "search hit BOTTOM, continuing at TOP" or "search
5925 hit TOP, continuing at BOTTOM" messages
5926 t truncate file message at the start if it is too long to fit
5927 on the command-line, "<" will appear in the left most column.
5928 Ignored in Ex mode.
5929 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005930 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005931 Ignored in Ex mode.
5932 W don't give "written" or "[w]" when writing a file
5933 A don't give the "ATTENTION" message when an existing swap file
5934 is found.
5935 I don't give the intro message when starting Vim |:intro|.
5936
5937 This gives you the opportunity to avoid that a change between buffers
5938 requires you to hit <Enter>, but still gives as useful a message as
5939 possible for the space available. To get the whole message that you
5940 would have got with 'shm' empty, use ":file!"
5941 Useful values:
5942 shm= No abbreviation of message.
5943 shm=a Abbreviation, but no loss of information.
5944 shm=at Abbreviation, and truncate message when necessary.
5945
5946 NOTE: This option is set to the Vi default value when 'compatible' is
5947 set and to the Vim default value when 'compatible' is reset.
5948
5949 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5950'shortname' 'sn' boolean (default off)
5951 local to buffer
5952 {not in Vi, not in MS-DOS versions}
5953 Filenames are assumed to be 8 characters plus one extension of 3
5954 characters. Multiple dots in file names are not allowed. When this
5955 option is on, dots in file names are replaced with underscores when
5956 adding an extension (".~" or ".swp"). This option is not available
5957 for MS-DOS, because then it would always be on. This option is useful
5958 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5959 or crossdos. When running the Win32 GUI version under Win32s, this
5960 option is always on by default.
5961
5962 *'showbreak'* *'sbr'* *E595*
5963'showbreak' 'sbr' string (default "")
5964 global
5965 {not in Vi}
5966 {not available when compiled without the |+linebreak|
5967 feature}
5968 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005969 values are "> " or "+++ ": >
5970 :set showbreak=>\
5971< Note the backslash to escape the trailing space. It's easier like
5972 this: >
5973 :let &showbreak = '+++ '
5974< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005975 comma (in a future version the comma might be used to separate the
5976 part that is shown at the end and at the start of a line).
5977 The characters are highlighted according to the '@' flag in
5978 'highlight'.
5979 Note that tabs after the showbreak will be displayed differently.
5980 If you want the 'showbreak' to appear in between line numbers, add the
5981 "n" flag to 'cpoptions'.
5982
5983 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5984'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5985 off)
5986 global
5987 {not in Vi}
5988 {not available when compiled without the
5989 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005990 Show (partial) command in the last line of the screen. Set this
5991 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005992 In Visual mode the size of the selected area is shown:
5993 - When selecting characters within a line, the number of characters.
5994 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005995 - When selecting a block, the size in screen characters:
5996 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 NOTE: This option is set to the Vi default value when 'compatible' is
5998 set and to the Vim default value when 'compatible' is reset.
5999
6000 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6001'showfulltag' 'sft' boolean (default off)
6002 global
6003 {not in Vi}
6004 When completing a word in insert mode (see |ins-completion|) from the
6005 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006006 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006007 matched a C function, you can see a template for what arguments are
6008 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006009 Note that this doesn't work well together with having "longest" in
6010 'completeopt', because the completion from the search pattern may not
6011 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012
6013 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6014'showmatch' 'sm' boolean (default off)
6015 global
6016 When a bracket is inserted, briefly jump to the matching one. The
6017 jump is only done if the match can be seen on the screen. The time to
6018 show the match can be set with 'matchtime'.
6019 A Beep is given if there is no match (no matter if the match can be
6020 seen or not). This option is reset when the 'paste' option is set.
6021 When the 'm' flag is not included in 'cpoptions', typing a character
6022 will immediately move the cursor back to where it belongs.
6023 See the "sm" field in 'guicursor' for setting the cursor shape and
6024 blinking when showing the match.
6025 The 'matchpairs' option can be used to specify the characters to show
6026 matches for. 'rightleft' and 'revins' are used to look for opposite
6027 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006028 Also see the matchparen plugin for highlighting the match when moving
6029 around |pi_paren.txt|.
6030 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031
6032 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6033'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6034 global
6035 If in Insert, Replace or Visual mode put a message on the last line.
6036 Use the 'M' flag in 'highlight' to set the type of highlighting for
6037 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006038 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 doesn't mean XIM is really active, especially when 'imactivatekey' is
6040 not set.
6041 NOTE: This option is set to the Vi default value when 'compatible' is
6042 set and to the Vim default value when 'compatible' is reset.
6043
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006044 *'showtabline'* *'stal'*
6045'showtabline' 'stal' number (default 1)
6046 global
6047 {not in Vi}
6048 {not available when compiled without the +windows
6049 feature}
6050 The value of this option specifies when the line with tab page labels
6051 will be displayed:
6052 0: never
6053 1: only if there are at least two tab pages
6054 2: always
6055 This is both for the GUI and non-GUI implementation of the tab pages
6056 line.
6057 See |tab-page| for more information about tab pages.
6058
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 *'sidescroll'* *'ss'*
6060'sidescroll' 'ss' number (default 0)
6061 global
6062 {not in Vi}
6063 The minimal number of columns to scroll horizontally. Used only when
6064 the 'wrap' option is off and the cursor is moved off of the screen.
6065 When it is zero the cursor will be put in the middle of the screen.
6066 When using a slow terminal set it to a large number or 0. When using
6067 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6068 commands.
6069
6070 *'sidescrolloff'* *'siso'*
6071'sidescrolloff' 'siso' number (default 0)
6072 global
6073 {not in Vi}
6074 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006075 right of the cursor if 'nowrap' is set. Setting this option to a
6076 value greater than 0 while having |'sidescroll'| also at a non-zero
6077 value makes some context visible in the line you are scrolling in
6078 horizontally (except at beginning of the line). Setting this option
6079 to a large value (like 999) has the effect of keeping the cursor
6080 horizontally centered in the window, as long as one does not come too
6081 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 NOTE: This option is set to 0 when 'compatible' is set.
6083
6084 Example: Try this together with 'sidescroll' and 'listchars' as
6085 in the following example to never allow the cursor to move
6086 onto the "extends" character:
6087
6088 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6089 :set sidescrolloff=1
6090
6091
6092 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6093'smartcase' 'scs' boolean (default off)
6094 global
6095 {not in Vi}
6096 Override the 'ignorecase' option if the search pattern contains upper
6097 case characters. Only used when the search pattern is typed and
6098 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006099 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6101 recalling the search pattern from history and hitting <Enter>.
6102 NOTE: This option is reset when 'compatible' is set.
6103
6104 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6105'smartindent' 'si' boolean (default off)
6106 local to buffer
6107 {not in Vi}
6108 {not available when compiled without the
6109 |+smartindent| feature}
6110 Do smart autoindenting when starting a new line. Works for C-like
6111 programs, but can also be used for other languages. 'cindent' does
6112 something like this, works better in most cases, but is more strict,
6113 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6114 'indentexpr' is a more advanced alternative.
6115 Normally 'autoindent' should also be on when using 'smartindent'.
6116 An indent is automatically inserted:
6117 - After a line ending in '{'.
6118 - After a line starting with a keyword from 'cinwords'.
6119 - Before a line starting with '}' (only with the "O" command).
6120 When typing '}' as the first character in a new line, that line is
6121 given the same indent as the matching '{'.
6122 When typing '#' as the first character in a new line, the indent for
6123 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006124 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6126 When using the ">>" command, lines starting with '#' are not shifted
6127 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006128 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 is set smart indenting is disabled.
6130
6131 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6132'smarttab' 'sta' boolean (default off)
6133 global
6134 {not in Vi}
6135 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006136 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6137 <BS> will delete a 'shiftwidth' worth of space at the start of the
6138 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006139 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006140 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6141 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006142 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006144 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 NOTE: This option is reset when 'compatible' is set.
6146
6147 *'softtabstop'* *'sts'*
6148'softtabstop' 'sts' number (default 0)
6149 local to buffer
6150 {not in Vi}
6151 Number of spaces that a <Tab> counts for while performing editing
6152 operations, like inserting a <Tab> or using <BS>. It "feels" like
6153 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6154 used. This is useful to keep the 'ts' setting at its standard value
6155 of 8, while being able to edit like it is set to 'sts'. However,
6156 commands like "x" still work on the actual characters.
6157 When 'sts' is zero, this feature is off.
6158 'softtabstop' is set to 0 when the 'paste' option is set.
6159 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6160 spaces is minimized by using <Tab>s.
6161 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6162 set.
6163 NOTE: This option is set to 0 when 'compatible' is set.
6164
Bram Moolenaar217ad922005-03-20 22:37:15 +00006165 *'spell'* *'nospell'*
6166'spell' boolean (default off)
6167 local to window
6168 {not in Vi}
6169 {not available when compiled without the |+syntax|
6170 feature}
6171 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006172 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006173
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006174 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006175'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006176 local to buffer
6177 {not in Vi}
6178 {not available when compiled without the |+syntax|
6179 feature}
6180 Pattern to locate the end of a sentence. The following word will be
6181 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006182 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006183 When this check is not wanted make this option empty.
6184 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006185 Be careful with special characters, see |option-backslash| about
6186 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006187 To set this option automatically depending on the language, see
6188 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006189
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006190 *'spellfile'* *'spf'*
6191'spellfile' 'spf' string (default empty)
6192 local to buffer
6193 {not in Vi}
6194 {not available when compiled without the |+syntax|
6195 feature}
6196 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006197 commands. It must end in ".{encoding}.add". You need to include the
6198 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006199 *E765*
6200 It may also be a comma separated list of names. A count before the
6201 |zg| and |zw| commands can be used to access each. This allows using
6202 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006203 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006204 you: Using the first directory in 'runtimepath' that is writable. If
6205 there is no "spell" directory yet it will be created. For the file
6206 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006207 ignoring the region.
6208 The resulting ".spl" file will be used for spell checking, it does not
6209 have to appear in 'spelllang'.
6210 Normally one file is used for all regions, but you can add the region
6211 name if you want to. However, it will then only be used when
6212 'spellfile' is set to it, for entries in 'spelllang' only files
6213 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006214 This option cannot be set from a |modeline| or in the |sandbox|, for
6215 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006216
Bram Moolenaar217ad922005-03-20 22:37:15 +00006217 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006218'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006219 local to buffer
6220 {not in Vi}
6221 {not available when compiled without the |+syntax|
6222 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006223 A comma separated list of word list names. When the 'spell' option is
6224 on spellchecking will be done for these languages. Example: >
6225 set spelllang=en_us,nl,medical
6226< This means US English, Dutch and medical words are recognized. Words
6227 that are not recognized will be highlighted.
6228 The word list name must not include a comma or dot. Using a dash is
6229 recommended to separate the two letter language name from a
6230 specification. Thus "en-rare" is used for rare English words.
6231 A region name must come last and have the form "_xx", where "xx" is
6232 the two-letter, lower case region name. You can use more than one
6233 region by listing them: "en_us,en_ca" supports both US and Canadian
6234 English, but not words specific for Australia, New Zealand or Great
6235 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006236 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006237 As a special case the name of a .spl file can be given as-is. The
6238 first "_xx" in the name is removed and used as the region name
6239 (_xx is an underscore, two letters and followed by a non-letter).
6240 This is mainly for testing purposes. You must make sure the correct
6241 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006242 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006243 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6244 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006245 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006246
Bram Moolenaar98692072006-02-04 00:57:42 +00006247 If the |spellfile.vim| plugin is active and you use a language name
6248 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6249 will ask you if you want to download the file.
6250
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006251 After this option has been set successfully, Vim will source the files
6252 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006253 up to the first comma, dot or underscore.
6254 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006255
6256
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006257 *'spellsuggest'* *'sps'*
6258'spellsuggest' 'sps' string (default "best")
6259 global
6260 {not in Vi}
6261 {not available when compiled without the |+syntax|
6262 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006263 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006264 the |spellsuggest()| function. This is a comma-separated list of
6265 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006266
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006267 best Internal method that works best for English. Finds
6268 changes like "fast" and uses a bit of sound-a-like
6269 scoring to improve the ordering.
6270
6271 double Internal method that uses two methods and mixes the
6272 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006273 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006274 word. That only works when the language specifies
6275 sound folding. Can be slow and doesn't always give
6276 better results.
6277
6278 fast Internal method that only checks for simple changes:
6279 character inserts/deletes/swaps. Works well for
6280 simple typing mistakes.
6281
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006282 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006283 Not used for |spellsuggest()|. The number of
6284 suggestions is never more than the value of 'lines'
6285 minus two.
6286
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006287 file:{filename} Read file {filename}, which must have two columns,
6288 separated by a slash. The first column contains the
6289 bad word, the second column the suggested good word.
6290 Example:
6291 theribal/terrible ~
6292 Use this for common mistakes that do not appear at the
6293 top of the suggestion list with the internal methods.
6294 Lines without a slash are ignored, use this for
6295 comments.
6296 The file is used for all languages.
6297
6298 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6299 trouble with spaces. |v:val| holds the badly spelled
6300 word. The expression must evaluate to a List of
6301 Lists, each with a suggestion and a score.
6302 Example:
6303 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006304 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006305 internal methods use. A lower score is better.
6306 This may invoke |spellsuggest()| if you temporarily
6307 set 'spellsuggest' to exclude the "expr:" part.
6308 Errors are silently ignored, unless you set the
6309 'verbose' option to a non-zero value.
6310
6311 Only one of "best", "double" or "fast" may be used. The others may
6312 appear several times in any order. Example: >
6313 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6314<
6315 This option cannot be set from a |modeline| or in the |sandbox|, for
6316 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006317
6318
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6320'splitbelow' 'sb' boolean (default off)
6321 global
6322 {not in Vi}
6323 {not available when compiled without the +windows
6324 feature}
6325 When on, splitting a window will put the new window below the current
6326 one. |:split|
6327
6328 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6329'splitright' 'spr' boolean (default off)
6330 global
6331 {not in Vi}
6332 {not available when compiled without the +vertsplit
6333 feature}
6334 When on, splitting a window will put the new window right of the
6335 current one. |:vsplit|
6336
6337 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6338'startofline' 'sol' boolean (default on)
6339 global
6340 {not in Vi}
6341 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006342 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006343 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006344 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 with a linewise operator, with "%" with a count and to buffer changing
6346 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6347 only has a line number, e.g., ":25" or ":+".
6348 In case of buffer changing commands the cursor is placed at the column
6349 where it was the last time the buffer was edited.
6350 NOTE: This option is set when 'compatible' is set.
6351
6352 *'statusline'* *'stl'* *E540* *E541* *E542*
6353'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006354 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 {not in Vi}
6356 {not available when compiled without the |+statusline|
6357 feature}
6358 When nonempty, this option determines the content of the status line.
6359 Also see |status-line|.
6360
6361 The option consists of printf style '%' items interspersed with
6362 normal text. Each status line item is of the form:
6363 %-0{minwid}.{maxwid}{item}
6364 All fields except the {item} is optional. A single percent sign can
6365 be given as "%%". Up to 80 items can be specified.
6366
Bram Moolenaar238a5642006-02-21 22:12:05 +00006367 When the option starts with "%!" then it is used as an expression,
6368 evaluated and the result is used as the option value. Example: >
6369 :set statusline=%!MyStatusLine()
6370< The result can contain %{} items that will be evaluated too.
6371
6372 When there is error while evaluating the option then it will be made
6373 empty to avoid further errors. Otherwise screen updating would loop.
6374
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 Note that the only effect of 'ruler' when this option is set (and
6376 'laststatus' is 2) is controlling the output of |CTRL-G|.
6377
6378 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006379 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006381 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 minwid Minimum width of the item, padding as set by '-' & '0'.
6383 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006384 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 on the left for text items. Numeric items will be
6386 shifted down to maxwid-2 digits followed by '>'number
6387 where number is the amount of missing digits, much like
6388 an exponential notation.
6389 item A one letter code as described below.
6390
6391 Following is a description of the possible statusline items. The
6392 second character in "item" is the type:
6393 N for number
6394 S for string
6395 F for flags as described below
6396 - not applicable
6397
6398 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006399 f S Path to the file in the buffer, as typed or relative to current
6400 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 F S Full path to the file in the buffer.
6402 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006403 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006405 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006407 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006409 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006411 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6413 {not available when compiled without |+autocmd| feature}
6414 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6415 being used: "<keymap>"
6416 n N Buffer number.
6417 b N Value of byte under cursor.
6418 B N As above, in hexadecimal.
6419 o N Byte number in file of byte under cursor, first byte is 1.
6420 Mnemonic: Offset from start of file (with one added)
6421 {not available when compiled without |+byte_offset| feature}
6422 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006423 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 l N Line number.
6425 L N Number of lines in buffer.
6426 c N Column number.
6427 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006428 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006429 p N Percentage through file in lines as in |CTRL-G|.
6430 P S Percentage through file of displayed window. This is like the
6431 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006432 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006434 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006435 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 ( - Start of item group. Can be used for setting the width and
6437 alignment of a section. Must be followed by %) somewhere.
6438 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006439 T N For 'tabline': start of tab page N label. Use %T after the last
6440 label. This information is used for mouse clicks.
6441 X N For 'tabline': start of close tab N label. Use %X after the
6442 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6443 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 < - Where to truncate line if too long. Default is at the start.
6445 No width fields allowed.
6446 = - Separation point between left and right aligned items.
6447 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006448 # - Set highlight group. The name must follow and then a # again.
6449 Thus use %#HLname# for highlight group HLname. The same
6450 highlighting is used, also for the statusline of non-current
6451 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006453 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 The difference between User{N} and StatusLine will be applied
6455 to StatusLineNC for the statusline of non-current windows.
6456 The number N must be between 1 and 9. See |hl-User1..9|
6457
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006458 When displaying a flag, Vim removes the leading comma, if any, when
6459 that flag comes right after plaintext. This will make a nice display
6460 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461
Bram Moolenaar582fd852005-03-28 20:58:01 +00006462 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 not set) and a minwid is not set for the group, the whole group will
6464 become empty. This will make a group like the following disappear
6465 completely from the statusline when none of the flags are set. >
6466 :set statusline=...%(\ [%M%R%H]%)...
6467<
6468 Beware that an expression is evaluated each and every time the status
6469 line is displayed. The current buffer and current window will be set
6470 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006471 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006473 real current buffer.
6474
6475 The 'statusline' option may be evaluated in the |sandbox|, see
6476 |sandbox-option|.
6477
6478 It is not allowed to change text or jump to another window while
6479 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480
6481 If the statusline is not updated when you want it (e.g., after setting
6482 a variable that's used in an expression), you can force an update by
6483 setting an option without changing its value. Example: >
6484 :let &ro = &ro
6485
6486< A result of all digits is regarded a number for display purposes.
6487 Otherwise the result is taken as flag text and applied to the rules
6488 described above.
6489
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006490 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6492 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6493
6494 Examples:
6495 Emulate standard status line with 'ruler' set >
6496 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6497< Similar, but add ASCII value of char under the cursor (like "ga") >
6498 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6499< Display byte count and byte value, modified flag in red. >
6500 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6501 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6502< Display a ,GZ flag if a compressed file is loaded >
6503 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6504< In the |:autocmd|'s: >
6505 :let b:gzflag = 1
6506< And: >
6507 :unlet b:gzflag
6508< And define this function: >
6509 :function VarExists(var, val)
6510 : if exists(a:var) | return a:val | else | return '' | endif
6511 :endfunction
6512<
6513 *'suffixes'* *'su'*
6514'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6515 global
6516 {not in Vi}
6517 Files with these suffixes get a lower priority when multiple files
6518 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006519 suffixes. Spaces after the comma are ignored. A dot is also seen as
6520 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 separator, precede it with a backslash (see |option-backslash| about
6522 including spaces and backslashes).
6523 See 'wildignore' for completely ignoring files.
6524 The use of |:set+=| and |:set-=| is preferred when adding or removing
6525 suffixes from the list. This avoids problems when a future version
6526 uses another default.
6527
6528 *'suffixesadd'* *'sua'*
6529'suffixesadd' 'sua' string (default "")
6530 local to buffer
6531 {not in Vi}
6532 {not available when compiled without the
6533 |+file_in_path| feature}
6534 Comma separated list of suffixes, which are used when searching for a
6535 file for the "gf", "[I", etc. commands. Example: >
6536 :set suffixesadd=.java
6537<
6538 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6539'swapfile' 'swf' boolean (default on)
6540 local to buffer
6541 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006542 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543 swapfile is not wanted for a specific buffer. For example, with
6544 confidential information that even root must not be able to access.
6545 Careful: All text will be in memory:
6546 - Don't use this for big files.
6547 - Recovery will be impossible!
6548 A swapfile will only be present when |'updatecount'| is non-zero and
6549 'swapfile' is set.
6550 When 'swapfile' is reset, the swap file for the current buffer is
6551 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6552 non-zero, a swap file is immediately created.
6553 Also see |swap-file| and |'swapsync'|.
6554
6555 This option is used together with 'bufhidden' and 'buftype' to
6556 specify special kinds of buffers. See |special-buffers|.
6557
6558 *'swapsync'* *'sws'*
6559'swapsync' 'sws' string (default "fsync")
6560 global
6561 {not in Vi}
6562 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006563 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 When this option is empty parts of the swap file may be in memory and
6565 not written to disk. When the system crashes you may lose more work.
6566 On Unix the system does a sync now and then without Vim asking for it,
6567 so the disadvantage of setting this option off is small. On some
6568 systems the swap file will not be written at all. For a unix system
6569 setting it to "sync" will use the sync() call instead of the default
6570 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006571 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572
6573 *'switchbuf'* *'swb'*
6574'switchbuf' 'swb' string (default "")
6575 global
6576 {not in Vi}
6577 This option controls the behavior when switching between buffers.
6578 Possible values (comma separated list):
6579 useopen If included, jump to the first open window that
6580 contains the specified buffer (if there is one).
6581 Otherwise: Do not examine other windows.
6582 This setting is checked with |quickfix| commands, when
6583 jumping to errors (":cc", ":cn", "cp", etc.). It is
6584 also used in all buffer related split commands, for
6585 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006586 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006587 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006589 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006591 newtab Like "split", but open a new tab page. Overrules
6592 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006594 *'synmaxcol'* *'smc'*
6595'synmaxcol' 'smc' number (default 3000)
6596 local to buffer
6597 {not in Vi}
6598 {not available when compiled without the |+syntax|
6599 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006600 Maximum column in which to search for syntax items. In long lines the
6601 text after this column is not highlighted and following lines may not
6602 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006603 This helps to avoid very slow redrawing for an XML file that is one
6604 long line.
6605 Set to zero to remove the limit.
6606
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 *'syntax'* *'syn'*
6608'syntax' 'syn' string (default empty)
6609 local to buffer
6610 {not in Vi}
6611 {not available when compiled without the |+syntax|
6612 feature}
6613 When this option is set, the syntax with this name is loaded, unless
6614 syntax highlighting has been switched off with ":syntax off".
6615 Otherwise this option does not always reflect the current syntax (the
6616 b:current_syntax variable does).
6617 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006618 not automatically recognized. Example, in an IDL file:
6619 /* vim: set syntax=idl : */ ~
6620 When a dot appears in the value then this separates two filetype
6621 names. Example:
6622 /* vim: set syntax=c.doxygen : */ ~
6623 This will use the "c" syntax first, then the "doxygen" syntax.
6624 Note that the second one must be prepared to be loaded as an addition,
6625 otherwise it will be skipped. More than one dot may appear.
6626 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 :set syntax=OFF
6628< To switch syntax highlighting on according to the current value of the
6629 'filetype' option: >
6630 :set syntax=ON
6631< What actually happens when setting the 'syntax' option is that the
6632 Syntax autocommand event is triggered with the value as argument.
6633 This option is not copied to another buffer, independent of the 's' or
6634 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006635 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006637 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006638'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006639 global
6640 {not in Vi}
6641 {not available when compiled without the +windows
6642 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006643 When nonempty, this option determines the content of the tab pages
6644 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006645 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006646
6647 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006648 option and only when there is no GUI tab line. When 'e' is in
6649 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6650 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006651
6652 The value is evaluated like with 'statusline'. You can use
6653 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006654 the text to be displayed. Use "%1T" for the first label, "%2T" for
6655 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006656
6657 Keep in mind that only one of the tab pages is the current one, others
6658 are invisible and you can't jump to their windows.
6659
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006660
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006661 *'tabpagemax'* *'tpm'*
6662'tabpagemax' 'tpm' number (default 10)
6663 global
6664 {not in Vi}
6665 {not available when compiled without the +windows
6666 feature}
6667 Maximum number of tab pages to be opened by the |-p| command line
6668 argument or the ":tab all" command. |tabpage|
6669
6670
6671 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672'tabstop' 'ts' number (default 8)
6673 local to buffer
6674 Number of spaces that a <Tab> in the file counts for. Also see
6675 |:retab| command, and 'softtabstop' option.
6676
6677 Note: Setting 'tabstop' to any other value than 8 can make your file
6678 appear wrong in many places (e.g., when printing it).
6679
6680 There are four main ways to use tabs in Vim:
6681 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6682 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006683 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 behave like a tab appears every 4 (or 3) characters.
6685 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6686 'expandtab'. This way you will always insert spaces. The
6687 formatting will never be messed up when 'tabstop' is changed.
6688 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006689 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 works when using Vim to edit the file.
6691 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6692 'noexpandtab'. This should then work (for initial indents only)
6693 for any tabstop setting that people use. It might be nice to have
6694 tabs after the first non-blank inserted as spaces if you do this
6695 though. Otherwise aligned comments will be wrong when 'tabstop' is
6696 changed.
6697
6698 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6699'tagbsearch' 'tbs' boolean (default on)
6700 global
6701 {not in Vi}
6702 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006703 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 searching makes searching for a tag a LOT faster, but a linear search
6705 will find more tags if the tags file wasn't properly sorted.
6706 Vim normally assumes that your tags files are sorted, or indicate that
6707 they are not sorted. Only when this is not the case does the
6708 'tagbsearch' option need to be switched off.
6709
6710 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006711 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 certain files, or retry all files with a linear search. When
6713 'tagbsearch' is off, only a linear search is done.
6714
6715 Linear searching is done anyway, for one file, when Vim finds a line
6716 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006717 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718< [The whitespace before and after the '0' must be a single <Tab>]
6719
6720 When a binary search was done and no match was found in any of the
6721 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6722 instead of a normal tag name, a retry is done with a linear search.
6723 Tags in unsorted tags files, and matches with different case will only
6724 be found in the retry.
6725
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006726 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 linear search can be avoided for the 'ignorecase' case. Use a value
6728 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6729 case-fold sorted with the -f switch to "sort" in most unices, as in
6730 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006731 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6732 for this as well. Note that case must be folded to uppercase for this
6733 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734
6735 When 'tagbsearch' is off, tags searching is slower when a full match
6736 exists, but faster when no full match exists. Tags in unsorted tags
6737 files may only be found with 'tagbsearch' off.
6738 When the tags file is not sorted, or sorted in a wrong way (not on
6739 ASCII byte value), 'tagbsearch' should be off, or the line given above
6740 must be included in the tags file.
6741 This option doesn't affect commands that find all matching tags (e.g.,
6742 command-line completion and ":help").
6743 {Vi: always uses binary search in some versions}
6744
6745 *'taglength'* *'tl'*
6746'taglength' 'tl' number (default 0)
6747 global
6748 If non-zero, tags are significant up to this number of characters.
6749
6750 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6751'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6752 global
6753 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006754 If on and using a tags file in another directory, file names in that
6755 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006756 NOTE: This option is set to the Vi default value when 'compatible' is
6757 set and to the Vim default value when 'compatible' is reset.
6758
6759 *'tags'* *'tag'* *E433*
6760'tags' 'tag' string (default "./tags,tags", when compiled with
6761 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6762 global or local to buffer |global-local|
6763 Filenames for the tag command, separated by spaces or commas. To
6764 include a space or comma in a file name, precede it with a backslash
6765 (see |option-backslash| about including spaces and backslashes).
6766 When a file name starts with "./", the '.' is replaced with the path
6767 of the current file. But only when the 'd' flag is not included in
6768 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6769 |tags-option|.
6770 "*", "**" and other wildcards can be used to search for tags files in
6771 a directory tree. See |file-searching|. {not available when compiled
6772 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006773 The |tagfiles()| function can be used to get a list of the file names
6774 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6776 files are also supported. They are automatically recognized. The
6777 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6778 differences are ignored (MS-Windows). |emacs-tags|
6779 The use of |:set+=| and |:set-=| is preferred when adding or removing
6780 file names from the list. This avoids problems when a future version
6781 uses another default.
6782 {Vi: default is "tags /usr/lib/tags"}
6783
6784 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6785'tagstack' 'tgst' boolean (default on)
6786 global
6787 {not in all versions of Vi}
6788 When on, the |tagstack| is used normally. When off, a ":tag" or
6789 ":tselect" command with an argument will not push the tag onto the
6790 tagstack. A following ":tag" without an argument, a ":pop" command or
6791 any other command that uses the tagstack will use the unmodified
6792 tagstack, but does change the pointer to the active entry.
6793 Resetting this option is useful when using a ":tag" command in a
6794 mapping which should not change the tagstack.
6795
6796 *'term'* *E529* *E530* *E531*
6797'term' string (default is $TERM, if that fails:
6798 in the GUI: "builtin_gui"
6799 on Amiga: "amiga"
6800 on BeOS: "beos-ansi"
6801 on Mac: "mac-ansi"
6802 on MiNT: "vt52"
6803 on MS-DOS: "pcterm"
6804 on OS/2: "os2ansi"
6805 on Unix: "ansi"
6806 on VMS: "ansi"
6807 on Win 32: "win32")
6808 global
6809 Name of the terminal. Used for choosing the terminal control
6810 characters. Environment variables are expanded |:set_env|.
6811 For example: >
6812 :set term=$TERM
6813< See |termcap|.
6814
6815 *'termbidi'* *'tbidi'*
6816 *'notermbidi'* *'notbidi'*
6817'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6818 global
6819 {not in Vi}
6820 {only available when compiled with the |+arabic|
6821 feature}
6822 The terminal is in charge of Bi-directionality of text (as specified
6823 by Unicode). The terminal is also expected to do the required shaping
6824 that some languages (such as Arabic) require.
6825 Setting this option implies that 'rightleft' will not be set when
6826 'arabic' is set and the value of 'arabicshape' will be ignored.
6827 Note that setting 'termbidi' has the immediate effect that
6828 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6829 This option is reset when the GUI is started.
6830 For further details see |arabic.txt|.
6831
6832 *'termencoding'* *'tenc'*
6833'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6834 Macintosh GUI: "macroman")
6835 global
6836 {only available when compiled with the |+multi_byte|
6837 feature}
6838 {not in Vi}
6839 Encoding used for the terminal. This specifies what character
6840 encoding the keyboard produces and the display will understand. For
6841 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006842 display). Except for the Mac when 'macatsui' is off, then
6843 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 In the Win32 console version the default value is the console codepage
6845 when it differs from the ANSI codepage.
6846 *E617*
6847 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6848 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6849 Any attempts to set a different value will be rejected, and an error
6850 message is shown.
6851 For the Win32 GUI 'termencoding' is not used for typed characters,
6852 because the Win32 system always passes Unicode characters.
6853 When empty, the same encoding is used as for the 'encoding' option.
6854 This is the normal value.
6855 Not all combinations for 'termencoding' and 'encoding' are valid. See
6856 |encoding-table|.
6857 The value for this option must be supported by internal conversions or
6858 iconv(). When this is not possible no conversion will be done and you
6859 will probably experience problems with non-ASCII characters.
6860 Example: You are working with the locale set to euc-jp (Japanese) and
6861 want to edit a UTF-8 file: >
6862 :let &termencoding = &encoding
6863 :set encoding=utf-8
6864< You need to do this when your system has no locale support for UTF-8.
6865
6866 *'terse'* *'noterse'*
6867'terse' boolean (default off)
6868 global
6869 When set: Add 's' flag to 'shortmess' option (this makes the message
6870 for a search that hits the start or end of the file not being
6871 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6872 shortens a lot of messages}
6873
6874 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6875'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6876 global
6877 {not in Vi}
6878 This option is obsolete. Use 'fileformats'.
6879 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6880 set to the default value for the current system. When 'textauto' is
6881 reset, 'fileformats' is made empty.
6882 NOTE: This option is set to the Vi default value when 'compatible' is
6883 set and to the Vim default value when 'compatible' is reset.
6884
6885 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6886'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6887 others: default off)
6888 local to buffer
6889 {not in Vi}
6890 This option is obsolete. Use 'fileformat'.
6891 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6892 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6893 "unix".
6894
6895 *'textwidth'* *'tw'*
6896'textwidth' 'tw' number (default 0)
6897 local to buffer
6898 {not in Vi}
6899 Maximum width of text that is being inserted. A longer line will be
6900 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006901 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6902 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006904 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 NOTE: This option is set to 0 when 'compatible' is set.
6906
6907 *'thesaurus'* *'tsr'*
6908'thesaurus' 'tsr' string (default "")
6909 global or local to buffer |global-local|
6910 {not in Vi}
6911 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 the file should contain words with similar meaning, separated by
6914 non-keyword characters (white space is preferred). Maximum line
6915 length is 510 bytes.
6916 To obtain a file to be used here, check out the wordlist FAQ at
6917 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006918 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 after a comma are ignored, otherwise spaces are included in the file
6920 name. See |option-backslash| about using backslashes.
6921 The use of |:set+=| and |:set-=| is preferred when adding or removing
6922 directories from the list. This avoids problems when a future version
6923 uses another default.
6924 Backticks cannot be used in this option for security reasons.
6925
6926 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6927'tildeop' 'top' boolean (default off)
6928 global
6929 {not in Vi}
6930 When on: The tilde command "~" behaves like an operator.
6931 NOTE: This option is reset when 'compatible' is set.
6932
6933 *'timeout'* *'to'* *'notimeout'* *'noto'*
6934'timeout' 'to' boolean (default on)
6935 global
6936 *'ttimeout'* *'nottimeout'*
6937'ttimeout' boolean (default off)
6938 global
6939 {not in Vi}
6940 These two options together determine the behavior when part of a
6941 mapped key sequence or keyboard code has been received:
6942
6943 'timeout' 'ttimeout' action ~
6944 off off do not time out
6945 on on or off time out on :mappings and key codes
6946 off on time out on key codes
6947
6948 If both options are off, Vim will wait until either the complete
6949 mapping or key sequence has been received, or it is clear that there
6950 is no mapping or key sequence for the received characters. For
6951 example: if you have mapped "vl" and Vim has received 'v', the next
6952 character is needed to see if the 'v' is followed by an 'l'.
6953 When one of the options is on, Vim will wait for about 1 second for
6954 the next character to arrive. After that the already received
6955 characters are interpreted as single characters. The waiting time can
6956 be changed with the 'timeoutlen' option.
6957 On slow terminals or very busy systems timing out may cause
6958 malfunctioning cursor keys. If both options are off, Vim waits
6959 forever after an entered <Esc> if there are key codes that start
6960 with <Esc>. You will have to type <Esc> twice. If you do not have
6961 problems with key codes, but would like to have :mapped key
6962 sequences not timing out in 1 second, set the 'ttimeout' option and
6963 reset the 'timeout' option.
6964
6965 NOTE: 'ttimeout' is reset when 'compatible' is set.
6966
6967 *'timeoutlen'* *'tm'*
6968'timeoutlen' 'tm' number (default 1000)
6969 global
6970 {not in all versions of Vi}
6971 *'ttimeoutlen'* *'ttm'*
6972'ttimeoutlen' 'ttm' number (default -1)
6973 global
6974 {not in Vi}
6975 The time in milliseconds that is waited for a key code or mapped key
6976 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6977 when part of a command has been typed.
6978 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6979 different timeout value for key codes is desired set 'ttimeoutlen' to
6980 a non-negative number.
6981
6982 ttimeoutlen mapping delay key code delay ~
6983 < 0 'timeoutlen' 'timeoutlen'
6984 >= 0 'timeoutlen' 'ttimeoutlen'
6985
6986 The timeout only happens when the 'timeout' and 'ttimeout' options
6987 tell so. A useful setting would be >
6988 :set timeout timeoutlen=3000 ttimeoutlen=100
6989< (time out on mapping after three seconds, time out on key codes after
6990 a tenth of a second).
6991
6992 *'title'* *'notitle'*
6993'title' boolean (default off, on when title can be restored)
6994 global
6995 {not in Vi}
6996 {not available when compiled without the |+title|
6997 feature}
6998 When on, the title of the window will be set to the value of
6999 'titlestring' (if it is not empty), or to:
7000 filename [+=-] (path) - VIM
7001 Where:
7002 filename the name of the file being edited
7003 - indicates the file cannot be modified, 'ma' off
7004 + indicates the file was modified
7005 = indicates the file is read-only
7006 =+ indicates the file is read-only and modified
7007 (path) is the path of the file being edited
7008 - VIM the server name |v:servername| or "VIM"
7009 Only works if the terminal supports setting window titles
7010 (currently Amiga console, Win32 console, all GUI versions and
7011 terminals with a non- empty 't_ts' option - these are Unix xterm and
7012 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7013 *X11*
7014 When Vim was compiled with HAVE_X11 defined, the original title will
7015 be restored if possible. The output of ":version" will include "+X11"
7016 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7017 works for the icon name |'icon'|.
7018 But: When Vim was started with the |-X| argument, restoring the title
7019 will not work (except in the GUI).
7020 If the title cannot be restored, it is set to the value of 'titleold'.
7021 You might want to restore the title outside of Vim then.
7022 When using an xterm from a remote machine you can use this command:
7023 rsh machine_name xterm -display $DISPLAY &
7024 then the WINDOWID environment variable should be inherited and the
7025 title of the window should change back to what it should be after
7026 exiting Vim.
7027
7028 *'titlelen'*
7029'titlelen' number (default 85)
7030 global
7031 {not in Vi}
7032 {not available when compiled without the |+title|
7033 feature}
7034 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007035 title. When the title is longer, only the end of the path name is
7036 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 Using a percentage makes this adapt to the width of the window. But
7038 it won't work perfectly, because the actual number of characters
7039 available also depends on the font used and other things in the title
7040 bar. When 'titlelen' is zero the full path is used. Otherwise,
7041 values from 1 to 30000 percent can be used.
7042 'titlelen' is also used for the 'titlestring' option.
7043
7044 *'titleold'*
7045'titleold' string (default "Thanks for flying Vim")
7046 global
7047 {not in Vi}
7048 {only available when compiled with the |+title|
7049 feature}
7050 This option will be used for the window title when exiting Vim if the
7051 original title cannot be restored. Only happens if 'title' is on or
7052 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007053 This option cannot be set from a |modeline| or in the |sandbox|, for
7054 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 *'titlestring'*
7056'titlestring' string (default "")
7057 global
7058 {not in Vi}
7059 {not available when compiled without the |+title|
7060 feature}
7061 When this option is not empty, it will be used for the title of the
7062 window. This happens only when the 'title' option is on.
7063 Only works if the terminal supports setting window titles (currently
7064 Amiga console, Win32 console, all GUI versions and terminals with a
7065 non-empty 't_ts' option).
7066 When Vim was compiled with HAVE_X11 defined, the original title will
7067 be restored if possible |X11|.
7068 When this option contains printf-style '%' items, they will be
7069 expanded according to the rules used for 'statusline'.
7070 Example: >
7071 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7072 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7073< The value of 'titlelen' is used to align items in the middle or right
7074 of the available space.
7075 Some people prefer to have the file name first: >
7076 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7077< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007078 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007079 separating space only when needed.
7080 NOTE: Use of special characters in 'titlestring' may cause the display
7081 to be garbled (e.g., when it contains a CR or NL character).
7082 {not available when compiled without the |+statusline| feature}
7083
7084 *'toolbar'* *'tb'*
7085'toolbar' 'tb' string (default "icons,tooltips")
7086 global
7087 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7088 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007089 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 possible values are:
7091 icons Toolbar buttons are shown with icons.
7092 text Toolbar buttons shown with text.
7093 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007094 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007095 tooltips Tooltips are active for toolbar buttons.
7096 Tooltips refer to the popup help text which appears after the mouse
7097 cursor is placed over a toolbar button for a brief moment.
7098
7099 If you want the toolbar to be shown with icons as well as text, do the
7100 following: >
7101 :set tb=icons,text
7102< Motif and Athena cannot display icons and text at the same time. They
7103 will show icons if both are requested.
7104
7105 If none of the strings specified in 'toolbar' are valid or if
7106 'toolbar' is empty, this option is ignored. If you want to disable
7107 the toolbar, you need to set the 'guioptions' option. For example: >
7108 :set guioptions-=T
7109< Also see |gui-toolbar|.
7110
7111 *'toolbariconsize'* *'tbis'*
7112'toolbariconsize' 'tbis' string (default "small")
7113 global
7114 {not in Vi}
7115 {only in the GTK+ 2 GUI}
7116 Controls the size of toolbar icons. The possible values are:
7117 tiny Use tiny toolbar icons.
7118 small Use small toolbar icons (default).
7119 medium Use medium-sized toolbar icons.
7120 large Use large toolbar icons.
7121 The exact dimensions in pixels of the various icon sizes depend on
7122 the current theme. Common dimensions are large=32x32, medium=24x24,
7123 small=20x20 and tiny=16x16.
7124
7125 If 'toolbariconsize' is empty, the global default size as determined
7126 by user preferences or the current theme is used.
7127
7128 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7129'ttybuiltin' 'tbi' boolean (default on)
7130 global
7131 {not in Vi}
7132 When on, the builtin termcaps are searched before the external ones.
7133 When off the builtin termcaps are searched after the external ones.
7134 When this option is changed, you should set the 'term' option next for
7135 the change to take effect, for example: >
7136 :set notbi term=$TERM
7137< See also |termcap|.
7138 Rationale: The default for this option is "on", because the builtin
7139 termcap entries are generally better (many systems contain faulty
7140 xterm entries...).
7141
7142 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7143'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7144 sun-cmd, screen, rxvt, dtterm or
7145 iris-ansi; also on when running Vim in
7146 a DOS console)
7147 global
7148 {not in Vi}
7149 Indicates a fast terminal connection. More characters will be sent to
7150 the screen for redrawing, instead of using insert/delete line
7151 commands. Improves smoothness of redrawing when there are multiple
7152 windows and the terminal does not support a scrolling region.
7153 Also enables the extra writing of characters at the end of each screen
7154 line for lines that wrap. This helps when using copy/paste with the
7155 mouse in an xterm and other terminals.
7156
7157 *'ttymouse'* *'ttym'*
7158'ttymouse' 'ttym' string (default depends on 'term')
7159 global
7160 {not in Vi}
7161 {only in Unix and VMS, doesn't work in the GUI; not
7162 available when compiled without |+mouse|}
7163 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007164 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 *xterm-mouse*
7166 xterm xterm-like mouse handling. The mouse generates
7167 "<Esc>[Mscr", where "scr" is three bytes:
7168 "s" = button state
7169 "c" = column plus 33
7170 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007171 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007172 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 xterm2 Works like "xterm", but with the xterm reporting the
7174 mouse position while the mouse is dragged. This works
7175 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007176 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 work. See below for how Vim detects this
7178 automatically.
7179 *netterm-mouse*
7180 netterm NetTerm mouse handling. The mouse generates
7181 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7182 for the row and column.
7183 *dec-mouse*
7184 dec DEC terminal mouse handling. The mouse generates a
7185 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007186 This is also available for an Xterm, if it was
7187 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 *jsbterm-mouse*
7189 jsbterm JSB term mouse handling.
7190 *pterm-mouse*
7191 pterm QNX pterm mouse handling.
7192
7193 The mouse handling must be enabled at compile time |+mouse_xterm|
7194 |+mouse_dec| |+mouse_netterm|.
7195 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7196 recognized, if enabled at compile time. DEC terminal mouse codes
7197 are recognized if enabled at compile time, and 'ttymouse' is not
7198 "xterm" (because the xterm and dec mouse codes conflict).
7199 This option is automatically set to "xterm", when the 'term' option is
7200 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7201 or "xterm2" already. The main use of this option is to set it to
7202 "xterm", when the terminal name doesn't start with "xterm", but it can
7203 handle xterm mouse codes.
7204 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007205 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 feature and if |t_RV| is set to the escape sequence to request the
7207 xterm version number. Otherwise "xterm2" must be set explicitly.
7208 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7209 t_RV to an empty string: >
7210 :set t_RV=
7211<
7212 *'ttyscroll'* *'tsl'*
7213'ttyscroll' 'tsl' number (default 999)
7214 global
7215 Maximum number of lines to scroll the screen. If there are more lines
7216 to scroll the window is redrawn. For terminals where scrolling is
7217 very slow and redrawing is not slow this can be set to a small number,
7218 e.g., 3, to speed up displaying.
7219
7220 *'ttytype'* *'tty'*
7221'ttytype' 'tty' string (default from $TERM)
7222 global
7223 Alias for 'term', see above.
7224
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007225 *'undodir'* *'udir'*
7226'undodir' 'udir' string (default ".")
7227 global
7228 {not in Vi}
7229 {only when compiled with the +persistent_undo feature}
7230 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007231 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007232 "." means using the directory of the file. The undo file name for
7233 "file.txt" is ".file.txt.un~".
7234 For other directories the file name is the full path of the edited
7235 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007236 When writing: The first directory that exists is used. "." always
7237 works, no directories after "." will be used for writing.
7238 When reading all entries are tried to find an undo file. The first
7239 undo file that exists is used. When it cannot be read an error is
7240 given, no further entry is used.
7241 See |undo-persistence|.
7242
7243 *'undofile'* *'udf'*
7244'undofile' 'udf' boolean (default off)
7245 local to buffer
7246 {not in Vi}
7247 {only when compiled with the +persistent_undo feature}
7248 When on, Vim automatically saves undo history to an undo file when
7249 writing a buffer to a file, and restores undo history from the same
7250 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007251 The directory where the undo file is stored is specified by 'undodir'.
7252 For more information about this feature see |undo-persistence|.
7253 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007254
Bram Moolenaar071d4272004-06-13 20:20:40 +00007255 *'undolevels'* *'ul'*
7256'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7257 Win32 and OS/2)
7258 global
7259 {not in Vi}
7260 Maximum number of changes that can be undone. Since undo information
7261 is kept in memory, higher numbers will cause more memory to be used
7262 (nevertheless, a single change can use an unlimited amount of memory).
7263 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7264 itself: >
7265 set ul=0
7266< But you can also get Vi compatibility by including the 'u' flag in
7267 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007268 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007269 Set to a negative number for no undo at all: >
7270 set ul=-1
7271< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007272 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273
7274 *'updatecount'* *'uc'*
7275'updatecount' 'uc' number (default: 200)
7276 global
7277 {not in Vi}
7278 After typing this many characters the swap file will be written to
7279 disk. When zero, no swap file will be created at all (see chapter on
7280 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7281 Vim with the "-n" option, see |startup|. When editing in readonly
7282 mode this option will be initialized to 10000.
7283 The swapfile can be disabled per buffer with |'swapfile'|.
7284 When 'updatecount' is set from zero to non-zero, swap files are
7285 created for all buffers that have 'swapfile' set. When 'updatecount'
7286 is set to zero, existing swap files are not deleted.
7287 Also see |'swapsync'|.
7288 This option has no meaning in buffers where |'buftype'| is "nofile"
7289 or "nowrite".
7290
7291 *'updatetime'* *'ut'*
7292'updatetime' 'ut' number (default 4000)
7293 global
7294 {not in Vi}
7295 If this many milliseconds nothing is typed the swap file will be
7296 written to disk (see |crash-recovery|). Also used for the
7297 |CursorHold| autocommand event.
7298
7299 *'verbose'* *'vbs'*
7300'verbose' 'vbs' number (default 0)
7301 global
7302 {not in Vi, although some versions have a boolean
7303 verbose option}
7304 When bigger than zero, Vim will give messages about what it is doing.
7305 Currently, these messages are given:
7306 >= 1 When the viminfo file is read or written.
7307 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007308 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007309 >= 8 Files for which a group of autocommands is executed.
7310 >= 9 Every executed autocommand.
7311 >= 12 Every executed function.
7312 >= 13 When an exception is thrown, caught, finished, or discarded.
7313 >= 14 Anything pending in a ":finally" clause.
7314 >= 15 Every executed Ex command (truncated at 200 characters).
7315
7316 This option can also be set with the "-V" argument. See |-V|.
7317 This option is also set by the |:verbose| command.
7318
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007319 When the 'verbosefile' option is set then the verbose messages are not
7320 displayed.
7321
7322 *'verbosefile'* *'vfile'*
7323'verbosefile' 'vfile' string (default empty)
7324 global
7325 {not in Vi}
7326 When not empty all messages are written in a file with this name.
7327 When the file exists messages are appended.
7328 Writing to the file ends when Vim exits or when 'verbosefile' is made
7329 empty.
7330 Setting 'verbosefile' to a new value is like making it empty first.
7331 The difference with |:redir| is that verbose messages are not
7332 displayed when 'verbosefile' is set.
7333
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 *'viewdir'* *'vdir'*
7335'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7336 "$VIM/vimfiles/view",
7337 for Unix: "~/.vim/view",
7338 for Macintosh: "$VIM:vimfiles:view"
7339 for VMS: "sys$login:vimfiles/view"
7340 for RiscOS: "Choices:vimfiles/view")
7341 global
7342 {not in Vi}
7343 {not available when compiled without the +mksession
7344 feature}
7345 Name of the directory where to store files for |:mkview|.
7346 This option cannot be set from a |modeline| or in the |sandbox|, for
7347 security reasons.
7348
7349 *'viewoptions'* *'vop'*
7350'viewoptions' 'vop' string (default: "folds,options,cursor")
7351 global
7352 {not in Vi}
7353 {not available when compiled without the +mksession
7354 feature}
7355 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007356 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357 word save and restore ~
7358 cursor cursor position in file and in window
7359 folds manually created folds, opened/closed folds and local
7360 fold options
7361 options options and mappings local to a window or buffer (not
7362 global values for local options)
7363 slash backslashes in file names replaced with forward
7364 slashes
7365 unix with Unix end-of-line format (single <NL>), even when
7366 on Windows or DOS
7367
7368 "slash" and "unix" are useful on Windows when sharing view files
7369 with Unix. The Unix version of Vim cannot source dos format scripts,
7370 but the Windows version of Vim can source unix format scripts.
7371
7372 *'viminfo'* *'vi'* *E526* *E527* *E528*
7373'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007374 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7375 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7376 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 global
7378 {not in Vi}
7379 {not available when compiled without the |+viminfo|
7380 feature}
7381 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007382 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 separated list of parameters, each consisting of a single character
7384 identifying the particular parameter, followed by a number or string
7385 which specifies the value of that parameter. If a particular
7386 character is left out, then the default value is used for that
7387 parameter. The following is a list of the identifying characters and
7388 the effect of their value.
7389 CHAR VALUE ~
7390 ! When included, save and restore global variables that start
7391 with an uppercase letter, and don't contain a lowercase
7392 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007393 and "_K_L_M" are not. Only String and Number types are
7394 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 " Maximum number of lines saved for each register. Old name of
7396 the '<' item, with the disadvantage that you need to put a
7397 backslash before the ", otherwise it will be recognized as the
7398 start of a comment!
7399 % When included, save and restore the buffer list. If Vim is
7400 started with a file name argument, the buffer list is not
7401 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007402 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007403 without a file name and buffers for help files are not written
7404 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007405 When followed by a number, the number specifies the maximum
7406 number of buffers that are stored. Without a number all
7407 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007408 ' Maximum number of previously edited files for which the marks
7409 are remembered. This parameter must always be included when
7410 'viminfo' is non-empty.
7411 Including this item also means that the |jumplist| and the
7412 |changelist| are stored in the viminfo file.
7413 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007414 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415 patterns are also saved. When not included, the value of
7416 'history' is used.
7417 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007418 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 < Maximum number of lines saved for each register. If zero then
7420 registers are not saved. When not included, all lines are
7421 saved. '"' is the old name for this item.
7422 Also see the 's' item below: limit specified in Kbyte.
7423 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007424 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425 c When included, convert the text in the viminfo file from the
7426 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007427 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007428 f Whether file marks need to be stored. If zero, file marks ('0
7429 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007430 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 cursor position (when exiting or when doing ":wviminfo").
7432 h Disable the effect of 'hlsearch' when loading the viminfo
7433 file. When not included, it depends on whether ":nohlsearch"
7434 has been used since the last search command.
7435 n Name of the viminfo file. The name must immediately follow
7436 the 'n'. Must be the last one! If the "-i" argument was
7437 given when starting Vim, that file name overrides the one
7438 given here with 'viminfo'. Environment variables are expanded
7439 when opening the file, not when setting the option.
7440 r Removable media. The argument is a string (up to the next
7441 ','). This parameter can be given several times. Each
7442 specifies the start of a path for which no marks will be
7443 stored. This is to avoid removable media. For MS-DOS you
7444 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7445 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7446 ignored. Maximum length of each 'r' argument is 50
7447 characters.
7448 s Maximum size of an item in Kbyte. If zero then registers are
7449 not saved. Currently only applies to registers. The default
7450 "s10" will exclude registers with more than 10 Kbyte of text.
7451 Also see the '<' item above: line count limit.
7452
7453 Example: >
7454 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7455<
7456 '50 Marks will be remembered for the last 50 files you
7457 edited.
7458 <1000 Contents of registers (up to 1000 lines each) will be
7459 remembered.
7460 s100 Registers with more than 100 Kbyte text are skipped.
7461 :0 Command-line history will not be saved.
7462 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7463 no / Since '/' is not specified, the default will be used,
7464 that is, save all of the search history, and also the
7465 previous search and substitute patterns.
7466 no % The buffer list will not be saved nor read back.
7467 no h 'hlsearch' highlighting will be restored.
7468
7469 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7470 load the contents of the file, this is not done automatically.
7471
7472 This option cannot be set from a |modeline| or in the |sandbox|, for
7473 security reasons.
7474
7475 *'virtualedit'* *'ve'*
7476'virtualedit' 've' string (default "")
7477 global
7478 {not in Vi}
7479 {not available when compiled without the
7480 |+virtualedit| feature}
7481 A comma separated list of these words:
7482 block Allow virtual editing in Visual block mode.
7483 insert Allow virtual editing in Insert mode.
7484 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007485 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007486
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007488 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 of the line. Useful for selecting a rectangle in Visual mode and
7490 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007491 "onemore" is not the same, it will only allow moving the cursor just
7492 after the last character of the line. This makes some commands more
7493 consistent. Previously the cursor was always past the end of the line
7494 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007495 break some plugins or Vim scripts. For example because |l| can move
7496 the cursor after the last character. Use with care!
7497 Using the |$| command will move to the last character in the line, not
7498 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007499 It doesn't make sense to combine "all" with "onemore", but you will
7500 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007501
7502 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7503'visualbell' 'vb' boolean (default off)
7504 global
7505 {not in Vi}
7506 Use visual bell instead of beeping. The terminal code to display the
7507 visual bell is given with 't_vb'. When no beep or flash is wanted,
7508 use ":set vb t_vb=".
7509 Note: When the GUI starts, 't_vb' is reset to its default value. You
7510 might want to set it again in your |gvimrc|.
7511 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7512 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7513 where 40 is the time in msec.
7514 Does not work on the Amiga, you always get a screen flash.
7515 Also see 'errorbells'.
7516
7517 *'warn'* *'nowarn'*
7518'warn' boolean (default on)
7519 global
7520 Give a warning message when a shell command is used while the buffer
7521 has been changed.
7522
7523 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7524'weirdinvert' 'wiv' boolean (default off)
7525 global
7526 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007527 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 It is provided for backwards compatibility with version 4.x.
7529 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7530 vice versa. Has no effect when the GUI is running.
7531
7532 *'whichwrap'* *'ww'*
7533'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7534 global
7535 {not in Vi}
7536 Allow specified keys that move the cursor left/right to move to the
7537 previous/next line when the cursor is on the first/last character in
7538 the line. Concatenate characters to allow this for these keys:
7539 char key mode ~
7540 b <BS> Normal and Visual
7541 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007542 h "h" Normal and Visual (not recommended)
7543 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007544 < <Left> Normal and Visual
7545 > <Right> Normal and Visual
7546 ~ "~" Normal
7547 [ <Left> Insert and Replace
7548 ] <Right> Insert and Replace
7549 For example: >
7550 :set ww=<,>,[,]
7551< allows wrap only when cursor keys are used.
7552 When the movement keys are used in combination with a delete or change
7553 operator, the <EOL> also counts for a character. This makes "3h"
7554 different from "3dh" when the cursor crosses the end of a line. This
7555 is also true for "x" and "X", because they do the same as "dl" and
7556 "dh". If you use this, you may also want to use the mapping
7557 ":map <BS> X" to make backspace delete the character in front of the
7558 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007559 When 'l' is included and it is used after an operator at the end of a
7560 line then it will not move to the next line. This makes "dl", "cl",
7561 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 NOTE: This option is set to the Vi default value when 'compatible' is
7563 set and to the Vim default value when 'compatible' is reset.
7564
7565 *'wildchar'* *'wc'*
7566'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7567 global
7568 {not in Vi}
7569 Character you have to type to start wildcard expansion in the
7570 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007571 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007572 The character is not recognized when used inside a macro. See
7573 'wildcharm' for that.
7574 Although 'wc' is a number option, you can set it to a special key: >
7575 :set wc=<Esc>
7576< NOTE: This option is set to the Vi default value when 'compatible' is
7577 set and to the Vim default value when 'compatible' is reset.
7578
7579 *'wildcharm'* *'wcm'*
7580'wildcharm' 'wcm' number (default: none (0))
7581 global
7582 {not in Vi}
7583 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007584 recognized when used inside a macro. You can find "spare" command-line
7585 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 you'll never actually type 'wildcharm', just use it in mappings that
7587 automatically invoke completion mode, e.g.: >
7588 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007589 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590< Then after typing :ss you can use CTRL-P & CTRL-N.
7591
7592 *'wildignore'* *'wig'*
7593'wildignore' 'wig' string (default "")
7594 global
7595 {not in Vi}
7596 {not available when compiled without the |+wildignore|
7597 feature}
7598 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007599 patterns is ignored when completing file or directory names, and
7600 influences the result of |expand()|, |glob()| and |globpath()| unless
7601 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7603 Also see 'suffixes'.
7604 Example: >
7605 :set wildignore=*.o,*.obj
7606< The use of |:set+=| and |:set-=| is preferred when adding or removing
7607 a pattern from the list. This avoids problems when a future version
7608 uses another default.
7609
7610 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7611'wildmenu' 'wmnu' boolean (default off)
7612 global
7613 {not in Vi}
7614 {not available if compiled without the |+wildmenu|
7615 feature}
7616 When 'wildmenu' is on, command-line completion operates in an enhanced
7617 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7618 the possible matches are shown just above the command line, with the
7619 first match highlighted (overwriting the status line, if there is
7620 one). Keys that show the previous/next match, such as <Tab> or
7621 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7622 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7623 specified. "longest" and "list" do not start "wildmenu" mode.
7624 If there are more matches than can fit in the line, a ">" is shown on
7625 the right and/or a "<" is shown on the left. The status line scrolls
7626 as needed.
7627 The "wildmenu" mode is abandoned when a key is hit that is not used
7628 for selecting a completion.
7629 While the "wildmenu" is active the following keys have special
7630 meanings:
7631
7632 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7633 <Down> - in filename/menu name completion: move into a
7634 subdirectory or submenu.
7635 <CR> - in menu completion, when the cursor is just after a
7636 dot: move into a submenu.
7637 <Up> - in filename/menu name completion: move up into
7638 parent directory or parent menu.
7639
7640 This makes the menus accessible from the console |console-menus|.
7641
7642 If you prefer the <Left> and <Right> keys to move the cursor instead
7643 of selecting a different match, use this: >
7644 :cnoremap <Left> <Space><BS><Left>
7645 :cnoremap <Right> <Space><BS><Right>
7646<
7647 The "WildMenu" highlighting is used for displaying the current match
7648 |hl-WildMenu|.
7649
7650 *'wildmode'* *'wim'*
7651'wildmode' 'wim' string (Vim default: "full")
7652 global
7653 {not in Vi}
7654 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007655 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007656 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 first part specifies the behavior for the first use of 'wildchar',
7658 The second part for the second use, etc.
7659 These are the possible values for each part:
7660 "" Complete only the first match.
7661 "full" Complete the next full match. After the last match,
7662 the original string is used and then the first match
7663 again.
7664 "longest" Complete till longest common string. If this doesn't
7665 result in a longer string, use the next part.
7666 "longest:full" Like "longest", but also start 'wildmenu' if it is
7667 enabled.
7668 "list" When more than one match, list all matches.
7669 "list:full" When more than one match, list all matches and
7670 complete first match.
7671 "list:longest" When more than one match, list all matches and
7672 complete till longest common string.
7673 When there is only a single match, it is fully completed in all cases.
7674
7675 Examples: >
7676 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007677< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 :set wildmode=longest,full
7679< Complete longest common string, then each full match >
7680 :set wildmode=list:full
7681< List all matches and complete each full match >
7682 :set wildmode=list,full
7683< List all matches without completing, then each full match >
7684 :set wildmode=longest,list
7685< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007686 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007688 *'wildoptions'* *'wop'*
7689'wildoptions' 'wop' string (default "")
7690 global
7691 {not in Vi}
7692 {not available when compiled without the |+wildignore|
7693 feature}
7694 A list of words that change how command line completion is done.
7695 Currently only one word is allowed:
7696 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007697 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007698 is displayed per line. Often used tag kinds are:
7699 d #define
7700 f function
7701 Also see |cmdline-completion|.
7702
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 *'winaltkeys'* *'wak'*
7704'winaltkeys' 'wak' string (default "menu")
7705 global
7706 {not in Vi}
7707 {only used in Win32, Motif, GTK and Photon GUI}
7708 Some GUI versions allow the access to menu entries by using the ALT
7709 key in combination with a character that appears underlined in the
7710 menu. This conflicts with the use of the ALT key for mappings and
7711 entering special characters. This option tells what to do:
7712 no Don't use ALT keys for menus. ALT key combinations can be
7713 mapped, but there is no automatic handling. This can then be
7714 done with the |:simalt| command.
7715 yes ALT key handling is done by the windowing system. ALT key
7716 combinations cannot be mapped.
7717 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007718 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 keys can be mapped.
7720 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7721 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007722 This option is not used for <F10>; on Win32 and with GTK <F10> will
7723 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007724
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007725 *'window'* *'wi'*
7726'window' 'wi' number (default screen height - 1)
7727 global
7728 Window height. Do not confuse this with the height of the Vim window,
7729 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007730 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7731 value is smaller than 'lines' minus one. The screen will scroll
7732 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007733 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7734 in a much smarter way, taking care of wrapping lines.
7735 When resizing the Vim window, the value is smaller than 1 or more than
7736 or equal to 'lines' it will be set to 'lines' minus 1.
7737 {Vi also uses the option to specify the number of displayed lines}
7738
Bram Moolenaar071d4272004-06-13 20:20:40 +00007739 *'winheight'* *'wh'* *E591*
7740'winheight' 'wh' number (default 1)
7741 global
7742 {not in Vi}
7743 {not available when compiled without the +windows
7744 feature}
7745 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007746 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007747 focus goes to a window that is smaller, its size is increased, at the
7748 cost of the height of other windows.
7749 Set 'winheight' to a small number for normal editing.
7750 Set it to 999 to make the current window fill most of the screen.
7751 Other windows will be only 'winminheight' high. This has the drawback
7752 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7753 to create only two windows, set the option after startup is done,
7754 using the |VimEnter| event: >
7755 au VimEnter * set winheight=999
7756< Minimum value is 1.
7757 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758 height of the current window.
7759 'winheight' applies to the current window. Use 'winminheight' to set
7760 the minimal height for other windows.
7761
7762 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7763'winfixheight' 'wfh' boolean (default off)
7764 local to window
7765 {not in Vi}
7766 {not available when compiled without the +windows
7767 feature}
7768 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007769 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7770 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007771 The height may be changed anyway when running out of room.
7772
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007773 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7774'winfixwidth' 'wfw' boolean (default off)
7775 local to window
7776 {not in Vi}
7777 {not available when compiled without the +windows
7778 feature}
7779 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007780 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007781 The width may be changed anyway when running out of room.
7782
Bram Moolenaar071d4272004-06-13 20:20:40 +00007783 *'winminheight'* *'wmh'*
7784'winminheight' 'wmh' number (default 1)
7785 global
7786 {not in Vi}
7787 {not available when compiled without the +windows
7788 feature}
7789 The minimal height of a window, when it's not the current window.
7790 This is a hard minimum, windows will never become smaller.
7791 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7792 status bar) if necessary. They will return to at least one line when
7793 they become active (since the cursor has to have somewhere to go.)
7794 Use 'winheight' to set the minimal height of the current window.
7795 This option is only checked when making a window smaller. Don't use a
7796 large number, it will cause errors when opening more than a few
7797 windows. A value of 0 to 3 is reasonable.
7798
7799 *'winminwidth'* *'wmw'*
7800'winminwidth' 'wmw' number (default 1)
7801 global
7802 {not in Vi}
7803 {not available when compiled without the +vertsplit
7804 feature}
7805 The minimal width of a window, when it's not the current window.
7806 This is a hard minimum, windows will never become smaller.
7807 When set to zero, windows may be "squashed" to zero columns (i.e. just
7808 a vertical separator) if necessary. They will return to at least one
7809 line when they become active (since the cursor has to have somewhere
7810 to go.)
7811 Use 'winwidth' to set the minimal width of the current window.
7812 This option is only checked when making a window smaller. Don't use a
7813 large number, it will cause errors when opening more than a few
7814 windows. A value of 0 to 12 is reasonable.
7815
7816 *'winwidth'* *'wiw'* *E592*
7817'winwidth' 'wiw' number (default 20)
7818 global
7819 {not in Vi}
7820 {not available when compiled without the +vertsplit
7821 feature}
7822 Minimal number of columns for the current window. This is not a hard
7823 minimum, Vim will use fewer columns if there is not enough room. If
7824 the current window is smaller, its size is increased, at the cost of
7825 the width of other windows. Set it to 999 to make the current window
7826 always fill the screen. Set it to a small number for normal editing.
7827 The width is not adjusted after one of the commands to change the
7828 width of the current window.
7829 'winwidth' applies to the current window. Use 'winminwidth' to set
7830 the minimal width for other windows.
7831
7832 *'wrap'* *'nowrap'*
7833'wrap' boolean (default on)
7834 local to window
7835 {not in Vi}
7836 This option changes how text is displayed. It doesn't change the text
7837 in the buffer, see 'textwidth' for that.
7838 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007839 displaying continues on the next line. When off lines will not wrap
7840 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 moved to a part that is not shown, the screen will scroll
7842 horizontally.
7843 The line will be broken in the middle of a word if necessary. See
7844 'linebreak' to get the break at a word boundary.
7845 To make scrolling horizontally a bit more useful, try this: >
7846 :set sidescroll=5
7847 :set listchars+=precedes:<,extends:>
7848< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007849 This option can't be set from a |modeline| when the 'diff' option is
7850 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007851
7852 *'wrapmargin'* *'wm'*
7853'wrapmargin' 'wm' number (default 0)
7854 local to buffer
7855 Number of characters from the right window border where wrapping
7856 starts. When typing text beyond this limit, an <EOL> will be inserted
7857 and inserting continues on the next line.
7858 Options that add a margin, such as 'number' and 'foldcolumn', cause
7859 the text width to be further reduced. This is Vi compatible.
7860 When 'textwidth' is non-zero, this option is not used.
7861 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7862 and less usefully}
7863
7864 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7865'wrapscan' 'ws' boolean (default on) *E384* *E385*
7866 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007867 Searches wrap around the end of the file. Also applies to |]s| and
7868 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
7870 *'write'* *'nowrite'*
7871'write' boolean (default on)
7872 global
7873 {not in Vi}
7874 Allows writing files. When not set, writing a file is not allowed.
7875 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007876 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007877 argument. Filtering text is still possible, even though this requires
7878 writing a temporary file.
7879
7880 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7881'writeany' 'wa' boolean (default off)
7882 global
7883 Allows writing to any file with no need for "!" override.
7884
7885 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7886'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7887 otherwise)
7888 global
7889 {not in Vi}
7890 Make a backup before overwriting a file. The backup is removed after
7891 the file was successfully written, unless the 'backup' option is
7892 also on. Reset this option if your file system is almost full. See
7893 |backup-table| for another explanation.
7894 When the 'backupskip' pattern matches, a backup is not made anyway.
7895 NOTE: This option is set to the default value when 'compatible' is
7896 set.
7897
7898 *'writedelay'* *'wd'*
7899'writedelay' 'wd' number (default 0)
7900 global
7901 {not in Vi}
7902 The number of microseconds to wait for each character sent to the
7903 screen. When non-zero, characters are sent to the terminal one by
7904 one. For MS-DOS pcterm this does not work. For debugging purposes.
7905
7906 vim:tw=78:ts=8:ft=help:norl: