blob: 0bdde3a556d06c4b41c0c04956caa48b33437f08 [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.
1453 Only supported for GTK version 2 and later.
1454 Only available with the |+multi_byte| feature.
1455
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 exclude:{pattern}
1457 Defines a pattern that is matched against the name of
1458 the terminal 'term'. If there is a match, no
1459 connection will be made to the X server. This is
1460 useful in this situation:
1461 - Running Vim in a console.
1462 - $DISPLAY is set to start applications on another
1463 display.
1464 - You do not want to connect to the X server in the
1465 console, but do want this in a terminal emulator.
1466 To never connect to the X server use: >
1467 exclude:.*
1468< This has the same effect as using the |-X| argument.
1469 Note that when there is no connection to the X server
1470 the window title won't be restored and the clipboard
1471 cannot be accessed.
1472 The value of 'magic' is ignored, {pattern} is
1473 interpreted as if 'magic' was on.
1474 The rest of the option value will be used for
1475 {pattern}, this must be the last entry.
1476
1477 *'cmdheight'* *'ch'*
1478'cmdheight' 'ch' number (default 1)
1479 global
1480 {not in Vi}
1481 Number of screen lines to use for the command-line. Helps avoiding
1482 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001483 The value of this option is stored with the tab page, so that each tab
1484 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 *'cmdwinheight'* *'cwh'*
1487'cmdwinheight' 'cwh' number (default 7)
1488 global
1489 {not in Vi}
1490 {not available when compiled without the |+vertsplit|
1491 feature}
1492 Number of screen lines to use for the command-line window. |cmdwin|
1493
1494 *'columns'* *'co'* *E594*
1495'columns' 'co' number (default 80 or terminal width)
1496 global
1497 {not in Vi}
1498 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001499 initialization and does not have to be set by hand. Also see
1500 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 When Vim is running in the GUI or in a resizable window, setting this
1502 option will cause the window size to be changed. When you only want
1503 to use the size for the GUI, put the command in your |gvimrc| file.
1504 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001505 number of columns of the display, the display may be messed up. For
1506 the GUI it is always possible and Vim limits the number of columns to
1507 what fits on the screen. You can use this command to get the widest
1508 window possible: >
1509 :set columns=9999
1510< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 *'comments'* *'com'* *E524* *E525*
1513'comments' 'com' string (default
1514 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+comments|
1518 feature}
1519 A comma separated list of strings that can start a comment line. See
1520 |format-comments|. See |option-backslash| about using backslashes to
1521 insert a space.
1522
1523 *'commentstring'* *'cms'* *E537*
1524'commentstring' 'cms' string (default "/*%s*/")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without the |+folding|
1528 feature}
1529 A template for a comment. The "%s" in the value is replaced with the
1530 comment text. Currently only used to add markers for folding, see
1531 |fold-marker|.
1532
1533 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001534'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1535 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 global
1537 {not in Vi}
1538 This option has the effect of making Vim either more Vi-compatible, or
1539 make Vim behave in a more useful way.
1540 This is a special kind of option, because when it's set or reset,
1541 other options are also changed as a side effect. CAREFUL: Setting or
1542 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001543 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 set this option in your vimrc file, you should probably put it at the
1545 very start.
1546 By default this option is on and the Vi defaults are used for the
1547 options. This default was chosen for those people who want to use Vim
1548 just like Vi, and don't even (want to) know about the 'compatible'
1549 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001550 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001551 this option is switched off, and all options that have not been
1552 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001553 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001554 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001555 happen for the system-wide vimrc or gvimrc file, nor for a file given
1556 with the |-u| argument). Also see |compatible-default| and
1557 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 You can also set this option with the "-C" argument, and reset it with
1559 "-N". See |-C| and |-N|.
1560 Switching this option off makes the Vim defaults be used for options
1561 that have a different Vi and Vim default value. See the options
1562 marked with a '+' below. Other options are not modified.
1563 At the moment this option is set, several other options will be set
1564 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001565 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 editing.
1567 See also 'cpoptions'.
1568
1569 option + set value effect ~
1570
1571 'allowrevins' off no CTRL-_ command
1572 'backupcopy' Unix: "yes" backup file is a copy
1573 others: "auto" copy or rename backup file
1574 'backspace' "" normal backspace
1575 'backup' off no backup file
1576 'cindent' off no C code indentation
1577 'cedit' + "" no key to open the |cmdwin|
1578 'cpoptions' + (all flags) Vi-compatible flags
1579 'cscopetag' off don't use cscope for ":tag"
1580 'cscopetagorder' 0 see |cscopetagorder|
1581 'cscopeverbose' off see |cscopeverbose|
1582 'digraph' off no digraphs
1583 'esckeys' + off no <Esc>-keys in Insert mode
1584 'expandtab' off tabs not expanded to spaces
1585 'fileformats' + "" no automatic file format detection,
1586 "dos,unix" except for DOS, Windows and OS/2
1587 'formatoptions' + "vt" Vi compatible formatting
1588 'gdefault' off no default 'g' flag for ":s"
1589 'history' + 0 no commandline history
1590 'hkmap' off no Hebrew keyboard mapping
1591 'hkmapp' off no phonetic Hebrew keyboard mapping
1592 'hlsearch' off no highlighting of search matches
1593 'incsearch' off no incremental searching
1594 'indentexpr' "" no indenting by expression
1595 'insertmode' off do not start in Insert mode
1596 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1597 characters and '_'
1598 'joinspaces' on insert 2 spaces after period
1599 'modeline' + off no modelines
1600 'more' + off no pauses in listings
1601 'revins' off no reverse insert
1602 'ruler' off no ruler
1603 'scrolljump' 1 no jump scroll
1604 'scrolloff' 0 no scroll offset
1605 'shiftround' off indent not rounded to shiftwidth
1606 'shortmess' + "" no shortening of messages
1607 'showcmd' + off command characters not shown
1608 'showmode' + off current mode not shown
1609 'smartcase' off no automatic ignore case switch
1610 'smartindent' off no smart indentation
1611 'smarttab' off no smart tab size
1612 'softtabstop' 0 tabs are always 'tabstop' positions
1613 'startofline' on goto startofline with some commands
1614 'tagrelative' + off tag file names are not relative
1615 'textauto' + off no automatic textmode detection
1616 'textwidth' 0 no automatic line wrap
1617 'tildeop' off tilde is not an operator
1618 'ttimeout' off no terminal timeout
1619 'whichwrap' + "" left-right movements don't wrap
1620 'wildchar' + CTRL-E only when the current value is <Tab>
1621 use CTRL-E for cmdline completion
1622 'writebackup' on or off depends on +writebackup feature
1623
1624 *'complete'* *'cpt'* *E535*
1625'complete' 'cpt' string (default: ".,w,b,u,t,i")
1626 local to buffer
1627 {not in Vi}
1628 This option specifies how keyword completion |ins-completion| works
1629 when CTRL-P or CTRL-N are used. It is also used for whole-line
1630 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1631 and the places to scan. It is a comma separated list of flags:
1632 . scan the current buffer ('wrapscan' is ignored)
1633 w scan buffers from other windows
1634 b scan other loaded buffers that are in the buffer list
1635 u scan the unloaded buffers that are in the buffer list
1636 U scan the buffers that are not in the buffer list
1637 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001638 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 k{dict} scan the file {dict}. Several "k" flags can be given,
1640 patterns are valid too. For example: >
1641 :set cpt=k/usr/dict/*,k~/spanish
1642< s scan the files given with the 'thesaurus' option
1643 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1644 are valid too.
1645 i scan current and included files
1646 d scan current and included files for defined name or macro
1647 |i_CTRL-X_CTRL-D|
1648 ] tag completion
1649 t same as "]"
1650
1651 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1652 not executed, this may lead to unexpected completions from some files
1653 (gzipped files for example). Unloaded buffers are not scanned for
1654 whole-line completion.
1655
1656 The default is ".,w,b,u,t,i", which means to scan:
1657 1. the current buffer
1658 2. buffers in other windows
1659 3. other loaded buffers
1660 4. unloaded buffers
1661 5. tags
1662 6. included files
1663
1664 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001665 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1666 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001668 *'completefunc'* *'cfu'*
1669'completefunc' 'cfu' string (default: empty)
1670 local to buffer
1671 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001672 {not available when compiled without the +eval
1673 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001674 This option specifies a function to be used for Insert mode completion
1675 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001676 See |complete-functions| for an explanation of how the function is
1677 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001678
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001679
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001680 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001681'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001683 {not available when compiled without the
1684 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001685 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001686 A comma separated list of options for Insert mode completion
1687 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001688
1689 menu Use a popup menu to show the possible completions. The
1690 menu is only shown when there is more than one match and
1691 sufficient colors are available. |ins-completion-menu|
1692
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001693 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001694 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 match, e.g., what file it comes from.
1696
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001697 longest Only insert the longest common text of the matches. If
1698 the menu is displayed you can use CTRL-L to add more
1699 characters. Whether case is ignored depends on the kind
1700 of completion. For buffer text the 'ignorecase' option is
1701 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001702
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001703 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001704 completion in the preview window. Only works in
1705 combination with "menu" or "menuone".
1706
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1709'confirm' 'cf' boolean (default off)
1710 global
1711 {not in Vi}
1712 When 'confirm' is on, certain operations that would normally
1713 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1714 instead raise a |dialog| asking if you wish to save the current
1715 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1716 If 'confirm' is off you can still activate confirmation for one
1717 command only (this is most useful in mappings) with the |:confirm|
1718 command.
1719 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1720
1721 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1722'conskey' 'consk' boolean (default off)
1723 global
1724 {not in Vi} {only for MS-DOS}
1725 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001726 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 three methods of console input are available:
1728 'conskey' 'bioskey' action ~
1729 on on or off direct console input
1730 off on BIOS
1731 off off STDIN
1732
1733 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1734'copyindent' 'ci' boolean (default off)
1735 local to buffer
1736 {not in Vi}
1737 Copy the structure of the existing lines indent when autoindenting a
1738 new line. Normally the new indent is reconstructed by a series of
1739 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1740 in which case only spaces are used). Enabling this option makes the
1741 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001742 existing line. 'expandtab' has no effect on these characters, a Tab
1743 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 line, the remaining space is filled in the normal manner.
1745 NOTE: 'copyindent' is reset when 'compatible' is set.
1746 Also see 'preserveindent'.
1747
1748 *'cpoptions'* *'cpo'*
1749'cpoptions' 'cpo' string (Vim default: "aABceFs",
1750 Vi default: all flags)
1751 global
1752 {not in Vi}
1753 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001754 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 not being vi-compatible is mostly or sometimes preferred.
1756 'cpoptions' stands for "compatible-options".
1757 Commas can be added for readability.
1758 To avoid problems with flags that are added in the future, use the
1759 "+=" and "-=" feature of ":set" |add-option-flags|.
1760 NOTE: This option is set to the Vi default value when 'compatible' is
1761 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001762 NOTE: This option is set to the POSIX default value at startup when
1763 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001764 variable exists |posix|. This means Vim tries to behave like the
1765 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766
1767 contains behavior ~
1768 *cpo-a*
1769 a When included, a ":read" command with a file name
1770 argument will set the alternate file name for the
1771 current window.
1772 *cpo-A*
1773 A When included, a ":write" command with a file name
1774 argument will set the alternate file name for the
1775 current window.
1776 *cpo-b*
1777 b "\|" in a ":map" command is recognized as the end of
1778 the map command. The '\' is included in the mapping,
1779 the text after the '|' is interpreted as the next
1780 command. Use a CTRL-V instead of a backslash to
1781 include the '|' in the mapping. Applies to all
1782 mapping, abbreviation, menu and autocmd commands.
1783 See also |map_bar|.
1784 *cpo-B*
1785 B A backslash has no special meaning in mappings,
1786 abbreviations and the "to" part of the menu commands.
1787 Remove this flag to be able to use a backslash like a
1788 CTRL-V. For example, the command ":map X \<Esc>"
1789 results in X being mapped to:
1790 'B' included: "\^[" (^[ is a real <Esc>)
1791 'B' excluded: "<Esc>" (5 characters)
1792 ('<' excluded in both cases)
1793 *cpo-c*
1794 c Searching continues at the end of any match at the
1795 cursor position, but not further than the start of the
1796 next line. When not present searching continues
1797 one character from the cursor position. With 'c'
1798 "abababababab" only gets three matches when repeating
1799 "/abab", without 'c' there are five matches.
1800 *cpo-C*
1801 C Do not concatenate sourced lines that start with a
1802 backslash. See |line-continuation|.
1803 *cpo-d*
1804 d Using "./" in the 'tags' option doesn't mean to use
1805 the tags file relative to the current file, but the
1806 tags file in the current directory.
1807 *cpo-D*
1808 D Can't use CTRL-K to enter a digraph after Normal mode
1809 commands with a character argument, like |r|, |f| and
1810 |t|.
1811 *cpo-e*
1812 e When executing a register with ":@r", always add a
1813 <CR> to the last line, also when the register is not
1814 linewise. If this flag is not present, the register
1815 is not linewise and the last line does not end in a
1816 <CR>, then the last line is put on the command-line
1817 and can be edited before hitting <CR>.
1818 *cpo-E*
1819 E It is an error when using "y", "d", "c", "g~", "gu" or
1820 "gU" on an Empty region. The operators only work when
1821 at least one character is to be operate on. Example:
1822 This makes "y0" fail in the first column.
1823 *cpo-f*
1824 f When included, a ":read" command with a file name
1825 argument will set the file name for the current buffer,
1826 if the current buffer doesn't have a file name yet.
1827 *cpo-F*
1828 F When included, a ":write" command with a file name
1829 argument will set the file name for the current
1830 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001831 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 *cpo-g*
1833 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001834 *cpo-H*
1835 H When using "I" on a line with only blanks, insert
1836 before the last blank. Without this flag insert after
1837 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 *cpo-i*
1839 i When included, interrupting the reading of a file will
1840 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001841 *cpo-I*
1842 I When moving the cursor up or down just after inserting
1843 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 *cpo-j*
1845 j When joining lines, only add two spaces after a '.',
1846 not after '!' or '?'. Also see 'joinspaces'.
1847 *cpo-J*
1848 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001849 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 white space.
1851 *cpo-k*
1852 k Disable the recognition of raw key codes in
1853 mappings, abbreviations, and the "to" part of menu
1854 commands. For example, if <Key> sends ^[OA (where ^[
1855 is <Esc>), the command ":map X ^[OA" results in X
1856 being mapped to:
1857 'k' included: "^[OA" (3 characters)
1858 'k' excluded: "<Key>" (one key code)
1859 Also see the '<' flag below.
1860 *cpo-K*
1861 K Don't wait for a key code to complete when it is
1862 halfway a mapping. This breaks mapping <F1><F1> when
1863 only part of the second <F1> has been read. It
1864 enables cancelling the mapping by typing <F1><Esc>.
1865 *cpo-l*
1866 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001867 literally, only "\]", "\^", "\-" and "\\" are special.
1868 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1870 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001871 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *cpo-L*
1873 L When the 'list' option is set, 'wrapmargin',
1874 'textwidth', 'softtabstop' and Virtual Replace mode
1875 (see |gR|) count a <Tab> as two characters, instead of
1876 the normal behavior of a <Tab>.
1877 *cpo-m*
1878 m When included, a showmatch will always wait half a
1879 second. When not included, a showmatch will wait half
1880 a second or until a character is typed. |'showmatch'|
1881 *cpo-M*
1882 M When excluded, "%" matching will take backslashes into
1883 account. Thus in "( \( )" and "\( ( \)" the outer
1884 parenthesis match. When included "%" ignores
1885 backslashes, which is Vi compatible.
1886 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001887 n When included, the column used for 'number' and
1888 'relativenumber' will also be used for text of wrapped
1889 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *cpo-o*
1891 o Line offset to search command is not remembered for
1892 next search.
1893 *cpo-O*
1894 O Don't complain if a file is being overwritten, even
1895 when it didn't exist when editing it. This is a
1896 protection against a file unexpectedly created by
1897 someone else. Vi didn't complain about this.
1898 *cpo-p*
1899 p Vi compatible Lisp indenting. When not present, a
1900 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001901 *cpo-P*
1902 P When included, a ":write" command that appends to a
1903 file will set the file name for the current buffer, if
1904 the current buffer doesn't have a file name yet and
1905 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001906 *cpo-q*
1907 q When joining multiple lines leave the cursor at the
1908 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 *cpo-r*
1910 r Redo ("." command) uses "/" to repeat a search
1911 command, instead of the actually used search string.
1912 *cpo-R*
1913 R Remove marks from filtered lines. Without this flag
1914 marks are kept like |:keepmarks| was used.
1915 *cpo-s*
1916 s Set buffer options when entering the buffer for the
1917 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001918 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 set when the buffer is created.
1920 *cpo-S*
1921 S Set buffer options always when entering a buffer
1922 (except 'readonly', 'fileformat', 'filetype' and
1923 'syntax'). This is the (most) Vi compatible setting.
1924 The options are set to the values in the current
1925 buffer. When you change an option and go to another
1926 buffer, the value is copied. Effectively makes the
1927 buffer options global to all buffers.
1928
1929 's' 'S' copy buffer options
1930 no no when buffer created
1931 yes no when buffer first entered (default)
1932 X yes each time when buffer entered (vi comp.)
1933 *cpo-t*
1934 t Search pattern for the tag command is remembered for
1935 "n" command. Otherwise Vim only puts the pattern in
1936 the history for search pattern, but doesn't change the
1937 last used search pattern.
1938 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001939 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 *cpo-v*
1941 v Backspaced characters remain visible on the screen in
1942 Insert mode. Without this flag the characters are
1943 erased from the screen right away. With this flag the
1944 screen newly typed text overwrites backspaced
1945 characters.
1946 *cpo-w*
1947 w When using "cw" on a blank character, only change one
1948 character and not all blanks until the start of the
1949 next word.
1950 *cpo-W*
1951 W Don't overwrite a readonly file. When omitted, ":w!"
1952 overwrites a readonly file, if possible.
1953 *cpo-x*
1954 x <Esc> on the command-line executes the command-line.
1955 The default in Vim is to abandon the command-line,
1956 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-X*
1958 X When using a count with "R" the replaced text is
1959 deleted only once. Also when repeating "R" with "."
1960 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 *cpo-y*
1962 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001963 *cpo-Z*
1964 Z When using "w!" while the 'readonly' option is set,
1965 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 *cpo-!*
1967 ! When redoing a filter command, use the last used
1968 external command, whatever it was. Otherwise the last
1969 used -filter- command is used.
1970 *cpo-$*
1971 $ When making a change to one line, don't redisplay the
1972 line, but put a '$' at the end of the changed text.
1973 The changed text will be overwritten when you type the
1974 new text. The line is redisplayed if you type any
1975 command that moves the cursor from the insertion
1976 point.
1977 *cpo-%*
1978 % Vi-compatible matching is done for the "%" command.
1979 Does not recognize "#if", "#endif", etc.
1980 Does not recognize "/*" and "*/".
1981 Parens inside single and double quotes are also
1982 counted, causing a string that contains a paren to
1983 disturb the matching. For example, in a line like
1984 "if (strcmp("foo(", s))" the first paren does not
1985 match the last one. When this flag is not included,
1986 parens inside single and double quotes are treated
1987 specially. When matching a paren outside of quotes,
1988 everything inside quotes is ignored. When matching a
1989 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001990 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001991 This flag is also used for other features, such as
1992 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001993 *cpo--*
1994 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001995 it would go above the first line or below the last
1996 line. Without it the cursor moves to the first or
1997 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001998 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001999 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002000 *cpo-+*
2001 + When included, a ":write file" command will reset the
2002 'modified' flag of the buffer, even though the buffer
2003 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002004 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 * Use ":*" in the same way as ":@". When not included,
2006 ":*" is an alias for ":'<,'>", select the Visual area.
2007 *cpo-<*
2008 < Disable the recognition of special key codes in |<>|
2009 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002010 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 ":map X <Tab>" results in X being mapped to:
2012 '<' included: "<Tab>" (5 characters)
2013 '<' excluded: "^I" (^I is a real <Tab>)
2014 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002015 *cpo->*
2016 > When appending to a register, put a line break before
2017 the appended text.
2018
2019 POSIX flags. These are not included in the Vi default value, except
2020 when $VIM_POSIX was set on startup. |posix|
2021
2022 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002023 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002024 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002025 *cpo-&*
2026 & When ":preserve" was used keep the swap file when
2027 exiting normally while this buffer is still loaded.
2028 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002029 *cpo-\*
2030 \ Backslash in a [] range in a search pattern is taken
2031 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002032 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2033 '\' excluded: "/[ \-]" finds <Space> and '-'
2034 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002035 *cpo-/*
2036 / When "%" is used as the replacement string in a |:s|
2037 command, use the previous replacement string. |:s%|
2038 *cpo-{*
2039 { The |{| and |}| commands also stop at a "{" character
2040 at the start of a line.
2041 *cpo-.*
2042 . The ":chdir" and ":cd" commands fail if the current
2043 buffer is modified, unless ! is used. Vim doesn't
2044 need this, since it remembers the full path of an
2045 opened file.
2046 *cpo-bar*
2047 | The value of the $LINES and $COLUMNS environment
2048 variables overrule the terminal size values obtained
2049 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002050
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002052 *'cryptmethod'* *'cm'*
2053'cryptmethod' number (default 0)
2054 local to buffer
2055 {not in Vi}
2056 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002057 *pkzip*
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002058 0 PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002059 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002060 *blowfish*
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002061 1 Blowfish method. Strong encryption. Requires Vim 7.3
2062 or later, files can NOT be read by Vim 7.2 and older.
2063 This adds a "seed" to the file, every time you write
2064 the file the encrypted bytes will be different.
2065
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002066 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002067 to the detected method of the file being read. Thus if you write it
2068 without changing 'cryptmethod' the same method will be used.
2069 Changing 'cryptmethod' does not mark the file as modified, you have to
2070 explicitly write it when not making modifications.
2071 Also see |:X|.
2072 When a new encryption method is added in a later version of Vim, and
2073 the current version does not recognize it, you will get *E821* .
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002074
2075
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 *'cscopepathcomp'* *'cspc'*
2077'cscopepathcomp' 'cspc' number (default 0)
2078 global
2079 {not available when compiled without the |+cscope|
2080 feature}
2081 {not in Vi}
2082 Determines how many components of the path to show in a list of tags.
2083 See |cscopepathcomp|.
2084
2085 *'cscopeprg'* *'csprg'*
2086'cscopeprg' 'csprg' string (default "cscope")
2087 global
2088 {not available when compiled without the |+cscope|
2089 feature}
2090 {not in Vi}
2091 Specifies the command to execute cscope. See |cscopeprg|.
2092 This option cannot be set from a |modeline| or in the |sandbox|, for
2093 security reasons.
2094
2095 *'cscopequickfix'* *'csqf'*
2096'cscopequickfix' 'csqf' string (default "")
2097 global
2098 {not available when compiled without the |+cscope|
2099 or |+quickfix| features}
2100 {not in Vi}
2101 Specifies whether to use quickfix window to show cscope results.
2102 See |cscopequickfix|.
2103
2104 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2105'cscopetag' 'cst' boolean (default off)
2106 global
2107 {not available when compiled without the |+cscope|
2108 feature}
2109 {not in Vi}
2110 Use cscope for tag commands. See |cscope-options|.
2111 NOTE: This option is reset when 'compatible' is set.
2112
2113 *'cscopetagorder'* *'csto'*
2114'cscopetagorder' 'csto' number (default 0)
2115 global
2116 {not available when compiled without the |+cscope|
2117 feature}
2118 {not in Vi}
2119 Determines the order in which ":cstag" performs a search. See
2120 |cscopetagorder|.
2121 NOTE: This option is set to 0 when 'compatible' is set.
2122
2123 *'cscopeverbose'* *'csverb'*
2124 *'nocscopeverbose'* *'nocsverb'*
2125'cscopeverbose' 'csverb' boolean (default off)
2126 global
2127 {not available when compiled without the |+cscope|
2128 feature}
2129 {not in Vi}
2130 Give messages when adding a cscope database. See |cscopeverbose|.
2131 NOTE: This option is reset when 'compatible' is set.
2132
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002133
2134 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2135'cursorcolumn' 'cuc' boolean (default off)
2136 local to window
2137 {not in Vi}
2138 {not available when compiled without the |+syntax|
2139 feature}
2140 Highlight the screen column of the cursor with CursorColumn
2141 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2142 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002143 If you only want the highlighting in the current window you can use
2144 these autocommands: >
2145 au WinLeave * set nocursorline nocursorcolumn
2146 au WinEnter * set cursorline cursorcolumn
2147<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002148
2149 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2150'cursorline' 'cul' boolean (default off)
2151 local to window
2152 {not in Vi}
2153 {not available when compiled without the |+syntax|
2154 feature}
2155 Highlight the screen line of the cursor with CursorLine
2156 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2157 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002158 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002159 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002160
2161
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 *'debug'*
2163'debug' string (default "")
2164 global
2165 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002166 These values can be used:
2167 msg Error messages that would otherwise be omitted will be given
2168 anyway.
2169 throw Error messages that would otherwise be omitted will be given
2170 anyway and also throw an exception and set |v:errmsg|.
2171 beep A message will be given when otherwise only a beep would be
2172 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002173 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002174 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2175 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176
2177 *'define'* *'def'*
2178'define' 'def' string (default "^\s*#\s*define")
2179 global or local to buffer |global-local|
2180 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002181 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 pattern, just like for the "/" command. This option is used for the
2183 commands like "[i" and "[d" |include-search|. The 'isident' option is
2184 used to recognize the defined name after the match:
2185 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2186 See |option-backslash| about inserting backslashes to include a space
2187 or backslash.
2188 The default value is for C programs. For C++ this value would be
2189 useful, to include const type declarations: >
2190 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2191< When using the ":set" command, you need to double the backslashes!
2192
2193 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2194'delcombine' 'deco' boolean (default off)
2195 global
2196 {not in Vi}
2197 {only available when compiled with the |+multi_byte|
2198 feature}
2199 If editing Unicode and this option is set, backspace and Normal mode
2200 "x" delete each combining character on its own. When it is off (the
2201 default) the character along with its combining characters are
2202 deleted.
2203 Note: When 'delcombine' is set "xx" may work different from "2x"!
2204
2205 This is useful for Arabic, Hebrew and many other languages where one
2206 may have combining characters overtop of base characters, and want
2207 to remove only the combining ones.
2208
2209 *'dictionary'* *'dict'*
2210'dictionary' 'dict' string (default "")
2211 global or local to buffer |global-local|
2212 {not in Vi}
2213 List of file names, separated by commas, that are used to lookup words
2214 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2215 contain a list of words. This can be one word per line, or several
2216 words per line, separated by non-keyword characters (white space is
2217 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002218 When this option is empty, or an entry "spell" is present, spell
2219 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002220 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 after a comma are ignored, otherwise spaces are included in the file
2222 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002223 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 Where to find a list of words?
2225 - On FreeBSD, there is the file "/usr/share/dict/words".
2226 - In the Simtel archive, look in the "msdos/linguist" directory.
2227 - In "miscfiles" of the GNU collection.
2228 The use of |:set+=| and |:set-=| is preferred when adding or removing
2229 directories from the list. This avoids problems when a future version
2230 uses another default.
2231 Backticks cannot be used in this option for security reasons.
2232
2233 *'diff'* *'nodiff'*
2234'diff' boolean (default off)
2235 local to window
2236 {not in Vi}
2237 {not available when compiled without the |+diff|
2238 feature}
2239 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002240 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241
2242 *'dex'* *'diffexpr'*
2243'diffexpr' 'dex' string (default "")
2244 global
2245 {not in Vi}
2246 {not available when compiled without the |+diff|
2247 feature}
2248 Expression which is evaluated to obtain an ed-style diff file from two
2249 versions of a file. See |diff-diffexpr|.
2250 This option cannot be set from a |modeline| or in the |sandbox|, for
2251 security reasons.
2252
2253 *'dip'* *'diffopt'*
2254'diffopt' 'dip' string (default "filler")
2255 global
2256 {not in Vi}
2257 {not available when compiled without the |+diff|
2258 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 All are optional. Items must be separated by a comma.
2261
2262 filler Show filler lines, to keep the text
2263 synchronized with a window that has inserted
2264 lines at the same position. Mostly useful
2265 when windows are side-by-side and 'scrollbind'
2266 is set.
2267
2268 context:{n} Use a context of {n} lines between a change
2269 and a fold that contains unchanged lines.
2270 When omitted a context of six lines is used.
2271 See |fold-diff|.
2272
2273 icase Ignore changes in case of text. "a" and "A"
2274 are considered the same. Adds the "-i" flag
2275 to the "diff" command if 'diffexpr' is empty.
2276
2277 iwhite Ignore changes in amount of white space. Adds
2278 the "-b" flag to the "diff" command if
2279 'diffexpr' is empty. Check the documentation
2280 of the "diff" command for what this does
2281 exactly. It should ignore adding trailing
2282 white space, but not leading white space.
2283
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002284 horizontal Start diff mode with horizontal splits (unless
2285 explicitly specified otherwise).
2286
2287 vertical Start diff mode with vertical splits (unless
2288 explicitly specified otherwise).
2289
2290 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2291 starting diff mode. Without this 2 is used.
2292
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 Examples: >
2294
2295 :set diffopt=filler,context:4
2296 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002297 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298<
2299 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2300'digraph' 'dg' boolean (default off)
2301 global
2302 {not in Vi}
2303 {not available when compiled without the |+digraphs|
2304 feature}
2305 Enable the entering of digraphs in Insert mode with {char1} <BS>
2306 {char2}. See |digraphs|.
2307 NOTE: This option is reset when 'compatible' is set.
2308
2309 *'directory'* *'dir'*
2310'directory' 'dir' string (default for Amiga: ".,t:",
2311 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2312 for Unix: ".,~/tmp,/var/tmp,/tmp")
2313 global
2314 List of directory names for the swap file, separated with commas.
2315 - The swap file will be created in the first directory where this is
2316 possible.
2317 - Empty means that no swap file will be used (recovery is
2318 impossible!).
2319 - A directory "." means to put the swap file in the same directory as
2320 the edited file. On Unix, a dot is prepended to the file name, so
2321 it doesn't show in a directory listing. On MS-Windows the "hidden"
2322 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002323 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 put the swap file relative to where the edited file is. The leading
2325 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002326 - For Unix and Win32, if a directory ends in two path separators "//"
2327 or "\\", the swap file name will be built from the complete path to
2328 the file with all path separators substituted to percent '%' signs.
2329 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002330 On Win32, when a separating comma is following, you must use "//",
2331 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 - Spaces after the comma are ignored, other spaces are considered part
2333 of the directory name. To have a space at the start of a directory
2334 name, precede it with a backslash.
2335 - To include a comma in a directory name precede it with a backslash.
2336 - A directory name may end in an ':' or '/'.
2337 - Environment variables are expanded |:set_env|.
2338 - Careful with '\' characters, type one before a space, type two to
2339 get one in the option (see |option-backslash|), for example: >
2340 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2341< - For backwards compatibility with Vim version 3.0 a '>' at the start
2342 of the option is removed.
2343 Using "." first in the list is recommended. This means that editing
2344 the same file twice will result in a warning. Using "/tmp" on Unix is
2345 discouraged: When the system crashes you lose the swap file.
2346 "/var/tmp" is often not cleared when rebooting, thus is a better
2347 choice than "/tmp". But it can contain a lot of files, your swap
2348 files get lost in the crowd. That is why a "tmp" directory in your
2349 home directory is tried first.
2350 The use of |:set+=| and |:set-=| is preferred when adding or removing
2351 directories from the list. This avoids problems when a future version
2352 uses another default.
2353 This option cannot be set from a |modeline| or in the |sandbox|, for
2354 security reasons.
2355 {Vi: directory to put temp file in, defaults to "/tmp"}
2356
2357 *'display'* *'dy'*
2358'display' 'dy' string (default "")
2359 global
2360 {not in Vi}
2361 Change the way text is displayed. This is comma separated list of
2362 flags:
2363 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002364 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 last line that doesn't fit is replaced with "@" lines.
2366 uhex Show unprintable characters hexadecimal as <xx>
2367 instead of using ^C and ~C.
2368
2369 *'eadirection'* *'ead'*
2370'eadirection' 'ead' string (default "both")
2371 global
2372 {not in Vi}
2373 {not available when compiled without the +vertsplit
2374 feature}
2375 Tells when the 'equalalways' option applies:
2376 ver vertically, width of windows is not affected
2377 hor horizontally, height of windows is not affected
2378 both width and height of windows is affected
2379
2380 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2381'edcompatible' 'ed' boolean (default off)
2382 global
2383 Makes the 'g' and 'c' flags of the ":substitute" command to be
2384 toggled each time the flag is given. See |complex-change|. See
2385 also 'gdefault' option.
2386 Switching this option on is discouraged!
2387
2388 *'encoding'* *'enc'* *E543*
2389'encoding' 'enc' string (default: "latin1" or value from $LANG)
2390 global
2391 {only available when compiled with the |+multi_byte|
2392 feature}
2393 {not in Vi}
2394 Sets the character encoding used inside Vim. It applies to text in
2395 the buffers, registers, Strings in expressions, text stored in the
2396 viminfo file, etc. It sets the kind of characters which Vim can work
2397 with. See |encoding-names| for the possible values.
2398
2399 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002400 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002402 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403
2404 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2405 "utf-8". Although care has been taken to allow different values of
2406 'encoding', "utf-8" is the natural choice for the environment and
2407 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002408 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 versions, and to avoid changing the encoding of newly created files
2410 without your knowledge (in case 'fileencodings' is empty).
2411
2412 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002413 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 iconv() or as specified with 'charconvert'.
2415
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002416 If you need to know whether 'encoding' is a multi-byte encoding, you
2417 can use: >
2418 if has("multi_byte_encoding")
2419<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Normally 'encoding' will be equal to your current locale. This will
2421 be the default if Vim recognizes your environment settings. If
2422 'encoding' is not set to the current locale, 'termencoding' must be
2423 set to convert typed and displayed text. See |encoding-table|.
2424
2425 When you set this option, it fires the |EncodingChanged| autocommand
2426 event so that you can set up fonts if necessary.
2427
2428 When the option is set, the value is converted to lowercase. Thus
2429 you can set it with uppercase values too. Underscores are translated
2430 to '-' signs.
2431 When the encoding is recognized, it is changed to the standard name.
2432 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2433 "iso-8859-2" and "utf8" becomes "utf-8".
2434
2435 Note: "latin1" is also used when the encoding could not be detected.
2436 This only works when editing files in the same encoding! When the
2437 actual character set is not latin1, make sure 'fileencoding' and
2438 'fileencodings' are empty. When conversion is needed, switch to using
2439 utf-8.
2440
2441 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2442 You don't notice this while editing, but it does matter for the
2443 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2444 setting 'encoding' to one of these values instead of utf-8 only has
2445 effect for encoding used for files when 'fileencoding' is empty.
2446
Bram Moolenaar661b1822005-07-28 22:36:45 +00002447 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2448 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449
2450 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2451'endofline' 'eol' boolean (default on)
2452 local to buffer
2453 {not in Vi}
2454 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002455 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 option is automatically set when starting to edit a new file, unless
2457 the file does not have an <EOL> for the last line in the file, in
2458 which case it is reset. Normally you don't have to set or reset this
2459 option. When 'binary' is off the value is not used when writing the
2460 file. When 'binary' is on it is used to remember the presence of a
2461 <EOL> for the last line in the file, so that when you write the file
2462 the situation from the original file can be kept. But you can change
2463 it if you want to.
2464
2465 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2466'equalalways' 'ea' boolean (default on)
2467 global
2468 {not in Vi}
2469 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002470 splitting or closing a window. This also happens the moment the
2471 option is switched on. When off, splitting a window will reduce the
2472 size of the current window and leave the other windows the same. When
2473 closing a window the extra lines are given to the window next to it
2474 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 When mixing vertically and horizontally split windows, a minimal size
2476 is computed and some windows may be larger if there is room. The
2477 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002478 Changing the height and width of a window can be avoided by setting
2479 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002480 If a window size is specified when creating a new window sizes are
2481 currently not equalized (it's complicated, but may be implemented in
2482 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483
2484 *'equalprg'* *'ep'*
2485'equalprg' 'ep' string (default "")
2486 global or local to buffer |global-local|
2487 {not in Vi}
2488 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002489 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002490 or 'indentexpr'. When Vim was compiled without internal formatting,
2491 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002492 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 about including spaces and backslashes.
2494 This option cannot be set from a |modeline| or in the |sandbox|, for
2495 security reasons.
2496
2497 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2498'errorbells' 'eb' boolean (default off)
2499 global
2500 Ring the bell (beep or screen flash) for error messages. This only
2501 makes a difference for error messages, the bell will be used always
2502 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002503 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 screen flash or do nothing.
2505
2506 *'errorfile'* *'ef'*
2507'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2508 others: "errors.err")
2509 global
2510 {not in Vi}
2511 {not available when compiled without the |+quickfix|
2512 feature}
2513 Name of the errorfile for the QuickFix mode (see |:cf|).
2514 When the "-q" command-line argument is used, 'errorfile' is set to the
2515 following argument. See |-q|.
2516 NOT used for the ":make" command. See 'makeef' for that.
2517 Environment variables are expanded |:set_env|.
2518 See |option-backslash| about including spaces and backslashes.
2519 This option cannot be set from a |modeline| or in the |sandbox|, for
2520 security reasons.
2521
2522 *'errorformat'* *'efm'*
2523'errorformat' 'efm' string (default is very long)
2524 global or local to buffer |global-local|
2525 {not in Vi}
2526 {not available when compiled without the |+quickfix|
2527 feature}
2528 Scanf-like description of the format for the lines in the error file
2529 (see |errorformat|).
2530
2531 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2532'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2533 global
2534 {not in Vi}
2535 Function keys that start with an <Esc> are recognized in Insert
2536 mode. When this option is off, the cursor and function keys cannot be
2537 used in Insert mode if they start with an <Esc>. The advantage of
2538 this is that the single <Esc> is recognized immediately, instead of
2539 after one second. Instead of resetting this option, you might want to
2540 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2541 when 'esckeys' is off, you can still map anything, but the cursor keys
2542 won't work by default.
2543 NOTE: This option is set to the Vi default value when 'compatible' is
2544 set and to the Vim default value when 'compatible' is reset.
2545
2546 *'eventignore'* *'ei'*
2547'eventignore' 'ei' string (default "")
2548 global
2549 {not in Vi}
2550 {not available when compiled without the |+autocmd|
2551 feature}
2552 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002553 When set to "all" or when "all" is one of the items, all autocommand
2554 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 Otherwise this is a comma separated list of event names. Example: >
2556 :set ei=WinEnter,WinLeave
2557<
2558 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2559'expandtab' 'et' boolean (default off)
2560 local to buffer
2561 {not in Vi}
2562 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002563 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2565 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2566 NOTE: This option is reset when 'compatible' is set.
2567
2568 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2569'exrc' 'ex' boolean (default off)
2570 global
2571 {not in Vi}
2572 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2573 directory. If you switch this option on you should also consider
2574 setting the 'secure' option (see |initialization|). Using a local
2575 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2576 also see |.vimrc| and |gui-init|.
2577 This option cannot be set from a |modeline| or in the |sandbox|, for
2578 security reasons.
2579
2580 *'fileencoding'* *'fenc'* *E213*
2581'fileencoding' 'fenc' string (default: "")
2582 local to buffer
2583 {only available when compiled with the |+multi_byte|
2584 feature}
2585 {not in Vi}
2586 Sets the character encoding for the file of this buffer.
2587 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002588 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 When 'fileencoding' is empty, the same value as 'encoding' will be
2590 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002591 Conversion will also be done when 'encoding' and 'fileencoding' are
2592 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2593 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002595 'encoding' is "utf-8" or another Unicode encoding, conversion
2596 is most likely done in a way that the reverse conversion
2597 results in the same text. When 'encoding' is not "utf-8" some
2598 characters may be lost!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 See 'encoding' for the possible values. Additionally, values may be
2600 specified that can be handled by the converter, see
2601 |mbyte-conversion|.
2602 When reading a file 'fileencoding' will be set from 'fileencodings'.
2603 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002604 'fileencoding', use the |++enc| argument. One exception: when
2605 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002606 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2608 When the option is set, the value is converted to lowercase. Thus
2609 you can set it with uppercase values too. '_' characters are
2610 replaced with '-'. If a name is recognized from the list for
2611 'encoding', it is replaced by the standard name. For example
2612 "ISO8859-2" becomes "iso-8859-2".
2613 When this option is set, after starting to edit a file, the 'modified'
2614 option is set, because the file would be different when written.
2615 If you do this in a modeline, you might want to set 'nomodified' to
2616 avoid this.
2617 This option can not be changed when 'modifiable' is off.
2618
2619 *'fe'*
2620 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002621 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 old short name was 'fe', which is no longer used.
2623
2624 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002625'fileencodings' 'fencs' string (default: "ucs-bom",
2626 "ucs-bom,utf-8,default,latin1" when
2627 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 global
2629 {only available when compiled with the |+multi_byte|
2630 feature}
2631 {not in Vi}
2632 This is a list of character encodings considered when starting to edit
2633 an existing file. When a file is read, Vim tries to use the first
2634 mentioned character encoding. If an error is detected, the next one
2635 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002636 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 an empty string, which means the value of 'encoding' is used.
2638 WARNING: Conversion can cause loss of information! When
2639 'encoding' is "utf-8" (or one of the other Unicode variants)
2640 conversion is most likely done in a way that the reverse
2641 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002642 "utf-8" some non-ASCII characters may be lost! You can use
2643 the |++bad| argument to specify what is done with characters
2644 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 For an empty file or a file with only ASCII characters most encodings
2646 will work and the first entry of 'fileencodings' will be used (except
2647 "ucs-bom", which requires the BOM to be present). If you prefer
2648 another encoding use an BufReadPost autocommand event to test if your
2649 preferred encoding is to be used. Example: >
2650 au BufReadPost * if search('\S', 'w') == 0 |
2651 \ set fenc=iso-2022-jp | endif
2652< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2653 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002654 When the |++enc| argument is used then the value of 'fileencodings' is
2655 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002656 Note that 'fileencodings' is not used for a new file, the global value
2657 of 'fileencoding' is used instead. You can set it with: >
2658 :setglobal fenc=iso-8859-2
2659< This means that a non-existing file may get a different encoding than
2660 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 The special value "ucs-bom" can be used to check for a Unicode BOM
2662 (Byte Order Mark) at the start of the file. It must not be preceded
2663 by "utf-8" or another Unicode encoding for this to work properly.
2664 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2665 because Vim cannot detect an error, thus the encoding is always
2666 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002667 The special value "default" can be used for the encoding from the
2668 environment. This is the default value for 'encoding'. It is useful
2669 when 'encoding' is set to "utf-8" and your environment uses a
2670 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002671 When 'encoding' is "utf-8" and a file contains an illegal byte
2672 sequence it won't be recognized as UTF-8. You can use the |8g8|
2673 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 WRONG VALUES: WHAT'S WRONG:
2675 latin1,utf-8 "latin1" will always be used
2676 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2677 file
2678 cp1250,latin1 "cp1250" will always be used
2679 If 'fileencodings' is empty, 'fileencoding' is not modified.
2680 See 'fileencoding' for the possible values.
2681 Setting this option does not have an effect until the next time a file
2682 is read.
2683
2684 *'fileformat'* *'ff'*
2685'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2686 Unix default: "unix",
2687 Macintosh default: "mac")
2688 local to buffer
2689 {not in Vi}
2690 This gives the <EOL> of the current buffer, which is used for
2691 reading/writing the buffer from/to a file:
2692 dos <CR> <NL>
2693 unix <NL>
2694 mac <CR>
2695 When "dos" is used, CTRL-Z at the end of a file is ignored.
2696 See |file-formats| and |file-read|.
2697 For the character encoding of the file see 'fileencoding'.
2698 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2699 works like it was set to "unix'.
2700 This option is set automatically when starting to edit a file and
2701 'fileformats' is not empty and 'binary' is off.
2702 When this option is set, after starting to edit a file, the 'modified'
2703 option is set, because the file would be different when written.
2704 This option can not be changed when 'modifiable' is off.
2705 For backwards compatibility: When this option is set to "dos",
2706 'textmode' is set, otherwise 'textmode' is reset.
2707
2708 *'fileformats'* *'ffs'*
2709'fileformats' 'ffs' string (default:
2710 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2711 Vim Unix: "unix,dos",
2712 Vim Mac: "mac,unix,dos",
2713 Vi Cygwin: "unix,dos",
2714 Vi others: "")
2715 global
2716 {not in Vi}
2717 This gives the end-of-line (<EOL>) formats that will be tried when
2718 starting to edit a new buffer and when reading a file into an existing
2719 buffer:
2720 - When empty, the format defined with 'fileformat' will be used
2721 always. It is not set automatically.
2722 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002723 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 'fileformats' name will be used when a file is read into an existing
2725 buffer, no matter what 'fileformat' for that buffer is set to.
2726 - When more than one name is present, separated by commas, automatic
2727 <EOL> detection will be done when reading a file. When starting to
2728 edit a file, a check is done for the <EOL>:
2729 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2730 'fileformat' is set to "dos".
2731 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002732 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 preceding <CR>, "unix" is preferred over "dos".
2734 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2735 This means that "mac" is only chosen when "unix" is not present,
2736 or when no <NL> is found in the file, and when "dos" is not
2737 present, or no <CR><NL> is present in the file.
2738 Also if "unix" was first chosen, but the first <CR> is before
2739 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2740 the file, then 'fileformat' is set to "mac".
2741 4. If 'fileformat' is still not set, the first name from
2742 'fileformats' is used.
2743 When reading a file into an existing buffer, the same is done, but
2744 this happens like 'fileformat' has been set appropriately for that
2745 file only, the option is not changed.
2746 When 'binary' is set, the value of 'fileformats' is not used.
2747
2748 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2749 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2750 done:
2751 - When 'fileformats' is empty, there is no automatic detection. Dos
2752 format will be used.
2753 - When 'fileformats' is set to one or more names, automatic detection
2754 is done. This is based on the first <NL> in the file: If there is a
2755 <CR> in front of it, Dos format is used, otherwise Unix format is
2756 used.
2757 Also see |file-formats|.
2758 For backwards compatibility: When this option is set to an empty
2759 string or one format (no comma is included), 'textauto' is reset,
2760 otherwise 'textauto' is set.
2761 NOTE: This option is set to the Vi default value when 'compatible' is
2762 set and to the Vim default value when 'compatible' is reset.
2763
2764 *'filetype'* *'ft'*
2765'filetype' 'ft' string (default: "")
2766 local to buffer
2767 {not in Vi}
2768 {not available when compiled without the |+autocmd|
2769 feature}
2770 When this option is set, the FileType autocommand event is triggered.
2771 All autocommands that match with the value of this option will be
2772 executed. Thus the value of 'filetype' is used in place of the file
2773 name.
2774 Otherwise this option does not always reflect the current file type.
2775 This option is normally set when the file type is detected. To enable
2776 this use the ":filetype on" command. |:filetype|
2777 Setting this option to a different value is most useful in a modeline,
2778 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002779 Example, for in an IDL file:
2780 /* vim: set filetype=idl : */ ~
2781 |FileType| |filetypes|
2782 When a dot appears in the value then this separates two filetype
2783 names. Example:
2784 /* vim: set filetype=c.doxygen : */ ~
2785 This will use the "c" filetype first, then the "doxygen" filetype.
2786 This works both for filetype plugins and for syntax files. More than
2787 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 Do not confuse this option with 'osfiletype', which is for the file
2789 type that is actually stored with the file.
2790 This option is not copied to another buffer, independent of the 's' or
2791 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002792 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793
2794 *'fillchars'* *'fcs'*
2795'fillchars' 'fcs' string (default "vert:|,fold:-")
2796 global
2797 {not in Vi}
2798 {not available when compiled without the |+windows|
2799 and |+folding| features}
2800 Characters to fill the statuslines and vertical separators.
2801 It is a comma separated list of items:
2802
2803 item default Used for ~
2804 stl:c ' ' or '^' statusline of the current window
2805 stlnc:c ' ' or '-' statusline of the non-current windows
2806 vert:c '|' vertical separators |:vsplit|
2807 fold:c '-' filling 'foldtext'
2808 diff:c '-' deleted lines of the 'diff' option
2809
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002810 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 "stlnc" the space will be used when there is highlighting, '^' or '-'
2812 otherwise.
2813
2814 Example: >
2815 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2816< This is similar to the default, except that these characters will also
2817 be used when there is highlighting.
2818
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002819 for "stl" and "stlnc" only single-byte values are supported.
2820
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 The highlighting used for these items:
2822 item highlight group ~
2823 stl:c StatusLine |hl-StatusLine|
2824 stlnc:c StatusLineNC |hl-StatusLineNC|
2825 vert:c VertSplit |hl-VertSplit|
2826 fold:c Folded |hl-Folded|
2827 diff:c DiffDelete |hl-DiffDelete|
2828
2829 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2830'fkmap' 'fk' boolean (default off) *E198*
2831 global
2832 {not in Vi}
2833 {only available when compiled with the |+rightleft|
2834 feature}
2835 When on, the keyboard is mapped for the Farsi character set.
2836 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002837 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838
2839 *'foldclose'* *'fcl'*
2840'foldclose' 'fcl' string (default "")
2841 global
2842 {not in Vi}
2843 {not available when compiled without the |+folding|
2844 feature}
2845 When set to "all", a fold is closed when the cursor isn't in it and
2846 its level is higher than 'foldlevel'. Useful if you want folds to
2847 automatically close when moving out of them.
2848
2849 *'foldcolumn'* *'fdc'*
2850'foldcolumn' 'fdc' number (default 0)
2851 local to window
2852 {not in Vi}
2853 {not available when compiled without the |+folding|
2854 feature}
2855 When non-zero, a column with the specified width is shown at the side
2856 of the window which indicates open and closed folds. The maximum
2857 value is 12.
2858 See |folding|.
2859
2860 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2861'foldenable' 'fen' boolean (default on)
2862 local to window
2863 {not in Vi}
2864 {not available when compiled without the |+folding|
2865 feature}
2866 When off, all folds are open. This option can be used to quickly
2867 switch between showing all text unfolded and viewing the text with
2868 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002869 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 'foldenable' is off.
2871 This option is set by commands that create a new fold or close a fold.
2872 See |folding|.
2873
2874 *'foldexpr'* *'fde'*
2875'foldexpr' 'fde' string (default: "0")
2876 local to window
2877 {not in Vi}
2878 {not available when compiled without the |+folding|
2879 or |+eval| feature}
2880 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002881 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002882
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002883 The expression may be evaluated in the |sandbox|, see
2884 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002885 This option can't be set from a |modeline| when the 'diff' option is
2886 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002887
2888 It is not allowed to change text or jump to another window while
2889 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890
2891 *'foldignore'* *'fdi'*
2892'foldignore' 'fdi' string (default: "#")
2893 local to window
2894 {not in Vi}
2895 {not available when compiled without the |+folding|
2896 feature}
2897 Used only when 'foldmethod' is "indent". Lines starting with
2898 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002899 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 The default "#" works well for C programs. See |fold-indent|.
2901
2902 *'foldlevel'* *'fdl'*
2903'foldlevel' 'fdl' number (default: 0)
2904 local to window
2905 {not in Vi}
2906 {not available when compiled without the |+folding|
2907 feature}
2908 Sets the fold level: Folds with a higher level will be closed.
2909 Setting this option to zero will close all folds. Higher numbers will
2910 close fewer folds.
2911 This option is set by commands like |zm|, |zM| and |zR|.
2912 See |fold-foldlevel|.
2913
2914 *'foldlevelstart'* *'fdls'*
2915'foldlevelstart' 'fdls' number (default: -1)
2916 global
2917 {not in Vi}
2918 {not available when compiled without the |+folding|
2919 feature}
2920 Sets 'foldlevel' when starting to edit another buffer in a window.
2921 Useful to always start editing with all folds closed (value zero),
2922 some folds closed (one) or no folds closed (99).
2923 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002924 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 ignores this option and closes all folds.
2926 It is also done before BufReadPre autocommands, to allow an autocmd to
2927 overrule the 'foldlevel' value for specific files.
2928 When the value is negative, it is not used.
2929
2930 *'foldmarker'* *'fmr'* *E536*
2931'foldmarker' 'fmr' string (default: "{{{,}}}")
2932 local to window
2933 {not in Vi}
2934 {not available when compiled without the |+folding|
2935 feature}
2936 The start and end marker used when 'foldmethod' is "marker". There
2937 must be one comma, which separates the start and end marker. The
2938 marker is a literal string (a regular expression would be too slow).
2939 See |fold-marker|.
2940
2941 *'foldmethod'* *'fdm'*
2942'foldmethod' 'fdm' string (default: "manual")
2943 local to window
2944 {not in Vi}
2945 {not available when compiled without the |+folding|
2946 feature}
2947 The kind of folding used for the current window. Possible values:
2948 |fold-manual| manual Folds are created manually.
2949 |fold-indent| indent Lines with equal indent form a fold.
2950 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2951 |fold-marker| marker Markers are used to specify folds.
2952 |fold-syntax| syntax Syntax highlighting items specify folds.
2953 |fold-diff| diff Fold text that is not changed.
2954
2955 *'foldminlines'* *'fml'*
2956'foldminlines' 'fml' number (default: 1)
2957 local to window
2958 {not in Vi}
2959 {not available when compiled without the |+folding|
2960 feature}
2961 Sets the minimum number of screen lines for a fold to be displayed
2962 closed. Also for manually closed folds.
2963 Note that this only has an effect of what is displayed. After using
2964 "zc" to close a fold, which is displayed open because it's smaller
2965 than 'foldminlines', a following "zc" may close a containing fold.
2966
2967 *'foldnestmax'* *'fdn'*
2968'foldnestmax' 'fdn' number (default: 20)
2969 local to window
2970 {not in Vi}
2971 {not available when compiled without the |+folding|
2972 feature}
2973 Sets the maximum nesting of folds for the "indent" and "syntax"
2974 methods. This avoids that too many folds will be created. Using more
2975 than 20 doesn't work, because the internal limit is 20.
2976
2977 *'foldopen'* *'fdo'*
2978'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2979 search,tag,undo")
2980 global
2981 {not in Vi}
2982 {not available when compiled without the |+folding|
2983 feature}
2984 Specifies for which type of commands folds will be opened, if the
2985 command moves the cursor into a closed fold. It is a comma separated
2986 list of items.
2987 item commands ~
2988 all any
2989 block "(", "{", "[[", "[{", etc.
2990 hor horizontal movements: "l", "w", "fx", etc.
2991 insert any command in Insert mode
2992 jump far jumps: "G", "gg", etc.
2993 mark jumping to a mark: "'m", CTRL-O, etc.
2994 percent "%"
2995 quickfix ":cn", ":crew", ":make", etc.
2996 search search for a pattern: "/", "n", "*", "gd", etc.
2997 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002998 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 tag jumping to a tag: ":ta", CTRL-T, etc.
3000 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003001 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 the |zv| command to the mapping to get the same effect.
3003 When a movement command is used for an operator (e.g., "dl" or "y%")
3004 this option is not used. This means the operator will include the
3005 whole closed fold.
3006 Note that vertical movements are not here, because it would make it
3007 very difficult to move onto a closed fold.
3008 In insert mode the folds containing the cursor will always be open
3009 when text is inserted.
3010 To close folds you can re-apply 'foldlevel' with the |zx| command or
3011 set the 'foldclose' option to "all".
3012
3013 *'foldtext'* *'fdt'*
3014'foldtext' 'fdt' string (default: "foldtext()")
3015 local to window
3016 {not in Vi}
3017 {not available when compiled without the |+folding|
3018 feature}
3019 An expression which is used to specify the text displayed for a closed
3020 fold. See |fold-foldtext|.
3021
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003022 The expression may be evaluated in the |sandbox|, see
3023 |sandbox-option|.
3024
3025 It is not allowed to change text or jump to another window while
3026 evaluating 'foldtext' |textlock|.
3027
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 *'formatoptions'* *'fo'*
3029'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3030 local to buffer
3031 {not in Vi}
3032 This is a sequence of letters which describes how automatic
3033 formatting is to be done. See |fo-table|. When the 'paste' option is
3034 on, no formatting is done (like 'formatoptions' is empty). Commas can
3035 be inserted for readability.
3036 To avoid problems with flags that are added in the future, use the
3037 "+=" and "-=" feature of ":set" |add-option-flags|.
3038 NOTE: This option is set to the Vi default value when 'compatible' is
3039 set and to the Vim default value when 'compatible' is reset.
3040
Bram Moolenaar86b68352004-12-27 21:59:20 +00003041 *'formatlistpat'* *'flp'*
3042'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3043 local to buffer
3044 {not in Vi}
3045 A pattern that is used to recognize a list header. This is used for
3046 the "n" flag in 'formatoptions'.
3047 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003048 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003049 while still checking more characters. There must be a character
3050 following the pattern, when it matches the whole line it is handled
3051 like there is no match.
3052 The default recognizes a number, followed by an optional punctuation
3053 character and white space.
3054
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 *'formatprg'* *'fp'*
3056'formatprg' 'fp' string (default "")
3057 global
3058 {not in Vi}
3059 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003060 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003062 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003063 If the 'formatexpr' option is not empty it will be used instead.
3064 Otherwise, if 'formatprg' option is an empty string, the internal
3065 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003066 Environment variables are expanded |:set_env|. See |option-backslash|
3067 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003068 The expression may be evaluated in the |sandbox|, see
3069 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003071 *'formatexpr'* *'fex'*
3072'formatexpr' 'fex' string (default "")
3073 local to buffer
3074 {not in Vi}
3075 {not available when compiled without the |+eval|
3076 feature}
3077 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003078 operator. When this option is empty 'formatprg' is used.
3079
3080 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003081 The |v:count| variable holds the number of lines to be formatted.
3082 The |v:char| variable holds the character that is going to be
3083 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003084
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003085 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003086 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003087< This will invoke the mylang#Format() function in the
3088 autoload/mylang.vim file in 'runtimepath'. |autoload|
3089
3090 The expression is also evaluated when 'textwidth' is set and adding
3091 text beyond that limit. This happens under the same conditions as
3092 when internal formatting is used. Make sure the cursor is kept in the
3093 same spot relative to the text then! The |mode()| function will
3094 return "i" or "R" in this situation. When the function returns
3095 non-zero Vim will fall back to using the internal format mechanism.
3096
3097 The expression may be evaluated in the |sandbox|, see
3098 |sandbox-option|.
3099
3100 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003101'fsync' 'fs' boolean (default on)
3102 global
3103 {not in Vi}
3104 When on, the library function fsync() will be called after writing a
3105 file. This will flush a file to disk, ensuring that it is safely
3106 written even on filesystems which do metadata-only journaling. This
3107 will force the harddrive to spin up on Linux systems running in laptop
3108 mode, so it may be undesirable in some situations. Be warned that
3109 turning this off increases the chances of data loss after a crash. On
3110 systems without an fsync() implementation, this variable is always
3111 off.
3112 Also see 'swapsync' for controlling fsync() on swap files.
3113
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3115'gdefault' 'gd' boolean (default off)
3116 global
3117 {not in Vi}
3118 When on, the ":substitute" flag 'g' is default on. This means that
3119 all matches in a line are substituted instead of one. When a 'g' flag
3120 is given to a ":substitute" command, this will toggle the substitution
3121 of all or one match. See |complex-change|.
3122
3123 command 'gdefault' on 'gdefault' off ~
3124 :s/// subst. all subst. one
3125 :s///g subst. one subst. all
3126 :s///gg subst. all subst. one
3127
3128 NOTE: This option is reset when 'compatible' is set.
3129
3130 *'grepformat'* *'gfm'*
3131'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3132 global
3133 {not in Vi}
3134 Format to recognize for the ":grep" command output.
3135 This is a scanf-like string that uses the same format as the
3136 'errorformat' option: see |errorformat|.
3137
3138 *'grepprg'* *'gp'*
3139'grepprg' 'gp' string (default "grep -n ",
3140 Unix: "grep -n $* /dev/null",
3141 Win32: "findstr /n" or "grep -n",
3142 VMS: "SEARCH/NUMBERS ")
3143 global or local to buffer |global-local|
3144 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003145 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 and '#' characters, which are expanded like when used in a command-
3147 line. The placeholder "$*" is allowed to specify where the arguments
3148 will be included. Environment variables are expanded |:set_env|. See
3149 |option-backslash| about including spaces and backslashes.
3150 When your "grep" accepts the "-H" argument, use this to make ":grep"
3151 also work well with a single file: >
3152 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003153< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003154 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3155 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003156 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 apply equally to 'grepprg'.
3158 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3159 otherwise it's "grep -n".
3160 This option cannot be set from a |modeline| or in the |sandbox|, for
3161 security reasons.
3162
3163 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3164'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3165 ve:ver35-Cursor,
3166 o:hor50-Cursor,
3167 i-ci:ver25-Cursor/lCursor,
3168 r-cr:hor20-Cursor/lCursor,
3169 sm:block-Cursor
3170 -blinkwait175-blinkoff150-blinkon175",
3171 for MS-DOS and Win32 console:
3172 "n-v-c:block,o:hor50,i-ci:hor15,
3173 r-cr:hor30,sm:block")
3174 global
3175 {not in Vi}
3176 {only available when compiled with GUI enabled, and
3177 for MS-DOS and Win32 console}
3178 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003179 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 the height of the cursor can be changed. This can be done by
3181 specifying a block cursor, or a percentage for a vertical or
3182 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003183 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003185 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 mode-list and an argument-list:
3187 mode-list:argument-list,mode-list:argument-list,..
3188 The mode-list is a dash separated list of these modes:
3189 n Normal mode
3190 v Visual mode
3191 ve Visual mode with 'selection' "exclusive" (same as 'v',
3192 if not specified)
3193 o Operator-pending mode
3194 i Insert mode
3195 r Replace mode
3196 c Command-line Normal (append) mode
3197 ci Command-line Insert mode
3198 cr Command-line Replace mode
3199 sm showmatch in Insert mode
3200 a all modes
3201 The argument-list is a dash separated list of these arguments:
3202 hor{N} horizontal bar, {N} percent of the character height
3203 ver{N} vertical bar, {N} percent of the character width
3204 block block cursor, fills the whole character
3205 [only one of the above three should be present]
3206 blinkwait{N} *cursor-blinking*
3207 blinkon{N}
3208 blinkoff{N}
3209 blink times for cursor: blinkwait is the delay before
3210 the cursor starts blinking, blinkon is the time that
3211 the cursor is shown and blinkoff is the time that the
3212 cursor is not shown. The times are in msec. When one
3213 of the numbers is zero, there is no blinking. The
3214 default is: "blinkwait700-blinkon400-blinkoff250".
3215 These numbers are used for a missing entry. This
3216 means that blinking is enabled by default. To switch
3217 blinking off you can use "blinkon0". The cursor only
3218 blinks when Vim is waiting for input, not while
3219 executing a command.
3220 To make the cursor blink in an xterm, see
3221 |xterm-blink|.
3222 {group-name}
3223 a highlight group name, that sets the color and font
3224 for the cursor
3225 {group-name}/{group-name}
3226 Two highlight group names, the first is used when
3227 no language mappings are used, the other when they
3228 are. |language-mapping|
3229
3230 Examples of parts:
3231 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3232 block cursor with colors from the "nCursor"
3233 highlight group
3234 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3235 In Insert and Command-line Insert mode, use a
3236 30% vertical bar cursor with colors from the
3237 "iCursor" highlight group. Blink a bit
3238 faster.
3239
3240 The 'a' mode is different. It will set the given argument-list for
3241 all modes. It does not reset anything to defaults. This can be used
3242 to do a common setting for all modes. For example, to switch off
3243 blinking: "a:blinkon0"
3244
3245 Examples of cursor highlighting: >
3246 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3247 :highlight Cursor gui=NONE guifg=bg guibg=fg
3248<
3249 *'guifont'* *'gfn'*
3250 *E235* *E596* *E610* *E611*
3251'guifont' 'gfn' string (default "")
3252 global
3253 {not in Vi}
3254 {only available when compiled with GUI enabled}
3255 This is a list of fonts which will be used for the GUI version of Vim.
3256 In its simplest form the value is just one font name. When
3257 the font cannot be found you will get an error message. To try other
3258 font names a list can be specified, font names separated with commas.
3259 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003260
Bram Moolenaar05159a02005-02-26 23:04:13 +00003261 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3262 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003263
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 Spaces after a comma are ignored. To include a comma in a font name
3265 precede it with a backslash. Setting an option requires an extra
3266 backslash before a space and a backslash. See also
3267 |option-backslash|. For example: >
3268 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003269< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003271
3272 If none of the fonts can be loaded, Vim will keep the current setting.
3273 If an empty font list is given, Vim will try using other resource
3274 settings (for X, it will use the Vim.font resource), and finally it
3275 will try some builtin default which should always be there ("7x13" in
3276 the case of X). The font names given should be "normal" fonts. Vim
3277 will try to find the related bold and italic fonts.
3278
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003279 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003280 :set guifont=*
3281< will bring up a font requester, where you can pick the font you want.
3282
3283 The font name depends on the GUI used. See |setting-guifont| for a
3284 way to set 'guifont' for various systems.
3285
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 For the GTK+ 2 GUI the font name looks like this: >
3287 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003288< That's all. XLFDs are not used. For Chinese this is reported to work
3289 well: >
3290 if has("gui_gtk2")
3291 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3292 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3293 endif
3294<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003295 For Mac OSX you can use something like this: >
3296 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003297< Also see 'macatsui', it can help fix display problems.
3298 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003300 width). An exception is GTK 2: all fonts are accepted, but
3301 mono-spaced fonts look best.
3302
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 To preview a font on X11, you might be able to use the "xfontsel"
3304 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003305
Bram Moolenaar071d4272004-06-13 20:20:40 +00003306 For the Win32 GUI *E244* *E245*
3307 - takes these options in the font name:
3308 hXX - height is XX (points, can be floating-point)
3309 wXX - width is XX (points, can be floating-point)
3310 b - bold
3311 i - italic
3312 u - underline
3313 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003314 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3316 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3317 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003318 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319
3320 Use a ':' to separate the options.
3321 - A '_' can be used in the place of a space, so you don't need to use
3322 backslashes to escape the spaces.
3323 - Examples: >
3324 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3325 :set guifont=Andale_Mono:h7.5:w4.5
3326< See also |font-sizes|.
3327
3328 *'guifontset'* *'gfs'*
3329 *E250* *E252* *E234* *E597* *E598*
3330'guifontset' 'gfs' string (default "")
3331 global
3332 {not in Vi}
3333 {only available when compiled with GUI enabled and
3334 with the |+xfontset| feature}
3335 {not available in the GTK+ 2 GUI}
3336 When not empty, specifies two (or more) fonts to be used. The first
3337 one for normal English, the second one for your special language. See
3338 |xfontset|.
3339 Setting this option also means that all font names will be handled as
3340 a fontset name. Also the ones used for the "font" argument of the
3341 |:highlight| command.
3342 The fonts must match with the current locale. If fonts for the
3343 character sets that the current locale uses are not included, setting
3344 'guifontset' will fail.
3345 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3346 the comma-separated names are alternative names, one of which will be
3347 used. In 'guifontset' the whole string is one fontset name,
3348 including the commas. It is not possible to specify alternative
3349 fontset names.
3350 This example works on many X11 systems: >
3351 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3352<
3353 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3354'guifontwide' 'gfw' string (default "")
3355 global
3356 {not in Vi}
3357 {only available when compiled with GUI enabled}
3358 When not empty, specifies a comma-separated list of fonts to be used
3359 for double-width characters. The first font that can be loaded is
3360 used.
3361 Note: The size of these fonts must be exactly twice as wide as the one
3362 specified with 'guifont' and the same height.
3363
3364 All GUI versions but GTK+ 2:
3365
3366 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3367 'guifontset' is empty or invalid.
3368 When 'guifont' is set and a valid font is found in it and
3369 'guifontwide' is empty Vim will attempt to find a matching
3370 double-width font and set 'guifontwide' to it.
3371
3372 GTK+ 2 GUI only: *guifontwide_gtk2*
3373
3374 If set and valid, 'guifontwide' is always used for double width
3375 characters, even if 'encoding' is not set to "utf-8".
3376 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003377 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 font for characters not available in 'guifont'. Thus you do not need
3379 to set 'guifontwide' at all unless you want to override the choice
3380 made by Pango/Xft.
3381
3382 *'guiheadroom'* *'ghr'*
3383'guiheadroom' 'ghr' number (default 50)
3384 global
3385 {not in Vi} {only for GTK and X11 GUI}
3386 The number of pixels subtracted from the screen height when fitting
3387 the GUI window on the screen. Set this before the GUI is started,
3388 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003389 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 lines will be left for window decorations and other items on the
3391 screen. Set it to a negative value to allow windows taller than the
3392 screen.
3393
3394 *'guioptions'* *'go'*
3395'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003396 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 global
3398 {not in Vi}
3399 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003400 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003401 sequence of letters which describes what components and options of the
3402 GUI should be used.
3403 To avoid problems with flags that are added in the future, use the
3404 "+=" and "-=" feature of ":set" |add-option-flags|.
3405
3406 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003407 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 'a' Autoselect: If present, then whenever VISUAL mode is started,
3409 or the Visual area extended, Vim tries to become the owner of
3410 the windowing system's global selection. This means that the
3411 Visually highlighted text is available for pasting into other
3412 applications as well as into Vim itself. When the Visual mode
3413 ends, possibly due to an operation on the text, or when an
3414 application wants to paste the selection, the highlighted text
3415 is automatically yanked into the "* selection register.
3416 Thus the selection is still available for pasting into other
3417 applications after the VISUAL mode has ended.
3418 If not present, then Vim won't become the owner of the
3419 windowing system's global selection unless explicitly told to
3420 by a yank or delete operation for the "* register.
3421 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003422 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003423 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003424 applies to the modeless selection.
3425
3426 'guioptions' autoselect Visual autoselect modeless ~
3427 "" - -
3428 "a" yes yes
3429 "A" - yes
3430 "aA" yes yes
3431
Bram Moolenaar02467872007-05-06 13:22:01 +00003432 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 'c' Use console dialogs instead of popup dialogs for simple
3434 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003435 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003436 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003437 'guitablabel' can be used to change the text in the labels.
3438 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003439 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003440 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003441 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 'f' Foreground: Don't use fork() to detach the GUI from the shell
3443 where it was started. Use this for programs that wait for the
3444 editor to finish (e.g., an e-mail program). Alternatively you
3445 can use "gvim -f" or ":gui -f" to start the GUI in the
3446 foreground. |gui-fork|
3447 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003448 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003449 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3451 corner of the window. It's black&white on non-GTK, because of
3452 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003453 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003455 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003456 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003458 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459 file is sourced the system menu has already been loaded; the
3460 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003461 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 'g' Grey menu items: Make menu items that are not active grey. If
3463 'g' is not included inactive menu items are not shown at all.
3464 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003465 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 't' Include tearoff menu items. Currently only works for Win32,
3467 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003468 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003469 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003470 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003471 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003472 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003473 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003474 'R' Right-hand scrollbar is present when there is a vertically
3475 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003476 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003478 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 'L' Left-hand scrollbar is present when there is a vertically
3480 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003481 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3483 the longest visible line, or on the cursor line if the 'h'
3484 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003485 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 'h' Limit horizontal scrollbar size to the length of the cursor
3487 line. Reduces computations. |gui-horiz-scroll|
3488
3489 And yes, you may even have scrollbars on the left AND the right if
3490 you really want to :-). See |gui-scrollbars| for more information.
3491
Bram Moolenaar02467872007-05-06 13:22:01 +00003492 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 'v' Use a vertical button layout for dialogs. When not included,
3494 a horizontal layout is preferred, but when it doesn't fit a
3495 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003496 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 'p' Use Pointer callbacks for X11 GUI. This is required for some
3498 window managers. If the cursor is not blinking or hollow at
3499 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003500 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003501 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003502 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504
Bram Moolenaar02467872007-05-06 13:22:01 +00003505
Bram Moolenaar071d4272004-06-13 20:20:40 +00003506 *'guipty'* *'noguipty'*
3507'guipty' boolean (default on)
3508 global
3509 {not in Vi}
3510 {only available when compiled with GUI enabled}
3511 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3512 I/O to/from shell commands. See |gui-pty|.
3513
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003514 *'guitablabel'* *'gtl'*
3515'guitablabel' 'gtl' string (default empty)
3516 global
3517 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003518 {only available when compiled with GUI enabled and
3519 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003520 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003521 pages line. When empty and when the result is empty Vim will use a
3522 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003523
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003524 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003525 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003526
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003527 Only used when the GUI tab pages line is displayed. 'e' must be
3528 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3529 used.
3530
Bram Moolenaar57657d82006-04-21 22:12:41 +00003531 *'guitabtooltip'* *'gtt'*
3532'guitabtooltip' 'gtt' string (default empty)
3533 global
3534 {not in Vi}
3535 {only available when compiled with GUI enabled and
3536 with the +windows feature}
3537 When nonempty describes the text to use in a tooltip for the GUI tab
3538 pages line. When empty Vim will use a default tooltip.
3539 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003540 You can include a line break. Simplest method is to use |:let|: >
3541 :let &guitabtooltip = "line one\nline two"
3542<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003543
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 *'helpfile'* *'hf'*
3545'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3546 (others) "$VIMRUNTIME/doc/help.txt")
3547 global
3548 {not in Vi}
3549 Name of the main help file. All distributed help files should be
3550 placed together in one directory. Additionally, all "doc" directories
3551 in 'runtimepath' will be used.
3552 Environment variables are expanded |:set_env|. For example:
3553 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003554 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555 spaces and backslashes.
3556 This option cannot be set from a |modeline| or in the |sandbox|, for
3557 security reasons.
3558
3559 *'helpheight'* *'hh'*
3560'helpheight' 'hh' number (default 20)
3561 global
3562 {not in Vi}
3563 {not available when compiled without the +windows
3564 feature}
3565 Minimal initial height of the help window when it is opened with the
3566 ":help" command. The initial height of the help window is half of the
3567 current window, or (when the 'ea' option is on) the same as other
3568 windows. When the height is less than 'helpheight', the height is
3569 set to 'helpheight'. Set to zero to disable.
3570
3571 *'helplang'* *'hlg'*
3572'helplang' 'hlg' string (default: messages language or empty)
3573 global
3574 {only available when compiled with the |+multi_lang|
3575 feature}
3576 {not in Vi}
3577 Comma separated list of languages. Vim will use the first language
3578 for which the desired help can be found. The English help will always
3579 be used as a last resort. You can add "en" to prefer English over
3580 another language, but that will only find tags that exist in that
3581 language and not in the English help.
3582 Example: >
3583 :set helplang=de,it
3584< This will first search German, then Italian and finally English help
3585 files.
3586 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3587 try to find the tag in the current language before using this option.
3588 See |help-translated|.
3589
3590 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3591'hidden' 'hid' boolean (default off)
3592 global
3593 {not in Vi}
3594 When off a buffer is unloaded when it is |abandon|ed. When on a
3595 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3596 displayed in another window, it does not become hidden, of course.
3597 The commands that move through the buffer list sometimes make a buffer
3598 hidden although the 'hidden' option is off: When the buffer is
3599 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003600 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003601 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602 This option is set for one command with ":hide {command}" |:hide|.
3603 WARNING: It's easy to forget that you have changes in hidden buffers.
3604 Think twice when using ":q!" or ":qa!".
3605
3606 *'highlight'* *'hl'*
3607'highlight' 'hl' string (default (as a single string):
3608 "8:SpecialKey,@:NonText,d:Directory,
3609 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3610 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003611 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3613 f:Folded,F:FoldColumn,A:DiffAdd,
3614 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003615 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003616 R:SpellRare,L:SpellLocal,
3617 +:Pmenu,=:PmenuSel,
3618 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 global
3620 {not in Vi}
3621 This option can be used to set highlighting mode for various
3622 occasions. It is a comma separated list of character pairs. The
3623 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003624 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3626 |hl-NonText| @ '~' and '@' at the end of the window and
3627 characters from 'showbreak'
3628 |hl-Directory| d directories in CTRL-D listing and other special
3629 things in listings
3630 |hl-ErrorMsg| e error messages
3631 h (obsolete, ignored)
3632 |hl-IncSearch| i 'incsearch' highlighting
3633 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3634 |hl-MoreMsg| m |more-prompt|
3635 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003636 |hl-LineNr| n line number for ":number" and ":#" commands, and
3637 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 |hl-Question| r |hit-enter| prompt and yes/no questions
3639 |hl-StatusLine| s status line of current window |status-line|
3640 |hl-StatusLineNC| S status lines of not-current windows
3641 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3642 |hl-VertSplit| c column used to separate vertically split windows
3643 |hl-Visual| v Visual mode
3644 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3645 Selection" Only X11 Gui's |gui-x11| and
3646 |xterm-clipboard|.
3647 |hl-WarningMsg| w warning messages
3648 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3649 |hl-Folded| f line used for closed folds
3650 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003651 |hl-DiffAdd| A added line in diff mode
3652 |hl-DiffChange| C changed line in diff mode
3653 |hl-DiffDelete| D deleted line in diff mode
3654 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003656 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003657 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003658 |hl-SpellRare| R rare word |spell|
3659 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003660 |hl-Pmenu| + popup menu normal line
3661 |hl-PmenuSel| = popup menu normal line
3662 |hl-PmenuSbar| x popup menu scrollbar
3663 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664
3665 The display modes are:
3666 r reverse (termcap entry "mr" and "me")
3667 i italic (termcap entry "ZH" and "ZR")
3668 b bold (termcap entry "md" and "me")
3669 s standout (termcap entry "so" and "se")
3670 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003671 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 n no highlighting
3673 - no highlighting
3674 : use a highlight group
3675 The default is used for occasions that are not included.
3676 If you want to change what the display modes do, see |dos-colors|
3677 for an example.
3678 When using the ':' display mode, this must be followed by the name of
3679 a highlight group. A highlight group can be used to define any type
3680 of highlighting, including using color. See |:highlight| on how to
3681 define one. The default uses a different group for each occasion.
3682 See |highlight-default| for the default highlight groups.
3683
3684 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3685'hlsearch' 'hls' boolean (default off)
3686 global
3687 {not in Vi}
3688 {not available when compiled without the
3689 |+extra_search| feature}
3690 When there is a previous search pattern, highlight all its matches.
3691 The type of highlighting used can be set with the 'l' occasion in the
3692 'highlight' option. This uses the "Search" highlight group by
3693 default. Note that only the matching text is highlighted, any offsets
3694 are not applied.
3695 See also: 'incsearch' and |:match|.
3696 When you get bored looking at the highlighted matches, you can turn it
3697 off with |:nohlsearch|. As soon as you use a search command, the
3698 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003699 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 When the search pattern can match an end-of-line, Vim will try to
3701 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003702 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003704 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 NOTE: This option is reset when 'compatible' is set.
3706
3707 *'history'* *'hi'*
3708'history' 'hi' number (Vim default: 20, Vi default: 0)
3709 global
3710 {not in Vi}
3711 A history of ":" commands, and a history of previous search patterns
3712 are remembered. This option decides how many entries may be stored in
3713 each of these histories (see |cmdline-editing|).
3714 NOTE: This option is set to the Vi default value when 'compatible' is
3715 set and to the Vim default value when 'compatible' is reset.
3716
3717 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3718'hkmap' 'hk' boolean (default off)
3719 global
3720 {not in Vi}
3721 {only available when compiled with the |+rightleft|
3722 feature}
3723 When on, the keyboard is mapped for the Hebrew character set.
3724 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3725 toggle this option. See |rileft.txt|.
3726 NOTE: This option is reset when 'compatible' is set.
3727
3728 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3729'hkmapp' 'hkp' boolean (default off)
3730 global
3731 {not in Vi}
3732 {only available when compiled with the |+rightleft|
3733 feature}
3734 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3735 This is useful if you have a non-Hebrew keyboard.
3736 See |rileft.txt|.
3737 NOTE: This option is reset when 'compatible' is set.
3738
3739 *'icon'* *'noicon'*
3740'icon' boolean (default off, on when title can be restored)
3741 global
3742 {not in Vi}
3743 {not available when compiled without the |+title|
3744 feature}
3745 When on, the icon text of the window will be set to the value of
3746 'iconstring' (if it is not empty), or to the name of the file
3747 currently being edited. Only the last part of the name is used.
3748 Overridden by the 'iconstring' option.
3749 Only works if the terminal supports setting window icons (currently
3750 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3751 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3752 builtin termcap).
3753 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003754 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 X11.
3756
3757 *'iconstring'*
3758'iconstring' string (default "")
3759 global
3760 {not in Vi}
3761 {not available when compiled without the |+title|
3762 feature}
3763 When this option is not empty, it will be used for the icon text of
3764 the window. This happens only when the 'icon' option is on.
3765 Only works if the terminal supports setting window icon text
3766 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3767 Does not work for MS Windows.
3768 When Vim was compiled with HAVE_X11 defined, the original icon will be
3769 restored if possible |X11|.
3770 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 'titlestring' for example settings.
3773 {not available when compiled without the |+statusline| feature}
3774
3775 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3776'ignorecase' 'ic' boolean (default off)
3777 global
3778 Ignore case in search patterns. Also used when searching in the tags
3779 file.
3780 Also see 'smartcase'.
3781 Can be overruled by using "\c" or "\C" in the pattern, see
3782 |/ignorecase|.
3783
3784 *'imactivatekey'* *'imak'*
3785'imactivatekey' 'imak' string (default "")
3786 global
3787 {not in Vi}
3788 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003789 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 Specifies the key that your Input Method in X-Windows uses for
3791 activation. When this is specified correctly, vim can fully control
3792 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3793 You can't use this option to change the activation key, the option
3794 tells Vim what the key is.
3795 Format:
3796 [MODIFIER_FLAG-]KEY_STRING
3797
3798 These characters can be used for MODIFIER_FLAG (case is ignored):
3799 S Shift key
3800 L Lock key
3801 C Control key
3802 1 Mod1 key
3803 2 Mod2 key
3804 3 Mod3 key
3805 4 Mod4 key
3806 5 Mod5 key
3807 Combinations are allowed, for example "S-C-space" or "SC-space" are
3808 both shift+ctrl+space.
3809 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3810
3811 Example: >
3812 :set imactivatekey=S-space
3813< "S-space" means shift+space. This is the activation key for kinput2 +
3814 canna (Japanese), and ami (Korean).
3815
3816 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3817'imcmdline' 'imc' boolean (default off)
3818 global
3819 {not in Vi}
3820 {only available when compiled with the |+xim|
3821 |+multi_byte_ime| or |global-ime| feature}
3822 When set the Input Method is always on when starting to edit a command
3823 line, unless entering a search pattern (see 'imsearch' for that).
3824 Setting this option is useful when your input method allows entering
3825 English characters directly, e.g., when it's used to type accented
3826 characters with dead keys.
3827
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003828 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3830 global
3831 {not in Vi}
3832 {only available when compiled with the |+xim|
3833 |+multi_byte_ime| or |global-ime| feature}
3834 When set the Input Method is never used. This is useful to disable
3835 the IM when it doesn't work properly.
3836 Currently this option is on by default for SGI/IRIX machines. This
3837 may change in later releases.
3838
3839 *'iminsert'* *'imi'*
3840'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3841 local to buffer
3842 {not in Vi}
3843 Specifies whether :lmap or an Input Method (IM) is to be used in
3844 Insert mode. Valid values:
3845 0 :lmap is off and IM is off
3846 1 :lmap is ON and IM is off
3847 2 :lmap is off and IM is ON
3848 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3849 or |global-ime|.
3850 To always reset the option to zero when leaving Insert mode with <Esc>
3851 this can be used: >
3852 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3853< This makes :lmap and IM turn off automatically when leaving Insert
3854 mode.
3855 Note that this option changes when using CTRL-^ in Insert mode
3856 |i_CTRL-^|.
3857 The value is set to 1 when setting 'keymap' to a valid keymap name.
3858 It is also used for the argument of commands like "r" and "f".
3859 The value 0 may not work correctly with Athena and Motif with some XIM
3860 methods. Use 'imdisable' to disable XIM then.
3861
3862 *'imsearch'* *'ims'*
3863'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3864 local to buffer
3865 {not in Vi}
3866 Specifies whether :lmap or an Input Method (IM) is to be used when
3867 entering a search pattern. Valid values:
3868 -1 the value of 'iminsert' is used, makes it look like
3869 'iminsert' is also used when typing a search pattern
3870 0 :lmap is off and IM is off
3871 1 :lmap is ON and IM is off
3872 2 :lmap is off and IM is ON
3873 Note that this option changes when using CTRL-^ in Command-line mode
3874 |c_CTRL-^|.
3875 The value is set to 1 when it is not -1 and setting the 'keymap'
3876 option to a valid keymap name.
3877 The value 0 may not work correctly with Athena and Motif with some XIM
3878 methods. Use 'imdisable' to disable XIM then.
3879
3880 *'include'* *'inc'*
3881'include' 'inc' string (default "^\s*#\s*include")
3882 global or local to buffer |global-local|
3883 {not in Vi}
3884 {not available when compiled without the
3885 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003886 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 pattern, just like for the "/" command (See |pattern|). The default
3888 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003889 "]I", "[d", etc.
3890 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003891 comes after the matched pattern. But if "\zs" appears in the pattern
3892 then the text matched from "\zs" to the end, or until "\ze" if it
3893 appears, is used as the file name. Use this to include characters
3894 that are not in 'isfname', such as a space. You can then use
3895 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003896 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897
3898 *'includeexpr'* *'inex'*
3899'includeexpr' 'inex' string (default "")
3900 local to buffer
3901 {not in Vi}
3902 {not available when compiled without the
3903 |+find_in_path| or |+eval| feature}
3904 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003905 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 :set includeexpr=substitute(v:fname,'\\.','/','g')
3907< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 Also used for |<cfile>|.
3912
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003913 The expression may be evaluated in the |sandbox|, see
3914 |sandbox-option|.
3915
3916 It is not allowed to change text or jump to another window while
3917 evaluating 'includeexpr' |textlock|.
3918
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3920'incsearch' 'is' boolean (default off)
3921 global
3922 {not in Vi}
3923 {not available when compiled without the
3924 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003925 While typing a search command, show where the pattern, as it was typed
3926 so far, matches. The matched string is highlighted. If the pattern
3927 is invalid or not found, nothing is shown. The screen will be updated
3928 often, this is only useful on fast terminals.
3929 Note that the match will be shown, but the cursor will return to its
3930 original position when no match is found and when pressing <Esc>. You
3931 still need to finish the search command with <Enter> to move the
3932 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003933 When compiled with the |+reltime| feature Vim only searches for about
3934 half a second. With a complicated pattern and/or a lot of text the
3935 match may not be found. This is to avoid that Vim hangs while you
3936 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003937 The highlighting can be set with the 'i' flag in 'highlight'.
3938 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003939 CTRL-L can be used to add one character from after the current match
3940 to the command line.
3941 CTRL-R CTRL-W can be used to add the word at the end of the current
3942 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 NOTE: This option is reset when 'compatible' is set.
3944
3945 *'indentexpr'* *'inde'*
3946'indentexpr' 'inde' string (default "")
3947 local to buffer
3948 {not in Vi}
3949 {not available when compiled without the |+cindent|
3950 or |+eval| features}
3951 Expression which is evaluated to obtain the proper indent for a line.
3952 It is used when a new line is created, for the |=| operator and
3953 in Insert mode as specified with the 'indentkeys' option.
3954 When this option is not empty, it overrules the 'cindent' and
3955 'smartindent' indenting.
3956 When 'paste' is set this option is not used for indenting.
3957 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003958 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 when the expression is evaluated (but it may be moved around).
3960 The expression must return the number of spaces worth of indent. It
3961 can return "-1" to keep the current indent (this means 'autoindent' is
3962 used for the indent).
3963 Functions useful for computing the indent are |indent()|, |cindent()|
3964 and |lispindent()|.
3965 The evaluation of the expression must not have side effects! It must
3966 not change the text, jump to another window, etc. Afterwards the
3967 cursor position is always restored, thus the cursor may be moved.
3968 Normally this option would be set to call a function: >
3969 :set indentexpr=GetMyIndent()
3970< Error messages will be suppressed, unless the 'debug' option contains
3971 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003972 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 NOTE: This option is made empty when 'compatible' is set.
3974
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003975 The expression may be evaluated in the |sandbox|, see
3976 |sandbox-option|.
3977
3978 It is not allowed to change text or jump to another window while
3979 evaluating 'indentexpr' |textlock|.
3980
3981
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 *'indentkeys'* *'indk'*
3983'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3984 local to buffer
3985 {not in Vi}
3986 {not available when compiled without the |+cindent|
3987 feature}
3988 A list of keys that, when typed in Insert mode, cause reindenting of
3989 the current line. Only happens if 'indentexpr' isn't empty.
3990 The format is identical to 'cinkeys', see |indentkeys-format|.
3991 See |C-indenting| and |indent-expression|.
3992
3993 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3994'infercase' 'inf' boolean (default off)
3995 local to buffer
3996 {not in Vi}
3997 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003998 'ignorecase' is also on, the case of the match is adjusted depending
3999 on the typed text. If the typed text contains a lowercase letter
4000 where the match has an upper case letter, the completed part is made
4001 lowercase. If the typed text has no lowercase letters and the match
4002 has a lowercase letter where the typed text has an uppercase letter,
4003 and there is a letter before it, the completed part is made uppercase.
4004 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005
4006 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4007'insertmode' 'im' boolean (default off)
4008 global
4009 {not in Vi}
4010 Makes Vim work in a way that Insert mode is the default mode. Useful
4011 if you want to use Vim as a modeless editor. Used for |evim|.
4012 These Insert mode commands will be useful:
4013 - Use the cursor keys to move around.
4014 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4015 this is a mapping, it is executed as if 'insertmode' was off.
4016 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004018 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4019 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020
4021 These items change when 'insertmode' is set:
4022 - when starting to edit of a file, Vim goes to Insert mode.
4023 - <Esc> in Insert mode is a no-op and beeps.
4024 - <Esc> in Normal mode makes Vim go to Insert mode.
4025 - CTRL-L in Insert mode is a command, it is not inserted.
4026 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4027 However, when <Esc> is used inside a mapping, it behaves like
4028 'insertmode' was not set. This was done to be able to use the same
4029 mappings with 'insertmode' set or not set.
4030 When executing commands with |:normal| 'insertmode' is not used.
4031
4032 NOTE: This option is reset when 'compatible' is set.
4033
4034 *'isfname'* *'isf'*
4035'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4036 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4037 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4038 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4039 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4040 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4041 global
4042 {not in Vi}
4043 The characters specified by this option are included in file names and
4044 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004045 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 Multi-byte characters 256 and above are always included, only the
4047 characters up to 255 are specified with this option.
4048 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004049 Think twice before adding white space to this option. Although a
4050 space may appear inside a file name, the effect will be that Vim
4051 doesn't know where a file name starts or ends when doing completion.
4052 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053
4054 Note that on systems using a backslash as path separator, Vim tries to
4055 do its best to make it work as you would expect. That is a bit
4056 tricky, since Vi originally used the backslash to escape special
4057 characters. Vim will not remove a backslash in front of a normal file
4058 name character on these systems, but it will on Unix and alikes. The
4059 '&' and '^' are not included by default, because these are special for
4060 cmd.exe.
4061
4062 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004063 Each part can be a single character number or a range. A range is two
4064 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065 decimal number between 0 and 255 or the ASCII character itself (does
4066 not work for digits). Example:
4067 "_,-,128-140,#-43" (include '_' and '-' and the range
4068 128 to 140 and '#' to 43)
4069 If a part starts with '^', the following character number or range
4070 will be excluded from the option. The option is interpreted from left
4071 to right. Put the excluded character after the range where it is
4072 included. To include '^' itself use it as the last character of the
4073 option or the end of a range. Example:
4074 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4075 If the character is '@', all characters where isalpha() returns TRUE
4076 are included. Normally these are the characters a to z and A to Z,
4077 plus accented characters. To include '@' itself use "@-@". Examples:
4078 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004079 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 "a-z,A-Z,@-@" All letters plus the '@' character.
4081 A comma can be included by using it where a character number is
4082 expected. Example:
4083 "48-57,,,_" Digits, comma and underscore.
4084 A comma can be excluded by prepending a '^'. Example:
4085 " -~,^,,9" All characters from space to '~', excluding
4086 comma, plus <Tab>.
4087 See |option-backslash| about including spaces and backslashes.
4088
4089 *'isident'* *'isi'*
4090'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4091 "@,48-57,_,128-167,224-235"
4092 otherwise: "@,48-57,_,192-255")
4093 global
4094 {not in Vi}
4095 The characters given by this option are included in identifiers.
4096 Identifiers are used in recognizing environment variables and after a
4097 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004098 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 option.
4100 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004101 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4103
4104 *'iskeyword'* *'isk'*
4105'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4106 "@,48-57,_,128-167,224-235"
4107 otherwise: "@,48-57,_,192-255"
4108 Vi default: "@,48-57,_")
4109 local to buffer
4110 {not in Vi}
4111 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004112 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 'isfname' for a description of the format of this option. For C
4114 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4115 For a help file it is set to all non-blank printable characters except
4116 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4117 command).
4118 When the 'lisp' option is on the '-' character is always included.
4119 NOTE: This option is set to the Vi default value when 'compatible' is
4120 set and to the Vim default value when 'compatible' is reset.
4121
4122 *'isprint'* *'isp'*
4123'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4124 "@,~-255"; otherwise: "@,161-255")
4125 global
4126 {not in Vi}
4127 The characters given by this option are displayed directly on the
4128 screen. It is also used for "\p" in a |pattern|. The characters from
4129 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4130 even when they are not included in 'isprint' or excluded. See
4131 'isfname' for a description of the format of this option.
4132
4133 Non-printable characters are displayed with two characters:
4134 0 - 31 "^@" - "^_"
4135 32 - 126 always single characters
4136 127 "^?"
4137 128 - 159 "~@" - "~_"
4138 160 - 254 "| " - "|~"
4139 255 "~?"
4140 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4141 displayed as <xx>, with the hexadecimal value of the byte.
4142 When 'display' contains "uhex" all unprintable characters are
4143 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004144 The SpecialKey highlighting will be used for unprintable characters.
4145 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146
4147 Multi-byte characters 256 and above are always included, only the
4148 characters up to 255 are specified with this option. When a character
4149 is printable but it is not available in the current font, a
4150 replacement character will be shown.
4151 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4152 There is no option to specify these characters.
4153
4154 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4155'joinspaces' 'js' boolean (default on)
4156 global
4157 {not in Vi}
4158 Insert two spaces after a '.', '?' and '!' with a join command.
4159 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4160 Otherwise only one space is inserted.
4161 NOTE: This option is set when 'compatible' is set.
4162
4163 *'key'*
4164'key' string (default "")
4165 local to buffer
4166 {not in Vi}
4167 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004168 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 Careful: Do not set the key value by hand, someone might see the typed
4170 key. Use the |:X| command. But you can make 'key' empty: >
4171 :set key=
4172< It is not possible to get the value of this option with ":set key" or
4173 "echo &key". This is to avoid showing it to someone who shouldn't
4174 know. It also means you cannot see it yourself once you have set it,
4175 be careful not to make a typing error!
4176
4177 *'keymap'* *'kmp'* *E544*
4178'keymap' 'kmp' string (default "")
4179 local to buffer
4180 {not in Vi}
4181 {only available when compiled with the |+keymap|
4182 feature}
4183 Name of a keyboard mapping. See |mbyte-keymap|.
4184 Setting this option to a valid keymap name has the side effect of
4185 setting 'iminsert' to one, so that the keymap becomes effective.
4186 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004187 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188
4189 *'keymodel'* *'km'*
4190'keymodel' 'km' string (default "")
4191 global
4192 {not in Vi}
4193 List of comma separated words, which enable special things that keys
4194 can do. These values can be used:
4195 startsel Using a shifted special key starts selection (either
4196 Select mode or Visual mode, depending on "key" being
4197 present in 'selectmode').
4198 stopsel Using a not-shifted special key stops selection.
4199 Special keys in this context are the cursor keys, <End>, <Home>,
4200 <PageUp> and <PageDown>.
4201 The 'keymodel' option is set by the |:behave| command.
4202
4203 *'keywordprg'* *'kp'*
4204'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4205 OS/2: "view /", VMS: "help")
4206 global or local to buffer |global-local|
4207 {not in Vi}
4208 Program to use for the |K| command. Environment variables are
4209 expanded |:set_env|. ":help" may be used to access the Vim internal
4210 help. (Note that previously setting the global option to the empty
4211 value did this, which is now deprecated.)
4212 When "man" is used, Vim will automatically translate a count for the
4213 "K" command to a section number. Also for "man -s", in which case the
4214 "-s" is removed when there is no count.
4215 See |option-backslash| about including spaces and backslashes.
4216 Example: >
4217 :set keywordprg=man\ -s
4218< This option cannot be set from a |modeline| or in the |sandbox|, for
4219 security reasons.
4220
4221 *'langmap'* *'lmap'* *E357* *E358*
4222'langmap' 'lmap' string (default "")
4223 global
4224 {not in Vi}
4225 {only available when compiled with the |+langmap|
4226 feature}
4227 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004228 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 inserted directly. When in command mode the 'langmap' option takes
4230 care of translating these special characters to the original meaning
4231 of the key. This means you don't have to change the keyboard mode to
4232 be able to execute Normal mode commands.
4233 This is the opposite of the 'keymap' option, where characters are
4234 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004236 Example (for Greek, in UTF-8): *greek* >
4237 :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 +00004238< Example (exchanges meaning of z and y for commands): >
4239 :set langmap=zy,yz,ZY,YZ
4240<
4241 The 'langmap' option is a list of parts, separated with commas. Each
4242 part can be in one of two forms:
4243 1. A list of pairs. Each pair is a "from" character immediately
4244 followed by the "to" character. Examples: "aA", "aAbBcC".
4245 2. A list of "from" characters, a semi-colon and a list of "to"
4246 characters. Example: "abc;ABC"
4247 Example: "aA,fgh;FGH,cCdDeE"
4248 Special characters need to be preceded with a backslash. These are
4249 ";", ',' and backslash itself.
4250
4251 This will allow you to activate vim actions without having to switch
4252 back and forth between the languages. Your language characters will
4253 be understood as normal vim English characters (according to the
4254 langmap mappings) in the following cases:
4255 o Normal/Visual mode (commands, buffer/register names, user mappings)
4256 o Insert/Replace Mode: Register names after CTRL-R
4257 o Insert/Replace Mode: Mappings
4258 Characters entered in Command-line mode will NOT be affected by
4259 this option. Note that this option can be changed at any time
4260 allowing to switch between mappings for different languages/encodings.
4261 Use a mapping to avoid having to type it each time!
4262
4263 *'langmenu'* *'lm'*
4264'langmenu' 'lm' string (default "")
4265 global
4266 {not in Vi}
4267 {only available when compiled with the |+menu| and
4268 |+multi_lang| features}
4269 Language to use for menu translation. Tells which file is loaded
4270 from the "lang" directory in 'runtimepath': >
4271 "lang/menu_" . &langmenu . ".vim"
4272< (without the spaces). For example, to always use the Dutch menus, no
4273 matter what $LANG is set to: >
4274 :set langmenu=nl_NL.ISO_8859-1
4275< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004276 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 If your $LANG is set to a non-English language but you do want to use
4278 the English menus: >
4279 :set langmenu=none
4280< This option must be set before loading menus, switching on filetype
4281 detection or syntax highlighting. Once the menus are defined setting
4282 this option has no effect. But you could do this: >
4283 :source $VIMRUNTIME/delmenu.vim
4284 :set langmenu=de_DE.ISO_8859-1
4285 :source $VIMRUNTIME/menu.vim
4286< Warning: This deletes all menus that you defined yourself!
4287
4288 *'laststatus'* *'ls'*
4289'laststatus' 'ls' number (default 1)
4290 global
4291 {not in Vi}
4292 The value of this option influences when the last window will have a
4293 status line:
4294 0: never
4295 1: only if there are at least two windows
4296 2: always
4297 The screen looks nicer with a status line if you have several
4298 windows, but it takes another screen line. |status-line|
4299
4300 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4301'lazyredraw' 'lz' boolean (default off)
4302 global
4303 {not in Vi}
4304 When this option is set, the screen will not be redrawn while
4305 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004306 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307 update use |:redraw|.
4308
4309 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4310'linebreak' 'lbr' boolean (default off)
4311 local to window
4312 {not in Vi}
4313 {not available when compiled without the |+linebreak|
4314 feature}
4315 If on Vim will wrap long lines at a character in 'breakat' rather
4316 than at the last character that fits on the screen. Unlike
4317 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4318 it only affects the way the file is displayed, not its contents. The
4319 value of 'showbreak' is used to put in front of wrapped lines.
4320 This option is not used when the 'wrap' option is off or 'list' is on.
4321 Note that <Tab> characters after an <EOL> are mostly not displayed
4322 with the right amount of white space.
4323
4324 *'lines'* *E593*
4325'lines' number (default 24 or terminal height)
4326 global
4327 Number of lines of the Vim window.
4328 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004329 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 When Vim is running in the GUI or in a resizable window, setting this
4331 option will cause the window size to be changed. When you only want
4332 to use the size for the GUI, put the command in your |gvimrc| file.
4333 Vim limits the number of lines to what fits on the screen. You can
4334 use this command to get the tallest window possible: >
4335 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004336< Minimum value is 2, maximum value is 1000.
4337 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 When you set this option and Vim is unable to change the physical
4339 number of lines of the display, the display may be messed up.
4340
4341 *'linespace'* *'lsp'*
4342'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4343 global
4344 {not in Vi}
4345 {only in the GUI}
4346 Number of pixel lines inserted between characters. Useful if the font
4347 uses the full character cell height, making lines touch each other.
4348 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004349 With some fonts there can be too much room between lines (to have
4350 space for ascents and descents). Then it makes sense to set
4351 'linespace' to a negative value. This may cause display problems
4352 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353
4354 *'lisp'* *'nolisp'*
4355'lisp' boolean (default off)
4356 local to buffer
4357 {not available when compiled without the |+lispindent|
4358 feature}
4359 Lisp mode: When <Enter> is typed in insert mode set the indent for
4360 the next line to Lisp standards (well, sort of). Also happens with
4361 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4362 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4363 better. Also see 'lispwords'.
4364 The '-' character is included in keyword characters. Redefines the
4365 "=" operator to use this same indentation algorithm rather than
4366 calling an external program if 'equalprg' is empty.
4367 This option is not used when 'paste' is set.
4368 {Vi: Does it a little bit differently}
4369
4370 *'lispwords'* *'lw'*
4371'lispwords' 'lw' string (default is very long)
4372 global
4373 {not in Vi}
4374 {not available when compiled without the |+lispindent|
4375 feature}
4376 Comma separated list of words that influence the Lisp indenting.
4377 |'lisp'|
4378
4379 *'list'* *'nolist'*
4380'list' boolean (default off)
4381 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004382 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4383 line. Useful to see the difference between tabs and spaces and for
4384 trailing blanks. Further changed by the 'listchars' option.
4385
4386 The cursor is displayed at the start of the space a Tab character
4387 occupies, not at the end as usual in Normal mode. To get this cursor
4388 position while displaying Tabs with spaces, use: >
4389 :set list lcs=tab\ \
4390<
4391 Note that list mode will also affect formatting (set with 'textwidth'
4392 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 changing the way tabs are displayed.
4394
4395 *'listchars'* *'lcs'*
4396'listchars' 'lcs' string (default "eol:$")
4397 global
4398 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004399 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400 settings.
4401 eol:c Character to show at the end of each line. When
4402 omitted, there is no extra character at the end of the
4403 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004404 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004406 fill the space that the tab normally occupies.
4407 "tab:>-" will show a tab that takes four spaces as
4408 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 trailing spaces are blank.
4411 extends:c Character to show in the last column, when 'wrap' is
4412 off and the line continues beyond the right of the
4413 screen.
4414 precedes:c Character to show in the first column, when 'wrap'
4415 is off and there is text preceding the character
4416 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004417 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004418 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004420 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004422 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423
4424 Examples: >
4425 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004426 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 :set lcs=extends:>,precedes:<
4428< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004429 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004430 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431
4432 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4433'loadplugins' 'lpl' boolean (default on)
4434 global
4435 {not in Vi}
4436 When on the plugin scripts are loaded when starting up |load-plugins|.
4437 This option can be reset in your |vimrc| file to disable the loading
4438 of plugins.
4439 Note that using the "-u NONE" and "--noplugin" command line arguments
4440 reset this option. |-u| |--noplugin|
4441
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004442 *'macatsui'* *'nomacatsui'*
4443'macatsui' boolean (default on)
4444 global
4445 {only available in Mac GUI version}
4446 This is a workaround for when drawing doesn't work properly. When set
4447 and compiled with multi-byte support ATSUI text drawing is used. When
4448 not set ATSUI text drawing is not used. Switch this option off when
4449 you experience drawing problems. In a future version the problems may
4450 be solved and this option becomes obsolete. Therefore use this method
4451 to unset it: >
4452 if exists('&macatsui')
4453 set nomacatsui
4454 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004455< Another option to check if you have drawing problems is
4456 'termencoding'.
4457
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 *'magic'* *'nomagic'*
4459'magic' boolean (default on)
4460 global
4461 Changes the special characters that can be used in search patterns.
4462 See |pattern|.
4463 NOTE: To avoid portability problems with using patterns, always keep
4464 this option at the default "on". Only switch it off when working with
4465 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004466 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467
4468 *'makeef'* *'mef'*
4469'makeef' 'mef' string (default: "")
4470 global
4471 {not in Vi}
4472 {not available when compiled without the |+quickfix|
4473 feature}
4474 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4475 and the |:grep| command.
4476 When it is empty, an internally generated temp file will be used.
4477 When "##" is included, it is replaced by a number to make the name
4478 unique. This makes sure that the ":make" command doesn't overwrite an
4479 existing file.
4480 NOT used for the ":cf" command. See 'errorfile' for that.
4481 Environment variables are expanded |:set_env|.
4482 See |option-backslash| about including spaces and backslashes.
4483 This option cannot be set from a |modeline| or in the |sandbox|, for
4484 security reasons.
4485
4486 *'makeprg'* *'mp'*
4487'makeprg' 'mp' string (default "make", VMS: "MMS")
4488 global or local to buffer |global-local|
4489 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004490 Program to use for the ":make" command. See |:make_makeprg|.
4491 This option may contain '%' and '#' characters, which are expanded to
4492 the current and alternate file name. |:_%| |:_#|
4493 Environment variables are expanded |:set_env|. See |option-backslash|
4494 about including spaces and backslashes.
4495 Note that a '|' must be escaped twice: once for ":set" and once for
4496 the interpretation of a command. When you use a filter called
4497 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 :set makeprg=gmake\ \\\|\ myfilter
4499< The placeholder "$*" can be given (even multiple times) to specify
4500 where the arguments will be included, for example: >
4501 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4502< This option cannot be set from a |modeline| or in the |sandbox|, for
4503 security reasons.
4504
4505 *'matchpairs'* *'mps'*
4506'matchpairs' 'mps' string (default "(:),{:},[:]")
4507 local to buffer
4508 {not in Vi}
4509 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004510 other. Currently only single byte character pairs are allowed, and
4511 they must be different. The characters must be separated by a colon.
4512 The pairs must be separated by a comma. Example for including '<' and
4513 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 :set mps+=<:>
4515
4516< A more exotic example, to jump between the '=' and ';' in an
4517 assignment, useful for languages like C and Java: >
4518 :au FileType c,cpp,java set mps+==:;
4519
4520< For a more advanced way of using "%", see the matchit.vim plugin in
4521 the $VIMRUNTIME/macros directory. |add-local-help|
4522
4523 *'matchtime'* *'mat'*
4524'matchtime' 'mat' number (default 5)
4525 global
4526 {not in Vi}{in Nvi}
4527 Tenths of a second to show the matching paren, when 'showmatch' is
4528 set. Note that this is not in milliseconds, like other options that
4529 set a time. This is to be compatible with Nvi.
4530
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004531 *'maxcombine'* *'mco'*
4532'maxcombine' 'mco' number (default 2)
4533 global
4534 {not in Vi}
4535 {only available when compiled with the |+multi_byte|
4536 feature}
4537 The maximum number of combining characters supported for displaying.
4538 Only used when 'encoding' is "utf-8".
4539 The default is OK for most languages. Hebrew may require 4.
4540 Maximum value is 6.
4541 Even when this option is set to 2 you can still edit text with more
4542 combining characters, you just can't see them. Use |g8| or |ga|.
4543 See |mbyte-combining|.
4544
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 *'maxfuncdepth'* *'mfd'*
4546'maxfuncdepth' 'mfd' number (default 100)
4547 global
4548 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004549 {not available when compiled without the +eval
4550 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 Maximum depth of function calls for user functions. This normally
4552 catches endless recursion. When using a recursive function with
4553 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4554 more memory, there is the danger of failing when memory is exhausted.
4555 See also |:function|.
4556
4557 *'maxmapdepth'* *'mmd'* *E223*
4558'maxmapdepth' 'mmd' number (default 1000)
4559 global
4560 {not in Vi}
4561 Maximum number of times a mapping is done without resulting in a
4562 character to be used. This normally catches endless mappings, like
4563 ":map x y" with ":map y x". It still does not catch ":map g wg",
4564 because the 'w' is used before the next mapping is done. See also
4565 |key-mapping|.
4566
4567 *'maxmem'* *'mm'*
4568'maxmem' 'mm' number (default between 256 to 5120 (system
4569 dependent) or half the amount of memory
4570 available)
4571 global
4572 {not in Vi}
4573 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4574 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004575 other memory to be freed. The maximum usable value is about 2000000.
4576 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004578 *'maxmempattern'* *'mmp'*
4579'maxmempattern' 'mmp' number (default 1000)
4580 global
4581 {not in Vi}
4582 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004583 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004584 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004585 When Vim runs into the limit it gives an error message and mostly
4586 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004587 Running into the limit often means that the pattern is very
4588 inefficient or too complex. This may already happen with the pattern
4589 "\(.\)*" on a very long line. ".*" works much better.
4590 Vim may run out of memory before hitting the 'maxmempattern' limit.
4591
Bram Moolenaar071d4272004-06-13 20:20:40 +00004592 *'maxmemtot'* *'mmt'*
4593'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4594 dependent) or half the amount of memory
4595 available)
4596 global
4597 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004598 Maximum amount of memory in Kbyte to use for all buffers together.
4599 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4600 without a limit. On 64 bit machines higher values might work. But
4601 hey, do you really need more than 2 Gbyte for text editing?
4602 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603
4604 *'menuitems'* *'mis'*
4605'menuitems' 'mis' number (default 25)
4606 global
4607 {not in Vi}
4608 {not available when compiled without the |+menu|
4609 feature}
4610 Maximum number of items to use in a menu. Used for menus that are
4611 generated from a list of items, e.g., the Buffers menu. Changing this
4612 option has no direct effect, the menu must be refreshed first.
4613
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004614 *'mkspellmem'* *'msm'*
4615'mkspellmem' 'msm' string (default "460000,2000,500")
4616 global
4617 {not in Vi}
4618 {not available when compiled without the |+syntax|
4619 feature}
4620 Parameters for |:mkspell|. This tunes when to start compressing the
4621 word tree. Compression can be slow when there are many words, but
4622 it's needed to avoid running out of memory. The amount of memory used
4623 per word depends very much on how similar the words are, that's why
4624 this tuning is complicated.
4625
4626 There are three numbers, separated by commas:
4627 {start},{inc},{added}
4628
4629 For most languages the uncompressed word tree fits in memory. {start}
4630 gives the amount of memory in Kbyte that can be used before any
4631 compression is done. It should be a bit smaller than the amount of
4632 memory that is available to Vim.
4633
4634 When going over the {start} limit the {inc} number specifies the
4635 amount of memory in Kbyte that can be allocated before another
4636 compression is done. A low number means compression is done after
4637 less words are added, which is slow. A high number means more memory
4638 will be allocated.
4639
4640 After doing compression, {added} times 1024 words can be added before
4641 the {inc} limit is ignored and compression is done when any extra
4642 amount of memory is needed. A low number means there is a smaller
4643 chance of hitting the {inc} limit, less memory is used but it's
4644 slower.
4645
4646 The languages for which these numbers are important are Italian and
4647 Hungarian. The default works for when you have about 512 Mbyte. If
4648 you have 1 Gbyte you could use: >
4649 :set mkspellmem=900000,3000,800
4650< If you have less than 512 Mbyte |:mkspell| may fail for some
4651 languages, no matter what you set 'mkspellmem' to.
4652
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004654'modeline' 'ml' boolean (Vim default: on (off for root),
4655 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 local to buffer
4657 *'modelines'* *'mls'*
4658'modelines' 'mls' number (default 5)
4659 global
4660 {not in Vi}
4661 If 'modeline' is on 'modelines' gives the number of lines that is
4662 checked for set commands. If 'modeline' is off or 'modelines' is zero
4663 no lines are checked. See |modeline|.
4664 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4665 set and to the Vim default value when 'compatible' is reset.
4666
4667 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4668'modifiable' 'ma' boolean (default on)
4669 local to buffer
4670 {not in Vi} *E21*
4671 When off the buffer contents cannot be changed. The 'fileformat' and
4672 'fileencoding' options also can't be changed.
4673 Can be reset with the |-M| command line argument.
4674
4675 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4676'modified' 'mod' boolean (default off)
4677 local to buffer
4678 {not in Vi}
4679 When on, the buffer is considered to be modified. This option is set
4680 when:
4681 1. A change was made to the text since it was last written. Using the
4682 |undo| command to go back to the original text will reset the
4683 option. But undoing changes that were made before writing the
4684 buffer will set the option again, since the text is different from
4685 when it was written.
4686 2. 'fileformat' or 'fileencoding' is different from its original
4687 value. The original value is set when the buffer is read or
4688 written. A ":set nomodified" command also resets the original
4689 values to the current values and the 'modified' option will be
4690 reset.
4691 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4692 will be ignored.
4693
4694 *'more'* *'nomore'*
4695'more' boolean (Vim default: on, Vi default: off)
4696 global
4697 {not in Vi}
4698 When on, listings pause when the whole screen is filled. You will get
4699 the |more-prompt|. When this option is off there are no pauses, the
4700 listing continues until finished.
4701 NOTE: This option is set to the Vi default value when 'compatible' is
4702 set and to the Vim default value when 'compatible' is reset.
4703
4704 *'mouse'* *E538*
4705'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4706 global
4707 {not in Vi}
4708 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004709 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4710 sysmouse and Linux console with gpm). For using the mouse in the
4711 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 The mouse can be enabled for different modes:
4713 n Normal mode
4714 v Visual mode
4715 i Insert mode
4716 c Command-line mode
4717 h all previous modes when editing a help file
4718 a all previous modes
4719 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 Normally you would enable the mouse in all four modes with: >
4721 :set mouse=a
4722< When the mouse is not enabled, the GUI will still use the mouse for
4723 modeless selection. This doesn't move the text cursor.
4724
4725 See |mouse-using|. Also see |'clipboard'|.
4726
4727 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004728 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 the mouse buttons can still be used by keeping the shift key pressed.
4730 Also see the 'clipboard' option.
4731
4732 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4733'mousefocus' 'mousef' boolean (default off)
4734 global
4735 {not in Vi}
4736 {only works in the GUI}
4737 The window that the mouse pointer is on is automatically activated.
4738 When changing the window layout or window focus in another way, the
4739 mouse pointer is moved to the window with keyboard focus. Off is the
4740 default because it makes using the pull down menus a little goofy, as
4741 a pointer transit may activate a window unintentionally.
4742
4743 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4744'mousehide' 'mh' boolean (default on)
4745 global
4746 {not in Vi}
4747 {only works in the GUI}
4748 When on, the mouse pointer is hidden when characters are typed.
4749 The mouse pointer is restored when the mouse is moved.
4750
4751 *'mousemodel'* *'mousem'*
4752'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4753 global
4754 {not in Vi}
4755 Sets the model to use for the mouse. The name mostly specifies what
4756 the right mouse button is used for:
4757 extend Right mouse button extends a selection. This works
4758 like in an xterm.
4759 popup Right mouse button pops up a menu. The shifted left
4760 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004761 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762 popup_setpos Like "popup", but the cursor will be moved to the
4763 position where the mouse was clicked, and thus the
4764 selected operation will act upon the clicked object.
4765 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004766 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 course, that right clicking outside a selection will
4768 end Visual mode.
4769 Overview of what button does what for each model:
4770 mouse extend popup(_setpos) ~
4771 left click place cursor place cursor
4772 left drag start selection start selection
4773 shift-left search word extend selection
4774 right click extend selection popup menu (place cursor)
4775 right drag extend selection -
4776 middle click paste paste
4777
4778 In the "popup" model the right mouse button produces a pop-up menu.
4779 You need to define this first, see |popup-menu|.
4780
4781 Note that you can further refine the meaning of buttons with mappings.
4782 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4783 selection (because that's handled in the GUI code directly).
4784
4785 The 'mousemodel' option is set by the |:behave| command.
4786
4787 *'mouseshape'* *'mouses'* *E547*
4788'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004789 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790 global
4791 {not in Vi}
4792 {only available when compiled with the |+mouseshape|
4793 feature}
4794 This option tells Vim what the mouse pointer should look like in
4795 different modes. The option is a comma separated list of parts, much
4796 like used for 'guicursor'. Each part consist of a mode/location-list
4797 and an argument-list:
4798 mode-list:shape,mode-list:shape,..
4799 The mode-list is a dash separated list of these modes/locations:
4800 In a normal window: ~
4801 n Normal mode
4802 v Visual mode
4803 ve Visual mode with 'selection' "exclusive" (same as 'v',
4804 if not specified)
4805 o Operator-pending mode
4806 i Insert mode
4807 r Replace mode
4808
4809 Others: ~
4810 c appending to the command-line
4811 ci inserting in the command-line
4812 cr replacing in the command-line
4813 m at the 'Hit ENTER' or 'More' prompts
4814 ml idem, but cursor in the last line
4815 e any mode, pointer below last window
4816 s any mode, pointer on a status line
4817 sd any mode, while dragging a status line
4818 vs any mode, pointer on a vertical separator line
4819 vd any mode, while dragging a vertical separator line
4820 a everywhere
4821
4822 The shape is one of the following:
4823 avail name looks like ~
4824 w x arrow Normal mouse pointer
4825 w x blank no pointer at all (use with care!)
4826 w x beam I-beam
4827 w x updown up-down sizing arrows
4828 w x leftright left-right sizing arrows
4829 w x busy The system's usual busy pointer
4830 w x no The system's usual 'no input' pointer
4831 x udsizing indicates up-down resizing
4832 x lrsizing indicates left-right resizing
4833 x crosshair like a big thin +
4834 x hand1 black hand
4835 x hand2 white hand
4836 x pencil what you write with
4837 x question big ?
4838 x rightup-arrow arrow pointing right-up
4839 w x up-arrow arrow pointing up
4840 x <number> any X11 pointer number (see X11/cursorfont.h)
4841
4842 The "avail" column contains a 'w' if the shape is available for Win32,
4843 x for X11.
4844 Any modes not specified or shapes not available use the normal mouse
4845 pointer.
4846
4847 Example: >
4848 :set mouseshape=s:udsizing,m:no
4849< will make the mouse turn to a sizing arrow over the status lines and
4850 indicate no input when the hit-enter prompt is displayed (since
4851 clicking the mouse has no effect in this state.)
4852
4853 *'mousetime'* *'mouset'*
4854'mousetime' 'mouset' number (default 500)
4855 global
4856 {not in Vi}
4857 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4858 time in msec between two mouse clicks for the second click to be
4859 recognized as a multi click.
4860
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004861 *'mzquantum'* *'mzq'*
4862'mzquantum' 'mzq' number (default 100)
4863 global
4864 {not in Vi}
4865 {not available when compiled without the |+mzscheme|
4866 feature}
4867 The number of milliseconds between polls for MzScheme threads.
4868 Negative or zero value means no thread scheduling.
4869
Bram Moolenaar071d4272004-06-13 20:20:40 +00004870 *'nrformats'* *'nf'*
4871'nrformats' 'nf' string (default "octal,hex")
4872 local to buffer
4873 {not in Vi}
4874 This defines what bases Vim will consider for numbers when using the
4875 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4876 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004877 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 incremented or decremented. This is useful for a list with a
4879 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004880 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004882 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004883 considered to be hexadecimal. Example: Using CTRL-X on
4884 "0x100" results in "0x0ff".
4885 Numbers which simply begin with a digit in the range 1-9 are always
4886 considered decimal. This also happens for numbers that are not
4887 recognized as octal or hex.
4888
4889 *'number'* *'nu'* *'nonumber'* *'nonu'*
4890'number' 'nu' boolean (default off)
4891 local to window
4892 Print the line number in front of each line. When the 'n' option is
4893 excluded from 'cpoptions' a wrapped line will not use the column of
4894 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004895 The 'numberwidth' option can be used to set the room used for the line
4896 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 When a long, wrapped line doesn't start with the first character, '-'
4898 characters are put before the number.
4899 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004900 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004902 *'numberwidth'* *'nuw'*
4903'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4904 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004905 {not in Vi}
4906 {only available when compiled with the |+linebreak|
4907 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004908 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004909 when the 'number' or 'relativenumber' option is set or printing lines
4910 with a line number. Since one space is always between the number and
4911 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004912 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004913 fit the highest line number in the buffer respectively the number of
4914 rows in the window, depending on whether 'number' or 'relativenumber'
4915 is set. Thus with the Vim default of 4 there is room for a line number
4916 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004917 The minimum value is 1, the maximum value is 10.
4918 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4919
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004920 *'omnifunc'* *'ofu'*
4921'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004922 local to buffer
4923 {not in Vi}
4924 {not available when compiled without the +eval
4925 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004926 This option specifies a function to be used for Insert mode omni
4927 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004928 See |complete-functions| for an explanation of how the function is
4929 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004930 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004931 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004932
4933
Bram Moolenaar02467872007-05-06 13:22:01 +00004934 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004935'opendevice' 'odev' boolean (default off)
4936 global
4937 {not in Vi}
4938 {only for MS-DOS, MS-Windows and OS/2}
4939 Enable reading and writing from devices. This may get Vim stuck on a
4940 device that can be opened but doesn't actually do the I/O. Therefore
4941 it is off by default.
4942 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4943 result in editing a device.
4944
4945
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004946 *'operatorfunc'* *'opfunc'*
4947'operatorfunc' 'opfunc' string (default: empty)
4948 global
4949 {not in Vi}
4950 This option specifies a function to be called by the |g@| operator.
4951 See |:map-operator| for more info and an example.
4952
4953 This option cannot be set from a |modeline| or in the |sandbox|, for
4954 security reasons.
4955
4956
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 *'osfiletype'* *'oft'* *E366*
4958'osfiletype' 'oft' string (RISC-OS default: "Text",
4959 others default: "")
4960 local to buffer
4961 {not in Vi}
4962 {only available when compiled with the |+osfiletype|
4963 feature}
4964 Some operating systems store extra information about files besides
4965 name, datestamp and permissions. This option contains the extra
4966 information, the nature of which will vary between systems.
4967 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00004968 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 It can affect the pattern matching of the automatic commands.
4970 |autocmd-osfiletypes|
4971
4972 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004973'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 global
4975 Specifies the nroff macros that separate paragraphs. These are pairs
4976 of two letters (see |object-motions|).
4977
4978 *'paste'* *'nopaste'*
4979'paste' boolean (default off)
4980 global
4981 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004982 Put Vim in Paste mode. This is useful if you want to cut or copy
4983 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 unexpected effects.
4985 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004986 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 knows about pasting and will mostly do the right thing without 'paste'
4988 being set. The same is true for a terminal where Vim handles the
4989 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004990 This option is reset when starting the GUI. Thus if you set it in
4991 your .vimrc it will work in a terminal, but not in the GUI. Setting
4992 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4993 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 When the 'paste' option is switched on (also when it was already on):
4995 - mapping in Insert mode and Command-line mode is disabled
4996 - abbreviations are disabled
4997 - 'textwidth' is set to 0
4998 - 'wrapmargin' is set to 0
4999 - 'autoindent' is reset
5000 - 'smartindent' is reset
5001 - 'softtabstop' is set to 0
5002 - 'revins' is reset
5003 - 'ruler' is reset
5004 - 'showmatch' is reset
5005 - 'formatoptions' is used like it is empty
5006 These options keep their value, but their effect is disabled:
5007 - 'lisp'
5008 - 'indentexpr'
5009 - 'cindent'
5010 NOTE: When you start editing another file while the 'paste' option is
5011 on, settings from the modelines or autocommands may change the
5012 settings again, causing trouble when pasting text. You might want to
5013 set the 'paste' option again.
5014 When the 'paste' option is reset the mentioned options are restored to
5015 the value before the moment 'paste' was switched from off to on.
5016 Resetting 'paste' before ever setting it does not have any effect.
5017 Since mapping doesn't work while 'paste' is active, you need to use
5018 the 'pastetoggle' option to toggle the 'paste' option with some key.
5019
5020 *'pastetoggle'* *'pt'*
5021'pastetoggle' 'pt' string (default "")
5022 global
5023 {not in Vi}
5024 When non-empty, specifies the key sequence that toggles the 'paste'
5025 option. This is like specifying a mapping: >
5026 :map {keys} :set invpaste<CR>
5027< Where {keys} is the value of 'pastetoggle'.
5028 The difference is that it will work even when 'paste' is set.
5029 'pastetoggle' works in Insert mode and Normal mode, but not in
5030 Command-line mode.
5031 Mappings are checked first, thus overrule 'pastetoggle'. However,
5032 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5033 this: >
5034 :map <F10> :set paste<CR>
5035 :map <F11> :set nopaste<CR>
5036 :imap <F10> <C-O>:set paste<CR>
5037 :imap <F11> <nop>
5038 :set pastetoggle=<F11>
5039< This will make <F10> start paste mode and <F11> stop paste mode.
5040 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5041 mode everything is inserted literally, except the 'pastetoggle' key
5042 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005043 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044
5045 *'pex'* *'patchexpr'*
5046'patchexpr' 'pex' string (default "")
5047 global
5048 {not in Vi}
5049 {not available when compiled without the |+diff|
5050 feature}
5051 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005052 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
5054 *'patchmode'* *'pm'* *E206*
5055'patchmode' 'pm' string (default "")
5056 global
5057 {not in Vi}
5058 When non-empty the oldest version of a file is kept. This can be used
5059 to keep the original version of a file if you are changing files in a
5060 source distribution. Only the first time that a file is written a
5061 copy of the original file will be kept. The name of the copy is the
5062 name of the original file with the string in the 'patchmode' option
5063 appended. This option should start with a dot. Use a string like
5064 ".org". 'backupdir' must not be empty for this to work (Detail: The
5065 backup file is renamed to the patchmode file after the new file has
5066 been successfully written, that's why it must be possible to write a
5067 backup file). If there was no file to be backed up, an empty file is
5068 created.
5069 When the 'backupskip' pattern matches, a patchmode file is not made.
5070 Using 'patchmode' for compressed files appends the extension at the
5071 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5072 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005073 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
5075 *'path'* *'pa'* *E343* *E345* *E347*
5076'path' 'pa' string (default on Unix: ".,/usr/include,,"
5077 on OS/2: ".,/emx/include,,"
5078 other systems: ".,,")
5079 global or local to buffer |global-local|
5080 {not in Vi}
5081 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005082 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5083 provided that the file being searched for has a relative path (not
5084 starting with "/", "./" or "../"). The directories in the 'path'
5085 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 - Use commas to separate directory names: >
5087 :set path=.,/usr/local/include,/usr/include
5088< - Spaces can also be used to separate directory names (for backwards
5089 compatibility with version 3.0). To have a space in a directory
5090 name, precede it with an extra backslash, and escape the space: >
5091 :set path=.,/dir/with\\\ space
5092< - To include a comma in a directory name precede it with an extra
5093 backslash: >
5094 :set path=.,/dir/with\\,comma
5095< - To search relative to the directory of the current file, use: >
5096 :set path=.
5097< - To search in the current directory use an empty string between two
5098 commas: >
5099 :set path=,,
5100< - A directory name may end in a ':' or '/'.
5101 - Environment variables are expanded |:set_env|.
5102 - When using |netrw.vim| URLs can be used. For example, adding
5103 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005104 - Search upwards and downwards in a directory tree using "*", "**" and
5105 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 {not available when compiled without the |+path_extra| feature}
5107 - Careful with '\' characters, type two to get one in the option: >
5108 :set path=.,c:\\include
5109< Or just use '/' instead: >
5110 :set path=.,c:/include
5111< Don't forget "." or files won't even be found in the same directory as
5112 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005113 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 it is something like 256 or 1024 characters.
5115 You can check if all the include files are found, using the value of
5116 'path', see |:checkpath|.
5117 The use of |:set+=| and |:set-=| is preferred when adding or removing
5118 directories from the list. This avoids problems when a future version
5119 uses another default. To remove the current directory use: >
5120 :set path-=
5121< To add the current directory use: >
5122 :set path+=
5123< To use an environment variable, you probably need to replace the
5124 separator. Here is an example to append $INCL, in which directory
5125 names are separated with a semi-colon: >
5126 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5127< Replace the ';' with a ':' or whatever separator is used. Note that
5128 this doesn't work when $INCL contains a comma or white space.
5129
5130 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5131'preserveindent' 'pi' boolean (default off)
5132 local to buffer
5133 {not in Vi}
5134 When changing the indent of the current line, preserve as much of the
5135 indent structure as possible. Normally the indent is replaced by a
5136 series of tabs followed by spaces as required (unless |'expandtab'| is
5137 enabled, in which case only spaces are used). Enabling this option
5138 means the indent will preserve as many existing characters as possible
5139 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005140 'expandtab' does not apply to the preserved white space, a Tab remains
5141 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 NOTE: When using ">>" multiple times the resulting indent is a mix of
5143 tabs and spaces. You might not like this.
5144 NOTE: 'preserveindent' is reset when 'compatible' is set.
5145 Also see 'copyindent'.
5146 Use |:retab| to clean up white space.
5147
5148 *'previewheight'* *'pvh'*
5149'previewheight' 'pvh' number (default 12)
5150 global
5151 {not in Vi}
5152 {not available when compiled without the |+windows| or
5153 |+quickfix| feature}
5154 Default height for a preview window. Used for |:ptag| and associated
5155 commands. Used for |CTRL-W_}| when no count is given.
5156
5157 *'previewwindow'* *'nopreviewwindow'*
5158 *'pvw'* *'nopvw'* *E590*
5159'previewwindow' 'pvw' boolean (default off)
5160 local to window
5161 {not in Vi}
5162 {not available when compiled without the |+windows| or
5163 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005164 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165 set. It's normally not set directly, but by using one of the commands
5166 |:ptag|, |:pedit|, etc.
5167
5168 *'printdevice'* *'pdev'*
5169'printdevice' 'pdev' string (default empty)
5170 global
5171 {not in Vi}
5172 {only available when compiled with the |+printer|
5173 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005174 The name of the printer to be used for |:hardcopy|.
5175 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005176 This option cannot be set from a |modeline| or in the |sandbox|, for
5177 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
Bram Moolenaar8299df92004-07-10 09:47:34 +00005179 *'printencoding'* *'penc'*
5180'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 global
5182 {not in Vi}
5183 {only available when compiled with the |+printer|
5184 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005185 Sets the character encoding used when printing.
5186 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187
5188 *'printexpr'* *'pexpr'*
5189'printexpr' 'pexpr' String (default: see below)
5190 global
5191 {not in Vi}
5192 {only available when compiled with the |+printer|
5193 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005194 Expression used to print the PostScript produced with |:hardcopy|.
5195 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
Bram Moolenaar8299df92004-07-10 09:47:34 +00005197 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198'printfont' 'pfn' string (default "courier")
5199 global
5200 {not in Vi}
5201 {only available when compiled with the |+printer|
5202 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005203 The name of the font that will be used for |:hardcopy|.
5204 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205
5206 *'printheader'* *'pheader'*
5207'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5208 global
5209 {not in Vi}
5210 {only available when compiled with the |+printer|
5211 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005212 The format of the header produced in |:hardcopy| output.
5213 See |pheader-option|.
5214
5215 *'printmbcharset'* *'pmbcs'*
5216'printmbcharset' 'pmbcs' string (default "")
5217 global
5218 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005219 {only available when compiled with the |+printer|,
5220 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005221 The CJK character set to be used for CJK output from |:hardcopy|.
5222 See |pmbcs-option|.
5223
5224 *'printmbfont'* *'pmbfn'*
5225'printmbfont' 'pmbfn' string (default "")
5226 global
5227 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005228 {only available when compiled with the |+printer|,
5229 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005230 List of font names to be used for CJK output from |:hardcopy|.
5231 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
5233 *'printoptions'* *'popt'*
5234'printoptions' 'popt' string (default "")
5235 global
5236 {not in Vi}
5237 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005238 List of items that control the format of the output of |:hardcopy|.
5239 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005241 *'prompt'* *'noprompt'*
5242'prompt' boolean (default on)
5243 global
5244 When on a ":" prompt is used in Ex mode.
5245
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005246 *'pumheight'* *'ph'*
5247'pumheight' 'ph' number (default 0)
5248 global
5249 {not available when compiled without the
5250 |+insert_expand| feature}
5251 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005252 Determines the maximum number of items to show in the popup menu for
5253 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005254 |ins-completion-menu|.
5255
5256
Bram Moolenaar677ee682005-01-27 14:41:15 +00005257 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005258'quoteescape' 'qe' string (default "\")
5259 local to buffer
5260 {not in Vi}
5261 The characters that are used to escape quotes in a string. Used for
5262 objects like a', a" and a` |a'|.
5263 When one of the characters in this option is found inside a string,
5264 the following character will be skipped. The default value makes the
5265 text "foo\"bar\\" considered to be one string.
5266
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5268'readonly' 'ro' boolean (default off)
5269 local to buffer
5270 If on, writes fail unless you use a '!'. Protects you from
5271 accidentally overwriting a file. Default on when Vim is started
5272 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005273 When using ":w!" the 'readonly' option is reset for the current
5274 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005276 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005278 *'redrawtime'* *'rdt'*
5279'redrawtime' 'rdt' number (default 2000)
5280 global
5281 {not in Vi}
5282 {only available when compiled with the |+reltime|
5283 feature}
5284 The time in milliseconds for redrawing the display. This applies to
5285 searching for patterns for 'hlsearch' and |:match| highlighting.
5286 When redrawing takes more than this many milliseconds no further
5287 matches will be highlighted. This is used to avoid that Vim hangs
5288 when using a very complicated pattern.
5289
Bram Moolenaar64486672010-05-16 15:46:46 +02005290 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5291'relativenumber' 'rnu' boolean (default off)
5292 local to window
5293 {not in Vi}
5294 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005295 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005296 precede some vertical motion commands (e.g. j k + -) with, without
5297 having to calculate it yourself. Especially useful in combination with
5298 other commands (e.g. y d c < > gq gw =).
5299 When the 'n' option is excluded from 'cpoptions' a wrapped
5300 line will not use the column of line numbers (this is the default when
5301 'compatible' isn't set).
5302 The 'numberwidth' option can be used to set the room used for the line
5303 number.
5304 When a long, wrapped line doesn't start with the first character, '-'
5305 characters are put before the number.
5306 See |hl-LineNr| for the highlighting used for the number.
5307 When setting this option, 'number' is reset.
5308
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 *'remap'* *'noremap'*
5310'remap' boolean (default on)
5311 global
5312 Allows for mappings to work recursively. If you do not want this for
5313 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005314 NOTE: To avoid portability problems with Vim scripts, always keep
5315 this option at the default "on". Only switch it off when working with
5316 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317
5318 *'report'*
5319'report' number (default 2)
5320 global
5321 Threshold for reporting number of lines changed. When the number of
5322 changed lines is more than 'report' a message will be given for most
5323 ":" commands. If you want it always, set 'report' to 0.
5324 For the ":substitute" command the number of substitutions is used
5325 instead of the number of lines.
5326
5327 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5328'restorescreen' 'rs' boolean (default on)
5329 global
5330 {not in Vi} {only in Windows 95/NT console version}
5331 When set, the screen contents is restored when exiting Vim. This also
5332 happens when executing external commands.
5333
5334 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5335 options in your .vimrc. To disable restoring:
5336 set t_ti= t_te=
5337 To enable restoring (for an xterm):
5338 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5339 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5340
5341 *'revins'* *'ri'* *'norevins'* *'nori'*
5342'revins' 'ri' boolean (default off)
5343 global
5344 {not in Vi}
5345 {only available when compiled with the |+rightleft|
5346 feature}
5347 Inserting characters in Insert mode will work backwards. See "typing
5348 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5349 command in Insert mode, when 'allowrevins' is set.
5350 NOTE: This option is reset when 'compatible' or 'paste' is set.
5351
5352 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5353'rightleft' 'rl' boolean (default off)
5354 local to window
5355 {not in Vi}
5356 {only available when compiled with the |+rightleft|
5357 feature}
5358 When on, display orientation becomes right-to-left, i.e., characters
5359 that are stored in the file appear from the right to the left.
5360 Using this option, it is possible to edit files for languages that
5361 are written from the right to the left such as Hebrew and Arabic.
5362 This option is per window, so it is possible to edit mixed files
5363 simultaneously, or to view the same file in both ways (this is
5364 useful whenever you have a mixed text file with both right-to-left
5365 and left-to-right strings so that both sets are displayed properly
5366 in different windows). Also see |rileft.txt|.
5367
5368 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5369'rightleftcmd' 'rlc' string (default "search")
5370 local to window
5371 {not in Vi}
5372 {only available when compiled with the |+rightleft|
5373 feature}
5374 Each word in this option enables the command line editing to work in
5375 right-to-left mode for a group of commands:
5376
5377 search "/" and "?" commands
5378
5379 This is useful for languages such as Hebrew, Arabic and Farsi.
5380 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5381
5382 *'ruler'* *'ru'* *'noruler'* *'noru'*
5383'ruler' 'ru' boolean (default off)
5384 global
5385 {not in Vi}
5386 {not available when compiled without the
5387 |+cmdline_info| feature}
5388 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005389 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390 text in the file is shown on the far right:
5391 Top first line is visible
5392 Bot last line is visible
5393 All first and last line are visible
5394 45% relative position in the file
5395 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005396 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005398 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399 this option takes precedence over 'ruler' and 'rulerformat'
5400 If the number of characters displayed is different from the number of
5401 bytes in the text (e.g., for a TAB or a multi-byte character), both
5402 the text column (byte number) and the screen column are shown,
5403 separated with a dash.
5404 For an empty line "0-1" is shown.
5405 For an empty buffer the line number will also be zero: "0,0-1".
5406 This option is reset when the 'paste' option is set.
5407 If you don't want to see the ruler all the time but want to know where
5408 you are, use "g CTRL-G" |g_CTRL-G|.
5409 NOTE: This option is reset when 'compatible' is set.
5410
5411 *'rulerformat'* *'ruf'*
5412'rulerformat' 'ruf' string (default empty)
5413 global
5414 {not in Vi}
5415 {not available when compiled without the |+statusline|
5416 feature}
5417 When this option is not empty, it determines the content of the ruler
5418 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005419 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420 The default ruler width is 17 characters. To make the ruler 15
5421 characters wide, put "%15(" at the start and "%)" at the end.
5422 Example: >
5423 :set rulerformat=%15(%c%V\ %p%%%)
5424<
5425 *'runtimepath'* *'rtp'* *vimfiles*
5426'runtimepath' 'rtp' string (default:
5427 Unix: "$HOME/.vim,
5428 $VIM/vimfiles,
5429 $VIMRUNTIME,
5430 $VIM/vimfiles/after,
5431 $HOME/.vim/after"
5432 Amiga: "home:vimfiles,
5433 $VIM/vimfiles,
5434 $VIMRUNTIME,
5435 $VIM/vimfiles/after,
5436 home:vimfiles/after"
5437 PC, OS/2: "$HOME/vimfiles,
5438 $VIM/vimfiles,
5439 $VIMRUNTIME,
5440 $VIM/vimfiles/after,
5441 $HOME/vimfiles/after"
5442 Macintosh: "$VIM:vimfiles,
5443 $VIMRUNTIME,
5444 $VIM:vimfiles:after"
5445 RISC-OS: "Choices:vimfiles,
5446 $VIMRUNTIME,
5447 Choices:vimfiles/after"
5448 VMS: "sys$login:vimfiles,
5449 $VIM/vimfiles,
5450 $VIMRUNTIME,
5451 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005452 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 global
5454 {not in Vi}
5455 This is a list of directories which will be searched for runtime
5456 files:
5457 filetype.vim filetypes by file name |new-filetype|
5458 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005459 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 colors/ color scheme files |:colorscheme|
5461 compiler/ compiler files |:compiler|
5462 doc/ documentation |write-local-help|
5463 ftplugin/ filetype plugins |write-filetype-plugin|
5464 indent/ indent scripts |indent-expression|
5465 keymap/ key mapping files |mbyte-keymap|
5466 lang/ menu translations |:menutrans|
5467 menu.vim GUI menus |menu.vim|
5468 plugin/ plugin scripts |write-plugin|
5469 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005470 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 syntax/ syntax files |mysyntaxfile|
5472 tutor/ files for vimtutor |tutor|
5473
5474 And any other file searched for with the |:runtime| command.
5475
5476 The defaults for most systems are setup to search five locations:
5477 1. In your home directory, for your personal preferences.
5478 2. In a system-wide Vim directory, for preferences from the system
5479 administrator.
5480 3. In $VIMRUNTIME, for files distributed with Vim.
5481 *after-directory*
5482 4. In the "after" directory in the system-wide Vim directory. This is
5483 for the system administrator to overrule or add to the distributed
5484 defaults (rarely needed)
5485 5. In the "after" directory in your home directory. This is for
5486 personal preferences to overrule or add to the distributed defaults
5487 or system-wide settings (rarely needed).
5488
5489 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5490 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005491 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 wildcards.
5493 See |:runtime|.
5494 Example: >
5495 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5496< This will use the directory "~/vimruntime" first (containing your
5497 personal Vim runtime files), then "/mygroup/vim" (shared between a
5498 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5499 files).
5500 You probably should always include $VIMRUNTIME somewhere, to use the
5501 distributed runtime files. You can put a directory before $VIMRUNTIME
5502 to find files which replace a distributed runtime files. You can put
5503 a directory after $VIMRUNTIME to find files which add to distributed
5504 runtime files.
5505 This option cannot be set from a |modeline| or in the |sandbox|, for
5506 security reasons.
5507
5508 *'scroll'* *'scr'*
5509'scroll' 'scr' number (default: half the window height)
5510 local to window
5511 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5512 set to half the number of lines in the window when the window size
5513 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005514 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5516 the number of screen lines instead of file lines, makes a difference
5517 when lines wrap}
5518
5519 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5520'scrollbind' 'scb' boolean (default off)
5521 local to window
5522 {not in Vi}
5523 {not available when compiled without the |+scrollbind|
5524 feature}
5525 See also |scroll-binding|. When this option is set, the current
5526 window scrolls as other scrollbind windows (windows that also have
5527 this option set) scroll. This option is useful for viewing the
5528 differences between two versions of a file, see 'diff'.
5529 See |'scrollopt'| for options that determine how this option should be
5530 interpreted.
5531 This option is mostly reset when splitting a window to edit another
5532 file. This means that ":split | edit file" results in two windows
5533 with scroll-binding, but ":split file" does not.
5534
5535 *'scrolljump'* *'sj'*
5536'scrolljump' 'sj' number (default 1)
5537 global
5538 {not in Vi}
5539 Minimal number of lines to scroll when the cursor gets off the
5540 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5541 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005542 When set to a negative number from -1 to -100 this is used as the
5543 percentage of the window height. Thus -50 scrolls half the window
5544 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 NOTE: This option is set to 1 when 'compatible' is set.
5546
5547 *'scrolloff'* *'so'*
5548'scrolloff' 'so' number (default 0)
5549 global
5550 {not in Vi}
5551 Minimal number of screen lines to keep above and below the cursor.
5552 This will make some context visible around where you are working. If
5553 you set it to a very large value (999) the cursor line will always be
5554 in the middle of the window (except at the start or end of the file or
5555 when long lines wrap).
5556 For scrolling horizontally see 'sidescrolloff'.
5557 NOTE: This option is set to 0 when 'compatible' is set.
5558
5559 *'scrollopt'* *'sbo'*
5560'scrollopt' 'sbo' string (default "ver,jump")
5561 global
5562 {not available when compiled without the |+scrollbind|
5563 feature}
5564 {not in Vi}
5565 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005566 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5567 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 The following words are available:
5569 ver Bind vertical scrolling for 'scrollbind' windows
5570 hor Bind horizontal scrolling for 'scrollbind' windows
5571 jump Applies to the offset between two windows for vertical
5572 scrolling. This offset is the difference in the first
5573 displayed line of the bound windows. When moving
5574 around in a window, another 'scrollbind' window may
5575 reach a position before the start or after the end of
5576 the buffer. The offset is not changed though, when
5577 moving back the 'scrollbind' window will try to scroll
5578 to the desired position when possible.
5579 When now making that window the current one, two
5580 things can be done with the relative offset:
5581 1. When "jump" is not included, the relative offset is
5582 adjusted for the scroll position in the new current
5583 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005584 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 2. When "jump" is included, the other windows are
5586 scrolled to keep the same relative offset. When
5587 going back to the other window, it still uses the
5588 same relative offset.
5589 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005590 When 'diff' mode is active there always is vertical scroll binding,
5591 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592
5593 *'sections'* *'sect'*
5594'sections' 'sect' string (default "SHNHH HUnhsh")
5595 global
5596 Specifies the nroff macros that separate sections. These are pairs of
5597 two letters (See |object-motions|). The default makes a section start
5598 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5599
5600 *'secure'* *'nosecure'* *E523*
5601'secure' boolean (default off)
5602 global
5603 {not in Vi}
5604 When on, ":autocmd", shell and write commands are not allowed in
5605 ".vimrc" and ".exrc" in the current directory and map commands are
5606 displayed. Switch it off only if you know that you will not run into
5607 problems, or when the 'exrc' option is off. On Unix this option is
5608 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005609 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 'secure' at the end of your ~/.vimrc then.
5611 This option cannot be set from a |modeline| or in the |sandbox|, for
5612 security reasons.
5613
5614 *'selection'* *'sel'*
5615'selection' 'sel' string (default "inclusive")
5616 global
5617 {not in Vi}
5618 This option defines the behavior of the selection. It is only used
5619 in Visual and Select mode.
5620 Possible values:
5621 value past line inclusive ~
5622 old no yes
5623 inclusive yes yes
5624 exclusive yes no
5625 "past line" means that the cursor is allowed to be positioned one
5626 character past the line.
5627 "inclusive" means that the last character of the selection is included
5628 in an operation. For example, when "x" is used to delete the
5629 selection.
5630 Note that when "exclusive" is used and selecting from the end
5631 backwards, you cannot include the last character of a line, when
5632 starting in Normal mode and 'virtualedit' empty.
5633
5634 The 'selection' option is set by the |:behave| command.
5635
5636 *'selectmode'* *'slm'*
5637'selectmode' 'slm' string (default "")
5638 global
5639 {not in Vi}
5640 This is a comma separated list of words, which specifies when to start
5641 Select mode instead of Visual mode, when a selection is started.
5642 Possible values:
5643 mouse when using the mouse
5644 key when using shifted special keys
5645 cmd when using "v", "V" or CTRL-V
5646 See |Select-mode|.
5647 The 'selectmode' option is set by the |:behave| command.
5648
5649 *'sessionoptions'* *'ssop'*
5650'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005651 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 global
5653 {not in Vi}
5654 {not available when compiled without the +mksession
5655 feature}
5656 Changes the effect of the |:mksession| command. It is a comma
5657 separated list of words. Each word enables saving and restoring
5658 something:
5659 word save and restore ~
5660 blank empty windows
5661 buffers hidden and unloaded buffers, not just those in windows
5662 curdir the current directory
5663 folds manually created folds, opened/closed folds and local
5664 fold options
5665 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005666 and contain at least one lowercase letter. Only
5667 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 help the help window
5669 localoptions options and mappings local to a window or buffer (not
5670 global values for local options)
5671 options all options and mappings (also global values for local
5672 options)
5673 resize size of the Vim window: 'lines' and 'columns'
5674 sesdir the directory in which the session file is located
5675 will become the current directory (useful with
5676 projects accessed over a network from different
5677 systems)
5678 slash backslashes in file names replaced with forward
5679 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005680 tabpages all tab pages; without this only the current tab page
5681 is restored, so that you can make a session for each
5682 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005683 unix with Unix end-of-line format (single <NL>), even when
5684 on Windows or DOS
5685 winpos position of the whole Vim window
5686 winsize window sizes
5687
5688 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005689 When neither "curdir" nor "sesdir" is included, file names are stored
5690 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 "slash" and "unix" are useful on Windows when sharing session files
5692 with Unix. The Unix version of Vim cannot source dos format scripts,
5693 but the Windows version of Vim can source unix format scripts.
5694
5695 *'shell'* *'sh'* *E91*
5696'shell' 'sh' string (default $SHELL or "sh",
5697 MS-DOS and Win32: "command.com" or
5698 "cmd.exe", OS/2: "cmd")
5699 global
5700 Name of the shell to use for ! and :! commands. When changing the
5701 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5702 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005703 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 See |option-backslash| about including spaces and backslashes.
5705 Environment variables are expanded |:set_env|.
5706 If the name of the shell contains a space, you might need to enclose
5707 it in quotes. Example: >
5708 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5709< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005710 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 "-f" is not inside the quotes, because it is not part of the command
5712 name. And Vim automagically recognizes the backslashes that are path
5713 separators.
5714 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5715 variable to change the way external commands are executed. See the
5716 libc.inf file of DJGPP.
5717 Under MS-Windows, when the executable ends in ".com" it must be
5718 included. Thus setting the shell to "command.com" or "4dos.com"
5719 works, but "command" and "4dos" do not work for all commands (e.g.,
5720 filtering).
5721 For unknown reasons, when using "4dos.com" the current directory is
5722 changed to "C:\". To avoid this set 'shell' like this: >
5723 :set shell=command.com\ /c\ 4dos
5724< This option cannot be set from a |modeline| or in the |sandbox|, for
5725 security reasons.
5726
5727 *'shellcmdflag'* *'shcf'*
5728'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5729 does not contain "sh" somewhere: "/c")
5730 global
5731 {not in Vi}
5732 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5733 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5734 systems, the default is set according to the value of 'shell', to
5735 reduce the need to set this option by the user. It's not used for
5736 OS/2 (EMX figures this out itself). See |option-backslash| about
5737 including spaces and backslashes. See |dos-shell|.
5738 This option cannot be set from a |modeline| or in the |sandbox|, for
5739 security reasons.
5740
5741 *'shellpipe'* *'sp'*
5742'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5743 global
5744 {not in Vi}
5745 {not available when compiled without the |+quickfix|
5746 feature}
5747 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005748 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 including spaces and backslashes.
5750 The name of the temporary file can be represented by "%s" if necessary
5751 (the file name is appended automatically if no %s appears in the value
5752 of this option).
5753 For the Amiga and MS-DOS the default is ">". The output is directly
5754 saved in a file and not echoed to the screen.
5755 For Unix the default it "| tee". The stdout of the compiler is saved
5756 in a file and echoed to the screen. If the 'shell' option is "csh" or
5757 "tcsh" after initializations, the default becomes "|& tee". If the
5758 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005759 "2>&1| tee". This means that stderr is also included. Before using
5760 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 The initialization of this option is done after reading the ".vimrc"
5762 and the other initializations, so that when the 'shell' option is set
5763 there, the 'shellpipe' option changes automatically, unless it was
5764 explicitly set before.
5765 When 'shellpipe' is set to an empty string, no redirection of the
5766 ":make" output will be done. This is useful if you use a 'makeprg'
5767 that writes to 'makeef' by itself. If you want no piping, but do
5768 want to include the 'makeef', set 'shellpipe' to a single space.
5769 Don't forget to precede the space with a backslash: ":set sp=\ ".
5770 In the future pipes may be used for filtering and this option will
5771 become obsolete (at least for Unix).
5772 This option cannot be set from a |modeline| or in the |sandbox|, for
5773 security reasons.
5774
5775 *'shellquote'* *'shq'*
5776'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5777 contains "sh" somewhere: "\"")
5778 global
5779 {not in Vi}
5780 Quoting character(s), put around the command passed to the shell, for
5781 the "!" and ":!" commands. The redirection is kept outside of the
5782 quoting. See 'shellxquote' to include the redirection. It's
5783 probably not useful to set both options.
5784 This is an empty string by default. Only known to be useful for
5785 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5786 or bash, where it should be "\"". The default is adjusted according
5787 the value of 'shell', to reduce the need to set this option by the
5788 user. See |dos-shell|.
5789 This option cannot be set from a |modeline| or in the |sandbox|, for
5790 security reasons.
5791
5792 *'shellredir'* *'srr'*
5793'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5794 global
5795 {not in Vi}
5796 String to be used to put the output of a filter command in a temporary
5797 file. See also |:!|. See |option-backslash| about including spaces
5798 and backslashes.
5799 The name of the temporary file can be represented by "%s" if necessary
5800 (the file name is appended automatically if no %s appears in the value
5801 of this option).
5802 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5803 or "zsh" during initializations, the default becomes ">&". If the
5804 'shell' option is "sh", "ksh" or "bash" the default becomes
5805 ">%s 2>&1". This means that stderr is also included.
5806 For Win32, the Unix checks are done and additionally "cmd" is checked
5807 for, which makes the default ">%s 2>&1". Also, the same names with
5808 ".exe" appended are checked for.
5809 The initialization of this option is done after reading the ".vimrc"
5810 and the other initializations, so that when the 'shell' option is set
5811 there, the 'shellredir' option changes automatically unless it was
5812 explicitly set before.
5813 In the future pipes may be used for filtering and this option will
5814 become obsolete (at least for Unix).
5815 This option cannot be set from a |modeline| or in the |sandbox|, for
5816 security reasons.
5817
5818 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5819'shellslash' 'ssl' boolean (default off)
5820 global
5821 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5822 When set, a forward slash is used when expanding file names. This is
5823 useful when a Unix-like shell is used instead of command.com or
5824 cmd.exe. Backward slashes can still be typed, but they are changed to
5825 forward slashes by Vim.
5826 Note that setting or resetting this option has no effect for some
5827 existing file names, thus this option needs to be set before opening
5828 any file for best results. This might change in the future.
5829 'shellslash' only works when a backslash can be used as a path
5830 separator. To test if this is so use: >
5831 if exists('+shellslash')
5832<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005833 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5834'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5835 global
5836 {not in Vi}
5837 When on, use temp files for shell commands. When off use a pipe.
5838 When using a pipe is not possible temp files are used anyway.
5839 Currently a pipe is only supported on Unix. You can check it with: >
5840 :if has("filterpipe")
5841< The advantage of using a pipe is that nobody can read the temp file
5842 and the 'shell' command does not need to support redirection.
5843 The advantage of using a temp file is that the file type and encoding
5844 can be detected.
5845 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5846 |FilterWritePost| autocommands event are not triggered when
5847 'shelltemp' is off.
5848
Bram Moolenaar071d4272004-06-13 20:20:40 +00005849 *'shelltype'* *'st'*
5850'shelltype' 'st' number (default 0)
5851 global
5852 {not in Vi} {only for the Amiga}
5853 On the Amiga this option influences the way how the commands work
5854 which use a shell.
5855 0 and 1: always use the shell
5856 2 and 3: use the shell only to filter lines
5857 4 and 5: use shell only for ':sh' command
5858 When not using the shell, the command is executed directly.
5859
5860 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5861 1 and 3: use "shell cmd" to start external commands
5862
5863 *'shellxquote'* *'sxq'*
5864'shellxquote' 'sxq' string (default: "";
5865 for Win32, when 'shell' contains "sh"
5866 somewhere: "\""
5867 for Unix, when using system(): "\"")
5868 global
5869 {not in Vi}
5870 Quoting character(s), put around the command passed to the shell, for
5871 the "!" and ":!" commands. Includes the redirection. See
5872 'shellquote' to exclude the redirection. It's probably not useful
5873 to set both options.
5874 This is an empty string by default. Known to be useful for
5875 third-party shells when using the Win32 version, such as the MKS Korn
5876 Shell or bash, where it should be "\"". The default is adjusted
5877 according the value of 'shell', to reduce the need to set this option
5878 by the user. See |dos-shell|.
5879 This option cannot be set from a |modeline| or in the |sandbox|, for
5880 security reasons.
5881
5882 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5883'shiftround' 'sr' boolean (default off)
5884 global
5885 {not in Vi}
5886 Round indent to multiple of 'shiftwidth'. Applies to > and <
5887 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5888 a multiple of 'shiftwidth' (this is Vi compatible).
5889 NOTE: This option is reset when 'compatible' is set.
5890
5891 *'shiftwidth'* *'sw'*
5892'shiftwidth' 'sw' number (default 8)
5893 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005894 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005895 |'cindent'|, |>>|, |<<|, etc.
5896
5897 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005898'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5899 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 global
5901 {not in Vi}
5902 This option helps to avoid all the |hit-enter| prompts caused by file
5903 messages, for example with CTRL-G, and to avoid some other messages.
5904 It is a list of flags:
5905 flag meaning when present ~
5906 f use "(3 of 5)" instead of "(file 3 of 5)"
5907 i use "[noeol]" instead of "[Incomplete last line]"
5908 l use "999L, 888C" instead of "999 lines, 888 characters"
5909 m use "[+]" instead of "[Modified]"
5910 n use "[New]" instead of "[New File]"
5911 r use "[RO]" instead of "[readonly]"
5912 w use "[w]" instead of "written" for file write message
5913 and "[a]" instead of "appended" for ':w >> file' command
5914 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5915 "[unix format]" and "[mac]" instead of "[mac format]".
5916 a all of the above abbreviations
5917
5918 o overwrite message for writing a file with subsequent message
5919 for reading a file (useful for ":wn" or when 'autowrite' on)
5920 O message for reading a file overwrites any previous message.
5921 Also for quickfix message (e.g., ":cn").
5922 s don't give "search hit BOTTOM, continuing at TOP" or "search
5923 hit TOP, continuing at BOTTOM" messages
5924 t truncate file message at the start if it is too long to fit
5925 on the command-line, "<" will appear in the left most column.
5926 Ignored in Ex mode.
5927 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005928 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 Ignored in Ex mode.
5930 W don't give "written" or "[w]" when writing a file
5931 A don't give the "ATTENTION" message when an existing swap file
5932 is found.
5933 I don't give the intro message when starting Vim |:intro|.
5934
5935 This gives you the opportunity to avoid that a change between buffers
5936 requires you to hit <Enter>, but still gives as useful a message as
5937 possible for the space available. To get the whole message that you
5938 would have got with 'shm' empty, use ":file!"
5939 Useful values:
5940 shm= No abbreviation of message.
5941 shm=a Abbreviation, but no loss of information.
5942 shm=at Abbreviation, and truncate message when necessary.
5943
5944 NOTE: This option is set to the Vi default value when 'compatible' is
5945 set and to the Vim default value when 'compatible' is reset.
5946
5947 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5948'shortname' 'sn' boolean (default off)
5949 local to buffer
5950 {not in Vi, not in MS-DOS versions}
5951 Filenames are assumed to be 8 characters plus one extension of 3
5952 characters. Multiple dots in file names are not allowed. When this
5953 option is on, dots in file names are replaced with underscores when
5954 adding an extension (".~" or ".swp"). This option is not available
5955 for MS-DOS, because then it would always be on. This option is useful
5956 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5957 or crossdos. When running the Win32 GUI version under Win32s, this
5958 option is always on by default.
5959
5960 *'showbreak'* *'sbr'* *E595*
5961'showbreak' 'sbr' string (default "")
5962 global
5963 {not in Vi}
5964 {not available when compiled without the |+linebreak|
5965 feature}
5966 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005967 values are "> " or "+++ ": >
5968 :set showbreak=>\
5969< Note the backslash to escape the trailing space. It's easier like
5970 this: >
5971 :let &showbreak = '+++ '
5972< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005973 comma (in a future version the comma might be used to separate the
5974 part that is shown at the end and at the start of a line).
5975 The characters are highlighted according to the '@' flag in
5976 'highlight'.
5977 Note that tabs after the showbreak will be displayed differently.
5978 If you want the 'showbreak' to appear in between line numbers, add the
5979 "n" flag to 'cpoptions'.
5980
5981 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5982'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5983 off)
5984 global
5985 {not in Vi}
5986 {not available when compiled without the
5987 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005988 Show (partial) command in the last line of the screen. Set this
5989 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 In Visual mode the size of the selected area is shown:
5991 - When selecting characters within a line, the number of characters.
5992 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005993 - When selecting a block, the size in screen characters:
5994 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005995 NOTE: This option is set to the Vi default value when 'compatible' is
5996 set and to the Vim default value when 'compatible' is reset.
5997
5998 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5999'showfulltag' 'sft' boolean (default off)
6000 global
6001 {not in Vi}
6002 When completing a word in insert mode (see |ins-completion|) from the
6003 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006004 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 matched a C function, you can see a template for what arguments are
6006 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006007 Note that this doesn't work well together with having "longest" in
6008 'completeopt', because the completion from the search pattern may not
6009 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010
6011 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6012'showmatch' 'sm' boolean (default off)
6013 global
6014 When a bracket is inserted, briefly jump to the matching one. The
6015 jump is only done if the match can be seen on the screen. The time to
6016 show the match can be set with 'matchtime'.
6017 A Beep is given if there is no match (no matter if the match can be
6018 seen or not). This option is reset when the 'paste' option is set.
6019 When the 'm' flag is not included in 'cpoptions', typing a character
6020 will immediately move the cursor back to where it belongs.
6021 See the "sm" field in 'guicursor' for setting the cursor shape and
6022 blinking when showing the match.
6023 The 'matchpairs' option can be used to specify the characters to show
6024 matches for. 'rightleft' and 'revins' are used to look for opposite
6025 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006026 Also see the matchparen plugin for highlighting the match when moving
6027 around |pi_paren.txt|.
6028 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029
6030 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6031'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6032 global
6033 If in Insert, Replace or Visual mode put a message on the last line.
6034 Use the 'M' flag in 'highlight' to set the type of highlighting for
6035 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006036 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006037 doesn't mean XIM is really active, especially when 'imactivatekey' is
6038 not set.
6039 NOTE: This option is set to the Vi default value when 'compatible' is
6040 set and to the Vim default value when 'compatible' is reset.
6041
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006042 *'showtabline'* *'stal'*
6043'showtabline' 'stal' number (default 1)
6044 global
6045 {not in Vi}
6046 {not available when compiled without the +windows
6047 feature}
6048 The value of this option specifies when the line with tab page labels
6049 will be displayed:
6050 0: never
6051 1: only if there are at least two tab pages
6052 2: always
6053 This is both for the GUI and non-GUI implementation of the tab pages
6054 line.
6055 See |tab-page| for more information about tab pages.
6056
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 *'sidescroll'* *'ss'*
6058'sidescroll' 'ss' number (default 0)
6059 global
6060 {not in Vi}
6061 The minimal number of columns to scroll horizontally. Used only when
6062 the 'wrap' option is off and the cursor is moved off of the screen.
6063 When it is zero the cursor will be put in the middle of the screen.
6064 When using a slow terminal set it to a large number or 0. When using
6065 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6066 commands.
6067
6068 *'sidescrolloff'* *'siso'*
6069'sidescrolloff' 'siso' number (default 0)
6070 global
6071 {not in Vi}
6072 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006073 right of the cursor if 'nowrap' is set. Setting this option to a
6074 value greater than 0 while having |'sidescroll'| also at a non-zero
6075 value makes some context visible in the line you are scrolling in
6076 horizontally (except at beginning of the line). Setting this option
6077 to a large value (like 999) has the effect of keeping the cursor
6078 horizontally centered in the window, as long as one does not come too
6079 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006080 NOTE: This option is set to 0 when 'compatible' is set.
6081
6082 Example: Try this together with 'sidescroll' and 'listchars' as
6083 in the following example to never allow the cursor to move
6084 onto the "extends" character:
6085
6086 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6087 :set sidescrolloff=1
6088
6089
6090 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6091'smartcase' 'scs' boolean (default off)
6092 global
6093 {not in Vi}
6094 Override the 'ignorecase' option if the search pattern contains upper
6095 case characters. Only used when the search pattern is typed and
6096 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006097 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6099 recalling the search pattern from history and hitting <Enter>.
6100 NOTE: This option is reset when 'compatible' is set.
6101
6102 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6103'smartindent' 'si' boolean (default off)
6104 local to buffer
6105 {not in Vi}
6106 {not available when compiled without the
6107 |+smartindent| feature}
6108 Do smart autoindenting when starting a new line. Works for C-like
6109 programs, but can also be used for other languages. 'cindent' does
6110 something like this, works better in most cases, but is more strict,
6111 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6112 'indentexpr' is a more advanced alternative.
6113 Normally 'autoindent' should also be on when using 'smartindent'.
6114 An indent is automatically inserted:
6115 - After a line ending in '{'.
6116 - After a line starting with a keyword from 'cinwords'.
6117 - Before a line starting with '}' (only with the "O" command).
6118 When typing '}' as the first character in a new line, that line is
6119 given the same indent as the matching '{'.
6120 When typing '#' as the first character in a new line, the indent for
6121 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006122 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6124 When using the ">>" command, lines starting with '#' are not shifted
6125 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 is set smart indenting is disabled.
6128
6129 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6130'smarttab' 'sta' boolean (default off)
6131 global
6132 {not in Vi}
6133 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006134 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6135 <BS> will delete a 'shiftwidth' worth of space at the start of the
6136 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006137 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006138 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6139 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006140 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006142 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 NOTE: This option is reset when 'compatible' is set.
6144
6145 *'softtabstop'* *'sts'*
6146'softtabstop' 'sts' number (default 0)
6147 local to buffer
6148 {not in Vi}
6149 Number of spaces that a <Tab> counts for while performing editing
6150 operations, like inserting a <Tab> or using <BS>. It "feels" like
6151 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6152 used. This is useful to keep the 'ts' setting at its standard value
6153 of 8, while being able to edit like it is set to 'sts'. However,
6154 commands like "x" still work on the actual characters.
6155 When 'sts' is zero, this feature is off.
6156 'softtabstop' is set to 0 when the 'paste' option is set.
6157 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6158 spaces is minimized by using <Tab>s.
6159 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6160 set.
6161 NOTE: This option is set to 0 when 'compatible' is set.
6162
Bram Moolenaar217ad922005-03-20 22:37:15 +00006163 *'spell'* *'nospell'*
6164'spell' boolean (default off)
6165 local to window
6166 {not in Vi}
6167 {not available when compiled without the |+syntax|
6168 feature}
6169 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006170 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006171
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006172 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006173'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006174 local to buffer
6175 {not in Vi}
6176 {not available when compiled without the |+syntax|
6177 feature}
6178 Pattern to locate the end of a sentence. The following word will be
6179 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006180 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006181 When this check is not wanted make this option empty.
6182 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006183 Be careful with special characters, see |option-backslash| about
6184 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006185 To set this option automatically depending on the language, see
6186 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006187
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006188 *'spellfile'* *'spf'*
6189'spellfile' 'spf' string (default empty)
6190 local to buffer
6191 {not in Vi}
6192 {not available when compiled without the |+syntax|
6193 feature}
6194 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006195 commands. It must end in ".{encoding}.add". You need to include the
6196 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006197 *E765*
6198 It may also be a comma separated list of names. A count before the
6199 |zg| and |zw| commands can be used to access each. This allows using
6200 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006201 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006202 you: Using the first directory in 'runtimepath' that is writable. If
6203 there is no "spell" directory yet it will be created. For the file
6204 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006205 ignoring the region.
6206 The resulting ".spl" file will be used for spell checking, it does not
6207 have to appear in 'spelllang'.
6208 Normally one file is used for all regions, but you can add the region
6209 name if you want to. However, it will then only be used when
6210 'spellfile' is set to it, for entries in 'spelllang' only files
6211 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006212 This option cannot be set from a |modeline| or in the |sandbox|, for
6213 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006214
Bram Moolenaar217ad922005-03-20 22:37:15 +00006215 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006216'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006217 local to buffer
6218 {not in Vi}
6219 {not available when compiled without the |+syntax|
6220 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006221 A comma separated list of word list names. When the 'spell' option is
6222 on spellchecking will be done for these languages. Example: >
6223 set spelllang=en_us,nl,medical
6224< This means US English, Dutch and medical words are recognized. Words
6225 that are not recognized will be highlighted.
6226 The word list name must not include a comma or dot. Using a dash is
6227 recommended to separate the two letter language name from a
6228 specification. Thus "en-rare" is used for rare English words.
6229 A region name must come last and have the form "_xx", where "xx" is
6230 the two-letter, lower case region name. You can use more than one
6231 region by listing them: "en_us,en_ca" supports both US and Canadian
6232 English, but not words specific for Australia, New Zealand or Great
6233 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006234 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006235 As a special case the name of a .spl file can be given as-is. The
6236 first "_xx" in the name is removed and used as the region name
6237 (_xx is an underscore, two letters and followed by a non-letter).
6238 This is mainly for testing purposes. You must make sure the correct
6239 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006240 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006241 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6242 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006243 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006244
Bram Moolenaar98692072006-02-04 00:57:42 +00006245 If the |spellfile.vim| plugin is active and you use a language name
6246 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6247 will ask you if you want to download the file.
6248
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006249 After this option has been set successfully, Vim will source the files
6250 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006251 up to the first comma, dot or underscore.
6252 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006253
6254
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006255 *'spellsuggest'* *'sps'*
6256'spellsuggest' 'sps' string (default "best")
6257 global
6258 {not in Vi}
6259 {not available when compiled without the |+syntax|
6260 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006261 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006262 the |spellsuggest()| function. This is a comma-separated list of
6263 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006264
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006265 best Internal method that works best for English. Finds
6266 changes like "fast" and uses a bit of sound-a-like
6267 scoring to improve the ordering.
6268
6269 double Internal method that uses two methods and mixes the
6270 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006271 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006272 word. That only works when the language specifies
6273 sound folding. Can be slow and doesn't always give
6274 better results.
6275
6276 fast Internal method that only checks for simple changes:
6277 character inserts/deletes/swaps. Works well for
6278 simple typing mistakes.
6279
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006280 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006281 Not used for |spellsuggest()|. The number of
6282 suggestions is never more than the value of 'lines'
6283 minus two.
6284
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006285 file:{filename} Read file {filename}, which must have two columns,
6286 separated by a slash. The first column contains the
6287 bad word, the second column the suggested good word.
6288 Example:
6289 theribal/terrible ~
6290 Use this for common mistakes that do not appear at the
6291 top of the suggestion list with the internal methods.
6292 Lines without a slash are ignored, use this for
6293 comments.
6294 The file is used for all languages.
6295
6296 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6297 trouble with spaces. |v:val| holds the badly spelled
6298 word. The expression must evaluate to a List of
6299 Lists, each with a suggestion and a score.
6300 Example:
6301 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006302 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006303 internal methods use. A lower score is better.
6304 This may invoke |spellsuggest()| if you temporarily
6305 set 'spellsuggest' to exclude the "expr:" part.
6306 Errors are silently ignored, unless you set the
6307 'verbose' option to a non-zero value.
6308
6309 Only one of "best", "double" or "fast" may be used. The others may
6310 appear several times in any order. Example: >
6311 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6312<
6313 This option cannot be set from a |modeline| or in the |sandbox|, for
6314 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006315
6316
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6318'splitbelow' 'sb' boolean (default off)
6319 global
6320 {not in Vi}
6321 {not available when compiled without the +windows
6322 feature}
6323 When on, splitting a window will put the new window below the current
6324 one. |:split|
6325
6326 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6327'splitright' 'spr' boolean (default off)
6328 global
6329 {not in Vi}
6330 {not available when compiled without the +vertsplit
6331 feature}
6332 When on, splitting a window will put the new window right of the
6333 current one. |:vsplit|
6334
6335 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6336'startofline' 'sol' boolean (default on)
6337 global
6338 {not in Vi}
6339 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006340 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006341 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006342 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006343 with a linewise operator, with "%" with a count and to buffer changing
6344 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6345 only has a line number, e.g., ":25" or ":+".
6346 In case of buffer changing commands the cursor is placed at the column
6347 where it was the last time the buffer was edited.
6348 NOTE: This option is set when 'compatible' is set.
6349
6350 *'statusline'* *'stl'* *E540* *E541* *E542*
6351'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006352 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 {not in Vi}
6354 {not available when compiled without the |+statusline|
6355 feature}
6356 When nonempty, this option determines the content of the status line.
6357 Also see |status-line|.
6358
6359 The option consists of printf style '%' items interspersed with
6360 normal text. Each status line item is of the form:
6361 %-0{minwid}.{maxwid}{item}
6362 All fields except the {item} is optional. A single percent sign can
6363 be given as "%%". Up to 80 items can be specified.
6364
Bram Moolenaar238a5642006-02-21 22:12:05 +00006365 When the option starts with "%!" then it is used as an expression,
6366 evaluated and the result is used as the option value. Example: >
6367 :set statusline=%!MyStatusLine()
6368< The result can contain %{} items that will be evaluated too.
6369
6370 When there is error while evaluating the option then it will be made
6371 empty to avoid further errors. Otherwise screen updating would loop.
6372
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 Note that the only effect of 'ruler' when this option is set (and
6374 'laststatus' is 2) is controlling the output of |CTRL-G|.
6375
6376 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006377 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006379 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 minwid Minimum width of the item, padding as set by '-' & '0'.
6381 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006382 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 on the left for text items. Numeric items will be
6384 shifted down to maxwid-2 digits followed by '>'number
6385 where number is the amount of missing digits, much like
6386 an exponential notation.
6387 item A one letter code as described below.
6388
6389 Following is a description of the possible statusline items. The
6390 second character in "item" is the type:
6391 N for number
6392 S for string
6393 F for flags as described below
6394 - not applicable
6395
6396 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006397 f S Path to the file in the buffer, as typed or relative to current
6398 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 F S Full path to the file in the buffer.
6400 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006401 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006403 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006405 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006407 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006409 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6411 {not available when compiled without |+autocmd| feature}
6412 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6413 being used: "<keymap>"
6414 n N Buffer number.
6415 b N Value of byte under cursor.
6416 B N As above, in hexadecimal.
6417 o N Byte number in file of byte under cursor, first byte is 1.
6418 Mnemonic: Offset from start of file (with one added)
6419 {not available when compiled without |+byte_offset| feature}
6420 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006421 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006422 l N Line number.
6423 L N Number of lines in buffer.
6424 c N Column number.
6425 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006426 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006427 p N Percentage through file in lines as in |CTRL-G|.
6428 P S Percentage through file of displayed window. This is like the
6429 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006430 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006432 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006433 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006434 ( - Start of item group. Can be used for setting the width and
6435 alignment of a section. Must be followed by %) somewhere.
6436 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006437 T N For 'tabline': start of tab page N label. Use %T after the last
6438 label. This information is used for mouse clicks.
6439 X N For 'tabline': start of close tab N label. Use %X after the
6440 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6441 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 < - Where to truncate line if too long. Default is at the start.
6443 No width fields allowed.
6444 = - Separation point between left and right aligned items.
6445 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006446 # - Set highlight group. The name must follow and then a # again.
6447 Thus use %#HLname# for highlight group HLname. The same
6448 highlighting is used, also for the statusline of non-current
6449 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006451 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006452 The difference between User{N} and StatusLine will be applied
6453 to StatusLineNC for the statusline of non-current windows.
6454 The number N must be between 1 and 9. See |hl-User1..9|
6455
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006456 When displaying a flag, Vim removes the leading comma, if any, when
6457 that flag comes right after plaintext. This will make a nice display
6458 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006459
Bram Moolenaar582fd852005-03-28 20:58:01 +00006460 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 not set) and a minwid is not set for the group, the whole group will
6462 become empty. This will make a group like the following disappear
6463 completely from the statusline when none of the flags are set. >
6464 :set statusline=...%(\ [%M%R%H]%)...
6465<
6466 Beware that an expression is evaluated each and every time the status
6467 line is displayed. The current buffer and current window will be set
6468 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006469 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006470 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006471 real current buffer.
6472
6473 The 'statusline' option may be evaluated in the |sandbox|, see
6474 |sandbox-option|.
6475
6476 It is not allowed to change text or jump to another window while
6477 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478
6479 If the statusline is not updated when you want it (e.g., after setting
6480 a variable that's used in an expression), you can force an update by
6481 setting an option without changing its value. Example: >
6482 :let &ro = &ro
6483
6484< A result of all digits is regarded a number for display purposes.
6485 Otherwise the result is taken as flag text and applied to the rules
6486 described above.
6487
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006488 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006489 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6490 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6491
6492 Examples:
6493 Emulate standard status line with 'ruler' set >
6494 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6495< Similar, but add ASCII value of char under the cursor (like "ga") >
6496 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6497< Display byte count and byte value, modified flag in red. >
6498 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6499 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6500< Display a ,GZ flag if a compressed file is loaded >
6501 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6502< In the |:autocmd|'s: >
6503 :let b:gzflag = 1
6504< And: >
6505 :unlet b:gzflag
6506< And define this function: >
6507 :function VarExists(var, val)
6508 : if exists(a:var) | return a:val | else | return '' | endif
6509 :endfunction
6510<
6511 *'suffixes'* *'su'*
6512'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6513 global
6514 {not in Vi}
6515 Files with these suffixes get a lower priority when multiple files
6516 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006517 suffixes. Spaces after the comma are ignored. A dot is also seen as
6518 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 separator, precede it with a backslash (see |option-backslash| about
6520 including spaces and backslashes).
6521 See 'wildignore' for completely ignoring files.
6522 The use of |:set+=| and |:set-=| is preferred when adding or removing
6523 suffixes from the list. This avoids problems when a future version
6524 uses another default.
6525
6526 *'suffixesadd'* *'sua'*
6527'suffixesadd' 'sua' string (default "")
6528 local to buffer
6529 {not in Vi}
6530 {not available when compiled without the
6531 |+file_in_path| feature}
6532 Comma separated list of suffixes, which are used when searching for a
6533 file for the "gf", "[I", etc. commands. Example: >
6534 :set suffixesadd=.java
6535<
6536 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6537'swapfile' 'swf' boolean (default on)
6538 local to buffer
6539 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006540 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006541 swapfile is not wanted for a specific buffer. For example, with
6542 confidential information that even root must not be able to access.
6543 Careful: All text will be in memory:
6544 - Don't use this for big files.
6545 - Recovery will be impossible!
6546 A swapfile will only be present when |'updatecount'| is non-zero and
6547 'swapfile' is set.
6548 When 'swapfile' is reset, the swap file for the current buffer is
6549 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6550 non-zero, a swap file is immediately created.
6551 Also see |swap-file| and |'swapsync'|.
6552
6553 This option is used together with 'bufhidden' and 'buftype' to
6554 specify special kinds of buffers. See |special-buffers|.
6555
6556 *'swapsync'* *'sws'*
6557'swapsync' 'sws' string (default "fsync")
6558 global
6559 {not in Vi}
6560 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006561 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 When this option is empty parts of the swap file may be in memory and
6563 not written to disk. When the system crashes you may lose more work.
6564 On Unix the system does a sync now and then without Vim asking for it,
6565 so the disadvantage of setting this option off is small. On some
6566 systems the swap file will not be written at all. For a unix system
6567 setting it to "sync" will use the sync() call instead of the default
6568 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006569 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570
6571 *'switchbuf'* *'swb'*
6572'switchbuf' 'swb' string (default "")
6573 global
6574 {not in Vi}
6575 This option controls the behavior when switching between buffers.
6576 Possible values (comma separated list):
6577 useopen If included, jump to the first open window that
6578 contains the specified buffer (if there is one).
6579 Otherwise: Do not examine other windows.
6580 This setting is checked with |quickfix| commands, when
6581 jumping to errors (":cc", ":cn", "cp", etc.). It is
6582 also used in all buffer related split commands, for
6583 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006584 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006585 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006586 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006587 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006588 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006589 newtab Like "split", but open a new tab page. Overrules
6590 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006592 *'synmaxcol'* *'smc'*
6593'synmaxcol' 'smc' number (default 3000)
6594 local to buffer
6595 {not in Vi}
6596 {not available when compiled without the |+syntax|
6597 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006598 Maximum column in which to search for syntax items. In long lines the
6599 text after this column is not highlighted and following lines may not
6600 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006601 This helps to avoid very slow redrawing for an XML file that is one
6602 long line.
6603 Set to zero to remove the limit.
6604
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605 *'syntax'* *'syn'*
6606'syntax' 'syn' string (default empty)
6607 local to buffer
6608 {not in Vi}
6609 {not available when compiled without the |+syntax|
6610 feature}
6611 When this option is set, the syntax with this name is loaded, unless
6612 syntax highlighting has been switched off with ":syntax off".
6613 Otherwise this option does not always reflect the current syntax (the
6614 b:current_syntax variable does).
6615 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006616 not automatically recognized. Example, in an IDL file:
6617 /* vim: set syntax=idl : */ ~
6618 When a dot appears in the value then this separates two filetype
6619 names. Example:
6620 /* vim: set syntax=c.doxygen : */ ~
6621 This will use the "c" syntax first, then the "doxygen" syntax.
6622 Note that the second one must be prepared to be loaded as an addition,
6623 otherwise it will be skipped. More than one dot may appear.
6624 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 :set syntax=OFF
6626< To switch syntax highlighting on according to the current value of the
6627 'filetype' option: >
6628 :set syntax=ON
6629< What actually happens when setting the 'syntax' option is that the
6630 Syntax autocommand event is triggered with the value as argument.
6631 This option is not copied to another buffer, independent of the 's' or
6632 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006633 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006635 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006636'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006637 global
6638 {not in Vi}
6639 {not available when compiled without the +windows
6640 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006641 When nonempty, this option determines the content of the tab pages
6642 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006643 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006644
6645 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006646 option and only when there is no GUI tab line. When 'e' is in
6647 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6648 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006649
6650 The value is evaluated like with 'statusline'. You can use
6651 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006652 the text to be displayed. Use "%1T" for the first label, "%2T" for
6653 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006654
6655 Keep in mind that only one of the tab pages is the current one, others
6656 are invisible and you can't jump to their windows.
6657
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006658
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006659 *'tabpagemax'* *'tpm'*
6660'tabpagemax' 'tpm' number (default 10)
6661 global
6662 {not in Vi}
6663 {not available when compiled without the +windows
6664 feature}
6665 Maximum number of tab pages to be opened by the |-p| command line
6666 argument or the ":tab all" command. |tabpage|
6667
6668
6669 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670'tabstop' 'ts' number (default 8)
6671 local to buffer
6672 Number of spaces that a <Tab> in the file counts for. Also see
6673 |:retab| command, and 'softtabstop' option.
6674
6675 Note: Setting 'tabstop' to any other value than 8 can make your file
6676 appear wrong in many places (e.g., when printing it).
6677
6678 There are four main ways to use tabs in Vim:
6679 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6680 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006681 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006682 behave like a tab appears every 4 (or 3) characters.
6683 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6684 'expandtab'. This way you will always insert spaces. The
6685 formatting will never be messed up when 'tabstop' is changed.
6686 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006687 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 works when using Vim to edit the file.
6689 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6690 'noexpandtab'. This should then work (for initial indents only)
6691 for any tabstop setting that people use. It might be nice to have
6692 tabs after the first non-blank inserted as spaces if you do this
6693 though. Otherwise aligned comments will be wrong when 'tabstop' is
6694 changed.
6695
6696 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6697'tagbsearch' 'tbs' boolean (default on)
6698 global
6699 {not in Vi}
6700 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006701 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 searching makes searching for a tag a LOT faster, but a linear search
6703 will find more tags if the tags file wasn't properly sorted.
6704 Vim normally assumes that your tags files are sorted, or indicate that
6705 they are not sorted. Only when this is not the case does the
6706 'tagbsearch' option need to be switched off.
6707
6708 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006709 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 certain files, or retry all files with a linear search. When
6711 'tagbsearch' is off, only a linear search is done.
6712
6713 Linear searching is done anyway, for one file, when Vim finds a line
6714 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006715 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716< [The whitespace before and after the '0' must be a single <Tab>]
6717
6718 When a binary search was done and no match was found in any of the
6719 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6720 instead of a normal tag name, a retry is done with a linear search.
6721 Tags in unsorted tags files, and matches with different case will only
6722 be found in the retry.
6723
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006724 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 linear search can be avoided for the 'ignorecase' case. Use a value
6726 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6727 case-fold sorted with the -f switch to "sort" in most unices, as in
6728 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006729 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6730 for this as well. Note that case must be folded to uppercase for this
6731 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732
6733 When 'tagbsearch' is off, tags searching is slower when a full match
6734 exists, but faster when no full match exists. Tags in unsorted tags
6735 files may only be found with 'tagbsearch' off.
6736 When the tags file is not sorted, or sorted in a wrong way (not on
6737 ASCII byte value), 'tagbsearch' should be off, or the line given above
6738 must be included in the tags file.
6739 This option doesn't affect commands that find all matching tags (e.g.,
6740 command-line completion and ":help").
6741 {Vi: always uses binary search in some versions}
6742
6743 *'taglength'* *'tl'*
6744'taglength' 'tl' number (default 0)
6745 global
6746 If non-zero, tags are significant up to this number of characters.
6747
6748 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6749'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6750 global
6751 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006752 If on and using a tags file in another directory, file names in that
6753 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006754 NOTE: This option is set to the Vi default value when 'compatible' is
6755 set and to the Vim default value when 'compatible' is reset.
6756
6757 *'tags'* *'tag'* *E433*
6758'tags' 'tag' string (default "./tags,tags", when compiled with
6759 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6760 global or local to buffer |global-local|
6761 Filenames for the tag command, separated by spaces or commas. To
6762 include a space or comma in a file name, precede it with a backslash
6763 (see |option-backslash| about including spaces and backslashes).
6764 When a file name starts with "./", the '.' is replaced with the path
6765 of the current file. But only when the 'd' flag is not included in
6766 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6767 |tags-option|.
6768 "*", "**" and other wildcards can be used to search for tags files in
6769 a directory tree. See |file-searching|. {not available when compiled
6770 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006771 The |tagfiles()| function can be used to get a list of the file names
6772 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6774 files are also supported. They are automatically recognized. The
6775 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6776 differences are ignored (MS-Windows). |emacs-tags|
6777 The use of |:set+=| and |:set-=| is preferred when adding or removing
6778 file names from the list. This avoids problems when a future version
6779 uses another default.
6780 {Vi: default is "tags /usr/lib/tags"}
6781
6782 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6783'tagstack' 'tgst' boolean (default on)
6784 global
6785 {not in all versions of Vi}
6786 When on, the |tagstack| is used normally. When off, a ":tag" or
6787 ":tselect" command with an argument will not push the tag onto the
6788 tagstack. A following ":tag" without an argument, a ":pop" command or
6789 any other command that uses the tagstack will use the unmodified
6790 tagstack, but does change the pointer to the active entry.
6791 Resetting this option is useful when using a ":tag" command in a
6792 mapping which should not change the tagstack.
6793
6794 *'term'* *E529* *E530* *E531*
6795'term' string (default is $TERM, if that fails:
6796 in the GUI: "builtin_gui"
6797 on Amiga: "amiga"
6798 on BeOS: "beos-ansi"
6799 on Mac: "mac-ansi"
6800 on MiNT: "vt52"
6801 on MS-DOS: "pcterm"
6802 on OS/2: "os2ansi"
6803 on Unix: "ansi"
6804 on VMS: "ansi"
6805 on Win 32: "win32")
6806 global
6807 Name of the terminal. Used for choosing the terminal control
6808 characters. Environment variables are expanded |:set_env|.
6809 For example: >
6810 :set term=$TERM
6811< See |termcap|.
6812
6813 *'termbidi'* *'tbidi'*
6814 *'notermbidi'* *'notbidi'*
6815'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6816 global
6817 {not in Vi}
6818 {only available when compiled with the |+arabic|
6819 feature}
6820 The terminal is in charge of Bi-directionality of text (as specified
6821 by Unicode). The terminal is also expected to do the required shaping
6822 that some languages (such as Arabic) require.
6823 Setting this option implies that 'rightleft' will not be set when
6824 'arabic' is set and the value of 'arabicshape' will be ignored.
6825 Note that setting 'termbidi' has the immediate effect that
6826 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6827 This option is reset when the GUI is started.
6828 For further details see |arabic.txt|.
6829
6830 *'termencoding'* *'tenc'*
6831'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6832 Macintosh GUI: "macroman")
6833 global
6834 {only available when compiled with the |+multi_byte|
6835 feature}
6836 {not in Vi}
6837 Encoding used for the terminal. This specifies what character
6838 encoding the keyboard produces and the display will understand. For
6839 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006840 display). Except for the Mac when 'macatsui' is off, then
6841 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842 In the Win32 console version the default value is the console codepage
6843 when it differs from the ANSI codepage.
6844 *E617*
6845 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6846 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6847 Any attempts to set a different value will be rejected, and an error
6848 message is shown.
6849 For the Win32 GUI 'termencoding' is not used for typed characters,
6850 because the Win32 system always passes Unicode characters.
6851 When empty, the same encoding is used as for the 'encoding' option.
6852 This is the normal value.
6853 Not all combinations for 'termencoding' and 'encoding' are valid. See
6854 |encoding-table|.
6855 The value for this option must be supported by internal conversions or
6856 iconv(). When this is not possible no conversion will be done and you
6857 will probably experience problems with non-ASCII characters.
6858 Example: You are working with the locale set to euc-jp (Japanese) and
6859 want to edit a UTF-8 file: >
6860 :let &termencoding = &encoding
6861 :set encoding=utf-8
6862< You need to do this when your system has no locale support for UTF-8.
6863
6864 *'terse'* *'noterse'*
6865'terse' boolean (default off)
6866 global
6867 When set: Add 's' flag to 'shortmess' option (this makes the message
6868 for a search that hits the start or end of the file not being
6869 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6870 shortens a lot of messages}
6871
6872 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6873'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6874 global
6875 {not in Vi}
6876 This option is obsolete. Use 'fileformats'.
6877 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6878 set to the default value for the current system. When 'textauto' is
6879 reset, 'fileformats' is made empty.
6880 NOTE: This option is set to the Vi default value when 'compatible' is
6881 set and to the Vim default value when 'compatible' is reset.
6882
6883 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6884'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6885 others: default off)
6886 local to buffer
6887 {not in Vi}
6888 This option is obsolete. Use 'fileformat'.
6889 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6890 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6891 "unix".
6892
6893 *'textwidth'* *'tw'*
6894'textwidth' 'tw' number (default 0)
6895 local to buffer
6896 {not in Vi}
6897 Maximum width of text that is being inserted. A longer line will be
6898 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006899 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6900 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006902 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 NOTE: This option is set to 0 when 'compatible' is set.
6904
6905 *'thesaurus'* *'tsr'*
6906'thesaurus' 'tsr' string (default "")
6907 global or local to buffer |global-local|
6908 {not in Vi}
6909 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006910 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 the file should contain words with similar meaning, separated by
6912 non-keyword characters (white space is preferred). Maximum line
6913 length is 510 bytes.
6914 To obtain a file to be used here, check out the wordlist FAQ at
6915 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006916 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 after a comma are ignored, otherwise spaces are included in the file
6918 name. See |option-backslash| about using backslashes.
6919 The use of |:set+=| and |:set-=| is preferred when adding or removing
6920 directories from the list. This avoids problems when a future version
6921 uses another default.
6922 Backticks cannot be used in this option for security reasons.
6923
6924 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6925'tildeop' 'top' boolean (default off)
6926 global
6927 {not in Vi}
6928 When on: The tilde command "~" behaves like an operator.
6929 NOTE: This option is reset when 'compatible' is set.
6930
6931 *'timeout'* *'to'* *'notimeout'* *'noto'*
6932'timeout' 'to' boolean (default on)
6933 global
6934 *'ttimeout'* *'nottimeout'*
6935'ttimeout' boolean (default off)
6936 global
6937 {not in Vi}
6938 These two options together determine the behavior when part of a
6939 mapped key sequence or keyboard code has been received:
6940
6941 'timeout' 'ttimeout' action ~
6942 off off do not time out
6943 on on or off time out on :mappings and key codes
6944 off on time out on key codes
6945
6946 If both options are off, Vim will wait until either the complete
6947 mapping or key sequence has been received, or it is clear that there
6948 is no mapping or key sequence for the received characters. For
6949 example: if you have mapped "vl" and Vim has received 'v', the next
6950 character is needed to see if the 'v' is followed by an 'l'.
6951 When one of the options is on, Vim will wait for about 1 second for
6952 the next character to arrive. After that the already received
6953 characters are interpreted as single characters. The waiting time can
6954 be changed with the 'timeoutlen' option.
6955 On slow terminals or very busy systems timing out may cause
6956 malfunctioning cursor keys. If both options are off, Vim waits
6957 forever after an entered <Esc> if there are key codes that start
6958 with <Esc>. You will have to type <Esc> twice. If you do not have
6959 problems with key codes, but would like to have :mapped key
6960 sequences not timing out in 1 second, set the 'ttimeout' option and
6961 reset the 'timeout' option.
6962
6963 NOTE: 'ttimeout' is reset when 'compatible' is set.
6964
6965 *'timeoutlen'* *'tm'*
6966'timeoutlen' 'tm' number (default 1000)
6967 global
6968 {not in all versions of Vi}
6969 *'ttimeoutlen'* *'ttm'*
6970'ttimeoutlen' 'ttm' number (default -1)
6971 global
6972 {not in Vi}
6973 The time in milliseconds that is waited for a key code or mapped key
6974 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6975 when part of a command has been typed.
6976 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6977 different timeout value for key codes is desired set 'ttimeoutlen' to
6978 a non-negative number.
6979
6980 ttimeoutlen mapping delay key code delay ~
6981 < 0 'timeoutlen' 'timeoutlen'
6982 >= 0 'timeoutlen' 'ttimeoutlen'
6983
6984 The timeout only happens when the 'timeout' and 'ttimeout' options
6985 tell so. A useful setting would be >
6986 :set timeout timeoutlen=3000 ttimeoutlen=100
6987< (time out on mapping after three seconds, time out on key codes after
6988 a tenth of a second).
6989
6990 *'title'* *'notitle'*
6991'title' boolean (default off, on when title can be restored)
6992 global
6993 {not in Vi}
6994 {not available when compiled without the |+title|
6995 feature}
6996 When on, the title of the window will be set to the value of
6997 'titlestring' (if it is not empty), or to:
6998 filename [+=-] (path) - VIM
6999 Where:
7000 filename the name of the file being edited
7001 - indicates the file cannot be modified, 'ma' off
7002 + indicates the file was modified
7003 = indicates the file is read-only
7004 =+ indicates the file is read-only and modified
7005 (path) is the path of the file being edited
7006 - VIM the server name |v:servername| or "VIM"
7007 Only works if the terminal supports setting window titles
7008 (currently Amiga console, Win32 console, all GUI versions and
7009 terminals with a non- empty 't_ts' option - these are Unix xterm and
7010 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7011 *X11*
7012 When Vim was compiled with HAVE_X11 defined, the original title will
7013 be restored if possible. The output of ":version" will include "+X11"
7014 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7015 works for the icon name |'icon'|.
7016 But: When Vim was started with the |-X| argument, restoring the title
7017 will not work (except in the GUI).
7018 If the title cannot be restored, it is set to the value of 'titleold'.
7019 You might want to restore the title outside of Vim then.
7020 When using an xterm from a remote machine you can use this command:
7021 rsh machine_name xterm -display $DISPLAY &
7022 then the WINDOWID environment variable should be inherited and the
7023 title of the window should change back to what it should be after
7024 exiting Vim.
7025
7026 *'titlelen'*
7027'titlelen' number (default 85)
7028 global
7029 {not in Vi}
7030 {not available when compiled without the |+title|
7031 feature}
7032 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007033 title. When the title is longer, only the end of the path name is
7034 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007035 Using a percentage makes this adapt to the width of the window. But
7036 it won't work perfectly, because the actual number of characters
7037 available also depends on the font used and other things in the title
7038 bar. When 'titlelen' is zero the full path is used. Otherwise,
7039 values from 1 to 30000 percent can be used.
7040 'titlelen' is also used for the 'titlestring' option.
7041
7042 *'titleold'*
7043'titleold' string (default "Thanks for flying Vim")
7044 global
7045 {not in Vi}
7046 {only available when compiled with the |+title|
7047 feature}
7048 This option will be used for the window title when exiting Vim if the
7049 original title cannot be restored. Only happens if 'title' is on or
7050 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007051 This option cannot be set from a |modeline| or in the |sandbox|, for
7052 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 *'titlestring'*
7054'titlestring' string (default "")
7055 global
7056 {not in Vi}
7057 {not available when compiled without the |+title|
7058 feature}
7059 When this option is not empty, it will be used for the title of the
7060 window. This happens only when the 'title' option is on.
7061 Only works if the terminal supports setting window titles (currently
7062 Amiga console, Win32 console, all GUI versions and terminals with a
7063 non-empty 't_ts' option).
7064 When Vim was compiled with HAVE_X11 defined, the original title will
7065 be restored if possible |X11|.
7066 When this option contains printf-style '%' items, they will be
7067 expanded according to the rules used for 'statusline'.
7068 Example: >
7069 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7070 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7071< The value of 'titlelen' is used to align items in the middle or right
7072 of the available space.
7073 Some people prefer to have the file name first: >
7074 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7075< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007076 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007077 separating space only when needed.
7078 NOTE: Use of special characters in 'titlestring' may cause the display
7079 to be garbled (e.g., when it contains a CR or NL character).
7080 {not available when compiled without the |+statusline| feature}
7081
7082 *'toolbar'* *'tb'*
7083'toolbar' 'tb' string (default "icons,tooltips")
7084 global
7085 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7086 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007087 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 possible values are:
7089 icons Toolbar buttons are shown with icons.
7090 text Toolbar buttons shown with text.
7091 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007092 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 tooltips Tooltips are active for toolbar buttons.
7094 Tooltips refer to the popup help text which appears after the mouse
7095 cursor is placed over a toolbar button for a brief moment.
7096
7097 If you want the toolbar to be shown with icons as well as text, do the
7098 following: >
7099 :set tb=icons,text
7100< Motif and Athena cannot display icons and text at the same time. They
7101 will show icons if both are requested.
7102
7103 If none of the strings specified in 'toolbar' are valid or if
7104 'toolbar' is empty, this option is ignored. If you want to disable
7105 the toolbar, you need to set the 'guioptions' option. For example: >
7106 :set guioptions-=T
7107< Also see |gui-toolbar|.
7108
7109 *'toolbariconsize'* *'tbis'*
7110'toolbariconsize' 'tbis' string (default "small")
7111 global
7112 {not in Vi}
7113 {only in the GTK+ 2 GUI}
7114 Controls the size of toolbar icons. The possible values are:
7115 tiny Use tiny toolbar icons.
7116 small Use small toolbar icons (default).
7117 medium Use medium-sized toolbar icons.
7118 large Use large toolbar icons.
7119 The exact dimensions in pixels of the various icon sizes depend on
7120 the current theme. Common dimensions are large=32x32, medium=24x24,
7121 small=20x20 and tiny=16x16.
7122
7123 If 'toolbariconsize' is empty, the global default size as determined
7124 by user preferences or the current theme is used.
7125
7126 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7127'ttybuiltin' 'tbi' boolean (default on)
7128 global
7129 {not in Vi}
7130 When on, the builtin termcaps are searched before the external ones.
7131 When off the builtin termcaps are searched after the external ones.
7132 When this option is changed, you should set the 'term' option next for
7133 the change to take effect, for example: >
7134 :set notbi term=$TERM
7135< See also |termcap|.
7136 Rationale: The default for this option is "on", because the builtin
7137 termcap entries are generally better (many systems contain faulty
7138 xterm entries...).
7139
7140 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7141'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7142 sun-cmd, screen, rxvt, dtterm or
7143 iris-ansi; also on when running Vim in
7144 a DOS console)
7145 global
7146 {not in Vi}
7147 Indicates a fast terminal connection. More characters will be sent to
7148 the screen for redrawing, instead of using insert/delete line
7149 commands. Improves smoothness of redrawing when there are multiple
7150 windows and the terminal does not support a scrolling region.
7151 Also enables the extra writing of characters at the end of each screen
7152 line for lines that wrap. This helps when using copy/paste with the
7153 mouse in an xterm and other terminals.
7154
7155 *'ttymouse'* *'ttym'*
7156'ttymouse' 'ttym' string (default depends on 'term')
7157 global
7158 {not in Vi}
7159 {only in Unix and VMS, doesn't work in the GUI; not
7160 available when compiled without |+mouse|}
7161 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007162 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 *xterm-mouse*
7164 xterm xterm-like mouse handling. The mouse generates
7165 "<Esc>[Mscr", where "scr" is three bytes:
7166 "s" = button state
7167 "c" = column plus 33
7168 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007169 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007170 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 xterm2 Works like "xterm", but with the xterm reporting the
7172 mouse position while the mouse is dragged. This works
7173 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007174 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007175 work. See below for how Vim detects this
7176 automatically.
7177 *netterm-mouse*
7178 netterm NetTerm mouse handling. The mouse generates
7179 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7180 for the row and column.
7181 *dec-mouse*
7182 dec DEC terminal mouse handling. The mouse generates a
7183 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007184 This is also available for an Xterm, if it was
7185 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 *jsbterm-mouse*
7187 jsbterm JSB term mouse handling.
7188 *pterm-mouse*
7189 pterm QNX pterm mouse handling.
7190
7191 The mouse handling must be enabled at compile time |+mouse_xterm|
7192 |+mouse_dec| |+mouse_netterm|.
7193 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7194 recognized, if enabled at compile time. DEC terminal mouse codes
7195 are recognized if enabled at compile time, and 'ttymouse' is not
7196 "xterm" (because the xterm and dec mouse codes conflict).
7197 This option is automatically set to "xterm", when the 'term' option is
7198 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7199 or "xterm2" already. The main use of this option is to set it to
7200 "xterm", when the terminal name doesn't start with "xterm", but it can
7201 handle xterm mouse codes.
7202 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007203 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 feature and if |t_RV| is set to the escape sequence to request the
7205 xterm version number. Otherwise "xterm2" must be set explicitly.
7206 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7207 t_RV to an empty string: >
7208 :set t_RV=
7209<
7210 *'ttyscroll'* *'tsl'*
7211'ttyscroll' 'tsl' number (default 999)
7212 global
7213 Maximum number of lines to scroll the screen. If there are more lines
7214 to scroll the window is redrawn. For terminals where scrolling is
7215 very slow and redrawing is not slow this can be set to a small number,
7216 e.g., 3, to speed up displaying.
7217
7218 *'ttytype'* *'tty'*
7219'ttytype' 'tty' string (default from $TERM)
7220 global
7221 Alias for 'term', see above.
7222
7223 *'undolevels'* *'ul'*
7224'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7225 Win32 and OS/2)
7226 global
7227 {not in Vi}
7228 Maximum number of changes that can be undone. Since undo information
7229 is kept in memory, higher numbers will cause more memory to be used
7230 (nevertheless, a single change can use an unlimited amount of memory).
7231 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7232 itself: >
7233 set ul=0
7234< But you can also get Vi compatibility by including the 'u' flag in
7235 'cpoptions', and still be able to use CTRL-R to repeat undo.
7236 Set to a negative number for no undo at all: >
7237 set ul=-1
7238< This helps when you run out of memory for a single change.
7239 Also see |undo-two-ways|.
7240
7241 *'updatecount'* *'uc'*
7242'updatecount' 'uc' number (default: 200)
7243 global
7244 {not in Vi}
7245 After typing this many characters the swap file will be written to
7246 disk. When zero, no swap file will be created at all (see chapter on
7247 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7248 Vim with the "-n" option, see |startup|. When editing in readonly
7249 mode this option will be initialized to 10000.
7250 The swapfile can be disabled per buffer with |'swapfile'|.
7251 When 'updatecount' is set from zero to non-zero, swap files are
7252 created for all buffers that have 'swapfile' set. When 'updatecount'
7253 is set to zero, existing swap files are not deleted.
7254 Also see |'swapsync'|.
7255 This option has no meaning in buffers where |'buftype'| is "nofile"
7256 or "nowrite".
7257
7258 *'updatetime'* *'ut'*
7259'updatetime' 'ut' number (default 4000)
7260 global
7261 {not in Vi}
7262 If this many milliseconds nothing is typed the swap file will be
7263 written to disk (see |crash-recovery|). Also used for the
7264 |CursorHold| autocommand event.
7265
7266 *'verbose'* *'vbs'*
7267'verbose' 'vbs' number (default 0)
7268 global
7269 {not in Vi, although some versions have a boolean
7270 verbose option}
7271 When bigger than zero, Vim will give messages about what it is doing.
7272 Currently, these messages are given:
7273 >= 1 When the viminfo file is read or written.
7274 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007275 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007276 >= 8 Files for which a group of autocommands is executed.
7277 >= 9 Every executed autocommand.
7278 >= 12 Every executed function.
7279 >= 13 When an exception is thrown, caught, finished, or discarded.
7280 >= 14 Anything pending in a ":finally" clause.
7281 >= 15 Every executed Ex command (truncated at 200 characters).
7282
7283 This option can also be set with the "-V" argument. See |-V|.
7284 This option is also set by the |:verbose| command.
7285
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007286 When the 'verbosefile' option is set then the verbose messages are not
7287 displayed.
7288
7289 *'verbosefile'* *'vfile'*
7290'verbosefile' 'vfile' string (default empty)
7291 global
7292 {not in Vi}
7293 When not empty all messages are written in a file with this name.
7294 When the file exists messages are appended.
7295 Writing to the file ends when Vim exits or when 'verbosefile' is made
7296 empty.
7297 Setting 'verbosefile' to a new value is like making it empty first.
7298 The difference with |:redir| is that verbose messages are not
7299 displayed when 'verbosefile' is set.
7300
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 *'viewdir'* *'vdir'*
7302'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7303 "$VIM/vimfiles/view",
7304 for Unix: "~/.vim/view",
7305 for Macintosh: "$VIM:vimfiles:view"
7306 for VMS: "sys$login:vimfiles/view"
7307 for RiscOS: "Choices:vimfiles/view")
7308 global
7309 {not in Vi}
7310 {not available when compiled without the +mksession
7311 feature}
7312 Name of the directory where to store files for |:mkview|.
7313 This option cannot be set from a |modeline| or in the |sandbox|, for
7314 security reasons.
7315
7316 *'viewoptions'* *'vop'*
7317'viewoptions' 'vop' string (default: "folds,options,cursor")
7318 global
7319 {not in Vi}
7320 {not available when compiled without the +mksession
7321 feature}
7322 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007323 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 word save and restore ~
7325 cursor cursor position in file and in window
7326 folds manually created folds, opened/closed folds and local
7327 fold options
7328 options options and mappings local to a window or buffer (not
7329 global values for local options)
7330 slash backslashes in file names replaced with forward
7331 slashes
7332 unix with Unix end-of-line format (single <NL>), even when
7333 on Windows or DOS
7334
7335 "slash" and "unix" are useful on Windows when sharing view files
7336 with Unix. The Unix version of Vim cannot source dos format scripts,
7337 but the Windows version of Vim can source unix format scripts.
7338
7339 *'viminfo'* *'vi'* *E526* *E527* *E528*
7340'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007341 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7342 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7343 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 global
7345 {not in Vi}
7346 {not available when compiled without the |+viminfo|
7347 feature}
7348 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 separated list of parameters, each consisting of a single character
7351 identifying the particular parameter, followed by a number or string
7352 which specifies the value of that parameter. If a particular
7353 character is left out, then the default value is used for that
7354 parameter. The following is a list of the identifying characters and
7355 the effect of their value.
7356 CHAR VALUE ~
7357 ! When included, save and restore global variables that start
7358 with an uppercase letter, and don't contain a lowercase
7359 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007360 and "_K_L_M" are not. Only String and Number types are
7361 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 " Maximum number of lines saved for each register. Old name of
7363 the '<' item, with the disadvantage that you need to put a
7364 backslash before the ", otherwise it will be recognized as the
7365 start of a comment!
7366 % When included, save and restore the buffer list. If Vim is
7367 started with a file name argument, the buffer list is not
7368 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007369 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007370 without a file name and buffers for help files are not written
7371 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007372 When followed by a number, the number specifies the maximum
7373 number of buffers that are stored. Without a number all
7374 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 ' Maximum number of previously edited files for which the marks
7376 are remembered. This parameter must always be included when
7377 'viminfo' is non-empty.
7378 Including this item also means that the |jumplist| and the
7379 |changelist| are stored in the viminfo file.
7380 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007381 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007382 patterns are also saved. When not included, the value of
7383 'history' is used.
7384 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007385 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007386 < Maximum number of lines saved for each register. If zero then
7387 registers are not saved. When not included, all lines are
7388 saved. '"' is the old name for this item.
7389 Also see the 's' item below: limit specified in Kbyte.
7390 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007391 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 c When included, convert the text in the viminfo file from the
7393 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007394 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 f Whether file marks need to be stored. If zero, file marks ('0
7396 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007397 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 cursor position (when exiting or when doing ":wviminfo").
7399 h Disable the effect of 'hlsearch' when loading the viminfo
7400 file. When not included, it depends on whether ":nohlsearch"
7401 has been used since the last search command.
7402 n Name of the viminfo file. The name must immediately follow
7403 the 'n'. Must be the last one! If the "-i" argument was
7404 given when starting Vim, that file name overrides the one
7405 given here with 'viminfo'. Environment variables are expanded
7406 when opening the file, not when setting the option.
7407 r Removable media. The argument is a string (up to the next
7408 ','). This parameter can be given several times. Each
7409 specifies the start of a path for which no marks will be
7410 stored. This is to avoid removable media. For MS-DOS you
7411 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7412 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7413 ignored. Maximum length of each 'r' argument is 50
7414 characters.
7415 s Maximum size of an item in Kbyte. If zero then registers are
7416 not saved. Currently only applies to registers. The default
7417 "s10" will exclude registers with more than 10 Kbyte of text.
7418 Also see the '<' item above: line count limit.
7419
7420 Example: >
7421 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7422<
7423 '50 Marks will be remembered for the last 50 files you
7424 edited.
7425 <1000 Contents of registers (up to 1000 lines each) will be
7426 remembered.
7427 s100 Registers with more than 100 Kbyte text are skipped.
7428 :0 Command-line history will not be saved.
7429 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7430 no / Since '/' is not specified, the default will be used,
7431 that is, save all of the search history, and also the
7432 previous search and substitute patterns.
7433 no % The buffer list will not be saved nor read back.
7434 no h 'hlsearch' highlighting will be restored.
7435
7436 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7437 load the contents of the file, this is not done automatically.
7438
7439 This option cannot be set from a |modeline| or in the |sandbox|, for
7440 security reasons.
7441
7442 *'virtualedit'* *'ve'*
7443'virtualedit' 've' string (default "")
7444 global
7445 {not in Vi}
7446 {not available when compiled without the
7447 |+virtualedit| feature}
7448 A comma separated list of these words:
7449 block Allow virtual editing in Visual block mode.
7450 insert Allow virtual editing in Insert mode.
7451 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007452 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007453
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007455 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007456 of the line. Useful for selecting a rectangle in Visual mode and
7457 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007458 "onemore" is not the same, it will only allow moving the cursor just
7459 after the last character of the line. This makes some commands more
7460 consistent. Previously the cursor was always past the end of the line
7461 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007462 break some plugins or Vim scripts. For example because |l| can move
7463 the cursor after the last character. Use with care!
7464 Using the |$| command will move to the last character in the line, not
7465 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007466 It doesn't make sense to combine "all" with "onemore", but you will
7467 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468
7469 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7470'visualbell' 'vb' boolean (default off)
7471 global
7472 {not in Vi}
7473 Use visual bell instead of beeping. The terminal code to display the
7474 visual bell is given with 't_vb'. When no beep or flash is wanted,
7475 use ":set vb t_vb=".
7476 Note: When the GUI starts, 't_vb' is reset to its default value. You
7477 might want to set it again in your |gvimrc|.
7478 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7479 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7480 where 40 is the time in msec.
7481 Does not work on the Amiga, you always get a screen flash.
7482 Also see 'errorbells'.
7483
7484 *'warn'* *'nowarn'*
7485'warn' boolean (default on)
7486 global
7487 Give a warning message when a shell command is used while the buffer
7488 has been changed.
7489
7490 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7491'weirdinvert' 'wiv' boolean (default off)
7492 global
7493 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007494 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007495 It is provided for backwards compatibility with version 4.x.
7496 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7497 vice versa. Has no effect when the GUI is running.
7498
7499 *'whichwrap'* *'ww'*
7500'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7501 global
7502 {not in Vi}
7503 Allow specified keys that move the cursor left/right to move to the
7504 previous/next line when the cursor is on the first/last character in
7505 the line. Concatenate characters to allow this for these keys:
7506 char key mode ~
7507 b <BS> Normal and Visual
7508 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007509 h "h" Normal and Visual (not recommended)
7510 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 < <Left> Normal and Visual
7512 > <Right> Normal and Visual
7513 ~ "~" Normal
7514 [ <Left> Insert and Replace
7515 ] <Right> Insert and Replace
7516 For example: >
7517 :set ww=<,>,[,]
7518< allows wrap only when cursor keys are used.
7519 When the movement keys are used in combination with a delete or change
7520 operator, the <EOL> also counts for a character. This makes "3h"
7521 different from "3dh" when the cursor crosses the end of a line. This
7522 is also true for "x" and "X", because they do the same as "dl" and
7523 "dh". If you use this, you may also want to use the mapping
7524 ":map <BS> X" to make backspace delete the character in front of the
7525 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007526 When 'l' is included and it is used after an operator at the end of a
7527 line then it will not move to the next line. This makes "dl", "cl",
7528 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 NOTE: This option is set to the Vi default value when 'compatible' is
7530 set and to the Vim default value when 'compatible' is reset.
7531
7532 *'wildchar'* *'wc'*
7533'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7534 global
7535 {not in Vi}
7536 Character you have to type to start wildcard expansion in the
7537 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007538 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539 The character is not recognized when used inside a macro. See
7540 'wildcharm' for that.
7541 Although 'wc' is a number option, you can set it to a special key: >
7542 :set wc=<Esc>
7543< NOTE: This option is set to the Vi default value when 'compatible' is
7544 set and to the Vim default value when 'compatible' is reset.
7545
7546 *'wildcharm'* *'wcm'*
7547'wildcharm' 'wcm' number (default: none (0))
7548 global
7549 {not in Vi}
7550 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007551 recognized when used inside a macro. You can find "spare" command-line
7552 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 you'll never actually type 'wildcharm', just use it in mappings that
7554 automatically invoke completion mode, e.g.: >
7555 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007556 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557< Then after typing :ss you can use CTRL-P & CTRL-N.
7558
7559 *'wildignore'* *'wig'*
7560'wildignore' 'wig' string (default "")
7561 global
7562 {not in Vi}
7563 {not available when compiled without the |+wildignore|
7564 feature}
7565 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007566 patterns is ignored when completing file or directory names, and
7567 influences the result of |expand()|, |glob()| and |globpath()| unless
7568 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7570 Also see 'suffixes'.
7571 Example: >
7572 :set wildignore=*.o,*.obj
7573< The use of |:set+=| and |:set-=| is preferred when adding or removing
7574 a pattern from the list. This avoids problems when a future version
7575 uses another default.
7576
7577 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7578'wildmenu' 'wmnu' boolean (default off)
7579 global
7580 {not in Vi}
7581 {not available if compiled without the |+wildmenu|
7582 feature}
7583 When 'wildmenu' is on, command-line completion operates in an enhanced
7584 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7585 the possible matches are shown just above the command line, with the
7586 first match highlighted (overwriting the status line, if there is
7587 one). Keys that show the previous/next match, such as <Tab> or
7588 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7589 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7590 specified. "longest" and "list" do not start "wildmenu" mode.
7591 If there are more matches than can fit in the line, a ">" is shown on
7592 the right and/or a "<" is shown on the left. The status line scrolls
7593 as needed.
7594 The "wildmenu" mode is abandoned when a key is hit that is not used
7595 for selecting a completion.
7596 While the "wildmenu" is active the following keys have special
7597 meanings:
7598
7599 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7600 <Down> - in filename/menu name completion: move into a
7601 subdirectory or submenu.
7602 <CR> - in menu completion, when the cursor is just after a
7603 dot: move into a submenu.
7604 <Up> - in filename/menu name completion: move up into
7605 parent directory or parent menu.
7606
7607 This makes the menus accessible from the console |console-menus|.
7608
7609 If you prefer the <Left> and <Right> keys to move the cursor instead
7610 of selecting a different match, use this: >
7611 :cnoremap <Left> <Space><BS><Left>
7612 :cnoremap <Right> <Space><BS><Right>
7613<
7614 The "WildMenu" highlighting is used for displaying the current match
7615 |hl-WildMenu|.
7616
7617 *'wildmode'* *'wim'*
7618'wildmode' 'wim' string (Vim default: "full")
7619 global
7620 {not in Vi}
7621 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007622 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007623 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007624 first part specifies the behavior for the first use of 'wildchar',
7625 The second part for the second use, etc.
7626 These are the possible values for each part:
7627 "" Complete only the first match.
7628 "full" Complete the next full match. After the last match,
7629 the original string is used and then the first match
7630 again.
7631 "longest" Complete till longest common string. If this doesn't
7632 result in a longer string, use the next part.
7633 "longest:full" Like "longest", but also start 'wildmenu' if it is
7634 enabled.
7635 "list" When more than one match, list all matches.
7636 "list:full" When more than one match, list all matches and
7637 complete first match.
7638 "list:longest" When more than one match, list all matches and
7639 complete till longest common string.
7640 When there is only a single match, it is fully completed in all cases.
7641
7642 Examples: >
7643 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007644< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 :set wildmode=longest,full
7646< Complete longest common string, then each full match >
7647 :set wildmode=list:full
7648< List all matches and complete each full match >
7649 :set wildmode=list,full
7650< List all matches without completing, then each full match >
7651 :set wildmode=longest,list
7652< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007653 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007655 *'wildoptions'* *'wop'*
7656'wildoptions' 'wop' string (default "")
7657 global
7658 {not in Vi}
7659 {not available when compiled without the |+wildignore|
7660 feature}
7661 A list of words that change how command line completion is done.
7662 Currently only one word is allowed:
7663 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007664 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007665 is displayed per line. Often used tag kinds are:
7666 d #define
7667 f function
7668 Also see |cmdline-completion|.
7669
Bram Moolenaar071d4272004-06-13 20:20:40 +00007670 *'winaltkeys'* *'wak'*
7671'winaltkeys' 'wak' string (default "menu")
7672 global
7673 {not in Vi}
7674 {only used in Win32, Motif, GTK and Photon GUI}
7675 Some GUI versions allow the access to menu entries by using the ALT
7676 key in combination with a character that appears underlined in the
7677 menu. This conflicts with the use of the ALT key for mappings and
7678 entering special characters. This option tells what to do:
7679 no Don't use ALT keys for menus. ALT key combinations can be
7680 mapped, but there is no automatic handling. This can then be
7681 done with the |:simalt| command.
7682 yes ALT key handling is done by the windowing system. ALT key
7683 combinations cannot be mapped.
7684 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007685 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 keys can be mapped.
7687 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7688 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007689 This option is not used for <F10>; on Win32 and with GTK <F10> will
7690 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007691
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007692 *'window'* *'wi'*
7693'window' 'wi' number (default screen height - 1)
7694 global
7695 Window height. Do not confuse this with the height of the Vim window,
7696 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007697 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7698 value is smaller than 'lines' minus one. The screen will scroll
7699 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007700 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7701 in a much smarter way, taking care of wrapping lines.
7702 When resizing the Vim window, the value is smaller than 1 or more than
7703 or equal to 'lines' it will be set to 'lines' minus 1.
7704 {Vi also uses the option to specify the number of displayed lines}
7705
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 *'winheight'* *'wh'* *E591*
7707'winheight' 'wh' number (default 1)
7708 global
7709 {not in Vi}
7710 {not available when compiled without the +windows
7711 feature}
7712 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007713 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007714 focus goes to a window that is smaller, its size is increased, at the
7715 cost of the height of other windows.
7716 Set 'winheight' to a small number for normal editing.
7717 Set it to 999 to make the current window fill most of the screen.
7718 Other windows will be only 'winminheight' high. This has the drawback
7719 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7720 to create only two windows, set the option after startup is done,
7721 using the |VimEnter| event: >
7722 au VimEnter * set winheight=999
7723< Minimum value is 1.
7724 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 height of the current window.
7726 'winheight' applies to the current window. Use 'winminheight' to set
7727 the minimal height for other windows.
7728
7729 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7730'winfixheight' 'wfh' boolean (default off)
7731 local to window
7732 {not in Vi}
7733 {not available when compiled without the +windows
7734 feature}
7735 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007736 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7737 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007738 The height may be changed anyway when running out of room.
7739
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007740 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7741'winfixwidth' 'wfw' boolean (default off)
7742 local to window
7743 {not in Vi}
7744 {not available when compiled without the +windows
7745 feature}
7746 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007747 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007748 The width may be changed anyway when running out of room.
7749
Bram Moolenaar071d4272004-06-13 20:20:40 +00007750 *'winminheight'* *'wmh'*
7751'winminheight' 'wmh' number (default 1)
7752 global
7753 {not in Vi}
7754 {not available when compiled without the +windows
7755 feature}
7756 The minimal height of a window, when it's not the current window.
7757 This is a hard minimum, windows will never become smaller.
7758 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7759 status bar) if necessary. They will return to at least one line when
7760 they become active (since the cursor has to have somewhere to go.)
7761 Use 'winheight' to set the minimal height of the current window.
7762 This option is only checked when making a window smaller. Don't use a
7763 large number, it will cause errors when opening more than a few
7764 windows. A value of 0 to 3 is reasonable.
7765
7766 *'winminwidth'* *'wmw'*
7767'winminwidth' 'wmw' number (default 1)
7768 global
7769 {not in Vi}
7770 {not available when compiled without the +vertsplit
7771 feature}
7772 The minimal width of a window, when it's not the current window.
7773 This is a hard minimum, windows will never become smaller.
7774 When set to zero, windows may be "squashed" to zero columns (i.e. just
7775 a vertical separator) if necessary. They will return to at least one
7776 line when they become active (since the cursor has to have somewhere
7777 to go.)
7778 Use 'winwidth' to set the minimal width of the current window.
7779 This option is only checked when making a window smaller. Don't use a
7780 large number, it will cause errors when opening more than a few
7781 windows. A value of 0 to 12 is reasonable.
7782
7783 *'winwidth'* *'wiw'* *E592*
7784'winwidth' 'wiw' number (default 20)
7785 global
7786 {not in Vi}
7787 {not available when compiled without the +vertsplit
7788 feature}
7789 Minimal number of columns for the current window. This is not a hard
7790 minimum, Vim will use fewer columns if there is not enough room. If
7791 the current window is smaller, its size is increased, at the cost of
7792 the width of other windows. Set it to 999 to make the current window
7793 always fill the screen. Set it to a small number for normal editing.
7794 The width is not adjusted after one of the commands to change the
7795 width of the current window.
7796 'winwidth' applies to the current window. Use 'winminwidth' to set
7797 the minimal width for other windows.
7798
7799 *'wrap'* *'nowrap'*
7800'wrap' boolean (default on)
7801 local to window
7802 {not in Vi}
7803 This option changes how text is displayed. It doesn't change the text
7804 in the buffer, see 'textwidth' for that.
7805 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007806 displaying continues on the next line. When off lines will not wrap
7807 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007808 moved to a part that is not shown, the screen will scroll
7809 horizontally.
7810 The line will be broken in the middle of a word if necessary. See
7811 'linebreak' to get the break at a word boundary.
7812 To make scrolling horizontally a bit more useful, try this: >
7813 :set sidescroll=5
7814 :set listchars+=precedes:<,extends:>
7815< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007816 This option can't be set from a |modeline| when the 'diff' option is
7817 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818
7819 *'wrapmargin'* *'wm'*
7820'wrapmargin' 'wm' number (default 0)
7821 local to buffer
7822 Number of characters from the right window border where wrapping
7823 starts. When typing text beyond this limit, an <EOL> will be inserted
7824 and inserting continues on the next line.
7825 Options that add a margin, such as 'number' and 'foldcolumn', cause
7826 the text width to be further reduced. This is Vi compatible.
7827 When 'textwidth' is non-zero, this option is not used.
7828 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7829 and less usefully}
7830
7831 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7832'wrapscan' 'ws' boolean (default on) *E384* *E385*
7833 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007834 Searches wrap around the end of the file. Also applies to |]s| and
7835 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836
7837 *'write'* *'nowrite'*
7838'write' boolean (default on)
7839 global
7840 {not in Vi}
7841 Allows writing files. When not set, writing a file is not allowed.
7842 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007843 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 argument. Filtering text is still possible, even though this requires
7845 writing a temporary file.
7846
7847 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7848'writeany' 'wa' boolean (default off)
7849 global
7850 Allows writing to any file with no need for "!" override.
7851
7852 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7853'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7854 otherwise)
7855 global
7856 {not in Vi}
7857 Make a backup before overwriting a file. The backup is removed after
7858 the file was successfully written, unless the 'backup' option is
7859 also on. Reset this option if your file system is almost full. See
7860 |backup-table| for another explanation.
7861 When the 'backupskip' pattern matches, a backup is not made anyway.
7862 NOTE: This option is set to the default value when 'compatible' is
7863 set.
7864
7865 *'writedelay'* *'wd'*
7866'writedelay' 'wd' number (default 0)
7867 global
7868 {not in Vi}
7869 The number of microseconds to wait for each character sent to the
7870 screen. When non-zero, characters are sent to the terminal one by
7871 one. For MS-DOS pcterm this does not work. For debugging purposes.
7872
7873 vim:tw=78:ts=8:ft=help:norl: