blob: a888d92ae0dcbbad1ceff4c76cfd8f97fda687ac [file] [log] [blame]
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001*options.txt* For Vim version 7.0aa. Last change: 2004 Dec 09
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==============================================================================
221. Setting options *set-option*
23
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
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
79 are removed. Otherwise there is no check for doubled
80 values. You can avoid this by removing a value first.
81 Example: >
82 :set guioptions-=T guioptions+=T
83< Also see |:set-args| above.
84 {not in Vi}
85
86:se[t] {option}^={value} *:set^=*
87 Multiply the {value} to a number option, or prepend
88 the {value} to a string option. When the option is a
89 comma separated list, a comma is added, unless the
90 value was empty.
91 Also see |:set-args| above.
92 {not in Vi}
93
94:se[t] {option}-={value} *:set-=*
95 Subtract the {value} from a number option, or remove
96 the {value} from a string option, if it is there.
97 If the {value} is not found in a string option, there
98 is no error or warning. When the option is a comma
99 separated list, a comma is deleted, unless the option
100 becomes empty.
101 When the option is a list of flags, {value} must be
102 exactly as they appear in the option. Remove flags
103 one by one to avoid problems.
104 Also see |:set-args| above.
105 {not in Vi}
106
107The {option} arguments to ":set" may be repeated. For example: >
108 :set ai nosi sw=3 ts=3
109If you make an error in one of the arguments, an error message will be given
110and the following arguments will be ignored.
111
112 *:set-verbose*
113When 'verbose' is non-zero, displaying an option value will also tell where it
114was last set. Example: >
115 :verbose set shiftwidth cindent?
116 shiftwidth=4
117 Last set from modeline
118 cindent
119 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
120This is only done when specific option values are requested, not for ":set
121all" or ":set" without an argument.
122When the option was set by hand there is no "Last set" message. There is only
123one value for all local options with the same name. Thus the message applies
124to the option name, not necessarily its value.
125When the option was set while executing a function, user command or
126autocommand, the script in which it was defined is reported.
127Note that an option may also have been set as a side effect of setting
128'compatible'.
129{not available when compiled without the +eval feature}
130
131 *:set-termcap* *E522*
132For {option} the form "t_xx" may be used to set a termcap option. This will
133override the value from the termcap. You can then use it in a mapping. If
134the "xx" part contains special characters, use the <t_xx> form: >
135 :set <t_#4>=^[Ot
136This can also be used to translate a special code for a normal key. For
137example, if Alt-b produces <Esc>b, use this: >
138 :set <M-b>=^[b
139(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
140The advantage over a mapping is that it works in all situations.
141
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000142The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
143security reasons.
144
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000146at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147"set all" probably does not fit on the screen, causing Vim to give the
148|more-prompt|.
149
150 *option-backslash*
151To include white space in a string option value it has to be preceded with a
152backslash. To include a backslash you have to use two. Effectively this
153means that the number of backslashes in an option value is halved (rounded
154down).
155A few examples: >
156 :set tags=tags\ /usr/tags results in "tags /usr/tags"
157 :set tags=tags\\,file results in "tags\,file"
158 :set tags=tags\\\ file results in "tags\ file"
159
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000160The "|" character separates a ":set" command from a following command. To
161include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162'titlestring' option to "hi|there": >
163 :set titlestring=hi\|there
164This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
165 :set titlestring=hi|set iconstring=there
166
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000167For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168precise: For options that expect a file name (those where environment
169variables are expanded) a backslash before a normal file name character is not
170removed. But a backslash before a special character (space, backslash, comma,
171etc.) is used like explained above.
172There is one special situation, when the value starts with "\\": >
173 :set dir=\\machine\path results in "\\machine\path"
174 :set dir=\\\\machine\\path results in "\\machine\path"
175 :set dir=\\path\\file results in "\\path\file" (wrong!)
176For the first one the start is kept, but for the second one the backslashes
177are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000178halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179result which is probably not what you want. Avoid it.
180
181 *add-option-flags* *remove-option-flags*
182 *E539* *E550* *E551* *E552*
183Some options are a list of flags. When you want to add a flag to such an
184option, without changing the existing ones, you can do it like this: >
185 :set guioptions+=a
186Remove a flag from an option like this: >
187 :set guioptions-=a
188This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000189Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000190the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
191doesn't appear.
192
193 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000194Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195environment variable exists the '$' and the following environment variable
196name is replaced with its value. If it does not exist the '$' and the name
197are not modified. Any non-id character (not a letter, digit or '_') may
198follow the environment variable name. That character and what follows is
199appended to the value of the environment variable. Examples: >
200 :set term=$TERM.new
201 :set path=/usr/$INCLUDE,$HOME/include,.
202When adding or removing a string from an option with ":set opt-=val" or ":set
203opt+=val" the expansion is done before the adding or removing.
204
205
206Handling of local options *local-options*
207
208Some of the options only apply to a window or buffer. Each window or buffer
209has its own copy of this option, thus can each have their own value. This
210allows you to set 'list' in one window but not in another. And set
211'shiftwidth' to 3 in one buffer and 4 in another.
212
213The following explains what happens to these local options in specific
214situations. You don't really need to know all of this, since Vim mostly uses
215the option values you would expect. Unfortunately, doing what the user
216expects is a bit complicated...
217
218When splitting a window, the local options are copied to the new window. Thus
219right after the split the contents of the two windows look the same.
220
221When editing a new buffer, its local option values must be initialized. Since
222the local options of the current buffer might be specifically for that buffer,
223these are not used. Instead, for each buffer-local option there also is a
224global value, which is used for new buffers. With ":set" both the local and
225global value is changed. With "setlocal" only the local value is changed,
226thus this value is not used when editing a new buffer.
227
228When editing a buffer that has been edited before, the last used window
229options are used again. If this buffer has been edited in this window, the
230values from back then are used. Otherwise the values from the window where
231the buffer was edited last are used.
232
233It's possible to set a local window option specifically for a type of buffer.
234When you edit another buffer in the same window, you don't want to keep
235using these local window options. Therefore Vim keeps a global value of the
236local window options, which is used when editing another buffer. Each window
237has its own copy of these values. Thus these are local to the window, but
238global to all buffers in the window. With this you can do: >
239 :e one
240 :set list
241 :e two
242Now the 'list' option will also be set in "two", since with the ":set list"
243command you have also set the global value. >
244 :set nolist
245 :e one
246 :setlocal list
247 :e two
248Now the 'list' option is not set, because ":set nolist" resets the global
249value, ":setlocal list" only changes the local value and ":e two" gets the
250global value. Note that if you do this next: >
251 :e one
252You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000253"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254
255 *:setl* *:setlocal*
256:setl[ocal] ... Like ":set" but set only the value local to the
257 current buffer or window. Not all options have a
258 local value. If the option does not have a local
259 value the global value is set.
260 With the "all" argument: display all local option's
261 local values.
262 Without argument: Display all local option's local
263 values which are different from the default.
264 When displaying a specific local option, show the
265 local value. For a global option the global value is
266 shown (but that might change in the future).
267 {not in Vi}
268
269:setl[ocal] {option}< Set the local value of {option} to its global value.
270 {not in Vi}
271
272 *:setg* *:setglobal*
273:setg[lobal] ... Like ":set" but set only the global value for a local
274 option without changing the local value.
275 When displaying an option, the global value is shown.
276 With the "all" argument: display all local option's
277 global values.
278 Without argument: display all local option's global
279 values which are different from the default.
280 {not in Vi}
281
282For buffer-local and window-local options:
283 Command global value local value ~
284 :set option=value set set
285 :setlocal option=value - set
286:setglobal option=value set -
287 :set option? - display
288 :setlocal option? - display
289:setglobal option? display -
290
291
292Global options with a local value *global-local*
293
294Options are global when you mostly use one value for all buffers. For some
295global options it's useful to sometimes have a different local value. You can
296set the local value with ":setlocal". That buffer will then use the local
297value, while other buffers continue using the global value.
298
299For example, you have two windows, both on C source code. They use the global
300'makeprg' option. If you do this in one of the two windows: >
301 :set makeprg=gmake
302then the other window will switch to the same value. There is no need to set
303the 'makeprg' option in the other C source window too.
304However, if you start editing a Perl file in a new window, you want to use
305another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000306files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 :setlocal makeprg=perlmake
308You can switch back to using the global value by making the local value empty: >
309 :setlocal makeprg=
310This only works for a string option. For a boolean option you need to use the
311"<" flag, like this: >
312 :setlocal autoread<
313Note that for non-boolean options using "<" copies the global value to the
314local value, it doesn't switch back to using the global value (that matters
315when changing the global value later).
316Note: In the future more global options can be made global-local. Using
317":setlocal" on a global option might work differently then.
318
319
320Setting the filetype
321
322:setf[iletype] {filetype} *:setf* *:setfiletype*
323 Set the 'filetype' option to {filetype}, but only if
324 not done yet in a sequence of (nested) autocommands.
325 This is short for: >
326 :if !did_filetype()
327 : setlocal filetype={filetype}
328 :endif
329< This command is used in a filetype.vim file to avoid
330 setting the 'filetype' option twice, causing different
331 settings and syntax files to be loaded.
332 {not in Vi}
333
334:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
335:opt[ions] Open a window for viewing and setting all options.
336 Options are grouped by function.
337 Offers short help for each option. Hit <CR> on the
338 short help to open a help window with more help for
339 the option.
340 Modify the value of the option and hit <CR> on the
341 "set" line to set the new value. For window and
342 buffer specific options, the last accessed window is
343 used to set the option value in, unless this is a help
344 window, in which case the window below help window is
345 used (skipping the option-window).
346 {not available when compiled without the |+eval| or
347 |+autocmd| features}
348
349 *$HOME*
350Using "~" is like using "$HOME", but it is only recognized at the start of an
351option and after a space or comma.
352
353On Unix systems "~user" can be used too. It is replaced by the home directory
354of user "user". Example: >
355 :set path=~mool/include,/usr/include,.
356
357On Unix systems the form "${HOME}" can be used too. The name between {} can
358contain non-id characters then. Note that if you want to use this for the
359"gf" command, you need to add the '{' and '}' characters to 'isfname'.
360
361NOTE: expanding environment variables and "~/" is only done with the ":set"
362command, not when assigning a value to an option with ":let".
363
364
365Note the maximum length of an expanded option is limited. How much depends on
366the system, mostly it is something like 256 or 1024 characters.
367
368 *:fix* *:fixdel*
369:fix[del] Set the value of 't_kD':
370 't_kb' is 't_kD' becomes ~
371 CTRL-? CTRL-H
372 not CTRL-? CTRL-?
373
374 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
375
376 If your delete key terminal code is wrong, but the
377 code for backspace is alright, you can put this in
378 your .vimrc: >
379 :fixdel
380< This works no matter what the actual code for
381 backspace is.
382
383 If the backspace key terminal code is wrong you can
384 use this: >
385 :if &term == "termname"
386 : set t_kb=^V<BS>
387 : fixdel
388 :endif
389< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000390 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000391 with your terminal name.
392
393 If your <Delete> key sends a strange key sequence (not
394 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
395 :if &term == "termname"
396 : set t_kD=^V<Delete>
397 :endif
398< Where "^V" is CTRL-V and "<Delete>" is the delete key
399 (don't type eight characters!). Replace "termname"
400 with your terminal name.
401
402 *Linux-backspace*
403 Note about Linux: By default the backspace key
404 produces CTRL-?, which is wrong. You can fix it by
405 putting this line in your rc.local: >
406 echo "keycode 14 = BackSpace" | loadkeys
407<
408 *NetBSD-backspace*
409 Note about NetBSD: If your backspace doesn't produce
410 the right code, try this: >
411 xmodmap -e "keycode 22 = BackSpace"
412< If this works, add this in your .Xmodmap file: >
413 keysym 22 = BackSpace
414< You need to restart for this to take effect.
415
416==============================================================================
4172. Automatically setting options *auto-setting*
418
419Besides changing options with the ":set" command, there are three alternatives
420to set options automatically for one or more files:
421
4221. When starting Vim initializations are read from various places. See
423 |initialization|. Most of them are performed for all editing sessions,
424 and some of them depend on the directory where Vim is started.
425 You can create an initialization file with |:mkvimrc|, |:mkview| and
426 |:mksession|.
4272. If you start editing a new file, the automatic commands are executed.
428 This can be used to set options for files matching a particular pattern and
429 many other things. See |autocommand|.
4303. If you start editing a new file, and the 'modeline' option is on, a
431 number of lines at the beginning and end of the file are checked for
432 modelines. This is explained here.
433
434 *modeline* *vim:* *vi:* *ex:* *E520*
435There are two forms of modelines. The first form:
436 [text]{white}{vi:|vim:|ex:}[white]{options}
437
438[text] any text or empty
439{white} at least one blank character (<Space> or <Tab>)
440{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
441[white] optional white space
442{options} a list of option settings, separated with white space or ':',
443 where each part between ':' is the argument for a ":set"
444 command
445
446Example: >
447 vi:noai:sw=3 ts=6
448
449The second form (this is compatible with some versions of Vi):
450
451 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
452
453[text] any text or empty
454{white} at least one blank character (<Space> or <Tab>)
455{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
456[white] optional white space
457se[t] the string "set " or "se " (note the space)
458{options} a list of options, separated with white space, which is the
459 argument for a ":set" command
460: a colon
461[text] any text or empty
462
463Example: >
464 /* vim: set ai tw=75: */
465
466The white space before {vi:|vim:|ex:} is required. This minimizes the chance
467that a normal word like "lex:" is caught. There is one exception: "vi:" and
468"vim:" can also be at the start of the line (for compatibility with version
4693.0). Using "ex:" at the start of the line will be ignored (this could be
470short for "example:").
471
472 *modeline-local*
473The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000474buffer and window that contain the file. Although it's possible to set global
475options from a modeline, this is unusual. If you have two windows open and
476the files in it set the same global option to a different value, the result
477depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000479When editing a file that was already loaded, only the window-local options
480from the modeline are used. Thus if you manually changed a buffer-local
481option after opening the file, it won't be changed if you edit the same buffer
482in another window. But window-local options will be set.
483
Bram Moolenaar071d4272004-06-13 20:20:40 +0000484 *modeline-version*
485If the modeline is only to be used for some versions of Vim, the version
486number can be specified where "vim:" is used:
487 vim{vers}: version {vers} or later
488 vim<{vers}: version before {vers}
489 vim={vers}: version {vers}
490 vim>{vers}: version after {vers}
491{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
492For example, to use a modeline only for Vim 6.0 and later: >
493 /* vim600: set foldmethod=marker: */
494To use a modeline for Vim before version 5.7: >
495 /* vim<570: set sw=4: */
496There can be no blanks between "vim" and the ":".
497
498
499The number of lines that are checked can be set with the 'modelines' option.
500If 'modeline' is off or 'modelines' is 0 no lines are checked.
501
502Note that for the first form all of the rest of the line is used, thus a line
503like: >
504 /* vi:ts=4: */
505will give an error message for the trailing "*/". This line is OK: >
506 /* vi:set ts=4: */
507
508If an error is detected the rest of the line is skipped.
509
510If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000511backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512 /* vi:set dir=c\:\tmp: */
513This sets the 'dir' option to "c:\tmp". Only a single backslash before the
514':' is removed. Thus to include "\:" you have to specify "\\:".
515
516No other commands than "set" are supported, for security reasons (somebody
517might create a Trojan horse text file with modelines).
518
519Hint: If you would like to do something else than setting an option, you could
520define an autocommand that checks the file for a specific string. For
521example: >
522 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
523And define a function SetVar() that does something with the line containing
524"VAR".
525
526==============================================================================
5273. Options summary *option-summary*
528
529In the list below all the options are mentioned with their full name and with
530an abbreviation if there is one. Both forms may be used.
531
532In this document when a boolean option is "set" that means that ":set option"
533is entered. When an option is "reset", ":set nooption" is used.
534
535For some options there are two default values: The "Vim default", which is
536used when 'compatible' is not set, and the "Vi default", which is used when
537'compatible' is set.
538
539Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000540are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541different value in each window. For example the 'list' option can be set in
542one window and reset in another for the same text, giving both types of view
543at the same time. There are a few options that are specific to a certain
544file. These can have a different value for each file or buffer. For example
545the 'textwidth' option can be 78 for a normal text file and 0 for a C
546program.
547
548 global one option for all buffers and windows
549 local to window each window has its own copy of this option
550 local to buffer each buffer has its own copy of this option
551
552When creating a new window the option values from the currently active window
553are used as a default value for the window-specific options. For the
554buffer-specific options this depends on the 's' and 'S' flags in the
555'cpoptions' option. If 's' is included (which is the default) the values for
556buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000557first entered. If 'S' is present the options are copied each time the buffer
558is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000559present, the options are copied from the currently active buffer when the
560buffer is created.
561
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000562Not all options are supported in all versions. To test if option "foo" can be
563used with ":set" use "exists('&foo')". This doesn't mean the value is
564actually remembered and works. Some options are hidden, which means that you
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565can set them but the value is not remembered. To test if option "foo" is
566really supported use "exists('+foo')".
567
568 *E355*
569A jump table for the options with a short description can be found at |Q_op|.
570
571 *'aleph'* *'al'* *aleph* *Aleph*
572'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
573 global
574 {not in Vi}
575 {only available when compiled with the |+rightleft|
576 feature}
577 The ASCII code for the first letter of the Hebrew alphabet. The
578 routine that maps the keyboard in Hebrew mode, both in Insert mode
579 (when hkmap is set) and on the command-line (when hitting CTRL-_)
580 outputs the Hebrew characters in the range [aleph..aleph+26].
581 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
582 See |rileft.txt|.
583
584 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
585'allowrevins' 'ari' boolean (default off)
586 global
587 {not in Vi}
588 {only available when compiled with the |+rightleft|
589 feature}
590 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
591 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
592 into reverse Insert mode, and don't know how to get out. See
593 'revins'.
594 NOTE: This option is reset when 'compatible' is set.
595
596 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
597'altkeymap' 'akm' boolean (default off)
598 global
599 {not in Vi}
600 {only available when compiled with the |+farsi|
601 feature}
602 When on, the second language is Farsi. In editing mode CTRL-_ toggles
603 the keyboard map between Farsi and English, when 'allowrevins' set.
604
605 When off, the keyboard map toggles between Hebrew and English. This
606 is useful to start the Vim in native mode i.e. English (left-to-right
607 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000608 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610 *'ambiwidth'* *'ambw'*
611'ambiwidth' 'ambw' string (default: "single")
612 global
613 {not in Vi}
614 {only available when compiled with the |+multi_byte|
615 feature}
616 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
617 Tells Vim what to do with characters with East Asian Width Class
618 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
619 letters, Cyrillic letters).
620
621 There are currently two possible values:
622 "single": Use the same width as characters in US-ASCII. This is
623 expected by most users.
624 "double": Use twice the width of ASCII characters.
625
626 There are a number of CJK fonts for which the width of glyphs for
627 those characters are solely based on how many octets they take in
628 legacy/traditional CJK encodings. In those encodings, Euro,
629 Registered sign, Greek/Cyrillic letters are represented by two octets,
630 therefore those fonts have "wide" glyphs for them. This is also
631 true of some line drawing characters used to make tables in text
632 file. Therefore, when a CJK font is used for GUI Vim or
633 Vim is running inside a terminal (emulators) that uses a CJK font
634 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
635 this option should be set to "double" to match the width perceived
636 by Vim with the width of glyphs in the font. Perhaps it also has
637 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
638 when the system locale is set to one of CJK locales. See Unicode
639 Standard Annex #11 (http://www.unicode.org/reports/tr11).
640
641 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
642'antialias' 'anti' boolean (default: off)
643 global
644 {not in Vi}
645 {only available when compiled with GUI enabled
646 on Mac OS X}
647 This option only has an effect in the GUI version of Vim on Mac OS X
648 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
649 which can be easier to read at certain sizes on certain displays.
650 Setting this option can sometimes cause problems if 'guifont' is set
651 to its default (empty string).
652
653 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
654'autochdir' 'acd' boolean (default off)
655 global
656 {not in Vi}
657 {only available when compiled with the
658 |+netbeans_intg| or |+sun_workshop| feature}
659 When on, Vim will change its value for the current working directory
660 whenever you open a file, switch buffers, delete a buffer or
661 open/close a window. It will change to the directory containing the
662 file which was opened or selected. This option is provided for
663 backward compatibility with the Vim released with Sun ONE Studio 4
664 Enterprise Edition.
665
666 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
667'arabic' 'arab' boolean (default off)
668 local to window
669 {not in Vi}
670 {only available when compiled with the |+arabic|
671 feature}
672 This option can be set to start editing Arabic text.
673 Setting this option will:
674 - Set the 'rightleft' option, unless 'termbidi' is set.
675 - Set the 'arabicshape' option, unless 'termbidi' is set.
676 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
677 between typing English and Arabic key mapping.
678 - Set the 'delcombine' option
679 Note that 'encoding' must be "utf-8" for working with Arabic text.
680
681 Resetting this option will:
682 - Reset the 'rightleft' option.
683 - Disable the use of 'keymap' (without changing its value).
684 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
685 option.
686 Also see |arabic.txt|.
687
688 *'arabicshape'* *'arshape'*
689 *'noarabicshape'* *'noarshape'*
690'arabicshape' 'arshape' boolean (default on)
691 global
692 {not in Vi}
693 {only available when compiled with the |+arabic|
694 feature}
695 When on and 'termbidi' is off, the required visual character
696 corrections that need to take place for displaying the Arabic language
697 take affect. Shaping, in essence, gets enabled; the term is a broad
698 one which encompasses:
699 a) the changing/morphing of characters based on their location
700 within a word (initial, medial, final and stand-alone).
701 b) the enabling of the ability to compose characters
702 c) the enabling of the required combining of some characters
703 When disabled the character display reverts back to each character's
704 true stand-alone form.
705 Arabic is a complex language which requires other settings, for
706 further details see |arabic.txt|.
707
708 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
709'autoindent' 'ai' boolean (default off)
710 local to buffer
711 Copy indent from current line when starting a new line (typing <CR>
712 in Insert mode or when using the "o" or "O" command). If you do not
713 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000714 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
715 another line has the same effect, unless the 'I' flag is included in
716 'cpoptions'.
717 When autoindent is on, formatting (with the "gq" command or when you
718 reach 'textwidth' in Insert mode) uses the indentation of the first
719 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 When 'smartindent' or 'cindent' is on the indent is changed in
721 a different way.
722 The 'autoindent' option is reset when the 'paste' option is set.
723 {small difference from Vi: After the indent is deleted when typing
724 <Esc> or <CR>, the cursor position when moving up or down is after the
725 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
726
727 *'autoread'* *'ar'* *'noautoread'* *'noar'*
728'autoread' 'ar' boolean (default off)
729 global or local to buffer |global-local|
730 {not in Vi}
731 When a file has been detected to have been changed outside of Vim and
732 it has not been changed inside of Vim, automatically read it again.
733 When the file has been deleted this is not done. |timestamp|
734 If this option has a local value, use this command to switch back to
735 using the global value: >
736 :set autoread<
737<
738 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
739'autowrite' 'aw' boolean (default off)
740 global
741 Write the contents of the file, if it has been modified, on each
742 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
743 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
744 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
745 Note that for some commands the 'autowrite' option is not used, see
746 'autowriteall' for that.
747
748 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
749'autowriteall' 'awa' boolean (default off)
750 global
751 {not in Vi}
752 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
753 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
754 Setting this option also implies that Vim behaves like 'autowrite' has
755 been set.
756
757 *'background'* *'bg'*
758'background' 'bg' string (default "dark" or "light")
759 global
760 {not in Vi}
761 When set to "dark", Vim will try to use colors that look good on a
762 dark background. When set to "light", Vim will try to use colors that
763 look good on a light background. Any other value is illegal.
764 Vim tries to set the default value according to the terminal used.
765 This will not always be correct.
766 Setting this option does not change the background color, it tells Vim
767 what the background color looks like. For changing the background
768 color, see |:hi-normal|.
769
770 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000771 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 change.
773 When a color scheme is loaded (the "colors_name" variable is set)
774 setting 'background' will cause the color scheme to be reloaded. If
775 the color scheme adjusts to the value of 'background' this will work.
776 However, if the color scheme sets 'background' itself the effect may
777 be undone. First delete the "colors_name" variable when needed.
778
779 When setting 'background' to the default value with: >
780 :set background&
781< Vim will guess the value. In the GUI this should work correctly,
782 in other cases Vim might not be able to guess the right value.
783
784 When starting the GUI, the default value for 'background' will be
785 "light". When the value is not set in the .gvimrc, and Vim detects
786 that the background is actually quite dark, 'background' is set to
787 "dark". But this happens only AFTER the .gvimrc file has been read
788 (because the window needs to be opened to find the actual background
789 color). To get around this, force the GUI window to be opened by
790 putting a ":gui" command in the .gvimrc file, before where the value
791 of 'background' is used (e.g., before ":syntax on").
792 Normally this option would be set in the .vimrc file. Possibly
793 depending on the terminal name. Example: >
794 :if &term == "pcterm"
795 : set background=dark
796 :endif
797< When this option is set, the default settings for the highlight groups
798 will change. To use other settings, place ":highlight" commands AFTER
799 the setting of the 'background' option.
800 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
801 to select the colors for syntax highlighting. After changing this
802 option, you must load syntax.vim again to see the result. This can be
803 done with ":syntax on".
804
805 *'backspace'* *'bs'*
806'backspace' 'bs' string (default "")
807 global
808 {not in Vi}
809 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
810 mode. This is a list of items, separated by commas. Each item allows
811 a way to backspace over something:
812 value effect ~
813 indent allow backspacing over autoindent
814 eol allow backspacing over line breaks (join lines)
815 start allow backspacing over the start of insert; CTRL-W and CTRL-U
816 stop once at the start of insert.
817
818 When the value is empty, Vi compatible backspacing is used.
819
820 For backwards compatibility with version 5.4 and earlier:
821 value effect ~
822 0 same as ":set backspace=" (Vi compatible)
823 1 same as ":set backspace=indent,eol"
824 2 same as ":set backspace=indent,eol,start"
825
826 See |:fixdel| if your <BS> or <Del> key does not do what you want.
827 NOTE: This option is set to "" when 'compatible' is set.
828
829 *'backup'* *'bk'* *'nobackup'* *'nobk'*
830'backup' 'bk' boolean (default off)
831 global
832 {not in Vi}
833 Make a backup before overwriting a file. Leave it around after the
834 file has been successfully written. If you do not want to keep the
835 backup file, but you do want a backup while the file is being
836 written, reset this option and set the 'writebackup' option (this is
837 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000838 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000839 |backup-table| for more explanations.
840 When the 'backupskip' pattern matches, a backup is not made anyway.
841 When 'patchmode' is set, the backup may be renamed to become the
842 oldest version of a file.
843 NOTE: This option is reset when 'compatible' is set.
844
845 *'backupcopy'* *'bkc'*
846'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
847 global
848 {not in Vi}
849 When writing a file and a backup is made, this option tells how it's
850 done. This is a comma separated list of words.
851
852 The main values are:
853 "yes" make a copy of the file and overwrite the original one
854 "no" rename the file and write a new one
855 "auto" one of the previous, what works best
856
857 Extra values that can be combined with the ones above are:
858 "breaksymlink" always break symlinks when writing
859 "breakhardlink" always break hardlinks when writing
860
861 Making a copy and overwriting the original file:
862 - Takes extra time to copy the file.
863 + When the file has special attributes, is a (hard/symbolic) link or
864 has a resource fork, all this is preserved.
865 - When the file is a link the backup will have the name of the link,
866 not of the real file.
867
868 Renaming the file and writing a new one:
869 + It's fast.
870 - Sometimes not all attributes of the file can be copied to the new
871 file.
872 - When the file is a link the new file will not be a link.
873
874 The "auto" value is the middle way: When Vim sees that renaming file
875 is possible without side effects (the attributes can be passed on and
876 and the file is not a link) that is used. When problems are expected,
877 a copy will be made.
878
879 The "breaksymlink" and "breakhardlink" values can be used in
880 combination with any of "yes", "no" and "auto". When included, they
881 force Vim to always break either symbolic or hard links by doing
882 exactly what the "no" option does, renaming the original file to
883 become the backup and writing a new file in its place. This can be
884 useful for example in source trees where all the files are symbolic or
885 hard links and any changes should stay in the local source tree, not
886 be propagated back to the original source.
887 *crontab*
888 One situation where "no" and "auto" will cause problems: A program
889 that opens a file, invokes Vim to edit that file, and then tests if
890 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000891 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000892 example.
893
894 When a copy is made, the original file is truncated and then filled
895 with the new text. This means that protection bits, owner and
896 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000897 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 group of the backup is set to the group of the original file. If this
899 fails, the protection bits for the group are made the same as for
900 others.
901
902 When the file is renamed this is the other way around: The backup has
903 the same attributes of the original file, and the newly written file
904 is owned by the current user. When the file was a (hard/symbolic)
905 link, the new file will not! That's why the "auto" value doesn't
906 rename when the file is a link. The owner and group of the newly
907 written file will be set to the same ones as the original file, but
908 the system may refuse to do this. In that case the "auto" value will
909 again not rename the file.
910
911 *'backupdir'* *'bdir'*
912'backupdir' 'bdir' string (default for Amiga: ".,t:",
913 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
914 for Unix: ".,~/tmp,~/")
915 global
916 {not in Vi}
917 List of directories for the backup file, separated with commas.
918 - The backup file will be created in the first directory in the list
919 where this is possible.
920 - Empty means that no backup file will be created ('patchmode' is
921 impossible!). Writing may fail because of this.
922 - A directory "." means to put the backup file in the same directory
923 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000924 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 put the backup file relative to where the edited file is. The
926 leading "." is replaced with the path name of the edited file.
927 ("." inside a directory name has no special meaning).
928 - Spaces after the comma are ignored, other spaces are considered part
929 of the directory name. To have a space at the start of a directory
930 name, precede it with a backslash.
931 - To include a comma in a directory name precede it with a backslash.
932 - A directory name may end in an '/'.
933 - Environment variables are expanded |:set_env|.
934 - Careful with '\' characters, type one before a space, type two to
935 get one in the option (see |option-backslash|), for example: >
936 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
937< - For backwards compatibility with Vim version 3.0 a '>' at the start
938 of the option is removed.
939 See also 'backup' and 'writebackup' options.
940 If you want to hide your backup files on Unix, consider this value: >
941 :set backupdir=./.backup,~/.backup,.,/tmp
942< You must create a ".backup" directory in each directory and in your
943 home directory for this to work properly.
944 The use of |:set+=| and |:set-=| is preferred when adding or removing
945 directories from the list. This avoids problems when a future version
946 uses another default.
947 This option cannot be set from a |modeline| or in the |sandbox|, for
948 security reasons.
949
950 *'backupext'* *'bex'* *E589*
951'backupext' 'bex' string (default "~", for VMS: "_")
952 global
953 {not in Vi}
954 String which is appended to a file name to make the name of the
955 backup file. The default is quite unusual, because this avoids
956 accidentally overwriting existing files with a backup file. You might
957 prefer using ".bak", but make sure that you don't have files with
958 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000959 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000961 If you like to keep a lot of backups, you could use a BufWritePre
962 autocommand to change 'backupext' just before writing the file to
963 include a timestamp. >
964 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
965< Use 'backupdir' to put the backup in a different directory.
966
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967 *'backupskip'* *'bsk'*
968'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
969 global
970 {not in Vi}
971 {not available when compiled without the |+wildignore|
972 feature}
973 A list of file patterns. When one of the patterns matches with the
974 name of the file which is written, no backup file is created. Both
975 the specified file name and the full path name of the file are used.
976 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
977 Watch out for special characters, see |option-backslash|.
978 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
979 default value. "/tmp/*" is only used for Unix.
980
981 *'balloondelay'* *'bdlay'*
982'balloondelay' 'bdlay' number (default: 600)
983 global
984 {not in Vi}
985 {only available when compiled with the |+balloon_eval|
986 feature}
987 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
988
989 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
990'ballooneval' 'beval' boolean (default off)
991 global
992 {not in Vi}
993 {only available when compiled with the |+balloon_eval|
994 and |+sun_workshop| or |+netbeans_intg| features}
995 Switch on the |balloon-eval| functionality.
996
997 *'binary'* *'bin'* *'nobinary'* *'nobin'*
998'binary' 'bin' boolean (default off)
999 local to buffer
1000 {not in Vi}
1001 This option should be set before editing a binary file. You can also
1002 use the |-b| Vim argument. When this option is switched on a few
1003 options will be changed (also when it already was on):
1004 'textwidth' will be set to 0
1005 'wrapmargin' will be set to 0
1006 'modeline' will be off
1007 'expandtab' will be off
1008 Also, 'fileformat' and 'fileformats' options will not be used, the
1009 file is read and written like 'fileformat' was "unix" (a single <NL>
1010 separates lines).
1011 The 'fileencoding' and 'fileencodings' options will not be used, the
1012 file is read without conversion.
1013 NOTE: When you start editing a(nother) file while the 'bin' option is
1014 on, settings from autocommands may change the settings again (e.g.,
1015 'textwidth'), causing trouble when editing. You might want to set
1016 'bin' again when the file has been loaded.
1017 The previous values of these options are remembered and restored when
1018 'bin' is switched from on to off. Each buffer has its own set of
1019 saved option values.
1020 To edit a file with 'binary' set you can use the |++bin| argument.
1021 This avoids you have to do ":set bin", which would have effect for all
1022 files you edit.
1023 When writing a file the <EOL> for the last line is only written if
1024 there was one in the original file (normally Vim appends an <EOL> to
1025 the last line if there is none; this would make the file longer). See
1026 the 'endofline' option.
1027
1028 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1029'bioskey' 'biosk' boolean (default on)
1030 global
1031 {not in Vi} {only for MS-DOS}
1032 When on the bios is called to obtain a keyboard character. This works
1033 better to detect CTRL-C, but only works for the console. When using a
1034 terminal over a serial port reset this option.
1035 Also see |'conskey'|.
1036
1037 *'bomb'* *'nobomb'*
1038'bomb' boolean (default off)
1039 local to buffer
1040 {not in Vi}
1041 {only available when compiled with the |+multi_byte|
1042 feature}
1043 When writing a file and the following conditions are met, a BOM (Byte
1044 Order Mark) is prepended to the file:
1045 - this option is on
1046 - the 'binary' option is off
1047 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1048 endian variants.
1049 Some applications use the BOM to recognize the encoding of the file.
1050 Often used for UCS-2 files on MS-Windows. For other applications it
1051 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1052 appear halfway the resulting file.
1053 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1054 check for the presence of the BOM is done and 'bomb' set accordingly.
1055 Unless 'binary' is set, it is removed from the first line, so that you
1056 don't see it when editing. When you don't change the options, the BOM
1057 will be restored when writing the file.
1058
1059 *'breakat'* *'brk'*
1060'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1061 global
1062 {not in Vi}
1063 {not available when compiled without the |+linebreak|
1064 feature}
1065 This option lets you choose which characters might cause a line
1066 break if 'linebreak' is on.
1067
1068 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001069'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 global
1071 {not in Vi} {only for Motif and Win32 GUI}
1072 Which directory to use for the file browser:
1073 last Use same directory as with last file browser.
1074 buffer Use the directory of the related buffer.
1075 current Use the current directory.
1076 {path} Use the specified directory
1077
1078 *'bufhidden'* *'bh'*
1079'bufhidden' 'bh' string (default: "")
1080 local to buffer
1081 {not in Vi}
1082 {not available when compiled without the |+quickfix|
1083 feature}
1084 This option specifies what happens when a buffer is no longer
1085 displayed in a window:
1086 <empty> follow the global 'hidden' option
1087 hide hide the buffer (don't unload it), also when 'hidden'
1088 is not set
1089 unload unload the buffer, also when 'hidden' is set or using
1090 |:hide|
1091 delete delete the buffer from the buffer list, also when
1092 'hidden' is set or using |:hide|, like using
1093 |:bdelete|
1094 wipe wipe out the buffer from the buffer list, also when
1095 'hidden' is set or using |:hide|, like using
1096 |:bwipeout|
1097
1098 This option is used together with 'buftype' and 'swapfile' to specify
1099 special kinds of buffers. See |special-buffers|.
1100
1101 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1102'buflisted' 'bl' boolean (default: on)
1103 local to buffer
1104 {not in Vi}
1105 When this option is set, the buffer shows up in the buffer list. If
1106 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1107 This option is reset by Vim for buffers that are only used to remember
1108 a file name or marks. Vim sets it when starting to edit a buffer.
1109 But not when moving to a buffer with ":buffer".
1110
1111 *'buftype'* *'bt'* *E382*
1112'buftype' 'bt' string (default: "")
1113 local to buffer
1114 {not in Vi}
1115 {not available when compiled without the |+quickfix|
1116 feature}
1117 The value of this option specifies the type of a buffer:
1118 <empty> normal buffer
1119 nofile buffer which is not related to a file and will not be
1120 written
1121 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001122 acwrite buffer which will always be written with BufWriteCmd
1123 autocommands. {not available when compiled without the
1124 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 quickfix quickfix buffer, contains list of errors |:cwindow|
1126 help help buffer (you are not supposed to set this
1127 manually)
1128
1129 This option is used together with 'bufhidden' and 'swapfile' to
1130 specify special kinds of buffers. See |special-buffers|.
1131
1132 Be careful with changing this option, it can have many side effects!
1133
1134 A "quickfix" buffer is only used for the error list. This value is
1135 set by the |:cwindow| command and you are not supposed to change it.
1136
1137 "nofile" and "nowrite" buffers are similar:
1138 both: The buffer is not to be written to disk, ":w" doesn't
1139 work (":w filename" does work though).
1140 both: The buffer is never considered to be |'modified'|.
1141 There is no warning when the changes will be lost, for
1142 example when you quit Vim.
1143 both: A swap file is only created when using too much memory
1144 (when 'swapfile' has been reset there is never a swap
1145 file).
1146 nofile only: The buffer name is fixed, it is not handled like a
1147 file name. It is not modified in response to a |:cd|
1148 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001149 *E676*
1150 "acwrite" implies that the buffer name is not related to a file, like
1151 "nofile", but it will be written. Thus, in contrast to "nofile" and
1152 "nowrite", ":w" does work and a modified buffer can't be abandoned
1153 without saving. For writing there must be matching |BufWriteCmd|,
1154 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155
1156 *'casemap'* *'cmp'*
1157'casemap' 'cmp' string (default: "internal,keepascii")
1158 global
1159 {not in Vi}
1160 Specifies details about changing the case of letters. It may contain
1161 these words, separated by a comma:
1162 internal Use internal case mapping functions, the current
1163 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001164 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 "internal" is omitted, the towupper() and towlower()
1166 system library functions are used when available.
1167 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1168 case mapping, the current locale is not effective.
1169 This probably only matters for Turkish.
1170
1171 *'cdpath'* *'cd'* *E344* *E346*
1172'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1173 global
1174 {not in Vi}
1175 {not available when compiled without the
1176 |+file_in_path| feature}
1177 This is a list of directories which will be searched when using the
1178 |:cd| and |:lcd| commands, provided that the directory being searched
1179 for has a relative path (not starting with "/", "./" or "../").
1180 The 'cdpath' option's value has the same form and semantics as
1181 |'path'|. Also see |file-searching|.
1182 The default value is taken from $CDPATH, with a "," prepended to look
1183 in the current directory first.
1184 If the default value taken from $CDPATH is not what you want, include
1185 a modified version of the following command in your vimrc file to
1186 override it: >
1187 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1188< This option cannot be set from a |modeline| or in the |sandbox|, for
1189 security reasons.
1190 (parts of 'cdpath' can be passed to the shell to expand file names).
1191
1192 *'cedit'*
1193'cedit' string (Vi default: "", Vim default: CTRL-F)
1194 global
1195 {not in Vi}
1196 {not available when compiled without the |+vertsplit|
1197 feature}
1198 The key used in Command-line Mode to open the command-line window.
1199 The default is CTRL-F when 'compatible' is off.
1200 Only non-printable keys are allowed.
1201 The key can be specified as a single character, but it is difficult to
1202 type. The preferred way is to use the <> notation. Examples: >
1203 :set cedit=<C-Y>
1204 :set cedit=<Esc>
1205< |Nvi| also has this option, but it only uses the first character.
1206 See |cmdwin|.
1207
1208 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1209'charconvert' 'ccv' string (default "")
1210 global
1211 {only available when compiled with the |+multi_byte|
1212 feature and the |+eval| feature}
1213 {not in Vi}
1214 An expression that is used for character encoding conversion. It is
1215 evaluated when a file that is to be read or has been written has a
1216 different encoding from what is desired.
1217 'charconvert' is not used when the internal iconv() function is
1218 supported and is able to do the conversion. Using iconv() is
1219 preferred, because it is much faster.
1220 'charconvert' is not used when reading stdin |--|, because there is no
1221 file to convert from. You will have to save the text in a file first.
1222 The expression must return zero or an empty string for success,
1223 non-zero for failure.
1224 The possible encoding names encountered are in 'encoding'.
1225 Additionally, names given in 'fileencodings' and 'fileencoding' are
1226 used.
1227 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1228 is done internally by Vim, 'charconvert' is not used for this.
1229 'charconvert' is also used to convert the viminfo file, if the 'c'
1230 flag is present in 'viminfo'. Also used for Unicode conversion.
1231 Example: >
1232 set charconvert=CharConvert()
1233 fun CharConvert()
1234 system("recode "
1235 \ . v:charconvert_from . ".." . v:charconvert_to
1236 \ . " <" . v:fname_in . " >" v:fname_out)
1237 return v:shell_error
1238 endfun
1239< The related Vim variables are:
1240 v:charconvert_from name of the current encoding
1241 v:charconvert_to name of the desired encoding
1242 v:fname_in name of the input file
1243 v:fname_out name of the output file
1244 Note that v:fname_in and v:fname_out will never be the same.
1245 Note that v:charconvert_from and v:charconvert_to may be different
1246 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1247 Encryption is not done by Vim when using 'charconvert'. If you want
1248 to encrypt the file after conversion, 'charconvert' should take care
1249 of this.
1250 This option cannot be set from a |modeline| or in the |sandbox|, for
1251 security reasons.
1252
1253 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1254'cindent' 'cin' boolean (default off)
1255 local to buffer
1256 {not in Vi}
1257 {not available when compiled without the |+cindent|
1258 feature}
1259 Enables automatic C program indenting See 'cinkeys' to set the keys
1260 that trigger reindenting in insert mode and 'cinoptions' to set your
1261 preferred indent style.
1262 If 'indentexpr' is not empty, it overrules 'cindent'.
1263 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1264 the "=" operator indents using this algorithm rather than calling an
1265 external program.
1266 See |C-indenting|.
1267 When you don't like the way 'cindent' works, try the 'smartindent'
1268 option or 'indentexpr'.
1269 This option is not used when 'paste' is set.
1270 NOTE: This option is reset when 'compatible' is set.
1271
1272 *'cinkeys'* *'cink'*
1273'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1274 local to buffer
1275 {not in Vi}
1276 {not available when compiled without the |+cindent|
1277 feature}
1278 A list of keys that, when typed in Insert mode, cause reindenting of
1279 the current line. Only used if 'cindent' is on and 'indentexpr' is
1280 empty.
1281 For the format of this option see |cinkeys-format|.
1282 See |C-indenting|.
1283
1284 *'cinoptions'* *'cino'*
1285'cinoptions' 'cino' string (default "")
1286 local to buffer
1287 {not in Vi}
1288 {not available when compiled without the |+cindent|
1289 feature}
1290 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1291 program. See |cinoptions-values| for the values of this option, and
1292 |C-indenting| for info on C indenting in general.
1293
1294
1295 *'cinwords'* *'cinw'*
1296'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1297 local to buffer
1298 {not in Vi}
1299 {not available when compiled without both the
1300 |+cindent| and the |+smartindent| features}
1301 These keywords start an extra indent in the next line when
1302 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1303 an appropriate place (inside {}).
1304 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1305 matter, include the keyword both the uppercase and lowercase:
1306 "if,If,IF".
1307
1308 *'clipboard'* *'cb'*
1309'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1310 for X-windows, "" otherwise)
1311 global
1312 {not in Vi}
1313 {only in GUI versions or when the |+xterm_clipboard|
1314 feature is included}
1315 This option is a list of comma separated names.
1316 These names are recognized:
1317
1318 unnamed When included, Vim will use the clipboard register '*'
1319 for all yank, delete, change and put operations which
1320 would normally go to the unnamed register. When a
1321 register is explicitly specified, it will always be
1322 used regardless of whether "unnamed" is in 'clipboard'
1323 or not. The clipboard register can always be
1324 explicitly accessed using the "* notation. Also see
1325 |gui-clipboard|.
1326
1327 autoselect Works like the 'a' flag in 'guioptions': If present,
1328 then whenever Visual mode is started, or the Visual
1329 area extended, Vim tries to become the owner of the
1330 windowing system's global selection or put the
1331 selected text on the clipboard used by the selection
1332 register "*. See |guioptions_a| and |quotestar| for
1333 details. When the GUI is active, the 'a' flag in
1334 'guioptions' is used, when the GUI is not active, this
1335 "autoselect" flag is used.
1336 Also applies to the modeless selection.
1337
1338 autoselectml Like "autoselect", but for the modeless selection
1339 only. Compare to the 'A' flag in 'guioptions'.
1340
1341 exclude:{pattern}
1342 Defines a pattern that is matched against the name of
1343 the terminal 'term'. If there is a match, no
1344 connection will be made to the X server. This is
1345 useful in this situation:
1346 - Running Vim in a console.
1347 - $DISPLAY is set to start applications on another
1348 display.
1349 - You do not want to connect to the X server in the
1350 console, but do want this in a terminal emulator.
1351 To never connect to the X server use: >
1352 exclude:.*
1353< This has the same effect as using the |-X| argument.
1354 Note that when there is no connection to the X server
1355 the window title won't be restored and the clipboard
1356 cannot be accessed.
1357 The value of 'magic' is ignored, {pattern} is
1358 interpreted as if 'magic' was on.
1359 The rest of the option value will be used for
1360 {pattern}, this must be the last entry.
1361
1362 *'cmdheight'* *'ch'*
1363'cmdheight' 'ch' number (default 1)
1364 global
1365 {not in Vi}
1366 Number of screen lines to use for the command-line. Helps avoiding
1367 |hit-enter| prompts.
1368
1369 *'cmdwinheight'* *'cwh'*
1370'cmdwinheight' 'cwh' number (default 7)
1371 global
1372 {not in Vi}
1373 {not available when compiled without the |+vertsplit|
1374 feature}
1375 Number of screen lines to use for the command-line window. |cmdwin|
1376
1377 *'columns'* *'co'* *E594*
1378'columns' 'co' number (default 80 or terminal width)
1379 global
1380 {not in Vi}
1381 Number of columns of the screen. Normally this is set by the terminal
1382 initialization and does not have to be set by hand.
1383 When Vim is running in the GUI or in a resizable window, setting this
1384 option will cause the window size to be changed. When you only want
1385 to use the size for the GUI, put the command in your |gvimrc| file.
1386 When you set this option and Vim is unable to change the physical
1387 number of columns of the display, the display may be messed up.
1388
1389 *'comments'* *'com'* *E524* *E525*
1390'comments' 'com' string (default
1391 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1392 local to buffer
1393 {not in Vi}
1394 {not available when compiled without the |+comments|
1395 feature}
1396 A comma separated list of strings that can start a comment line. See
1397 |format-comments|. See |option-backslash| about using backslashes to
1398 insert a space.
1399
1400 *'commentstring'* *'cms'* *E537*
1401'commentstring' 'cms' string (default "/*%s*/")
1402 local to buffer
1403 {not in Vi}
1404 {not available when compiled without the |+folding|
1405 feature}
1406 A template for a comment. The "%s" in the value is replaced with the
1407 comment text. Currently only used to add markers for folding, see
1408 |fold-marker|.
1409
1410 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1411'compatible' 'cp' boolean (default on, off when a .vimrc file is found)
1412 global
1413 {not in Vi}
1414 This option has the effect of making Vim either more Vi-compatible, or
1415 make Vim behave in a more useful way.
1416 This is a special kind of option, because when it's set or reset,
1417 other options are also changed as a side effect. CAREFUL: Setting or
1418 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001419 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420 set this option in your vimrc file, you should probably put it at the
1421 very start.
1422 By default this option is on and the Vi defaults are used for the
1423 options. This default was chosen for those people who want to use Vim
1424 just like Vi, and don't even (want to) know about the 'compatible'
1425 option.
1426 When a ".vimrc" file is found while Vim is starting up, this option is
1427 switched off, and all options that have not been modified will be set
1428 to the Vim defaults. Effectively, this means that when a ".vimrc"
1429 file exists, Vim will use the Vim defaults, otherwise it will use the
1430 Vi defaults. (Note: This doesn't happen for the system-wide vimrc
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001431 file). Also see |compatible-default|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432 You can also set this option with the "-C" argument, and reset it with
1433 "-N". See |-C| and |-N|.
1434 Switching this option off makes the Vim defaults be used for options
1435 that have a different Vi and Vim default value. See the options
1436 marked with a '+' below. Other options are not modified.
1437 At the moment this option is set, several other options will be set
1438 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001439 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 editing.
1441 See also 'cpoptions'.
1442
1443 option + set value effect ~
1444
1445 'allowrevins' off no CTRL-_ command
1446 'backupcopy' Unix: "yes" backup file is a copy
1447 others: "auto" copy or rename backup file
1448 'backspace' "" normal backspace
1449 'backup' off no backup file
1450 'cindent' off no C code indentation
1451 'cedit' + "" no key to open the |cmdwin|
1452 'cpoptions' + (all flags) Vi-compatible flags
1453 'cscopetag' off don't use cscope for ":tag"
1454 'cscopetagorder' 0 see |cscopetagorder|
1455 'cscopeverbose' off see |cscopeverbose|
1456 'digraph' off no digraphs
1457 'esckeys' + off no <Esc>-keys in Insert mode
1458 'expandtab' off tabs not expanded to spaces
1459 'fileformats' + "" no automatic file format detection,
1460 "dos,unix" except for DOS, Windows and OS/2
1461 'formatoptions' + "vt" Vi compatible formatting
1462 'gdefault' off no default 'g' flag for ":s"
1463 'history' + 0 no commandline history
1464 'hkmap' off no Hebrew keyboard mapping
1465 'hkmapp' off no phonetic Hebrew keyboard mapping
1466 'hlsearch' off no highlighting of search matches
1467 'incsearch' off no incremental searching
1468 'indentexpr' "" no indenting by expression
1469 'insertmode' off do not start in Insert mode
1470 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1471 characters and '_'
1472 'joinspaces' on insert 2 spaces after period
1473 'modeline' + off no modelines
1474 'more' + off no pauses in listings
1475 'revins' off no reverse insert
1476 'ruler' off no ruler
1477 'scrolljump' 1 no jump scroll
1478 'scrolloff' 0 no scroll offset
1479 'shiftround' off indent not rounded to shiftwidth
1480 'shortmess' + "" no shortening of messages
1481 'showcmd' + off command characters not shown
1482 'showmode' + off current mode not shown
1483 'smartcase' off no automatic ignore case switch
1484 'smartindent' off no smart indentation
1485 'smarttab' off no smart tab size
1486 'softtabstop' 0 tabs are always 'tabstop' positions
1487 'startofline' on goto startofline with some commands
1488 'tagrelative' + off tag file names are not relative
1489 'textauto' + off no automatic textmode detection
1490 'textwidth' 0 no automatic line wrap
1491 'tildeop' off tilde is not an operator
1492 'ttimeout' off no terminal timeout
1493 'whichwrap' + "" left-right movements don't wrap
1494 'wildchar' + CTRL-E only when the current value is <Tab>
1495 use CTRL-E for cmdline completion
1496 'writebackup' on or off depends on +writebackup feature
1497
1498 *'complete'* *'cpt'* *E535*
1499'complete' 'cpt' string (default: ".,w,b,u,t,i")
1500 local to buffer
1501 {not in Vi}
1502 This option specifies how keyword completion |ins-completion| works
1503 when CTRL-P or CTRL-N are used. It is also used for whole-line
1504 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1505 and the places to scan. It is a comma separated list of flags:
1506 . scan the current buffer ('wrapscan' is ignored)
1507 w scan buffers from other windows
1508 b scan other loaded buffers that are in the buffer list
1509 u scan the unloaded buffers that are in the buffer list
1510 U scan the buffers that are not in the buffer list
1511 k scan the files given with the 'dictionary' option
1512 k{dict} scan the file {dict}. Several "k" flags can be given,
1513 patterns are valid too. For example: >
1514 :set cpt=k/usr/dict/*,k~/spanish
1515< s scan the files given with the 'thesaurus' option
1516 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1517 are valid too.
1518 i scan current and included files
1519 d scan current and included files for defined name or macro
1520 |i_CTRL-X_CTRL-D|
1521 ] tag completion
1522 t same as "]"
1523
1524 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1525 not executed, this may lead to unexpected completions from some files
1526 (gzipped files for example). Unloaded buffers are not scanned for
1527 whole-line completion.
1528
1529 The default is ".,w,b,u,t,i", which means to scan:
1530 1. the current buffer
1531 2. buffers in other windows
1532 3. other loaded buffers
1533 4. unloaded buffers
1534 5. tags
1535 6. included files
1536
1537 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1538 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1539 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1540
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001541 *'completefunc'* *'cfu'*
1542'completefunc' 'cfu' string (default: empty)
1543 local to buffer
1544 {not in Vi}
1545 This option specifies a completion function to be used for CTRL-X
1546 CTRL-X. The function will be invoked with four arguments:
1547 a:line the text of the current line
1548 a:base the text with which matches should match
1549 a:col column in a:line where the cursor is, first column is
1550 zero
1551 a:findstart either 1 or 0
1552 When the a:findstart argument is 1, the function must return the
1553 column of where the completion starts. It must be a number between
1554 zero and "a:col". This involves looking at the characters in a:line
1555 before column a:col and include those characters that could be part of
1556 the completed item.
1557 When the a:findstart argument is 0 the function must return a string
1558 with the matching words, separated by newlines. When there are no
1559 matches return an empty string.
1560 An example that completes the names of the months: >
1561 fun! CompleteMonths(line, base, col, findstart)
1562 if a:findstart
1563 " locate start column of word
1564 let start = a:col
1565 while start > 0 && a:line[start - 1] =~ '\a'
1566 let start = start - 1
1567 endwhile
1568 return start
1569 else
1570 " find months matching with "a:base"
1571 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1572 if a:base != ''
1573 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1574 endif
1575 let res = substitute(res, ' \+', "\n", 'g')
1576 return res
1577 endif
1578 endfun
1579 set completefunc=CompleteMonths
1580< Note that a substitute() function is used to reduce the list of
1581 possible values and remove the ones that don't match the base. The
1582 part before the "\|" matches the base, the part after it is used
1583 when there is no match. The "\2" in the replacement is empty if the
1584 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001585
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1587'confirm' 'cf' boolean (default off)
1588 global
1589 {not in Vi}
1590 When 'confirm' is on, certain operations that would normally
1591 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1592 instead raise a |dialog| asking if you wish to save the current
1593 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1594 If 'confirm' is off you can still activate confirmation for one
1595 command only (this is most useful in mappings) with the |:confirm|
1596 command.
1597 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1598
1599 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1600'conskey' 'consk' boolean (default off)
1601 global
1602 {not in Vi} {only for MS-DOS}
1603 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001604 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 three methods of console input are available:
1606 'conskey' 'bioskey' action ~
1607 on on or off direct console input
1608 off on BIOS
1609 off off STDIN
1610
1611 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1612'copyindent' 'ci' boolean (default off)
1613 local to buffer
1614 {not in Vi}
1615 Copy the structure of the existing lines indent when autoindenting a
1616 new line. Normally the new indent is reconstructed by a series of
1617 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1618 in which case only spaces are used). Enabling this option makes the
1619 new line copy whatever characters were used for indenting on the
1620 existing line. If the new indent is greater than on the existing
1621 line, the remaining space is filled in the normal manner.
1622 NOTE: 'copyindent' is reset when 'compatible' is set.
1623 Also see 'preserveindent'.
1624
1625 *'cpoptions'* *'cpo'*
1626'cpoptions' 'cpo' string (Vim default: "aABceFs",
1627 Vi default: all flags)
1628 global
1629 {not in Vi}
1630 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001631 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 not being vi-compatible is mostly or sometimes preferred.
1633 'cpoptions' stands for "compatible-options".
1634 Commas can be added for readability.
1635 To avoid problems with flags that are added in the future, use the
1636 "+=" and "-=" feature of ":set" |add-option-flags|.
1637 NOTE: This option is set to the Vi default value when 'compatible' is
1638 set and to the Vim default value when 'compatible' is reset.
1639
1640 contains behavior ~
1641 *cpo-a*
1642 a When included, a ":read" command with a file name
1643 argument will set the alternate file name for the
1644 current window.
1645 *cpo-A*
1646 A When included, a ":write" command with a file name
1647 argument will set the alternate file name for the
1648 current window.
1649 *cpo-b*
1650 b "\|" in a ":map" command is recognized as the end of
1651 the map command. The '\' is included in the mapping,
1652 the text after the '|' is interpreted as the next
1653 command. Use a CTRL-V instead of a backslash to
1654 include the '|' in the mapping. Applies to all
1655 mapping, abbreviation, menu and autocmd commands.
1656 See also |map_bar|.
1657 *cpo-B*
1658 B A backslash has no special meaning in mappings,
1659 abbreviations and the "to" part of the menu commands.
1660 Remove this flag to be able to use a backslash like a
1661 CTRL-V. For example, the command ":map X \<Esc>"
1662 results in X being mapped to:
1663 'B' included: "\^[" (^[ is a real <Esc>)
1664 'B' excluded: "<Esc>" (5 characters)
1665 ('<' excluded in both cases)
1666 *cpo-c*
1667 c Searching continues at the end of any match at the
1668 cursor position, but not further than the start of the
1669 next line. When not present searching continues
1670 one character from the cursor position. With 'c'
1671 "abababababab" only gets three matches when repeating
1672 "/abab", without 'c' there are five matches.
1673 *cpo-C*
1674 C Do not concatenate sourced lines that start with a
1675 backslash. See |line-continuation|.
1676 *cpo-d*
1677 d Using "./" in the 'tags' option doesn't mean to use
1678 the tags file relative to the current file, but the
1679 tags file in the current directory.
1680 *cpo-D*
1681 D Can't use CTRL-K to enter a digraph after Normal mode
1682 commands with a character argument, like |r|, |f| and
1683 |t|.
1684 *cpo-e*
1685 e When executing a register with ":@r", always add a
1686 <CR> to the last line, also when the register is not
1687 linewise. If this flag is not present, the register
1688 is not linewise and the last line does not end in a
1689 <CR>, then the last line is put on the command-line
1690 and can be edited before hitting <CR>.
1691 *cpo-E*
1692 E It is an error when using "y", "d", "c", "g~", "gu" or
1693 "gU" on an Empty region. The operators only work when
1694 at least one character is to be operate on. Example:
1695 This makes "y0" fail in the first column.
1696 *cpo-f*
1697 f When included, a ":read" command with a file name
1698 argument will set the file name for the current buffer,
1699 if the current buffer doesn't have a file name yet.
1700 *cpo-F*
1701 F When included, a ":write" command with a file name
1702 argument will set the file name for the current
1703 buffer, if the current buffer doesn't have a file name
1704 yet.
1705 *cpo-g*
1706 g Goto line 1 when using ":edit" without argument.
1707 *cpo-i*
1708 i When included, interrupting the reading of a file will
1709 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001710 *cpo-I*
1711 I When moving the cursor up or down just after inserting
1712 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 *cpo-j*
1714 j When joining lines, only add two spaces after a '.',
1715 not after '!' or '?'. Also see 'joinspaces'.
1716 *cpo-J*
1717 J A |sentence| has to be followed by two spaces after
1718 the '.', '!' or '?'. A <Tab> is not recognized as
1719 white space.
1720 *cpo-k*
1721 k Disable the recognition of raw key codes in
1722 mappings, abbreviations, and the "to" part of menu
1723 commands. For example, if <Key> sends ^[OA (where ^[
1724 is <Esc>), the command ":map X ^[OA" results in X
1725 being mapped to:
1726 'k' included: "^[OA" (3 characters)
1727 'k' excluded: "<Key>" (one key code)
1728 Also see the '<' flag below.
1729 *cpo-K*
1730 K Don't wait for a key code to complete when it is
1731 halfway a mapping. This breaks mapping <F1><F1> when
1732 only part of the second <F1> has been read. It
1733 enables cancelling the mapping by typing <F1><Esc>.
1734 *cpo-l*
1735 l Backslash in a [] range in a search pattern is taken
1736 literally, only "\]" is special See |/[]|
1737 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1738 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1739 *cpo-L*
1740 L When the 'list' option is set, 'wrapmargin',
1741 'textwidth', 'softtabstop' and Virtual Replace mode
1742 (see |gR|) count a <Tab> as two characters, instead of
1743 the normal behavior of a <Tab>.
1744 *cpo-m*
1745 m When included, a showmatch will always wait half a
1746 second. When not included, a showmatch will wait half
1747 a second or until a character is typed. |'showmatch'|
1748 *cpo-M*
1749 M When excluded, "%" matching will take backslashes into
1750 account. Thus in "( \( )" and "\( ( \)" the outer
1751 parenthesis match. When included "%" ignores
1752 backslashes, which is Vi compatible.
1753 *cpo-n*
1754 n When included, the column used for 'number' will also
1755 be used for text of wrapped lines.
1756 *cpo-o*
1757 o Line offset to search command is not remembered for
1758 next search.
1759 *cpo-O*
1760 O Don't complain if a file is being overwritten, even
1761 when it didn't exist when editing it. This is a
1762 protection against a file unexpectedly created by
1763 someone else. Vi didn't complain about this.
1764 *cpo-p*
1765 p Vi compatible Lisp indenting. When not present, a
1766 slightly better algorithm is used.
1767 *cpo-r*
1768 r Redo ("." command) uses "/" to repeat a search
1769 command, instead of the actually used search string.
1770 *cpo-R*
1771 R Remove marks from filtered lines. Without this flag
1772 marks are kept like |:keepmarks| was used.
1773 *cpo-s*
1774 s Set buffer options when entering the buffer for the
1775 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001776 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 set when the buffer is created.
1778 *cpo-S*
1779 S Set buffer options always when entering a buffer
1780 (except 'readonly', 'fileformat', 'filetype' and
1781 'syntax'). This is the (most) Vi compatible setting.
1782 The options are set to the values in the current
1783 buffer. When you change an option and go to another
1784 buffer, the value is copied. Effectively makes the
1785 buffer options global to all buffers.
1786
1787 's' 'S' copy buffer options
1788 no no when buffer created
1789 yes no when buffer first entered (default)
1790 X yes each time when buffer entered (vi comp.)
1791 *cpo-t*
1792 t Search pattern for the tag command is remembered for
1793 "n" command. Otherwise Vim only puts the pattern in
1794 the history for search pattern, but doesn't change the
1795 last used search pattern.
1796 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001797 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 *cpo-v*
1799 v Backspaced characters remain visible on the screen in
1800 Insert mode. Without this flag the characters are
1801 erased from the screen right away. With this flag the
1802 screen newly typed text overwrites backspaced
1803 characters.
1804 *cpo-w*
1805 w When using "cw" on a blank character, only change one
1806 character and not all blanks until the start of the
1807 next word.
1808 *cpo-W*
1809 W Don't overwrite a readonly file. When omitted, ":w!"
1810 overwrites a readonly file, if possible.
1811 *cpo-x*
1812 x <Esc> on the command-line executes the command-line.
1813 The default in Vim is to abandon the command-line,
1814 because <Esc> normally aborts a command. |c_<Esc>|
1815 *cpo-y*
1816 y A yank command can be redone with ".".
1817 *cpo-!*
1818 ! When redoing a filter command, use the last used
1819 external command, whatever it was. Otherwise the last
1820 used -filter- command is used.
1821 *cpo-$*
1822 $ When making a change to one line, don't redisplay the
1823 line, but put a '$' at the end of the changed text.
1824 The changed text will be overwritten when you type the
1825 new text. The line is redisplayed if you type any
1826 command that moves the cursor from the insertion
1827 point.
1828 *cpo-%*
1829 % Vi-compatible matching is done for the "%" command.
1830 Does not recognize "#if", "#endif", etc.
1831 Does not recognize "/*" and "*/".
1832 Parens inside single and double quotes are also
1833 counted, causing a string that contains a paren to
1834 disturb the matching. For example, in a line like
1835 "if (strcmp("foo(", s))" the first paren does not
1836 match the last one. When this flag is not included,
1837 parens inside single and double quotes are treated
1838 specially. When matching a paren outside of quotes,
1839 everything inside quotes is ignored. When matching a
1840 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001841 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001842 This flag is also used for other features, such as
1843 C-indenting.
1844 cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 * Use ":*" in the same way as ":@". When not included,
1846 ":*" is an alias for ":'<,'>", select the Visual area.
1847 *cpo-<*
1848 < Disable the recognition of special key codes in |<>|
1849 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001850 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 ":map X <Tab>" results in X being mapped to:
1852 '<' included: "<Tab>" (5 characters)
1853 '<' excluded: "^I" (^I is a real <Tab>)
1854 Also see the 'k' flag above.
1855
1856 *'cscopepathcomp'* *'cspc'*
1857'cscopepathcomp' 'cspc' number (default 0)
1858 global
1859 {not available when compiled without the |+cscope|
1860 feature}
1861 {not in Vi}
1862 Determines how many components of the path to show in a list of tags.
1863 See |cscopepathcomp|.
1864
1865 *'cscopeprg'* *'csprg'*
1866'cscopeprg' 'csprg' string (default "cscope")
1867 global
1868 {not available when compiled without the |+cscope|
1869 feature}
1870 {not in Vi}
1871 Specifies the command to execute cscope. See |cscopeprg|.
1872 This option cannot be set from a |modeline| or in the |sandbox|, for
1873 security reasons.
1874
1875 *'cscopequickfix'* *'csqf'*
1876'cscopequickfix' 'csqf' string (default "")
1877 global
1878 {not available when compiled without the |+cscope|
1879 or |+quickfix| features}
1880 {not in Vi}
1881 Specifies whether to use quickfix window to show cscope results.
1882 See |cscopequickfix|.
1883
1884 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1885'cscopetag' 'cst' boolean (default off)
1886 global
1887 {not available when compiled without the |+cscope|
1888 feature}
1889 {not in Vi}
1890 Use cscope for tag commands. See |cscope-options|.
1891 NOTE: This option is reset when 'compatible' is set.
1892
1893 *'cscopetagorder'* *'csto'*
1894'cscopetagorder' 'csto' number (default 0)
1895 global
1896 {not available when compiled without the |+cscope|
1897 feature}
1898 {not in Vi}
1899 Determines the order in which ":cstag" performs a search. See
1900 |cscopetagorder|.
1901 NOTE: This option is set to 0 when 'compatible' is set.
1902
1903 *'cscopeverbose'* *'csverb'*
1904 *'nocscopeverbose'* *'nocsverb'*
1905'cscopeverbose' 'csverb' boolean (default off)
1906 global
1907 {not available when compiled without the |+cscope|
1908 feature}
1909 {not in Vi}
1910 Give messages when adding a cscope database. See |cscopeverbose|.
1911 NOTE: This option is reset when 'compatible' is set.
1912
1913 *'debug'*
1914'debug' string (default "")
1915 global
1916 {not in Vi}
1917 When set to "msg", error messages that would otherwise be omitted will
1918 be given anyway. This is useful when debugging 'foldexpr' or
1919 'indentexpr'.
1920
1921 *'define'* *'def'*
1922'define' 'def' string (default "^\s*#\s*define")
1923 global or local to buffer |global-local|
1924 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001925 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 pattern, just like for the "/" command. This option is used for the
1927 commands like "[i" and "[d" |include-search|. The 'isident' option is
1928 used to recognize the defined name after the match:
1929 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
1930 See |option-backslash| about inserting backslashes to include a space
1931 or backslash.
1932 The default value is for C programs. For C++ this value would be
1933 useful, to include const type declarations: >
1934 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
1935< When using the ":set" command, you need to double the backslashes!
1936
1937 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
1938'delcombine' 'deco' boolean (default off)
1939 global
1940 {not in Vi}
1941 {only available when compiled with the |+multi_byte|
1942 feature}
1943 If editing Unicode and this option is set, backspace and Normal mode
1944 "x" delete each combining character on its own. When it is off (the
1945 default) the character along with its combining characters are
1946 deleted.
1947 Note: When 'delcombine' is set "xx" may work different from "2x"!
1948
1949 This is useful for Arabic, Hebrew and many other languages where one
1950 may have combining characters overtop of base characters, and want
1951 to remove only the combining ones.
1952
1953 *'dictionary'* *'dict'*
1954'dictionary' 'dict' string (default "")
1955 global or local to buffer |global-local|
1956 {not in Vi}
1957 List of file names, separated by commas, that are used to lookup words
1958 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
1959 contain a list of words. This can be one word per line, or several
1960 words per line, separated by non-keyword characters (white space is
1961 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001962 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 after a comma are ignored, otherwise spaces are included in the file
1964 name. See |option-backslash| about using backslashes.
1965 Where to find a list of words?
1966 - On FreeBSD, there is the file "/usr/share/dict/words".
1967 - In the Simtel archive, look in the "msdos/linguist" directory.
1968 - In "miscfiles" of the GNU collection.
1969 The use of |:set+=| and |:set-=| is preferred when adding or removing
1970 directories from the list. This avoids problems when a future version
1971 uses another default.
1972 Backticks cannot be used in this option for security reasons.
1973
1974 *'diff'* *'nodiff'*
1975'diff' boolean (default off)
1976 local to window
1977 {not in Vi}
1978 {not available when compiled without the |+diff|
1979 feature}
1980 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001981 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
1983 *'dex'* *'diffexpr'*
1984'diffexpr' 'dex' string (default "")
1985 global
1986 {not in Vi}
1987 {not available when compiled without the |+diff|
1988 feature}
1989 Expression which is evaluated to obtain an ed-style diff file from two
1990 versions of a file. See |diff-diffexpr|.
1991 This option cannot be set from a |modeline| or in the |sandbox|, for
1992 security reasons.
1993
1994 *'dip'* *'diffopt'*
1995'diffopt' 'dip' string (default "filler")
1996 global
1997 {not in Vi}
1998 {not available when compiled without the |+diff|
1999 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002000 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 All are optional. Items must be separated by a comma.
2002
2003 filler Show filler lines, to keep the text
2004 synchronized with a window that has inserted
2005 lines at the same position. Mostly useful
2006 when windows are side-by-side and 'scrollbind'
2007 is set.
2008
2009 context:{n} Use a context of {n} lines between a change
2010 and a fold that contains unchanged lines.
2011 When omitted a context of six lines is used.
2012 See |fold-diff|.
2013
2014 icase Ignore changes in case of text. "a" and "A"
2015 are considered the same. Adds the "-i" flag
2016 to the "diff" command if 'diffexpr' is empty.
2017
2018 iwhite Ignore changes in amount of white space. Adds
2019 the "-b" flag to the "diff" command if
2020 'diffexpr' is empty. Check the documentation
2021 of the "diff" command for what this does
2022 exactly. It should ignore adding trailing
2023 white space, but not leading white space.
2024
2025 Examples: >
2026
2027 :set diffopt=filler,context:4
2028 :set diffopt=
2029 :set diffopt=filler
2030<
2031 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2032'digraph' 'dg' boolean (default off)
2033 global
2034 {not in Vi}
2035 {not available when compiled without the |+digraphs|
2036 feature}
2037 Enable the entering of digraphs in Insert mode with {char1} <BS>
2038 {char2}. See |digraphs|.
2039 NOTE: This option is reset when 'compatible' is set.
2040
2041 *'directory'* *'dir'*
2042'directory' 'dir' string (default for Amiga: ".,t:",
2043 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2044 for Unix: ".,~/tmp,/var/tmp,/tmp")
2045 global
2046 List of directory names for the swap file, separated with commas.
2047 - The swap file will be created in the first directory where this is
2048 possible.
2049 - Empty means that no swap file will be used (recovery is
2050 impossible!).
2051 - A directory "." means to put the swap file in the same directory as
2052 the edited file. On Unix, a dot is prepended to the file name, so
2053 it doesn't show in a directory listing. On MS-Windows the "hidden"
2054 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002055 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 put the swap file relative to where the edited file is. The leading
2057 "." is replaced with the path name of the edited file.
2058 - For Unix and Win32, if a directory ends in two path separators, the
2059 swap file name will be built from the complete path to the file
2060 with all path separators substituted to percent '%' signs. This will
2061 ensure file name uniqueness in the preserve directory.
2062 - Spaces after the comma are ignored, other spaces are considered part
2063 of the directory name. To have a space at the start of a directory
2064 name, precede it with a backslash.
2065 - To include a comma in a directory name precede it with a backslash.
2066 - A directory name may end in an ':' or '/'.
2067 - Environment variables are expanded |:set_env|.
2068 - Careful with '\' characters, type one before a space, type two to
2069 get one in the option (see |option-backslash|), for example: >
2070 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2071< - For backwards compatibility with Vim version 3.0 a '>' at the start
2072 of the option is removed.
2073 Using "." first in the list is recommended. This means that editing
2074 the same file twice will result in a warning. Using "/tmp" on Unix is
2075 discouraged: When the system crashes you lose the swap file.
2076 "/var/tmp" is often not cleared when rebooting, thus is a better
2077 choice than "/tmp". But it can contain a lot of files, your swap
2078 files get lost in the crowd. That is why a "tmp" directory in your
2079 home directory is tried first.
2080 The use of |:set+=| and |:set-=| is preferred when adding or removing
2081 directories from the list. This avoids problems when a future version
2082 uses another default.
2083 This option cannot be set from a |modeline| or in the |sandbox|, for
2084 security reasons.
2085 {Vi: directory to put temp file in, defaults to "/tmp"}
2086
2087 *'display'* *'dy'*
2088'display' 'dy' string (default "")
2089 global
2090 {not in Vi}
2091 Change the way text is displayed. This is comma separated list of
2092 flags:
2093 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002094 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 last line that doesn't fit is replaced with "@" lines.
2096 uhex Show unprintable characters hexadecimal as <xx>
2097 instead of using ^C and ~C.
2098
2099 *'eadirection'* *'ead'*
2100'eadirection' 'ead' string (default "both")
2101 global
2102 {not in Vi}
2103 {not available when compiled without the +vertsplit
2104 feature}
2105 Tells when the 'equalalways' option applies:
2106 ver vertically, width of windows is not affected
2107 hor horizontally, height of windows is not affected
2108 both width and height of windows is affected
2109
2110 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2111'edcompatible' 'ed' boolean (default off)
2112 global
2113 Makes the 'g' and 'c' flags of the ":substitute" command to be
2114 toggled each time the flag is given. See |complex-change|. See
2115 also 'gdefault' option.
2116 Switching this option on is discouraged!
2117
2118 *'encoding'* *'enc'* *E543*
2119'encoding' 'enc' string (default: "latin1" or value from $LANG)
2120 global
2121 {only available when compiled with the |+multi_byte|
2122 feature}
2123 {not in Vi}
2124 Sets the character encoding used inside Vim. It applies to text in
2125 the buffers, registers, Strings in expressions, text stored in the
2126 viminfo file, etc. It sets the kind of characters which Vim can work
2127 with. See |encoding-names| for the possible values.
2128
2129 NOTE: Changing this option will not change the encoding of the
2130 existing text in Vim. It may cause multi-byte text to become invalid.
2131 It should normally be kept at its default value, or set when Vim
2132 starts up. See |multibyte|.
2133
2134 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2135 "utf-8". Although care has been taken to allow different values of
2136 'encoding', "utf-8" is the natural choice for the environment and
2137 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 versions, and to avoid changing the encoding of newly created files
2140 without your knowledge (in case 'fileencodings' is empty).
2141
2142 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002143 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002144 iconv() or as specified with 'charconvert'.
2145
2146 Normally 'encoding' will be equal to your current locale. This will
2147 be the default if Vim recognizes your environment settings. If
2148 'encoding' is not set to the current locale, 'termencoding' must be
2149 set to convert typed and displayed text. See |encoding-table|.
2150
2151 When you set this option, it fires the |EncodingChanged| autocommand
2152 event so that you can set up fonts if necessary.
2153
2154 When the option is set, the value is converted to lowercase. Thus
2155 you can set it with uppercase values too. Underscores are translated
2156 to '-' signs.
2157 When the encoding is recognized, it is changed to the standard name.
2158 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2159 "iso-8859-2" and "utf8" becomes "utf-8".
2160
2161 Note: "latin1" is also used when the encoding could not be detected.
2162 This only works when editing files in the same encoding! When the
2163 actual character set is not latin1, make sure 'fileencoding' and
2164 'fileencodings' are empty. When conversion is needed, switch to using
2165 utf-8.
2166
2167 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2168 You don't notice this while editing, but it does matter for the
2169 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2170 setting 'encoding' to one of these values instead of utf-8 only has
2171 effect for encoding used for files when 'fileencoding' is empty.
2172
2173 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2174 not set yet, the default for 'fileencodings' is changed.
2175
2176 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2177'endofline' 'eol' boolean (default on)
2178 local to buffer
2179 {not in Vi}
2180 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002181 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 option is automatically set when starting to edit a new file, unless
2183 the file does not have an <EOL> for the last line in the file, in
2184 which case it is reset. Normally you don't have to set or reset this
2185 option. When 'binary' is off the value is not used when writing the
2186 file. When 'binary' is on it is used to remember the presence of a
2187 <EOL> for the last line in the file, so that when you write the file
2188 the situation from the original file can be kept. But you can change
2189 it if you want to.
2190
2191 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2192'equalalways' 'ea' boolean (default on)
2193 global
2194 {not in Vi}
2195 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002196 splitting or closing a window. This also happens the moment the
2197 option is switched on. When off, splitting a window will reduce the
2198 size of the current window and leave the other windows the same. When
2199 closing a window the extra lines are given to the window next to it
2200 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 When mixing vertically and horizontally split windows, a minimal size
2202 is computed and some windows may be larger if there is room. The
2203 'eadirection' option tells in which direction the size is affected.
2204 Changing the height of a window can be avoided by setting
2205 'winfixheight'.
2206
2207 *'equalprg'* *'ep'*
2208'equalprg' 'ep' string (default "")
2209 global or local to buffer |global-local|
2210 {not in Vi}
2211 External program to use for "=" command. When this option is empty
2212 the internal formatting functions are used ('lisp', 'cindent' or
2213 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002214 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 about including spaces and backslashes.
2216 This option cannot be set from a |modeline| or in the |sandbox|, for
2217 security reasons.
2218
2219 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2220'errorbells' 'eb' boolean (default off)
2221 global
2222 Ring the bell (beep or screen flash) for error messages. This only
2223 makes a difference for error messages, the bell will be used always
2224 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002225 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 screen flash or do nothing.
2227
2228 *'errorfile'* *'ef'*
2229'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2230 others: "errors.err")
2231 global
2232 {not in Vi}
2233 {not available when compiled without the |+quickfix|
2234 feature}
2235 Name of the errorfile for the QuickFix mode (see |:cf|).
2236 When the "-q" command-line argument is used, 'errorfile' is set to the
2237 following argument. See |-q|.
2238 NOT used for the ":make" command. See 'makeef' for that.
2239 Environment variables are expanded |:set_env|.
2240 See |option-backslash| about including spaces and backslashes.
2241 This option cannot be set from a |modeline| or in the |sandbox|, for
2242 security reasons.
2243
2244 *'errorformat'* *'efm'*
2245'errorformat' 'efm' string (default is very long)
2246 global or local to buffer |global-local|
2247 {not in Vi}
2248 {not available when compiled without the |+quickfix|
2249 feature}
2250 Scanf-like description of the format for the lines in the error file
2251 (see |errorformat|).
2252
2253 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2254'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2255 global
2256 {not in Vi}
2257 Function keys that start with an <Esc> are recognized in Insert
2258 mode. When this option is off, the cursor and function keys cannot be
2259 used in Insert mode if they start with an <Esc>. The advantage of
2260 this is that the single <Esc> is recognized immediately, instead of
2261 after one second. Instead of resetting this option, you might want to
2262 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2263 when 'esckeys' is off, you can still map anything, but the cursor keys
2264 won't work by default.
2265 NOTE: This option is set to the Vi default value when 'compatible' is
2266 set and to the Vim default value when 'compatible' is reset.
2267
2268 *'eventignore'* *'ei'*
2269'eventignore' 'ei' string (default "")
2270 global
2271 {not in Vi}
2272 {not available when compiled without the |+autocmd|
2273 feature}
2274 A list of autocommand event names, which are to be ignored.
2275 When set to "all", all autocommand events are ignored, autocommands
2276 will not be executed.
2277 Otherwise this is a comma separated list of event names. Example: >
2278 :set ei=WinEnter,WinLeave
2279<
2280 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2281'expandtab' 'et' boolean (default off)
2282 local to buffer
2283 {not in Vi}
2284 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002285 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2287 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2288 NOTE: This option is reset when 'compatible' is set.
2289
2290 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2291'exrc' 'ex' boolean (default off)
2292 global
2293 {not in Vi}
2294 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2295 directory. If you switch this option on you should also consider
2296 setting the 'secure' option (see |initialization|). Using a local
2297 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2298 also see |.vimrc| and |gui-init|.
2299 This option cannot be set from a |modeline| or in the |sandbox|, for
2300 security reasons.
2301
2302 *'fileencoding'* *'fenc'* *E213*
2303'fileencoding' 'fenc' string (default: "")
2304 local to buffer
2305 {only available when compiled with the |+multi_byte|
2306 feature}
2307 {not in Vi}
2308 Sets the character encoding for the file of this buffer.
2309 When 'fileencoding' is different from 'encoding', conversion will be
2310 done when reading and writing the file.
2311 When 'fileencoding' is empty, the same value as 'encoding' will be
2312 used (no conversion when reading or writing a file).
2313 WARNING: Conversion can cause loss of information! When
2314 'encoding' is "utf-8" conversion is most likely done in a way
2315 that the reverse conversion results in the same text. When
2316 'encoding' is not "utf-8" some characters may be lost!
2317 See 'encoding' for the possible values. Additionally, values may be
2318 specified that can be handled by the converter, see
2319 |mbyte-conversion|.
2320 When reading a file 'fileencoding' will be set from 'fileencodings'.
2321 To read a file in a certain encoding it won't work by setting
2322 'fileencoding', use the |++enc| argument.
2323 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2324 When the option is set, the value is converted to lowercase. Thus
2325 you can set it with uppercase values too. '_' characters are
2326 replaced with '-'. If a name is recognized from the list for
2327 'encoding', it is replaced by the standard name. For example
2328 "ISO8859-2" becomes "iso-8859-2".
2329 When this option is set, after starting to edit a file, the 'modified'
2330 option is set, because the file would be different when written.
2331 If you do this in a modeline, you might want to set 'nomodified' to
2332 avoid this.
2333 This option can not be changed when 'modifiable' is off.
2334
2335 *'fe'*
2336 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002337 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 old short name was 'fe', which is no longer used.
2339
2340 *'fileencodings'* *'fencs'*
2341'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
2342 when 'encoding' is set to a Unicode value)
2343 global
2344 {only available when compiled with the |+multi_byte|
2345 feature}
2346 {not in Vi}
2347 This is a list of character encodings considered when starting to edit
2348 an existing file. When a file is read, Vim tries to use the first
2349 mentioned character encoding. If an error is detected, the next one
2350 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002351 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002352 an empty string, which means the value of 'encoding' is used.
2353 WARNING: Conversion can cause loss of information! When
2354 'encoding' is "utf-8" (or one of the other Unicode variants)
2355 conversion is most likely done in a way that the reverse
2356 conversion results in the same text. When 'encoding' is not
2357 "utf-8" special characters may be lost!
2358 For an empty file or a file with only ASCII characters most encodings
2359 will work and the first entry of 'fileencodings' will be used (except
2360 "ucs-bom", which requires the BOM to be present). If you prefer
2361 another encoding use an BufReadPost autocommand event to test if your
2362 preferred encoding is to be used. Example: >
2363 au BufReadPost * if search('\S', 'w') == 0 |
2364 \ set fenc=iso-2022-jp | endif
2365< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2366 non-blank characters.
2367 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2368 is always empty then. This means that a non-existing file may get a
2369 different encoding than an empty file.
2370 The special value "ucs-bom" can be used to check for a Unicode BOM
2371 (Byte Order Mark) at the start of the file. It must not be preceded
2372 by "utf-8" or another Unicode encoding for this to work properly.
2373 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2374 because Vim cannot detect an error, thus the encoding is always
2375 accepted.
2376 WRONG VALUES: WHAT'S WRONG:
2377 latin1,utf-8 "latin1" will always be used
2378 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2379 file
2380 cp1250,latin1 "cp1250" will always be used
2381 If 'fileencodings' is empty, 'fileencoding' is not modified.
2382 See 'fileencoding' for the possible values.
2383 Setting this option does not have an effect until the next time a file
2384 is read.
2385
2386 *'fileformat'* *'ff'*
2387'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2388 Unix default: "unix",
2389 Macintosh default: "mac")
2390 local to buffer
2391 {not in Vi}
2392 This gives the <EOL> of the current buffer, which is used for
2393 reading/writing the buffer from/to a file:
2394 dos <CR> <NL>
2395 unix <NL>
2396 mac <CR>
2397 When "dos" is used, CTRL-Z at the end of a file is ignored.
2398 See |file-formats| and |file-read|.
2399 For the character encoding of the file see 'fileencoding'.
2400 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2401 works like it was set to "unix'.
2402 This option is set automatically when starting to edit a file and
2403 'fileformats' is not empty and 'binary' is off.
2404 When this option is set, after starting to edit a file, the 'modified'
2405 option is set, because the file would be different when written.
2406 This option can not be changed when 'modifiable' is off.
2407 For backwards compatibility: When this option is set to "dos",
2408 'textmode' is set, otherwise 'textmode' is reset.
2409
2410 *'fileformats'* *'ffs'*
2411'fileformats' 'ffs' string (default:
2412 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2413 Vim Unix: "unix,dos",
2414 Vim Mac: "mac,unix,dos",
2415 Vi Cygwin: "unix,dos",
2416 Vi others: "")
2417 global
2418 {not in Vi}
2419 This gives the end-of-line (<EOL>) formats that will be tried when
2420 starting to edit a new buffer and when reading a file into an existing
2421 buffer:
2422 - When empty, the format defined with 'fileformat' will be used
2423 always. It is not set automatically.
2424 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002425 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 'fileformats' name will be used when a file is read into an existing
2427 buffer, no matter what 'fileformat' for that buffer is set to.
2428 - When more than one name is present, separated by commas, automatic
2429 <EOL> detection will be done when reading a file. When starting to
2430 edit a file, a check is done for the <EOL>:
2431 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2432 'fileformat' is set to "dos".
2433 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002434 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 preceding <CR>, "unix" is preferred over "dos".
2436 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2437 This means that "mac" is only chosen when "unix" is not present,
2438 or when no <NL> is found in the file, and when "dos" is not
2439 present, or no <CR><NL> is present in the file.
2440 Also if "unix" was first chosen, but the first <CR> is before
2441 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2442 the file, then 'fileformat' is set to "mac".
2443 4. If 'fileformat' is still not set, the first name from
2444 'fileformats' is used.
2445 When reading a file into an existing buffer, the same is done, but
2446 this happens like 'fileformat' has been set appropriately for that
2447 file only, the option is not changed.
2448 When 'binary' is set, the value of 'fileformats' is not used.
2449
2450 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2451 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2452 done:
2453 - When 'fileformats' is empty, there is no automatic detection. Dos
2454 format will be used.
2455 - When 'fileformats' is set to one or more names, automatic detection
2456 is done. This is based on the first <NL> in the file: If there is a
2457 <CR> in front of it, Dos format is used, otherwise Unix format is
2458 used.
2459 Also see |file-formats|.
2460 For backwards compatibility: When this option is set to an empty
2461 string or one format (no comma is included), 'textauto' is reset,
2462 otherwise 'textauto' is set.
2463 NOTE: This option is set to the Vi default value when 'compatible' is
2464 set and to the Vim default value when 'compatible' is reset.
2465
2466 *'filetype'* *'ft'*
2467'filetype' 'ft' string (default: "")
2468 local to buffer
2469 {not in Vi}
2470 {not available when compiled without the |+autocmd|
2471 feature}
2472 When this option is set, the FileType autocommand event is triggered.
2473 All autocommands that match with the value of this option will be
2474 executed. Thus the value of 'filetype' is used in place of the file
2475 name.
2476 Otherwise this option does not always reflect the current file type.
2477 This option is normally set when the file type is detected. To enable
2478 this use the ":filetype on" command. |:filetype|
2479 Setting this option to a different value is most useful in a modeline,
2480 for a file for which the file type is not automatically recognized.
2481 Example, for in an IDL file: >
2482 /* vim: set filetype=idl : */
2483< |FileType| |filetypes|
2484 Do not confuse this option with 'osfiletype', which is for the file
2485 type that is actually stored with the file.
2486 This option is not copied to another buffer, independent of the 's' or
2487 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002488 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489
2490 *'fillchars'* *'fcs'*
2491'fillchars' 'fcs' string (default "vert:|,fold:-")
2492 global
2493 {not in Vi}
2494 {not available when compiled without the |+windows|
2495 and |+folding| features}
2496 Characters to fill the statuslines and vertical separators.
2497 It is a comma separated list of items:
2498
2499 item default Used for ~
2500 stl:c ' ' or '^' statusline of the current window
2501 stlnc:c ' ' or '-' statusline of the non-current windows
2502 vert:c '|' vertical separators |:vsplit|
2503 fold:c '-' filling 'foldtext'
2504 diff:c '-' deleted lines of the 'diff' option
2505
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002506 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 "stlnc" the space will be used when there is highlighting, '^' or '-'
2508 otherwise.
2509
2510 Example: >
2511 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2512< This is similar to the default, except that these characters will also
2513 be used when there is highlighting.
2514
2515 The highlighting used for these items:
2516 item highlight group ~
2517 stl:c StatusLine |hl-StatusLine|
2518 stlnc:c StatusLineNC |hl-StatusLineNC|
2519 vert:c VertSplit |hl-VertSplit|
2520 fold:c Folded |hl-Folded|
2521 diff:c DiffDelete |hl-DiffDelete|
2522
2523 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2524'fkmap' 'fk' boolean (default off) *E198*
2525 global
2526 {not in Vi}
2527 {only available when compiled with the |+rightleft|
2528 feature}
2529 When on, the keyboard is mapped for the Farsi character set.
2530 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002531 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532
2533 *'foldclose'* *'fcl'*
2534'foldclose' 'fcl' string (default "")
2535 global
2536 {not in Vi}
2537 {not available when compiled without the |+folding|
2538 feature}
2539 When set to "all", a fold is closed when the cursor isn't in it and
2540 its level is higher than 'foldlevel'. Useful if you want folds to
2541 automatically close when moving out of them.
2542
2543 *'foldcolumn'* *'fdc'*
2544'foldcolumn' 'fdc' number (default 0)
2545 local to window
2546 {not in Vi}
2547 {not available when compiled without the |+folding|
2548 feature}
2549 When non-zero, a column with the specified width is shown at the side
2550 of the window which indicates open and closed folds. The maximum
2551 value is 12.
2552 See |folding|.
2553
2554 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2555'foldenable' 'fen' boolean (default on)
2556 local to window
2557 {not in Vi}
2558 {not available when compiled without the |+folding|
2559 feature}
2560 When off, all folds are open. This option can be used to quickly
2561 switch between showing all text unfolded and viewing the text with
2562 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002563 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 'foldenable' is off.
2565 This option is set by commands that create a new fold or close a fold.
2566 See |folding|.
2567
2568 *'foldexpr'* *'fde'*
2569'foldexpr' 'fde' string (default: "0")
2570 local to window
2571 {not in Vi}
2572 {not available when compiled without the |+folding|
2573 or |+eval| feature}
2574 The expression used for when 'foldmethod' is "expr". It is evaluated
2575 for each line to obtain its fold level. See |fold-expr|. Also see
2576 |eval-sandbox|.
2577
2578 *'foldignore'* *'fdi'*
2579'foldignore' 'fdi' string (default: "#")
2580 local to window
2581 {not in Vi}
2582 {not available when compiled without the |+folding|
2583 feature}
2584 Used only when 'foldmethod' is "indent". Lines starting with
2585 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 The default "#" works well for C programs. See |fold-indent|.
2588
2589 *'foldlevel'* *'fdl'*
2590'foldlevel' 'fdl' number (default: 0)
2591 local to window
2592 {not in Vi}
2593 {not available when compiled without the |+folding|
2594 feature}
2595 Sets the fold level: Folds with a higher level will be closed.
2596 Setting this option to zero will close all folds. Higher numbers will
2597 close fewer folds.
2598 This option is set by commands like |zm|, |zM| and |zR|.
2599 See |fold-foldlevel|.
2600
2601 *'foldlevelstart'* *'fdls'*
2602'foldlevelstart' 'fdls' number (default: -1)
2603 global
2604 {not in Vi}
2605 {not available when compiled without the |+folding|
2606 feature}
2607 Sets 'foldlevel' when starting to edit another buffer in a window.
2608 Useful to always start editing with all folds closed (value zero),
2609 some folds closed (one) or no folds closed (99).
2610 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002611 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 ignores this option and closes all folds.
2613 It is also done before BufReadPre autocommands, to allow an autocmd to
2614 overrule the 'foldlevel' value for specific files.
2615 When the value is negative, it is not used.
2616
2617 *'foldmarker'* *'fmr'* *E536*
2618'foldmarker' 'fmr' string (default: "{{{,}}}")
2619 local to window
2620 {not in Vi}
2621 {not available when compiled without the |+folding|
2622 feature}
2623 The start and end marker used when 'foldmethod' is "marker". There
2624 must be one comma, which separates the start and end marker. The
2625 marker is a literal string (a regular expression would be too slow).
2626 See |fold-marker|.
2627
2628 *'foldmethod'* *'fdm'*
2629'foldmethod' 'fdm' string (default: "manual")
2630 local to window
2631 {not in Vi}
2632 {not available when compiled without the |+folding|
2633 feature}
2634 The kind of folding used for the current window. Possible values:
2635 |fold-manual| manual Folds are created manually.
2636 |fold-indent| indent Lines with equal indent form a fold.
2637 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2638 |fold-marker| marker Markers are used to specify folds.
2639 |fold-syntax| syntax Syntax highlighting items specify folds.
2640 |fold-diff| diff Fold text that is not changed.
2641
2642 *'foldminlines'* *'fml'*
2643'foldminlines' 'fml' number (default: 1)
2644 local to window
2645 {not in Vi}
2646 {not available when compiled without the |+folding|
2647 feature}
2648 Sets the minimum number of screen lines for a fold to be displayed
2649 closed. Also for manually closed folds.
2650 Note that this only has an effect of what is displayed. After using
2651 "zc" to close a fold, which is displayed open because it's smaller
2652 than 'foldminlines', a following "zc" may close a containing fold.
2653
2654 *'foldnestmax'* *'fdn'*
2655'foldnestmax' 'fdn' number (default: 20)
2656 local to window
2657 {not in Vi}
2658 {not available when compiled without the |+folding|
2659 feature}
2660 Sets the maximum nesting of folds for the "indent" and "syntax"
2661 methods. This avoids that too many folds will be created. Using more
2662 than 20 doesn't work, because the internal limit is 20.
2663
2664 *'foldopen'* *'fdo'*
2665'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2666 search,tag,undo")
2667 global
2668 {not in Vi}
2669 {not available when compiled without the |+folding|
2670 feature}
2671 Specifies for which type of commands folds will be opened, if the
2672 command moves the cursor into a closed fold. It is a comma separated
2673 list of items.
2674 item commands ~
2675 all any
2676 block "(", "{", "[[", "[{", etc.
2677 hor horizontal movements: "l", "w", "fx", etc.
2678 insert any command in Insert mode
2679 jump far jumps: "G", "gg", etc.
2680 mark jumping to a mark: "'m", CTRL-O, etc.
2681 percent "%"
2682 quickfix ":cn", ":crew", ":make", etc.
2683 search search for a pattern: "/", "n", "*", "gd", etc.
2684 (not for a search pattern in a ":" command)
2685 tag jumping to a tag: ":ta", CTRL-T, etc.
2686 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002687 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 the |zv| command to the mapping to get the same effect.
2689 When a movement command is used for an operator (e.g., "dl" or "y%")
2690 this option is not used. This means the operator will include the
2691 whole closed fold.
2692 Note that vertical movements are not here, because it would make it
2693 very difficult to move onto a closed fold.
2694 In insert mode the folds containing the cursor will always be open
2695 when text is inserted.
2696 To close folds you can re-apply 'foldlevel' with the |zx| command or
2697 set the 'foldclose' option to "all".
2698
2699 *'foldtext'* *'fdt'*
2700'foldtext' 'fdt' string (default: "foldtext()")
2701 local to window
2702 {not in Vi}
2703 {not available when compiled without the |+folding|
2704 feature}
2705 An expression which is used to specify the text displayed for a closed
2706 fold. See |fold-foldtext|.
2707
2708 *'formatoptions'* *'fo'*
2709'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2710 local to buffer
2711 {not in Vi}
2712 This is a sequence of letters which describes how automatic
2713 formatting is to be done. See |fo-table|. When the 'paste' option is
2714 on, no formatting is done (like 'formatoptions' is empty). Commas can
2715 be inserted for readability.
2716 To avoid problems with flags that are added in the future, use the
2717 "+=" and "-=" feature of ":set" |add-option-flags|.
2718 NOTE: This option is set to the Vi default value when 'compatible' is
2719 set and to the Vim default value when 'compatible' is reset.
2720
2721 *'formatprg'* *'fp'*
2722'formatprg' 'fp' string (default "")
2723 global
2724 {not in Vi}
2725 The name of an external program that will be used to format the lines
2726 selected with the "gq" command. The program must take the input on
2727 stdin and produce the output on stdout. The Unix program "fmt" is
2728 such a program. If this option is an empty string, the internal
2729 format function will be used |C-indenting|. Environment variables are
2730 expanded |:set_env|. See |option-backslash| about including spaces
2731 and backslashes.
2732 This option cannot be set from a |modeline| or in the |sandbox|, for
2733 security reasons.
2734
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002735 *'fsync'* *'fs'*
2736'fsync' 'fs' boolean (default on)
2737 global
2738 {not in Vi}
2739 When on, the library function fsync() will be called after writing a
2740 file. This will flush a file to disk, ensuring that it is safely
2741 written even on filesystems which do metadata-only journaling. This
2742 will force the harddrive to spin up on Linux systems running in laptop
2743 mode, so it may be undesirable in some situations. Be warned that
2744 turning this off increases the chances of data loss after a crash. On
2745 systems without an fsync() implementation, this variable is always
2746 off.
2747 Also see 'swapsync' for controlling fsync() on swap files.
2748
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2750'gdefault' 'gd' boolean (default off)
2751 global
2752 {not in Vi}
2753 When on, the ":substitute" flag 'g' is default on. This means that
2754 all matches in a line are substituted instead of one. When a 'g' flag
2755 is given to a ":substitute" command, this will toggle the substitution
2756 of all or one match. See |complex-change|.
2757
2758 command 'gdefault' on 'gdefault' off ~
2759 :s/// subst. all subst. one
2760 :s///g subst. one subst. all
2761 :s///gg subst. all subst. one
2762
2763 NOTE: This option is reset when 'compatible' is set.
2764
2765 *'grepformat'* *'gfm'*
2766'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2767 global
2768 {not in Vi}
2769 Format to recognize for the ":grep" command output.
2770 This is a scanf-like string that uses the same format as the
2771 'errorformat' option: see |errorformat|.
2772
2773 *'grepprg'* *'gp'*
2774'grepprg' 'gp' string (default "grep -n ",
2775 Unix: "grep -n $* /dev/null",
2776 Win32: "findstr /n" or "grep -n",
2777 VMS: "SEARCH/NUMBERS ")
2778 global or local to buffer |global-local|
2779 {not in Vi}
2780 Program to use for the ":grep" command. This option may contain '%'
2781 and '#' characters, which are expanded like when used in a command-
2782 line. The placeholder "$*" is allowed to specify where the arguments
2783 will be included. Environment variables are expanded |:set_env|. See
2784 |option-backslash| about including spaces and backslashes.
2785 When your "grep" accepts the "-H" argument, use this to make ":grep"
2786 also work well with a single file: >
2787 :set grepprg=grep\ -nH
2788< See also the section |:make_makeprg|, since most of the comments there
2789 apply equally to 'grepprg'.
2790 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2791 otherwise it's "grep -n".
2792 This option cannot be set from a |modeline| or in the |sandbox|, for
2793 security reasons.
2794
2795 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2796'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2797 ve:ver35-Cursor,
2798 o:hor50-Cursor,
2799 i-ci:ver25-Cursor/lCursor,
2800 r-cr:hor20-Cursor/lCursor,
2801 sm:block-Cursor
2802 -blinkwait175-blinkoff150-blinkon175",
2803 for MS-DOS and Win32 console:
2804 "n-v-c:block,o:hor50,i-ci:hor15,
2805 r-cr:hor30,sm:block")
2806 global
2807 {not in Vi}
2808 {only available when compiled with GUI enabled, and
2809 for MS-DOS and Win32 console}
2810 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002811 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 the height of the cursor can be changed. This can be done by
2813 specifying a block cursor, or a percentage for a vertical or
2814 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002815 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002817 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818 mode-list and an argument-list:
2819 mode-list:argument-list,mode-list:argument-list,..
2820 The mode-list is a dash separated list of these modes:
2821 n Normal mode
2822 v Visual mode
2823 ve Visual mode with 'selection' "exclusive" (same as 'v',
2824 if not specified)
2825 o Operator-pending mode
2826 i Insert mode
2827 r Replace mode
2828 c Command-line Normal (append) mode
2829 ci Command-line Insert mode
2830 cr Command-line Replace mode
2831 sm showmatch in Insert mode
2832 a all modes
2833 The argument-list is a dash separated list of these arguments:
2834 hor{N} horizontal bar, {N} percent of the character height
2835 ver{N} vertical bar, {N} percent of the character width
2836 block block cursor, fills the whole character
2837 [only one of the above three should be present]
2838 blinkwait{N} *cursor-blinking*
2839 blinkon{N}
2840 blinkoff{N}
2841 blink times for cursor: blinkwait is the delay before
2842 the cursor starts blinking, blinkon is the time that
2843 the cursor is shown and blinkoff is the time that the
2844 cursor is not shown. The times are in msec. When one
2845 of the numbers is zero, there is no blinking. The
2846 default is: "blinkwait700-blinkon400-blinkoff250".
2847 These numbers are used for a missing entry. This
2848 means that blinking is enabled by default. To switch
2849 blinking off you can use "blinkon0". The cursor only
2850 blinks when Vim is waiting for input, not while
2851 executing a command.
2852 To make the cursor blink in an xterm, see
2853 |xterm-blink|.
2854 {group-name}
2855 a highlight group name, that sets the color and font
2856 for the cursor
2857 {group-name}/{group-name}
2858 Two highlight group names, the first is used when
2859 no language mappings are used, the other when they
2860 are. |language-mapping|
2861
2862 Examples of parts:
2863 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2864 block cursor with colors from the "nCursor"
2865 highlight group
2866 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2867 In Insert and Command-line Insert mode, use a
2868 30% vertical bar cursor with colors from the
2869 "iCursor" highlight group. Blink a bit
2870 faster.
2871
2872 The 'a' mode is different. It will set the given argument-list for
2873 all modes. It does not reset anything to defaults. This can be used
2874 to do a common setting for all modes. For example, to switch off
2875 blinking: "a:blinkon0"
2876
2877 Examples of cursor highlighting: >
2878 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2879 :highlight Cursor gui=NONE guifg=bg guibg=fg
2880<
2881 *'guifont'* *'gfn'*
2882 *E235* *E596* *E610* *E611*
2883'guifont' 'gfn' string (default "")
2884 global
2885 {not in Vi}
2886 {only available when compiled with GUI enabled}
2887 This is a list of fonts which will be used for the GUI version of Vim.
2888 In its simplest form the value is just one font name. When
2889 the font cannot be found you will get an error message. To try other
2890 font names a list can be specified, font names separated with commas.
2891 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002892
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 Spaces after a comma are ignored. To include a comma in a font name
2896 precede it with a backslash. Setting an option requires an extra
2897 backslash before a space and a backslash. See also
2898 |option-backslash|. For example: >
2899 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002900< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002902
2903 If none of the fonts can be loaded, Vim will keep the current setting.
2904 If an empty font list is given, Vim will try using other resource
2905 settings (for X, it will use the Vim.font resource), and finally it
2906 will try some builtin default which should always be there ("7x13" in
2907 the case of X). The font names given should be "normal" fonts. Vim
2908 will try to find the related bold and italic fonts.
2909
2910 For Win32, GTK and Photon only: >
2911 :set guifont=*
2912< will bring up a font requester, where you can pick the font you want.
2913
2914 The font name depends on the GUI used. See |setting-guifont| for a
2915 way to set 'guifont' for various systems.
2916
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917 For the GTK+ 2 GUI the font name looks like this: >
2918 :set guifont=Andale\ Mono\ 11
2919< That's all. XLFDs are no longer accepted.
2920 *E236*
2921 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00002922 width). An exception is GTK 2: all fonts are accepted, but
2923 mono-spaced fonts look best.
2924
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 To preview a font on X11, you might be able to use the "xfontsel"
2926 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00002927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 For the Win32 GUI *E244* *E245*
2929 - takes these options in the font name:
2930 hXX - height is XX (points, can be floating-point)
2931 wXX - width is XX (points, can be floating-point)
2932 b - bold
2933 i - italic
2934 u - underline
2935 s - strikeout
2936 cXX - character set XX. valid charsets are: ANSI, ARABIC,
2937 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2938 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2939 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002940 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941
2942 Use a ':' to separate the options.
2943 - A '_' can be used in the place of a space, so you don't need to use
2944 backslashes to escape the spaces.
2945 - Examples: >
2946 :set guifont=courier_new:h12:w5:b:cRUSSIAN
2947 :set guifont=Andale_Mono:h7.5:w4.5
2948< See also |font-sizes|.
2949
2950 *'guifontset'* *'gfs'*
2951 *E250* *E252* *E234* *E597* *E598*
2952'guifontset' 'gfs' string (default "")
2953 global
2954 {not in Vi}
2955 {only available when compiled with GUI enabled and
2956 with the |+xfontset| feature}
2957 {not available in the GTK+ 2 GUI}
2958 When not empty, specifies two (or more) fonts to be used. The first
2959 one for normal English, the second one for your special language. See
2960 |xfontset|.
2961 Setting this option also means that all font names will be handled as
2962 a fontset name. Also the ones used for the "font" argument of the
2963 |:highlight| command.
2964 The fonts must match with the current locale. If fonts for the
2965 character sets that the current locale uses are not included, setting
2966 'guifontset' will fail.
2967 Note the difference between 'guifont' and 'guifontset': In 'guifont'
2968 the comma-separated names are alternative names, one of which will be
2969 used. In 'guifontset' the whole string is one fontset name,
2970 including the commas. It is not possible to specify alternative
2971 fontset names.
2972 This example works on many X11 systems: >
2973 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
2974<
2975 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
2976'guifontwide' 'gfw' string (default "")
2977 global
2978 {not in Vi}
2979 {only available when compiled with GUI enabled}
2980 When not empty, specifies a comma-separated list of fonts to be used
2981 for double-width characters. The first font that can be loaded is
2982 used.
2983 Note: The size of these fonts must be exactly twice as wide as the one
2984 specified with 'guifont' and the same height.
2985
2986 All GUI versions but GTK+ 2:
2987
2988 'guifontwide' is only used when 'encoding' is set to "utf-8" and
2989 'guifontset' is empty or invalid.
2990 When 'guifont' is set and a valid font is found in it and
2991 'guifontwide' is empty Vim will attempt to find a matching
2992 double-width font and set 'guifontwide' to it.
2993
2994 GTK+ 2 GUI only: *guifontwide_gtk2*
2995
2996 If set and valid, 'guifontwide' is always used for double width
2997 characters, even if 'encoding' is not set to "utf-8".
2998 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002999 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 font for characters not available in 'guifont'. Thus you do not need
3001 to set 'guifontwide' at all unless you want to override the choice
3002 made by Pango/Xft.
3003
3004 *'guiheadroom'* *'ghr'*
3005'guiheadroom' 'ghr' number (default 50)
3006 global
3007 {not in Vi} {only for GTK and X11 GUI}
3008 The number of pixels subtracted from the screen height when fitting
3009 the GUI window on the screen. Set this before the GUI is started,
3010 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 lines will be left for window decorations and other items on the
3013 screen. Set it to a negative value to allow windows taller than the
3014 screen.
3015
3016 *'guioptions'* *'go'*
3017'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
3018 "agimrLtT" (GTK, Motif and Athena)
3019 global
3020 {not in Vi}
3021 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003022 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 sequence of letters which describes what components and options of the
3024 GUI should be used.
3025 To avoid problems with flags that are added in the future, use the
3026 "+=" and "-=" feature of ":set" |add-option-flags|.
3027
3028 Valid letters are as follows:
3029 *guioptions_a*
3030 'a' Autoselect: If present, then whenever VISUAL mode is started,
3031 or the Visual area extended, Vim tries to become the owner of
3032 the windowing system's global selection. This means that the
3033 Visually highlighted text is available for pasting into other
3034 applications as well as into Vim itself. When the Visual mode
3035 ends, possibly due to an operation on the text, or when an
3036 application wants to paste the selection, the highlighted text
3037 is automatically yanked into the "* selection register.
3038 Thus the selection is still available for pasting into other
3039 applications after the VISUAL mode has ended.
3040 If not present, then Vim won't become the owner of the
3041 windowing system's global selection unless explicitly told to
3042 by a yank or delete operation for the "* register.
3043 The same applies to the modeless selection.
3044
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003045 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 applies to the modeless selection.
3047
3048 'guioptions' autoselect Visual autoselect modeless ~
3049 "" - -
3050 "a" yes yes
3051 "A" - yes
3052 "aA" yes yes
3053
3054 'c' Use console dialogs instead of popup dialogs for simple
3055 choices.
3056
3057 'f' Foreground: Don't use fork() to detach the GUI from the shell
3058 where it was started. Use this for programs that wait for the
3059 editor to finish (e.g., an e-mail program). Alternatively you
3060 can use "gvim -f" or ":gui -f" to start the GUI in the
3061 foreground. |gui-fork|
3062 Note: Set this option in the vimrc file. The forking may have
3063 happened already when the gvimrc file is read.
3064
3065 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3066 corner of the window. It's black&white on non-GTK, because of
3067 limitations of X11. For a color icon, see |X11-icon|.
3068
3069 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 that this flag must be added in the .vimrc file, before
3072 switching on syntax or filetype recognition (when the .gvimrc
3073 file is sourced the system menu has already been loaded; the
3074 ":syntax on" and ":filetype on" commands load the menu too).
3075 'g' Grey menu items: Make menu items that are not active grey. If
3076 'g' is not included inactive menu items are not shown at all.
3077 Exception: Athena will always use grey menu items.
3078
3079 't' Include tearoff menu items. Currently only works for Win32,
3080 GTK+, and Motif 1.2 GUI.
3081 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3082 Athena GUIs.
3083
3084 'r' Right-hand scrollbar is always present.
3085 'R' Right-hand scrollbar is present when there is a vertically
3086 split window.
3087 'l' Left-hand scrollbar is always present.
3088 'L' Left-hand scrollbar is present when there is a vertically
3089 split window.
3090 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3091 the longest visible line, or on the cursor line if the 'h'
3092 flag is included. |gui-horiz-scroll|
3093 'h' Limit horizontal scrollbar size to the length of the cursor
3094 line. Reduces computations. |gui-horiz-scroll|
3095
3096 And yes, you may even have scrollbars on the left AND the right if
3097 you really want to :-). See |gui-scrollbars| for more information.
3098
3099 'v' Use a vertical button layout for dialogs. When not included,
3100 a horizontal layout is preferred, but when it doesn't fit a
3101 vertical layout is used anyway.
3102 'p' Use Pointer callbacks for X11 GUI. This is required for some
3103 window managers. If the cursor is not blinking or hollow at
3104 the right moment, try adding this flag. This must be done
3105 before starting the GUI. Set it in your gvimrc. Adding or
3106 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108
3109 *'guipty'* *'noguipty'*
3110'guipty' boolean (default on)
3111 global
3112 {not in Vi}
3113 {only available when compiled with GUI enabled}
3114 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3115 I/O to/from shell commands. See |gui-pty|.
3116
3117 *'helpfile'* *'hf'*
3118'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3119 (others) "$VIMRUNTIME/doc/help.txt")
3120 global
3121 {not in Vi}
3122 Name of the main help file. All distributed help files should be
3123 placed together in one directory. Additionally, all "doc" directories
3124 in 'runtimepath' will be used.
3125 Environment variables are expanded |:set_env|. For example:
3126 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003127 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 spaces and backslashes.
3129 This option cannot be set from a |modeline| or in the |sandbox|, for
3130 security reasons.
3131
3132 *'helpheight'* *'hh'*
3133'helpheight' 'hh' number (default 20)
3134 global
3135 {not in Vi}
3136 {not available when compiled without the +windows
3137 feature}
3138 Minimal initial height of the help window when it is opened with the
3139 ":help" command. The initial height of the help window is half of the
3140 current window, or (when the 'ea' option is on) the same as other
3141 windows. When the height is less than 'helpheight', the height is
3142 set to 'helpheight'. Set to zero to disable.
3143
3144 *'helplang'* *'hlg'*
3145'helplang' 'hlg' string (default: messages language or empty)
3146 global
3147 {only available when compiled with the |+multi_lang|
3148 feature}
3149 {not in Vi}
3150 Comma separated list of languages. Vim will use the first language
3151 for which the desired help can be found. The English help will always
3152 be used as a last resort. You can add "en" to prefer English over
3153 another language, but that will only find tags that exist in that
3154 language and not in the English help.
3155 Example: >
3156 :set helplang=de,it
3157< This will first search German, then Italian and finally English help
3158 files.
3159 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3160 try to find the tag in the current language before using this option.
3161 See |help-translated|.
3162
3163 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3164'hidden' 'hid' boolean (default off)
3165 global
3166 {not in Vi}
3167 When off a buffer is unloaded when it is |abandon|ed. When on a
3168 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3169 displayed in another window, it does not become hidden, of course.
3170 The commands that move through the buffer list sometimes make a buffer
3171 hidden although the 'hidden' option is off: When the buffer is
3172 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003173 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003174 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 This option is set for one command with ":hide {command}" |:hide|.
3176 WARNING: It's easy to forget that you have changes in hidden buffers.
3177 Think twice when using ":q!" or ":qa!".
3178
3179 *'highlight'* *'hl'*
3180'highlight' 'hl' string (default (as a single string):
3181 "8:SpecialKey,@:NonText,d:Directory,
3182 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3183 M:ModeMsg,n:LineNr,r:Question,
3184 s:StatusLine,S:StatusLineNC,c:VertSplit
3185 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3186 f:Folded,F:FoldColumn,A:DiffAdd,
3187 C:DiffChange,D:DiffDelete,T:DiffText,
3188 >:SignColumn")
3189 global
3190 {not in Vi}
3191 This option can be used to set highlighting mode for various
3192 occasions. It is a comma separated list of character pairs. The
3193 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003194 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3196 |hl-NonText| @ '~' and '@' at the end of the window and
3197 characters from 'showbreak'
3198 |hl-Directory| d directories in CTRL-D listing and other special
3199 things in listings
3200 |hl-ErrorMsg| e error messages
3201 h (obsolete, ignored)
3202 |hl-IncSearch| i 'incsearch' highlighting
3203 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3204 |hl-MoreMsg| m |more-prompt|
3205 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3206 |hl-LineNr| n line number for ":number" and ":#" commands
3207 |hl-Question| r |hit-enter| prompt and yes/no questions
3208 |hl-StatusLine| s status line of current window |status-line|
3209 |hl-StatusLineNC| S status lines of not-current windows
3210 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3211 |hl-VertSplit| c column used to separate vertically split windows
3212 |hl-Visual| v Visual mode
3213 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3214 Selection" Only X11 Gui's |gui-x11| and
3215 |xterm-clipboard|.
3216 |hl-WarningMsg| w warning messages
3217 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3218 |hl-Folded| f line used for closed folds
3219 |hl-FoldColumn| F 'foldcolumn'
3220 |hl-SignColumn| > column used for |signs|
3221
3222 The display modes are:
3223 r reverse (termcap entry "mr" and "me")
3224 i italic (termcap entry "ZH" and "ZR")
3225 b bold (termcap entry "md" and "me")
3226 s standout (termcap entry "so" and "se")
3227 u underline (termcap entry "us" and "ue")
3228 n no highlighting
3229 - no highlighting
3230 : use a highlight group
3231 The default is used for occasions that are not included.
3232 If you want to change what the display modes do, see |dos-colors|
3233 for an example.
3234 When using the ':' display mode, this must be followed by the name of
3235 a highlight group. A highlight group can be used to define any type
3236 of highlighting, including using color. See |:highlight| on how to
3237 define one. The default uses a different group for each occasion.
3238 See |highlight-default| for the default highlight groups.
3239
3240 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3241'hlsearch' 'hls' boolean (default off)
3242 global
3243 {not in Vi}
3244 {not available when compiled without the
3245 |+extra_search| feature}
3246 When there is a previous search pattern, highlight all its matches.
3247 The type of highlighting used can be set with the 'l' occasion in the
3248 'highlight' option. This uses the "Search" highlight group by
3249 default. Note that only the matching text is highlighted, any offsets
3250 are not applied.
3251 See also: 'incsearch' and |:match|.
3252 When you get bored looking at the highlighted matches, you can turn it
3253 off with |:nohlsearch|. As soon as you use a search command, the
3254 highlighting comes back.
3255 When the search pattern can match an end-of-line, Vim will try to
3256 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003257 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 line below a closed fold. A match in a previous line which is not
3259 drawn may not continue in an newly drawn line.
3260 NOTE: This option is reset when 'compatible' is set.
3261
3262 *'history'* *'hi'*
3263'history' 'hi' number (Vim default: 20, Vi default: 0)
3264 global
3265 {not in Vi}
3266 A history of ":" commands, and a history of previous search patterns
3267 are remembered. This option decides how many entries may be stored in
3268 each of these histories (see |cmdline-editing|).
3269 NOTE: This option is set to the Vi default value when 'compatible' is
3270 set and to the Vim default value when 'compatible' is reset.
3271
3272 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3273'hkmap' 'hk' boolean (default off)
3274 global
3275 {not in Vi}
3276 {only available when compiled with the |+rightleft|
3277 feature}
3278 When on, the keyboard is mapped for the Hebrew character set.
3279 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3280 toggle this option. See |rileft.txt|.
3281 NOTE: This option is reset when 'compatible' is set.
3282
3283 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3284'hkmapp' 'hkp' boolean (default off)
3285 global
3286 {not in Vi}
3287 {only available when compiled with the |+rightleft|
3288 feature}
3289 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3290 This is useful if you have a non-Hebrew keyboard.
3291 See |rileft.txt|.
3292 NOTE: This option is reset when 'compatible' is set.
3293
3294 *'icon'* *'noicon'*
3295'icon' boolean (default off, on when title can be restored)
3296 global
3297 {not in Vi}
3298 {not available when compiled without the |+title|
3299 feature}
3300 When on, the icon text of the window will be set to the value of
3301 'iconstring' (if it is not empty), or to the name of the file
3302 currently being edited. Only the last part of the name is used.
3303 Overridden by the 'iconstring' option.
3304 Only works if the terminal supports setting window icons (currently
3305 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3306 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3307 builtin termcap).
3308 When Vim was compiled with HAVE_X11 defined, the original icon will be
3309 restored if possible |X11|. See |X11-icon| for changing the icon on
3310 X11.
3311
3312 *'iconstring'*
3313'iconstring' string (default "")
3314 global
3315 {not in Vi}
3316 {not available when compiled without the |+title|
3317 feature}
3318 When this option is not empty, it will be used for the icon text of
3319 the window. This happens only when the 'icon' option is on.
3320 Only works if the terminal supports setting window icon text
3321 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3322 Does not work for MS Windows.
3323 When Vim was compiled with HAVE_X11 defined, the original icon will be
3324 restored if possible |X11|.
3325 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003326 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 'titlestring' for example settings.
3328 {not available when compiled without the |+statusline| feature}
3329
3330 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3331'ignorecase' 'ic' boolean (default off)
3332 global
3333 Ignore case in search patterns. Also used when searching in the tags
3334 file.
3335 Also see 'smartcase'.
3336 Can be overruled by using "\c" or "\C" in the pattern, see
3337 |/ignorecase|.
3338
3339 *'imactivatekey'* *'imak'*
3340'imactivatekey' 'imak' string (default "")
3341 global
3342 {not in Vi}
3343 {only available when compiled with |+xim| and
3344 |+GUI_GTK|}
3345 Specifies the key that your Input Method in X-Windows uses for
3346 activation. When this is specified correctly, vim can fully control
3347 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3348 You can't use this option to change the activation key, the option
3349 tells Vim what the key is.
3350 Format:
3351 [MODIFIER_FLAG-]KEY_STRING
3352
3353 These characters can be used for MODIFIER_FLAG (case is ignored):
3354 S Shift key
3355 L Lock key
3356 C Control key
3357 1 Mod1 key
3358 2 Mod2 key
3359 3 Mod3 key
3360 4 Mod4 key
3361 5 Mod5 key
3362 Combinations are allowed, for example "S-C-space" or "SC-space" are
3363 both shift+ctrl+space.
3364 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3365
3366 Example: >
3367 :set imactivatekey=S-space
3368< "S-space" means shift+space. This is the activation key for kinput2 +
3369 canna (Japanese), and ami (Korean).
3370
3371 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3372'imcmdline' 'imc' boolean (default off)
3373 global
3374 {not in Vi}
3375 {only available when compiled with the |+xim|
3376 |+multi_byte_ime| or |global-ime| feature}
3377 When set the Input Method is always on when starting to edit a command
3378 line, unless entering a search pattern (see 'imsearch' for that).
3379 Setting this option is useful when your input method allows entering
3380 English characters directly, e.g., when it's used to type accented
3381 characters with dead keys.
3382
3383 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3384'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3385 global
3386 {not in Vi}
3387 {only available when compiled with the |+xim|
3388 |+multi_byte_ime| or |global-ime| feature}
3389 When set the Input Method is never used. This is useful to disable
3390 the IM when it doesn't work properly.
3391 Currently this option is on by default for SGI/IRIX machines. This
3392 may change in later releases.
3393
3394 *'iminsert'* *'imi'*
3395'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3396 local to buffer
3397 {not in Vi}
3398 Specifies whether :lmap or an Input Method (IM) is to be used in
3399 Insert mode. Valid values:
3400 0 :lmap is off and IM is off
3401 1 :lmap is ON and IM is off
3402 2 :lmap is off and IM is ON
3403 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3404 or |global-ime|.
3405 To always reset the option to zero when leaving Insert mode with <Esc>
3406 this can be used: >
3407 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3408< This makes :lmap and IM turn off automatically when leaving Insert
3409 mode.
3410 Note that this option changes when using CTRL-^ in Insert mode
3411 |i_CTRL-^|.
3412 The value is set to 1 when setting 'keymap' to a valid keymap name.
3413 It is also used for the argument of commands like "r" and "f".
3414 The value 0 may not work correctly with Athena and Motif with some XIM
3415 methods. Use 'imdisable' to disable XIM then.
3416
3417 *'imsearch'* *'ims'*
3418'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3419 local to buffer
3420 {not in Vi}
3421 Specifies whether :lmap or an Input Method (IM) is to be used when
3422 entering a search pattern. Valid values:
3423 -1 the value of 'iminsert' is used, makes it look like
3424 'iminsert' is also used when typing a search pattern
3425 0 :lmap is off and IM is off
3426 1 :lmap is ON and IM is off
3427 2 :lmap is off and IM is ON
3428 Note that this option changes when using CTRL-^ in Command-line mode
3429 |c_CTRL-^|.
3430 The value is set to 1 when it is not -1 and setting the 'keymap'
3431 option to a valid keymap name.
3432 The value 0 may not work correctly with Athena and Motif with some XIM
3433 methods. Use 'imdisable' to disable XIM then.
3434
3435 *'include'* *'inc'*
3436'include' 'inc' string (default "^\s*#\s*include")
3437 global or local to buffer |global-local|
3438 {not in Vi}
3439 {not available when compiled without the
3440 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003441 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 pattern, just like for the "/" command (See |pattern|). The default
3443 value is for C programs. This option is used for the commands "[i",
3444 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3445 name that comes after the matched pattern. See |option-backslash|
3446 about including spaces and backslashes.
3447
3448 *'includeexpr'* *'inex'*
3449'includeexpr' 'inex' string (default "")
3450 local to buffer
3451 {not in Vi}
3452 {not available when compiled without the
3453 |+find_in_path| or |+eval| feature}
3454 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003455 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 :set includeexpr=substitute(v:fname,'\\.','/','g')
3457< The "v:fname" variable will be set to the file name that was detected.
3458 Evaluated in the |sandbox|.
3459 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003460 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003461 Also used for |<cfile>|.
3462
3463 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3464'incsearch' 'is' boolean (default off)
3465 global
3466 {not in Vi}
3467 {not available when compiled without the
3468 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003469 While typing a search command, show where the pattern, as it was typed
3470 so far, matches. The matched string is highlighted. If the pattern
3471 is invalid or not found, nothing is shown. The screen will be updated
3472 often, this is only useful on fast terminals.
3473 Note that the match will be shown, but the cursor will return to its
3474 original position when no match is found and when pressing <Esc>. You
3475 still need to finish the search command with <Enter> to move the
3476 cursor to the match.
3477 The highlighting can be set with the 'i' flag in 'highlight'.
3478 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 NOTE: This option is reset when 'compatible' is set.
3480
3481 *'indentexpr'* *'inde'*
3482'indentexpr' 'inde' string (default "")
3483 local to buffer
3484 {not in Vi}
3485 {not available when compiled without the |+cindent|
3486 or |+eval| features}
3487 Expression which is evaluated to obtain the proper indent for a line.
3488 It is used when a new line is created, for the |=| operator and
3489 in Insert mode as specified with the 'indentkeys' option.
3490 When this option is not empty, it overrules the 'cindent' and
3491 'smartindent' indenting.
3492 When 'paste' is set this option is not used for indenting.
3493 The expression is evaluated with |v:lnum| set to the line number for
3494 which the indent is to be computed. The cursor is also as this line
3495 when the expression is evaluated (but it may be moved around).
3496 The expression must return the number of spaces worth of indent. It
3497 can return "-1" to keep the current indent (this means 'autoindent' is
3498 used for the indent).
3499 Functions useful for computing the indent are |indent()|, |cindent()|
3500 and |lispindent()|.
3501 The evaluation of the expression must not have side effects! It must
3502 not change the text, jump to another window, etc. Afterwards the
3503 cursor position is always restored, thus the cursor may be moved.
3504 Normally this option would be set to call a function: >
3505 :set indentexpr=GetMyIndent()
3506< Error messages will be suppressed, unless the 'debug' option contains
3507 "msg".
3508 See |indent-expression|. Also see |eval-sandbox|.
3509 NOTE: This option is made empty when 'compatible' is set.
3510
3511 *'indentkeys'* *'indk'*
3512'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3513 local to buffer
3514 {not in Vi}
3515 {not available when compiled without the |+cindent|
3516 feature}
3517 A list of keys that, when typed in Insert mode, cause reindenting of
3518 the current line. Only happens if 'indentexpr' isn't empty.
3519 The format is identical to 'cinkeys', see |indentkeys-format|.
3520 See |C-indenting| and |indent-expression|.
3521
3522 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3523'infercase' 'inf' boolean (default off)
3524 local to buffer
3525 {not in Vi}
3526 When doing keyword completion in insert mode |ins-completion|, and
3527 'ignorecase' is also on, the case of the match is adjusted. If the
3528 typed text contains a lowercase letter where the match has an upper
3529 case letter, the completed part is made lowercase. If the typed text
3530 has no lowercase letters and the match has a lowercase letter where
3531 the typed text has an uppercase letter, and there is a letter before
3532 it, the completed part is made uppercase.
3533
3534 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3535'insertmode' 'im' boolean (default off)
3536 global
3537 {not in Vi}
3538 Makes Vim work in a way that Insert mode is the default mode. Useful
3539 if you want to use Vim as a modeless editor. Used for |evim|.
3540 These Insert mode commands will be useful:
3541 - Use the cursor keys to move around.
3542 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3543 this is a mapping, it is executed as if 'insertmode' was off.
3544 Normal mode remains active until the mapping is finished.
3545 *i_CTRL-L*
3546 - Use CTRL-L to execute a number of Normal mode commands, then use
3547 <Esc> to get back to Insert mode.
3548
3549 These items change when 'insertmode' is set:
3550 - when starting to edit of a file, Vim goes to Insert mode.
3551 - <Esc> in Insert mode is a no-op and beeps.
3552 - <Esc> in Normal mode makes Vim go to Insert mode.
3553 - CTRL-L in Insert mode is a command, it is not inserted.
3554 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3555 However, when <Esc> is used inside a mapping, it behaves like
3556 'insertmode' was not set. This was done to be able to use the same
3557 mappings with 'insertmode' set or not set.
3558 When executing commands with |:normal| 'insertmode' is not used.
3559
3560 NOTE: This option is reset when 'compatible' is set.
3561
3562 *'isfname'* *'isf'*
3563'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3564 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3565 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3566 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3567 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3568 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3569 global
3570 {not in Vi}
3571 The characters specified by this option are included in file names and
3572 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003573 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 Multi-byte characters 256 and above are always included, only the
3575 characters up to 255 are specified with this option.
3576 For UTF-8 the characters 0xa0 to 0xff are included as well.
3577
3578 Note that on systems using a backslash as path separator, Vim tries to
3579 do its best to make it work as you would expect. That is a bit
3580 tricky, since Vi originally used the backslash to escape special
3581 characters. Vim will not remove a backslash in front of a normal file
3582 name character on these systems, but it will on Unix and alikes. The
3583 '&' and '^' are not included by default, because these are special for
3584 cmd.exe.
3585
3586 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003587 Each part can be a single character number or a range. A range is two
3588 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 decimal number between 0 and 255 or the ASCII character itself (does
3590 not work for digits). Example:
3591 "_,-,128-140,#-43" (include '_' and '-' and the range
3592 128 to 140 and '#' to 43)
3593 If a part starts with '^', the following character number or range
3594 will be excluded from the option. The option is interpreted from left
3595 to right. Put the excluded character after the range where it is
3596 included. To include '^' itself use it as the last character of the
3597 option or the end of a range. Example:
3598 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3599 If the character is '@', all characters where isalpha() returns TRUE
3600 are included. Normally these are the characters a to z and A to Z,
3601 plus accented characters. To include '@' itself use "@-@". Examples:
3602 "@,^a-z" All alphabetic characters, excluding lower
3603 case letters.
3604 "a-z,A-Z,@-@" All letters plus the '@' character.
3605 A comma can be included by using it where a character number is
3606 expected. Example:
3607 "48-57,,,_" Digits, comma and underscore.
3608 A comma can be excluded by prepending a '^'. Example:
3609 " -~,^,,9" All characters from space to '~', excluding
3610 comma, plus <Tab>.
3611 See |option-backslash| about including spaces and backslashes.
3612
3613 *'isident'* *'isi'*
3614'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3615 "@,48-57,_,128-167,224-235"
3616 otherwise: "@,48-57,_,192-255")
3617 global
3618 {not in Vi}
3619 The characters given by this option are included in identifiers.
3620 Identifiers are used in recognizing environment variables and after a
3621 match of the 'define' option. It is also used for "\i" in a
3622 |pattern|. See 'isfname' for a description of the format of this
3623 option.
3624 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003625 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3627
3628 *'iskeyword'* *'isk'*
3629'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3630 "@,48-57,_,128-167,224-235"
3631 otherwise: "@,48-57,_,192-255"
3632 Vi default: "@,48-57,_")
3633 local to buffer
3634 {not in Vi}
3635 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003636 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 'isfname' for a description of the format of this option. For C
3638 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3639 For a help file it is set to all non-blank printable characters except
3640 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3641 command).
3642 When the 'lisp' option is on the '-' character is always included.
3643 NOTE: This option is set to the Vi default value when 'compatible' is
3644 set and to the Vim default value when 'compatible' is reset.
3645
3646 *'isprint'* *'isp'*
3647'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3648 "@,~-255"; otherwise: "@,161-255")
3649 global
3650 {not in Vi}
3651 The characters given by this option are displayed directly on the
3652 screen. It is also used for "\p" in a |pattern|. The characters from
3653 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3654 even when they are not included in 'isprint' or excluded. See
3655 'isfname' for a description of the format of this option.
3656
3657 Non-printable characters are displayed with two characters:
3658 0 - 31 "^@" - "^_"
3659 32 - 126 always single characters
3660 127 "^?"
3661 128 - 159 "~@" - "~_"
3662 160 - 254 "| " - "|~"
3663 255 "~?"
3664 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3665 displayed as <xx>, with the hexadecimal value of the byte.
3666 When 'display' contains "uhex" all unprintable characters are
3667 displayed as <xx>.
3668 The NonText highlighting will be used for unprintable characters.
3669 |hl-NonText|
3670
3671 Multi-byte characters 256 and above are always included, only the
3672 characters up to 255 are specified with this option. When a character
3673 is printable but it is not available in the current font, a
3674 replacement character will be shown.
3675 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3676 There is no option to specify these characters.
3677
3678 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3679'joinspaces' 'js' boolean (default on)
3680 global
3681 {not in Vi}
3682 Insert two spaces after a '.', '?' and '!' with a join command.
3683 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3684 Otherwise only one space is inserted.
3685 NOTE: This option is set when 'compatible' is set.
3686
3687 *'key'*
3688'key' string (default "")
3689 local to buffer
3690 {not in Vi}
3691 The key that is used for encrypting and decrypting the current buffer.
3692 See |encryption|.
3693 Careful: Do not set the key value by hand, someone might see the typed
3694 key. Use the |:X| command. But you can make 'key' empty: >
3695 :set key=
3696< It is not possible to get the value of this option with ":set key" or
3697 "echo &key". This is to avoid showing it to someone who shouldn't
3698 know. It also means you cannot see it yourself once you have set it,
3699 be careful not to make a typing error!
3700
3701 *'keymap'* *'kmp'* *E544*
3702'keymap' 'kmp' string (default "")
3703 local to buffer
3704 {not in Vi}
3705 {only available when compiled with the |+keymap|
3706 feature}
3707 Name of a keyboard mapping. See |mbyte-keymap|.
3708 Setting this option to a valid keymap name has the side effect of
3709 setting 'iminsert' to one, so that the keymap becomes effective.
3710 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003711 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712
3713 *'keymodel'* *'km'*
3714'keymodel' 'km' string (default "")
3715 global
3716 {not in Vi}
3717 List of comma separated words, which enable special things that keys
3718 can do. These values can be used:
3719 startsel Using a shifted special key starts selection (either
3720 Select mode or Visual mode, depending on "key" being
3721 present in 'selectmode').
3722 stopsel Using a not-shifted special key stops selection.
3723 Special keys in this context are the cursor keys, <End>, <Home>,
3724 <PageUp> and <PageDown>.
3725 The 'keymodel' option is set by the |:behave| command.
3726
3727 *'keywordprg'* *'kp'*
3728'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3729 OS/2: "view /", VMS: "help")
3730 global or local to buffer |global-local|
3731 {not in Vi}
3732 Program to use for the |K| command. Environment variables are
3733 expanded |:set_env|. ":help" may be used to access the Vim internal
3734 help. (Note that previously setting the global option to the empty
3735 value did this, which is now deprecated.)
3736 When "man" is used, Vim will automatically translate a count for the
3737 "K" command to a section number. Also for "man -s", in which case the
3738 "-s" is removed when there is no count.
3739 See |option-backslash| about including spaces and backslashes.
3740 Example: >
3741 :set keywordprg=man\ -s
3742< This option cannot be set from a |modeline| or in the |sandbox|, for
3743 security reasons.
3744
3745 *'langmap'* *'lmap'* *E357* *E358*
3746'langmap' 'lmap' string (default "")
3747 global
3748 {not in Vi}
3749 {only available when compiled with the |+langmap|
3750 feature}
3751 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003752 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 inserted directly. When in command mode the 'langmap' option takes
3754 care of translating these special characters to the original meaning
3755 of the key. This means you don't have to change the keyboard mode to
3756 be able to execute Normal mode commands.
3757 This is the opposite of the 'keymap' option, where characters are
3758 mapped in Insert mode.
3759 This only works for 8-bit characters. The value of 'langmap' may be
3760 specified with multi-byte characters (e.g., UTF-8), but only the lower
3761 8 bits of each character will be used.
3762
3763 Example (for Greek): *greek* >
3764 :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
3765< Example (exchanges meaning of z and y for commands): >
3766 :set langmap=zy,yz,ZY,YZ
3767<
3768 The 'langmap' option is a list of parts, separated with commas. Each
3769 part can be in one of two forms:
3770 1. A list of pairs. Each pair is a "from" character immediately
3771 followed by the "to" character. Examples: "aA", "aAbBcC".
3772 2. A list of "from" characters, a semi-colon and a list of "to"
3773 characters. Example: "abc;ABC"
3774 Example: "aA,fgh;FGH,cCdDeE"
3775 Special characters need to be preceded with a backslash. These are
3776 ";", ',' and backslash itself.
3777
3778 This will allow you to activate vim actions without having to switch
3779 back and forth between the languages. Your language characters will
3780 be understood as normal vim English characters (according to the
3781 langmap mappings) in the following cases:
3782 o Normal/Visual mode (commands, buffer/register names, user mappings)
3783 o Insert/Replace Mode: Register names after CTRL-R
3784 o Insert/Replace Mode: Mappings
3785 Characters entered in Command-line mode will NOT be affected by
3786 this option. Note that this option can be changed at any time
3787 allowing to switch between mappings for different languages/encodings.
3788 Use a mapping to avoid having to type it each time!
3789
3790 *'langmenu'* *'lm'*
3791'langmenu' 'lm' string (default "")
3792 global
3793 {not in Vi}
3794 {only available when compiled with the |+menu| and
3795 |+multi_lang| features}
3796 Language to use for menu translation. Tells which file is loaded
3797 from the "lang" directory in 'runtimepath': >
3798 "lang/menu_" . &langmenu . ".vim"
3799< (without the spaces). For example, to always use the Dutch menus, no
3800 matter what $LANG is set to: >
3801 :set langmenu=nl_NL.ISO_8859-1
3802< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003803 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 If your $LANG is set to a non-English language but you do want to use
3805 the English menus: >
3806 :set langmenu=none
3807< This option must be set before loading menus, switching on filetype
3808 detection or syntax highlighting. Once the menus are defined setting
3809 this option has no effect. But you could do this: >
3810 :source $VIMRUNTIME/delmenu.vim
3811 :set langmenu=de_DE.ISO_8859-1
3812 :source $VIMRUNTIME/menu.vim
3813< Warning: This deletes all menus that you defined yourself!
3814
3815 *'laststatus'* *'ls'*
3816'laststatus' 'ls' number (default 1)
3817 global
3818 {not in Vi}
3819 The value of this option influences when the last window will have a
3820 status line:
3821 0: never
3822 1: only if there are at least two windows
3823 2: always
3824 The screen looks nicer with a status line if you have several
3825 windows, but it takes another screen line. |status-line|
3826
3827 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3828'lazyredraw' 'lz' boolean (default off)
3829 global
3830 {not in Vi}
3831 When this option is set, the screen will not be redrawn while
3832 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003833 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 update use |:redraw|.
3835
3836 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3837'linebreak' 'lbr' boolean (default off)
3838 local to window
3839 {not in Vi}
3840 {not available when compiled without the |+linebreak|
3841 feature}
3842 If on Vim will wrap long lines at a character in 'breakat' rather
3843 than at the last character that fits on the screen. Unlike
3844 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3845 it only affects the way the file is displayed, not its contents. The
3846 value of 'showbreak' is used to put in front of wrapped lines.
3847 This option is not used when the 'wrap' option is off or 'list' is on.
3848 Note that <Tab> characters after an <EOL> are mostly not displayed
3849 with the right amount of white space.
3850
3851 *'lines'* *E593*
3852'lines' number (default 24 or terminal height)
3853 global
3854 Number of lines of the Vim window.
3855 Normally you don't need to set this. It is done automatically by the
3856 terminal initialization code.
3857 When Vim is running in the GUI or in a resizable window, setting this
3858 option will cause the window size to be changed. When you only want
3859 to use the size for the GUI, put the command in your |gvimrc| file.
3860 Vim limits the number of lines to what fits on the screen. You can
3861 use this command to get the tallest window possible: >
3862 :set lines=999
3863< If you get less lines than expected, check the 'guiheadroom' option.
3864 When you set this option and Vim is unable to change the physical
3865 number of lines of the display, the display may be messed up.
3866
3867 *'linespace'* *'lsp'*
3868'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3869 global
3870 {not in Vi}
3871 {only in the GUI}
3872 Number of pixel lines inserted between characters. Useful if the font
3873 uses the full character cell height, making lines touch each other.
3874 When non-zero there is room for underlining.
3875
3876 *'lisp'* *'nolisp'*
3877'lisp' boolean (default off)
3878 local to buffer
3879 {not available when compiled without the |+lispindent|
3880 feature}
3881 Lisp mode: When <Enter> is typed in insert mode set the indent for
3882 the next line to Lisp standards (well, sort of). Also happens with
3883 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3884 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3885 better. Also see 'lispwords'.
3886 The '-' character is included in keyword characters. Redefines the
3887 "=" operator to use this same indentation algorithm rather than
3888 calling an external program if 'equalprg' is empty.
3889 This option is not used when 'paste' is set.
3890 {Vi: Does it a little bit differently}
3891
3892 *'lispwords'* *'lw'*
3893'lispwords' 'lw' string (default is very long)
3894 global
3895 {not in Vi}
3896 {not available when compiled without the |+lispindent|
3897 feature}
3898 Comma separated list of words that influence the Lisp indenting.
3899 |'lisp'|
3900
3901 *'list'* *'nolist'*
3902'list' boolean (default off)
3903 local to window
3904 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
3905 see the difference between tabs and spaces and for trailing blanks.
3906 Note that this will also affect formatting (set with 'textwidth' or
3907 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
3908 changing the way tabs are displayed.
3909
3910 *'listchars'* *'lcs'*
3911'listchars' 'lcs' string (default "eol:$")
3912 global
3913 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003914 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 settings.
3916 eol:c Character to show at the end of each line. When
3917 omitted, there is no extra character at the end of the
3918 line.
3919 tab:xy Two characters to be used to show a Tab. The first
3920 char is used once. The second char is repeated to
3921 fill the space that the Tab normally occupies.
3922 "tab:>-" will show a Tab that takes four spaces as
3923 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003924 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 trailing spaces are blank.
3926 extends:c Character to show in the last column, when 'wrap' is
3927 off and the line continues beyond the right of the
3928 screen.
3929 precedes:c Character to show in the first column, when 'wrap'
3930 is off and there is text preceding the character
3931 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003932 nbsp:c Character to show for a non-breakable space (character
3933 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 be used when 'encoding' is "utf-8", otherwise only printable
3937 characters are allowed.
3938
3939 Examples: >
3940 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003941 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 :set lcs=extends:>,precedes:<
3943< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003944 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945
3946 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3947'loadplugins' 'lpl' boolean (default on)
3948 global
3949 {not in Vi}
3950 When on the plugin scripts are loaded when starting up |load-plugins|.
3951 This option can be reset in your |vimrc| file to disable the loading
3952 of plugins.
3953 Note that using the "-u NONE" and "--noplugin" command line arguments
3954 reset this option. |-u| |--noplugin|
3955
3956 *'magic'* *'nomagic'*
3957'magic' boolean (default on)
3958 global
3959 Changes the special characters that can be used in search patterns.
3960 See |pattern|.
3961 NOTE: To avoid portability problems with using patterns, always keep
3962 this option at the default "on". Only switch it off when working with
3963 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003964 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965
3966 *'makeef'* *'mef'*
3967'makeef' 'mef' string (default: "")
3968 global
3969 {not in Vi}
3970 {not available when compiled without the |+quickfix|
3971 feature}
3972 Name of the errorfile for the |:make| command (see |:make_makeprg|)
3973 and the |:grep| command.
3974 When it is empty, an internally generated temp file will be used.
3975 When "##" is included, it is replaced by a number to make the name
3976 unique. This makes sure that the ":make" command doesn't overwrite an
3977 existing file.
3978 NOT used for the ":cf" command. See 'errorfile' for that.
3979 Environment variables are expanded |:set_env|.
3980 See |option-backslash| about including spaces and backslashes.
3981 This option cannot be set from a |modeline| or in the |sandbox|, for
3982 security reasons.
3983
3984 *'makeprg'* *'mp'*
3985'makeprg' 'mp' string (default "make", VMS: "MMS")
3986 global or local to buffer |global-local|
3987 {not in Vi}
3988 Program to use for the ":make" command. See |:make_makeprg|. This
3989 option may contain '%' and '#' characters, which are expanded like
3990 when used in a command-line. Environment variables are expanded
3991 |:set_env|. See |option-backslash| about including spaces and
3992 backslashes. Note that a '|' must be escaped twice: once for ":set"
3993 and once for the interpretation of a command. When you use a filter
3994 called "myfilter" do it like this: >
3995 :set makeprg=gmake\ \\\|\ myfilter
3996< The placeholder "$*" can be given (even multiple times) to specify
3997 where the arguments will be included, for example: >
3998 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3999< This option cannot be set from a |modeline| or in the |sandbox|, for
4000 security reasons.
4001
4002 *'matchpairs'* *'mps'*
4003'matchpairs' 'mps' string (default "(:),{:},[:]")
4004 local to buffer
4005 {not in Vi}
4006 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004007 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 must be different. The characters must be separated by a colon. The
4009 pairs must be separated by a comma. Example for including '<' and '>'
4010 (HTML): >
4011 :set mps+=<:>
4012
4013< A more exotic example, to jump between the '=' and ';' in an
4014 assignment, useful for languages like C and Java: >
4015 :au FileType c,cpp,java set mps+==:;
4016
4017< For a more advanced way of using "%", see the matchit.vim plugin in
4018 the $VIMRUNTIME/macros directory. |add-local-help|
4019
4020 *'matchtime'* *'mat'*
4021'matchtime' 'mat' number (default 5)
4022 global
4023 {not in Vi}{in Nvi}
4024 Tenths of a second to show the matching paren, when 'showmatch' is
4025 set. Note that this is not in milliseconds, like other options that
4026 set a time. This is to be compatible with Nvi.
4027
4028 *'maxfuncdepth'* *'mfd'*
4029'maxfuncdepth' 'mfd' number (default 100)
4030 global
4031 {not in Vi}
4032 Maximum depth of function calls for user functions. This normally
4033 catches endless recursion. When using a recursive function with
4034 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4035 more memory, there is the danger of failing when memory is exhausted.
4036 See also |:function|.
4037
4038 *'maxmapdepth'* *'mmd'* *E223*
4039'maxmapdepth' 'mmd' number (default 1000)
4040 global
4041 {not in Vi}
4042 Maximum number of times a mapping is done without resulting in a
4043 character to be used. This normally catches endless mappings, like
4044 ":map x y" with ":map y x". It still does not catch ":map g wg",
4045 because the 'w' is used before the next mapping is done. See also
4046 |key-mapping|.
4047
4048 *'maxmem'* *'mm'*
4049'maxmem' 'mm' number (default between 256 to 5120 (system
4050 dependent) or half the amount of memory
4051 available)
4052 global
4053 {not in Vi}
4054 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4055 limit is reached allocating extra memory for a buffer will cause
4056 other memory to be freed. Maximum value 2000000. Use this to work
4057 without a limit. Also see 'maxmemtot'.
4058
4059 *'maxmemtot'* *'mmt'*
4060'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4061 dependent) or half the amount of memory
4062 available)
4063 global
4064 {not in Vi}
4065 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004066 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004067 'maxmem'.
4068
4069 *'menuitems'* *'mis'*
4070'menuitems' 'mis' number (default 25)
4071 global
4072 {not in Vi}
4073 {not available when compiled without the |+menu|
4074 feature}
4075 Maximum number of items to use in a menu. Used for menus that are
4076 generated from a list of items, e.g., the Buffers menu. Changing this
4077 option has no direct effect, the menu must be refreshed first.
4078
4079 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4080'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4081 local to buffer
4082 *'modelines'* *'mls'*
4083'modelines' 'mls' number (default 5)
4084 global
4085 {not in Vi}
4086 If 'modeline' is on 'modelines' gives the number of lines that is
4087 checked for set commands. If 'modeline' is off or 'modelines' is zero
4088 no lines are checked. See |modeline|.
4089 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4090 set and to the Vim default value when 'compatible' is reset.
4091
4092 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4093'modifiable' 'ma' boolean (default on)
4094 local to buffer
4095 {not in Vi} *E21*
4096 When off the buffer contents cannot be changed. The 'fileformat' and
4097 'fileencoding' options also can't be changed.
4098 Can be reset with the |-M| command line argument.
4099
4100 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4101'modified' 'mod' boolean (default off)
4102 local to buffer
4103 {not in Vi}
4104 When on, the buffer is considered to be modified. This option is set
4105 when:
4106 1. A change was made to the text since it was last written. Using the
4107 |undo| command to go back to the original text will reset the
4108 option. But undoing changes that were made before writing the
4109 buffer will set the option again, since the text is different from
4110 when it was written.
4111 2. 'fileformat' or 'fileencoding' is different from its original
4112 value. The original value is set when the buffer is read or
4113 written. A ":set nomodified" command also resets the original
4114 values to the current values and the 'modified' option will be
4115 reset.
4116 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4117 will be ignored.
4118
4119 *'more'* *'nomore'*
4120'more' boolean (Vim default: on, Vi default: off)
4121 global
4122 {not in Vi}
4123 When on, listings pause when the whole screen is filled. You will get
4124 the |more-prompt|. When this option is off there are no pauses, the
4125 listing continues until finished.
4126 NOTE: This option is set to the Vi default value when 'compatible' is
4127 set and to the Vim default value when 'compatible' is reset.
4128
4129 *'mouse'* *E538*
4130'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4131 global
4132 {not in Vi}
4133 Enable the use of the mouse. Only works for certain terminals
4134 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4135 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4136 The mouse can be enabled for different modes:
4137 n Normal mode
4138 v Visual mode
4139 i Insert mode
4140 c Command-line mode
4141 h all previous modes when editing a help file
4142 a all previous modes
4143 r for |hit-enter| and |more-prompt| prompt
4144 A auto-select in Visual mode
4145 Normally you would enable the mouse in all four modes with: >
4146 :set mouse=a
4147< When the mouse is not enabled, the GUI will still use the mouse for
4148 modeless selection. This doesn't move the text cursor.
4149
4150 See |mouse-using|. Also see |'clipboard'|.
4151
4152 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004153 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 the mouse buttons can still be used by keeping the shift key pressed.
4155 Also see the 'clipboard' option.
4156
4157 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4158'mousefocus' 'mousef' boolean (default off)
4159 global
4160 {not in Vi}
4161 {only works in the GUI}
4162 The window that the mouse pointer is on is automatically activated.
4163 When changing the window layout or window focus in another way, the
4164 mouse pointer is moved to the window with keyboard focus. Off is the
4165 default because it makes using the pull down menus a little goofy, as
4166 a pointer transit may activate a window unintentionally.
4167
4168 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4169'mousehide' 'mh' boolean (default on)
4170 global
4171 {not in Vi}
4172 {only works in the GUI}
4173 When on, the mouse pointer is hidden when characters are typed.
4174 The mouse pointer is restored when the mouse is moved.
4175
4176 *'mousemodel'* *'mousem'*
4177'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4178 global
4179 {not in Vi}
4180 Sets the model to use for the mouse. The name mostly specifies what
4181 the right mouse button is used for:
4182 extend Right mouse button extends a selection. This works
4183 like in an xterm.
4184 popup Right mouse button pops up a menu. The shifted left
4185 mouse button extends a selection. This works like
4186 with Microsoft Windows
4187 popup_setpos Like "popup", but the cursor will be moved to the
4188 position where the mouse was clicked, and thus the
4189 selected operation will act upon the clicked object.
4190 If clicking inside a selection, that selection will
4191 be acted upon, ie. no cursor move. This implies of
4192 course, that right clicking outside a selection will
4193 end Visual mode.
4194 Overview of what button does what for each model:
4195 mouse extend popup(_setpos) ~
4196 left click place cursor place cursor
4197 left drag start selection start selection
4198 shift-left search word extend selection
4199 right click extend selection popup menu (place cursor)
4200 right drag extend selection -
4201 middle click paste paste
4202
4203 In the "popup" model the right mouse button produces a pop-up menu.
4204 You need to define this first, see |popup-menu|.
4205
4206 Note that you can further refine the meaning of buttons with mappings.
4207 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4208 selection (because that's handled in the GUI code directly).
4209
4210 The 'mousemodel' option is set by the |:behave| command.
4211
4212 *'mouseshape'* *'mouses'* *E547*
4213'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4214 m:no,ml:up-arrow,v:rightup-arrow"
4215 global
4216 {not in Vi}
4217 {only available when compiled with the |+mouseshape|
4218 feature}
4219 This option tells Vim what the mouse pointer should look like in
4220 different modes. The option is a comma separated list of parts, much
4221 like used for 'guicursor'. Each part consist of a mode/location-list
4222 and an argument-list:
4223 mode-list:shape,mode-list:shape,..
4224 The mode-list is a dash separated list of these modes/locations:
4225 In a normal window: ~
4226 n Normal mode
4227 v Visual mode
4228 ve Visual mode with 'selection' "exclusive" (same as 'v',
4229 if not specified)
4230 o Operator-pending mode
4231 i Insert mode
4232 r Replace mode
4233
4234 Others: ~
4235 c appending to the command-line
4236 ci inserting in the command-line
4237 cr replacing in the command-line
4238 m at the 'Hit ENTER' or 'More' prompts
4239 ml idem, but cursor in the last line
4240 e any mode, pointer below last window
4241 s any mode, pointer on a status line
4242 sd any mode, while dragging a status line
4243 vs any mode, pointer on a vertical separator line
4244 vd any mode, while dragging a vertical separator line
4245 a everywhere
4246
4247 The shape is one of the following:
4248 avail name looks like ~
4249 w x arrow Normal mouse pointer
4250 w x blank no pointer at all (use with care!)
4251 w x beam I-beam
4252 w x updown up-down sizing arrows
4253 w x leftright left-right sizing arrows
4254 w x busy The system's usual busy pointer
4255 w x no The system's usual 'no input' pointer
4256 x udsizing indicates up-down resizing
4257 x lrsizing indicates left-right resizing
4258 x crosshair like a big thin +
4259 x hand1 black hand
4260 x hand2 white hand
4261 x pencil what you write with
4262 x question big ?
4263 x rightup-arrow arrow pointing right-up
4264 w x up-arrow arrow pointing up
4265 x <number> any X11 pointer number (see X11/cursorfont.h)
4266
4267 The "avail" column contains a 'w' if the shape is available for Win32,
4268 x for X11.
4269 Any modes not specified or shapes not available use the normal mouse
4270 pointer.
4271
4272 Example: >
4273 :set mouseshape=s:udsizing,m:no
4274< will make the mouse turn to a sizing arrow over the status lines and
4275 indicate no input when the hit-enter prompt is displayed (since
4276 clicking the mouse has no effect in this state.)
4277
4278 *'mousetime'* *'mouset'*
4279'mousetime' 'mouset' number (default 500)
4280 global
4281 {not in Vi}
4282 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4283 time in msec between two mouse clicks for the second click to be
4284 recognized as a multi click.
4285
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004286 *'mzquantum'* *'mzq'*
4287'mzquantum' 'mzq' number (default 100)
4288 global
4289 {not in Vi}
4290 {not available when compiled without the |+mzscheme|
4291 feature}
4292 The number of milliseconds between polls for MzScheme threads.
4293 Negative or zero value means no thread scheduling.
4294
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 *'nrformats'* *'nf'*
4296'nrformats' 'nf' string (default "octal,hex")
4297 local to buffer
4298 {not in Vi}
4299 This defines what bases Vim will consider for numbers when using the
4300 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4301 respectively; see |CTRL-A| for more info on these commands.
4302 alpha if included, single alphabetical characters will be
4303 incremented or decremented. This is useful for a list with a
4304 letter index a), b), etc.
4305 octal if included, numbers that start with a zero will be considered
4306 to be octal. Example: Using CTRL-A on "007" results in "010".
4307 hex if included, numbers starting with "0x" or "0X" will be
4308 considered to be hexadecimal. Example: Using CTRL-X on
4309 "0x100" results in "0x0ff".
4310 Numbers which simply begin with a digit in the range 1-9 are always
4311 considered decimal. This also happens for numbers that are not
4312 recognized as octal or hex.
4313
4314 *'number'* *'nu'* *'nonumber'* *'nonu'*
4315'number' 'nu' boolean (default off)
4316 local to window
4317 Print the line number in front of each line. When the 'n' option is
4318 excluded from 'cpoptions' a wrapped line will not use the column of
4319 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004320 The 'numberwidth' option can be used to set the room used for the line
4321 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 When a long, wrapped line doesn't start with the first character, '-'
4323 characters are put before the number.
4324 See |hl-LineNr| for the highlighting used for the number.
4325
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004326 *'numberwidth'* *'nuw'*
4327'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4328 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004329 {not in Vi}
4330 {only available when compiled with the |+linebreak|
4331 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004332 Minimal number of columns to use for the line number. Only relevant
4333 when the 'number' option is set.
4334 Since one space is always between the number and the text, there is
4335 one less character for the number itself.
4336 The value is the minimum width. A bigger width is used when needed to
4337 fit the highest line number in the buffer. Thus with the Vim default
4338 of 4 there is room for a line number up to 999. When the buffer has
4339 1000 lines five columns will be used.
4340 The minimum value is 1, the maximum value is 10.
4341 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4342
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 *'osfiletype'* *'oft'* *E366*
4344'osfiletype' 'oft' string (RISC-OS default: "Text",
4345 others default: "")
4346 local to buffer
4347 {not in Vi}
4348 {only available when compiled with the |+osfiletype|
4349 feature}
4350 Some operating systems store extra information about files besides
4351 name, datestamp and permissions. This option contains the extra
4352 information, the nature of which will vary between systems.
4353 The value of this option is usually set when the file is loaded, and
4354 use to set the file type when file is written.
4355 It can affect the pattern matching of the automatic commands.
4356 |autocmd-osfiletypes|
4357
4358 *'paragraphs'* *'para'*
4359'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4360 global
4361 Specifies the nroff macros that separate paragraphs. These are pairs
4362 of two letters (see |object-motions|).
4363
4364 *'paste'* *'nopaste'*
4365'paste' boolean (default off)
4366 global
4367 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004368 Put Vim in Paste mode. This is useful if you want to cut or copy
4369 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 unexpected effects.
4371 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004372 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 knows about pasting and will mostly do the right thing without 'paste'
4374 being set. The same is true for a terminal where Vim handles the
4375 mouse clicks itself.
4376 When the 'paste' option is switched on (also when it was already on):
4377 - mapping in Insert mode and Command-line mode is disabled
4378 - abbreviations are disabled
4379 - 'textwidth' is set to 0
4380 - 'wrapmargin' is set to 0
4381 - 'autoindent' is reset
4382 - 'smartindent' is reset
4383 - 'softtabstop' is set to 0
4384 - 'revins' is reset
4385 - 'ruler' is reset
4386 - 'showmatch' is reset
4387 - 'formatoptions' is used like it is empty
4388 These options keep their value, but their effect is disabled:
4389 - 'lisp'
4390 - 'indentexpr'
4391 - 'cindent'
4392 NOTE: When you start editing another file while the 'paste' option is
4393 on, settings from the modelines or autocommands may change the
4394 settings again, causing trouble when pasting text. You might want to
4395 set the 'paste' option again.
4396 When the 'paste' option is reset the mentioned options are restored to
4397 the value before the moment 'paste' was switched from off to on.
4398 Resetting 'paste' before ever setting it does not have any effect.
4399 Since mapping doesn't work while 'paste' is active, you need to use
4400 the 'pastetoggle' option to toggle the 'paste' option with some key.
4401
4402 *'pastetoggle'* *'pt'*
4403'pastetoggle' 'pt' string (default "")
4404 global
4405 {not in Vi}
4406 When non-empty, specifies the key sequence that toggles the 'paste'
4407 option. This is like specifying a mapping: >
4408 :map {keys} :set invpaste<CR>
4409< Where {keys} is the value of 'pastetoggle'.
4410 The difference is that it will work even when 'paste' is set.
4411 'pastetoggle' works in Insert mode and Normal mode, but not in
4412 Command-line mode.
4413 Mappings are checked first, thus overrule 'pastetoggle'. However,
4414 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4415 this: >
4416 :map <F10> :set paste<CR>
4417 :map <F11> :set nopaste<CR>
4418 :imap <F10> <C-O>:set paste<CR>
4419 :imap <F11> <nop>
4420 :set pastetoggle=<F11>
4421< This will make <F10> start paste mode and <F11> stop paste mode.
4422 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4423 mode everything is inserted literally, except the 'pastetoggle' key
4424 sequence.
4425
4426 *'pex'* *'patchexpr'*
4427'patchexpr' 'pex' string (default "")
4428 global
4429 {not in Vi}
4430 {not available when compiled without the |+diff|
4431 feature}
4432 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004433 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434
4435 *'patchmode'* *'pm'* *E206*
4436'patchmode' 'pm' string (default "")
4437 global
4438 {not in Vi}
4439 When non-empty the oldest version of a file is kept. This can be used
4440 to keep the original version of a file if you are changing files in a
4441 source distribution. Only the first time that a file is written a
4442 copy of the original file will be kept. The name of the copy is the
4443 name of the original file with the string in the 'patchmode' option
4444 appended. This option should start with a dot. Use a string like
4445 ".org". 'backupdir' must not be empty for this to work (Detail: The
4446 backup file is renamed to the patchmode file after the new file has
4447 been successfully written, that's why it must be possible to write a
4448 backup file). If there was no file to be backed up, an empty file is
4449 created.
4450 When the 'backupskip' pattern matches, a patchmode file is not made.
4451 Using 'patchmode' for compressed files appends the extension at the
4452 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4453 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004454 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455
4456 *'path'* *'pa'* *E343* *E345* *E347*
4457'path' 'pa' string (default on Unix: ".,/usr/include,,"
4458 on OS/2: ".,/emx/include,,"
4459 other systems: ".,,")
4460 global or local to buffer |global-local|
4461 {not in Vi}
4462 This is a list of directories which will be searched when using the
4463 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4464 being searched for has a relative path (not starting with '/'). The
4465 directories in the 'path' option may be relative or absolute.
4466 - Use commas to separate directory names: >
4467 :set path=.,/usr/local/include,/usr/include
4468< - Spaces can also be used to separate directory names (for backwards
4469 compatibility with version 3.0). To have a space in a directory
4470 name, precede it with an extra backslash, and escape the space: >
4471 :set path=.,/dir/with\\\ space
4472< - To include a comma in a directory name precede it with an extra
4473 backslash: >
4474 :set path=.,/dir/with\\,comma
4475< - To search relative to the directory of the current file, use: >
4476 :set path=.
4477< - To search in the current directory use an empty string between two
4478 commas: >
4479 :set path=,,
4480< - A directory name may end in a ':' or '/'.
4481 - Environment variables are expanded |:set_env|.
4482 - When using |netrw.vim| URLs can be used. For example, adding
4483 "http://www.vim.org" will make ":find index.html" work.
4484 - Search upwards and downwards in a directory tree:
4485 1) "*" matches a sequence of characters, e.g.: >
4486 :set path=/usr/include/*
4487< means all subdirectories in /usr/include (but not /usr/include
4488 itself). >
4489 :set path=/usr/*c
4490< matches /usr/doc and /usr/src.
4491 2) "**" matches a subtree, up to 100 directories deep. Example: >
4492 :set path=/home/user_x/src/**
4493< means search in the whole subtree under "/home/usr_x/src".
4494 3) If the path ends with a ';', this path is the startpoint
4495 for upward search.
4496 See |file-searching| for more info and exact syntax.
4497 {not available when compiled without the |+path_extra| feature}
4498 - Careful with '\' characters, type two to get one in the option: >
4499 :set path=.,c:\\include
4500< Or just use '/' instead: >
4501 :set path=.,c:/include
4502< Don't forget "." or files won't even be found in the same directory as
4503 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004504 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 it is something like 256 or 1024 characters.
4506 You can check if all the include files are found, using the value of
4507 'path', see |:checkpath|.
4508 The use of |:set+=| and |:set-=| is preferred when adding or removing
4509 directories from the list. This avoids problems when a future version
4510 uses another default. To remove the current directory use: >
4511 :set path-=
4512< To add the current directory use: >
4513 :set path+=
4514< To use an environment variable, you probably need to replace the
4515 separator. Here is an example to append $INCL, in which directory
4516 names are separated with a semi-colon: >
4517 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4518< Replace the ';' with a ':' or whatever separator is used. Note that
4519 this doesn't work when $INCL contains a comma or white space.
4520
4521 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4522'preserveindent' 'pi' boolean (default off)
4523 local to buffer
4524 {not in Vi}
4525 When changing the indent of the current line, preserve as much of the
4526 indent structure as possible. Normally the indent is replaced by a
4527 series of tabs followed by spaces as required (unless |'expandtab'| is
4528 enabled, in which case only spaces are used). Enabling this option
4529 means the indent will preserve as many existing characters as possible
4530 for indenting, and only add additional tabs or spaces as required.
4531 NOTE: When using ">>" multiple times the resulting indent is a mix of
4532 tabs and spaces. You might not like this.
4533 NOTE: 'preserveindent' is reset when 'compatible' is set.
4534 Also see 'copyindent'.
4535 Use |:retab| to clean up white space.
4536
4537 *'previewheight'* *'pvh'*
4538'previewheight' 'pvh' number (default 12)
4539 global
4540 {not in Vi}
4541 {not available when compiled without the |+windows| or
4542 |+quickfix| feature}
4543 Default height for a preview window. Used for |:ptag| and associated
4544 commands. Used for |CTRL-W_}| when no count is given.
4545
4546 *'previewwindow'* *'nopreviewwindow'*
4547 *'pvw'* *'nopvw'* *E590*
4548'previewwindow' 'pvw' boolean (default off)
4549 local to window
4550 {not in Vi}
4551 {not available when compiled without the |+windows| or
4552 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004553 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 set. It's normally not set directly, but by using one of the commands
4555 |:ptag|, |:pedit|, etc.
4556
4557 *'printdevice'* *'pdev'*
4558'printdevice' 'pdev' string (default empty)
4559 global
4560 {not in Vi}
4561 {only available when compiled with the |+printer|
4562 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004563 The name of the printer to be used for |:hardcopy|.
4564 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004565 This option cannot be set from a |modeline| or in the |sandbox|, for
4566 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
Bram Moolenaar8299df92004-07-10 09:47:34 +00004568 *'printencoding'* *'penc'*
4569'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 global
4571 {not in Vi}
4572 {only available when compiled with the |+printer|
4573 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004574 Sets the character encoding used when printing.
4575 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576
4577 *'printexpr'* *'pexpr'*
4578'printexpr' 'pexpr' String (default: see below)
4579 global
4580 {not in Vi}
4581 {only available when compiled with the |+printer|
4582 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004583 Expression used to print the PostScript produced with |:hardcopy|.
4584 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585
Bram Moolenaar8299df92004-07-10 09:47:34 +00004586 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587'printfont' 'pfn' string (default "courier")
4588 global
4589 {not in Vi}
4590 {only available when compiled with the |+printer|
4591 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004592 The name of the font that will be used for |:hardcopy|.
4593 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594
4595 *'printheader'* *'pheader'*
4596'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4597 global
4598 {not in Vi}
4599 {only available when compiled with the |+printer|
4600 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004601 The format of the header produced in |:hardcopy| output.
4602 See |pheader-option|.
4603
4604 *'printmbcharset'* *'pmbcs'*
4605'printmbcharset' 'pmbcs' string (default "")
4606 global
4607 {not in Vi}
4608 {only available when compiled with the |+printer|
4609 and |+multi_byte| features}
4610 The CJK character set to be used for CJK output from |:hardcopy|.
4611 See |pmbcs-option|.
4612
4613 *'printmbfont'* *'pmbfn'*
4614'printmbfont' 'pmbfn' string (default "")
4615 global
4616 {not in Vi}
4617 {only available when compiled with the |+printer|
4618 and |+multi_byte| features}
4619 List of font names to be used for CJK output from |:hardcopy|.
4620 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621
4622 *'printoptions'* *'popt'*
4623'printoptions' 'popt' string (default "")
4624 global
4625 {not in Vi}
4626 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004627 List of items that control the format of the output of |:hardcopy|.
4628 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004630 *'quoteescape''* *'qe'*
4631'quoteescape' 'qe' string (default "\")
4632 local to buffer
4633 {not in Vi}
4634 The characters that are used to escape quotes in a string. Used for
4635 objects like a', a" and a` |a'|.
4636 When one of the characters in this option is found inside a string,
4637 the following character will be skipped. The default value makes the
4638 text "foo\"bar\\" considered to be one string.
4639
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4641'readonly' 'ro' boolean (default off)
4642 local to buffer
4643 If on, writes fail unless you use a '!'. Protects you from
4644 accidentally overwriting a file. Default on when Vim is started
4645 in read-only mode ("vim -R") or when the executable is called "view".
4646 {not in Vi:} When using the ":view" command the 'readonly' option is
4647 set for the newly edited buffer. When using ":w!" the 'readonly'
4648 option is reset for the current buffer.
4649
4650 *'remap'* *'noremap'*
4651'remap' boolean (default on)
4652 global
4653 Allows for mappings to work recursively. If you do not want this for
4654 a single entry, use the :noremap[!] command.
4655
4656 *'report'*
4657'report' number (default 2)
4658 global
4659 Threshold for reporting number of lines changed. When the number of
4660 changed lines is more than 'report' a message will be given for most
4661 ":" commands. If you want it always, set 'report' to 0.
4662 For the ":substitute" command the number of substitutions is used
4663 instead of the number of lines.
4664
4665 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4666'restorescreen' 'rs' boolean (default on)
4667 global
4668 {not in Vi} {only in Windows 95/NT console version}
4669 When set, the screen contents is restored when exiting Vim. This also
4670 happens when executing external commands.
4671
4672 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4673 options in your .vimrc. To disable restoring:
4674 set t_ti= t_te=
4675 To enable restoring (for an xterm):
4676 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4677 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4678
4679 *'revins'* *'ri'* *'norevins'* *'nori'*
4680'revins' 'ri' boolean (default off)
4681 global
4682 {not in Vi}
4683 {only available when compiled with the |+rightleft|
4684 feature}
4685 Inserting characters in Insert mode will work backwards. See "typing
4686 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4687 command in Insert mode, when 'allowrevins' is set.
4688 NOTE: This option is reset when 'compatible' or 'paste' is set.
4689
4690 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4691'rightleft' 'rl' boolean (default off)
4692 local to window
4693 {not in Vi}
4694 {only available when compiled with the |+rightleft|
4695 feature}
4696 When on, display orientation becomes right-to-left, i.e., characters
4697 that are stored in the file appear from the right to the left.
4698 Using this option, it is possible to edit files for languages that
4699 are written from the right to the left such as Hebrew and Arabic.
4700 This option is per window, so it is possible to edit mixed files
4701 simultaneously, or to view the same file in both ways (this is
4702 useful whenever you have a mixed text file with both right-to-left
4703 and left-to-right strings so that both sets are displayed properly
4704 in different windows). Also see |rileft.txt|.
4705
4706 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4707'rightleftcmd' 'rlc' string (default "search")
4708 local to window
4709 {not in Vi}
4710 {only available when compiled with the |+rightleft|
4711 feature}
4712 Each word in this option enables the command line editing to work in
4713 right-to-left mode for a group of commands:
4714
4715 search "/" and "?" commands
4716
4717 This is useful for languages such as Hebrew, Arabic and Farsi.
4718 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4719
4720 *'ruler'* *'ru'* *'noruler'* *'noru'*
4721'ruler' 'ru' boolean (default off)
4722 global
4723 {not in Vi}
4724 {not available when compiled without the
4725 |+cmdline_info| feature}
4726 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004727 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 text in the file is shown on the far right:
4729 Top first line is visible
4730 Bot last line is visible
4731 All first and last line are visible
4732 45% relative position in the file
4733 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004734 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735 ruler is shown there. Otherwise it is shown in the last line of the
4736 screen. If the statusline is given by 'statusline' (ie. not empty),
4737 this option takes precedence over 'ruler' and 'rulerformat'
4738 If the number of characters displayed is different from the number of
4739 bytes in the text (e.g., for a TAB or a multi-byte character), both
4740 the text column (byte number) and the screen column are shown,
4741 separated with a dash.
4742 For an empty line "0-1" is shown.
4743 For an empty buffer the line number will also be zero: "0,0-1".
4744 This option is reset when the 'paste' option is set.
4745 If you don't want to see the ruler all the time but want to know where
4746 you are, use "g CTRL-G" |g_CTRL-G|.
4747 NOTE: This option is reset when 'compatible' is set.
4748
4749 *'rulerformat'* *'ruf'*
4750'rulerformat' 'ruf' string (default empty)
4751 global
4752 {not in Vi}
4753 {not available when compiled without the |+statusline|
4754 feature}
4755 When this option is not empty, it determines the content of the ruler
4756 string, as displayed for the 'ruler' option.
4757 The format of this option, is like that of 'statusline'.
4758 The default ruler width is 17 characters. To make the ruler 15
4759 characters wide, put "%15(" at the start and "%)" at the end.
4760 Example: >
4761 :set rulerformat=%15(%c%V\ %p%%%)
4762<
4763 *'runtimepath'* *'rtp'* *vimfiles*
4764'runtimepath' 'rtp' string (default:
4765 Unix: "$HOME/.vim,
4766 $VIM/vimfiles,
4767 $VIMRUNTIME,
4768 $VIM/vimfiles/after,
4769 $HOME/.vim/after"
4770 Amiga: "home:vimfiles,
4771 $VIM/vimfiles,
4772 $VIMRUNTIME,
4773 $VIM/vimfiles/after,
4774 home:vimfiles/after"
4775 PC, OS/2: "$HOME/vimfiles,
4776 $VIM/vimfiles,
4777 $VIMRUNTIME,
4778 $VIM/vimfiles/after,
4779 $HOME/vimfiles/after"
4780 Macintosh: "$VIM:vimfiles,
4781 $VIMRUNTIME,
4782 $VIM:vimfiles:after"
4783 RISC-OS: "Choices:vimfiles,
4784 $VIMRUNTIME,
4785 Choices:vimfiles/after"
4786 VMS: "sys$login:vimfiles,
4787 $VIM/vimfiles,
4788 $VIMRUNTIME,
4789 $VIM/vimfiles/after,
4790 sys$login:vimfiles/after"
4791 global
4792 {not in Vi}
4793 This is a list of directories which will be searched for runtime
4794 files:
4795 filetype.vim filetypes by file name |new-filetype|
4796 scripts.vim filetypes by file contents |new-filetype-scripts|
4797 colors/ color scheme files |:colorscheme|
4798 compiler/ compiler files |:compiler|
4799 doc/ documentation |write-local-help|
4800 ftplugin/ filetype plugins |write-filetype-plugin|
4801 indent/ indent scripts |indent-expression|
4802 keymap/ key mapping files |mbyte-keymap|
4803 lang/ menu translations |:menutrans|
4804 menu.vim GUI menus |menu.vim|
4805 plugin/ plugin scripts |write-plugin|
4806 print/ files for printing |postscript-print-encoding|
4807 syntax/ syntax files |mysyntaxfile|
4808 tutor/ files for vimtutor |tutor|
4809
4810 And any other file searched for with the |:runtime| command.
4811
4812 The defaults for most systems are setup to search five locations:
4813 1. In your home directory, for your personal preferences.
4814 2. In a system-wide Vim directory, for preferences from the system
4815 administrator.
4816 3. In $VIMRUNTIME, for files distributed with Vim.
4817 *after-directory*
4818 4. In the "after" directory in the system-wide Vim directory. This is
4819 for the system administrator to overrule or add to the distributed
4820 defaults (rarely needed)
4821 5. In the "after" directory in your home directory. This is for
4822 personal preferences to overrule or add to the distributed defaults
4823 or system-wide settings (rarely needed).
4824
4825 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4826 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004827 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 wildcards.
4829 See |:runtime|.
4830 Example: >
4831 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4832< This will use the directory "~/vimruntime" first (containing your
4833 personal Vim runtime files), then "/mygroup/vim" (shared between a
4834 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4835 files).
4836 You probably should always include $VIMRUNTIME somewhere, to use the
4837 distributed runtime files. You can put a directory before $VIMRUNTIME
4838 to find files which replace a distributed runtime files. You can put
4839 a directory after $VIMRUNTIME to find files which add to distributed
4840 runtime files.
4841 This option cannot be set from a |modeline| or in the |sandbox|, for
4842 security reasons.
4843
4844 *'scroll'* *'scr'*
4845'scroll' 'scr' number (default: half the window height)
4846 local to window
4847 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4848 set to half the number of lines in the window when the window size
4849 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004850 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4852 the number of screen lines instead of file lines, makes a difference
4853 when lines wrap}
4854
4855 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4856'scrollbind' 'scb' boolean (default off)
4857 local to window
4858 {not in Vi}
4859 {not available when compiled without the |+scrollbind|
4860 feature}
4861 See also |scroll-binding|. When this option is set, the current
4862 window scrolls as other scrollbind windows (windows that also have
4863 this option set) scroll. This option is useful for viewing the
4864 differences between two versions of a file, see 'diff'.
4865 See |'scrollopt'| for options that determine how this option should be
4866 interpreted.
4867 This option is mostly reset when splitting a window to edit another
4868 file. This means that ":split | edit file" results in two windows
4869 with scroll-binding, but ":split file" does not.
4870
4871 *'scrolljump'* *'sj'*
4872'scrolljump' 'sj' number (default 1)
4873 global
4874 {not in Vi}
4875 Minimal number of lines to scroll when the cursor gets off the
4876 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4877 CTRL-D). Useful if your terminal scrolls very slowly.
4878 NOTE: This option is set to 1 when 'compatible' is set.
4879
4880 *'scrolloff'* *'so'*
4881'scrolloff' 'so' number (default 0)
4882 global
4883 {not in Vi}
4884 Minimal number of screen lines to keep above and below the cursor.
4885 This will make some context visible around where you are working. If
4886 you set it to a very large value (999) the cursor line will always be
4887 in the middle of the window (except at the start or end of the file or
4888 when long lines wrap).
4889 For scrolling horizontally see 'sidescrolloff'.
4890 NOTE: This option is set to 0 when 'compatible' is set.
4891
4892 *'scrollopt'* *'sbo'*
4893'scrollopt' 'sbo' string (default "ver,jump")
4894 global
4895 {not available when compiled without the |+scrollbind|
4896 feature}
4897 {not in Vi}
4898 This is a comma-separated list of words that specifies how
4899 'scrollbind' windows should behave.
4900 The following words are available:
4901 ver Bind vertical scrolling for 'scrollbind' windows
4902 hor Bind horizontal scrolling for 'scrollbind' windows
4903 jump Applies to the offset between two windows for vertical
4904 scrolling. This offset is the difference in the first
4905 displayed line of the bound windows. When moving
4906 around in a window, another 'scrollbind' window may
4907 reach a position before the start or after the end of
4908 the buffer. The offset is not changed though, when
4909 moving back the 'scrollbind' window will try to scroll
4910 to the desired position when possible.
4911 When now making that window the current one, two
4912 things can be done with the relative offset:
4913 1. When "jump" is not included, the relative offset is
4914 adjusted for the scroll position in the new current
4915 window. When going back to the other window, the
4916 the new relative offset will be used.
4917 2. When "jump" is included, the other windows are
4918 scrolled to keep the same relative offset. When
4919 going back to the other window, it still uses the
4920 same relative offset.
4921 Also see |scroll-binding|.
4922
4923 *'sections'* *'sect'*
4924'sections' 'sect' string (default "SHNHH HUnhsh")
4925 global
4926 Specifies the nroff macros that separate sections. These are pairs of
4927 two letters (See |object-motions|). The default makes a section start
4928 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
4929
4930 *'secure'* *'nosecure'* *E523*
4931'secure' boolean (default off)
4932 global
4933 {not in Vi}
4934 When on, ":autocmd", shell and write commands are not allowed in
4935 ".vimrc" and ".exrc" in the current directory and map commands are
4936 displayed. Switch it off only if you know that you will not run into
4937 problems, or when the 'exrc' option is off. On Unix this option is
4938 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004939 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 'secure' at the end of your ~/.vimrc then.
4941 This option cannot be set from a |modeline| or in the |sandbox|, for
4942 security reasons.
4943
4944 *'selection'* *'sel'*
4945'selection' 'sel' string (default "inclusive")
4946 global
4947 {not in Vi}
4948 This option defines the behavior of the selection. It is only used
4949 in Visual and Select mode.
4950 Possible values:
4951 value past line inclusive ~
4952 old no yes
4953 inclusive yes yes
4954 exclusive yes no
4955 "past line" means that the cursor is allowed to be positioned one
4956 character past the line.
4957 "inclusive" means that the last character of the selection is included
4958 in an operation. For example, when "x" is used to delete the
4959 selection.
4960 Note that when "exclusive" is used and selecting from the end
4961 backwards, you cannot include the last character of a line, when
4962 starting in Normal mode and 'virtualedit' empty.
4963
4964 The 'selection' option is set by the |:behave| command.
4965
4966 *'selectmode'* *'slm'*
4967'selectmode' 'slm' string (default "")
4968 global
4969 {not in Vi}
4970 This is a comma separated list of words, which specifies when to start
4971 Select mode instead of Visual mode, when a selection is started.
4972 Possible values:
4973 mouse when using the mouse
4974 key when using shifted special keys
4975 cmd when using "v", "V" or CTRL-V
4976 See |Select-mode|.
4977 The 'selectmode' option is set by the |:behave| command.
4978
4979 *'sessionoptions'* *'ssop'*
4980'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
4981 help,options,winsize")
4982 global
4983 {not in Vi}
4984 {not available when compiled without the +mksession
4985 feature}
4986 Changes the effect of the |:mksession| command. It is a comma
4987 separated list of words. Each word enables saving and restoring
4988 something:
4989 word save and restore ~
4990 blank empty windows
4991 buffers hidden and unloaded buffers, not just those in windows
4992 curdir the current directory
4993 folds manually created folds, opened/closed folds and local
4994 fold options
4995 globals global variables that start with an uppercase letter
4996 and contain at least one lowercase letter.
4997 help the help window
4998 localoptions options and mappings local to a window or buffer (not
4999 global values for local options)
5000 options all options and mappings (also global values for local
5001 options)
5002 resize size of the Vim window: 'lines' and 'columns'
5003 sesdir the directory in which the session file is located
5004 will become the current directory (useful with
5005 projects accessed over a network from different
5006 systems)
5007 slash backslashes in file names replaced with forward
5008 slashes
5009 unix with Unix end-of-line format (single <NL>), even when
5010 on Windows or DOS
5011 winpos position of the whole Vim window
5012 winsize window sizes
5013
5014 Don't include both "curdir" and "sesdir".
5015 When "curdir" nor "sesdir" is included, file names are stored with
5016 absolute paths.
5017 "slash" and "unix" are useful on Windows when sharing session files
5018 with Unix. The Unix version of Vim cannot source dos format scripts,
5019 but the Windows version of Vim can source unix format scripts.
5020
5021 *'shell'* *'sh'* *E91*
5022'shell' 'sh' string (default $SHELL or "sh",
5023 MS-DOS and Win32: "command.com" or
5024 "cmd.exe", OS/2: "cmd")
5025 global
5026 Name of the shell to use for ! and :! commands. When changing the
5027 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5028 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005029 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005030 See |option-backslash| about including spaces and backslashes.
5031 Environment variables are expanded |:set_env|.
5032 If the name of the shell contains a space, you might need to enclose
5033 it in quotes. Example: >
5034 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5035< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005036 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005037 "-f" is not inside the quotes, because it is not part of the command
5038 name. And Vim automagically recognizes the backslashes that are path
5039 separators.
5040 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5041 variable to change the way external commands are executed. See the
5042 libc.inf file of DJGPP.
5043 Under MS-Windows, when the executable ends in ".com" it must be
5044 included. Thus setting the shell to "command.com" or "4dos.com"
5045 works, but "command" and "4dos" do not work for all commands (e.g.,
5046 filtering).
5047 For unknown reasons, when using "4dos.com" the current directory is
5048 changed to "C:\". To avoid this set 'shell' like this: >
5049 :set shell=command.com\ /c\ 4dos
5050< This option cannot be set from a |modeline| or in the |sandbox|, for
5051 security reasons.
5052
5053 *'shellcmdflag'* *'shcf'*
5054'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5055 does not contain "sh" somewhere: "/c")
5056 global
5057 {not in Vi}
5058 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5059 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5060 systems, the default is set according to the value of 'shell', to
5061 reduce the need to set this option by the user. It's not used for
5062 OS/2 (EMX figures this out itself). See |option-backslash| about
5063 including spaces and backslashes. See |dos-shell|.
5064 This option cannot be set from a |modeline| or in the |sandbox|, for
5065 security reasons.
5066
5067 *'shellpipe'* *'sp'*
5068'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5069 global
5070 {not in Vi}
5071 {not available when compiled without the |+quickfix|
5072 feature}
5073 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005074 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 including spaces and backslashes.
5076 The name of the temporary file can be represented by "%s" if necessary
5077 (the file name is appended automatically if no %s appears in the value
5078 of this option).
5079 For the Amiga and MS-DOS the default is ">". The output is directly
5080 saved in a file and not echoed to the screen.
5081 For Unix the default it "| tee". The stdout of the compiler is saved
5082 in a file and echoed to the screen. If the 'shell' option is "csh" or
5083 "tcsh" after initializations, the default becomes "|& tee". If the
5084 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5085 "2>&1| tee". This means that stderr is also included.
5086 The initialization of this option is done after reading the ".vimrc"
5087 and the other initializations, so that when the 'shell' option is set
5088 there, the 'shellpipe' option changes automatically, unless it was
5089 explicitly set before.
5090 When 'shellpipe' is set to an empty string, no redirection of the
5091 ":make" output will be done. This is useful if you use a 'makeprg'
5092 that writes to 'makeef' by itself. If you want no piping, but do
5093 want to include the 'makeef', set 'shellpipe' to a single space.
5094 Don't forget to precede the space with a backslash: ":set sp=\ ".
5095 In the future pipes may be used for filtering and this option will
5096 become obsolete (at least for Unix).
5097 This option cannot be set from a |modeline| or in the |sandbox|, for
5098 security reasons.
5099
5100 *'shellquote'* *'shq'*
5101'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5102 contains "sh" somewhere: "\"")
5103 global
5104 {not in Vi}
5105 Quoting character(s), put around the command passed to the shell, for
5106 the "!" and ":!" commands. The redirection is kept outside of the
5107 quoting. See 'shellxquote' to include the redirection. It's
5108 probably not useful to set both options.
5109 This is an empty string by default. Only known to be useful for
5110 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5111 or bash, where it should be "\"". The default is adjusted according
5112 the value of 'shell', to reduce the need to set this option by the
5113 user. See |dos-shell|.
5114 This option cannot be set from a |modeline| or in the |sandbox|, for
5115 security reasons.
5116
5117 *'shellredir'* *'srr'*
5118'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5119 global
5120 {not in Vi}
5121 String to be used to put the output of a filter command in a temporary
5122 file. See also |:!|. See |option-backslash| about including spaces
5123 and backslashes.
5124 The name of the temporary file can be represented by "%s" if necessary
5125 (the file name is appended automatically if no %s appears in the value
5126 of this option).
5127 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5128 or "zsh" during initializations, the default becomes ">&". If the
5129 'shell' option is "sh", "ksh" or "bash" the default becomes
5130 ">%s 2>&1". This means that stderr is also included.
5131 For Win32, the Unix checks are done and additionally "cmd" is checked
5132 for, which makes the default ">%s 2>&1". Also, the same names with
5133 ".exe" appended are checked for.
5134 The initialization of this option is done after reading the ".vimrc"
5135 and the other initializations, so that when the 'shell' option is set
5136 there, the 'shellredir' option changes automatically unless it was
5137 explicitly set before.
5138 In the future pipes may be used for filtering and this option will
5139 become obsolete (at least for Unix).
5140 This option cannot be set from a |modeline| or in the |sandbox|, for
5141 security reasons.
5142
5143 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5144'shellslash' 'ssl' boolean (default off)
5145 global
5146 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5147 When set, a forward slash is used when expanding file names. This is
5148 useful when a Unix-like shell is used instead of command.com or
5149 cmd.exe. Backward slashes can still be typed, but they are changed to
5150 forward slashes by Vim.
5151 Note that setting or resetting this option has no effect for some
5152 existing file names, thus this option needs to be set before opening
5153 any file for best results. This might change in the future.
5154 'shellslash' only works when a backslash can be used as a path
5155 separator. To test if this is so use: >
5156 if exists('+shellslash')
5157<
5158 *'shelltype'* *'st'*
5159'shelltype' 'st' number (default 0)
5160 global
5161 {not in Vi} {only for the Amiga}
5162 On the Amiga this option influences the way how the commands work
5163 which use a shell.
5164 0 and 1: always use the shell
5165 2 and 3: use the shell only to filter lines
5166 4 and 5: use shell only for ':sh' command
5167 When not using the shell, the command is executed directly.
5168
5169 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5170 1 and 3: use "shell cmd" to start external commands
5171
5172 *'shellxquote'* *'sxq'*
5173'shellxquote' 'sxq' string (default: "";
5174 for Win32, when 'shell' contains "sh"
5175 somewhere: "\""
5176 for Unix, when using system(): "\"")
5177 global
5178 {not in Vi}
5179 Quoting character(s), put around the command passed to the shell, for
5180 the "!" and ":!" commands. Includes the redirection. See
5181 'shellquote' to exclude the redirection. It's probably not useful
5182 to set both options.
5183 This is an empty string by default. Known to be useful for
5184 third-party shells when using the Win32 version, such as the MKS Korn
5185 Shell or bash, where it should be "\"". The default is adjusted
5186 according the value of 'shell', to reduce the need to set this option
5187 by the user. See |dos-shell|.
5188 This option cannot be set from a |modeline| or in the |sandbox|, for
5189 security reasons.
5190
5191 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5192'shiftround' 'sr' boolean (default off)
5193 global
5194 {not in Vi}
5195 Round indent to multiple of 'shiftwidth'. Applies to > and <
5196 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5197 a multiple of 'shiftwidth' (this is Vi compatible).
5198 NOTE: This option is reset when 'compatible' is set.
5199
5200 *'shiftwidth'* *'sw'*
5201'shiftwidth' 'sw' number (default 8)
5202 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005203 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204 |'cindent'|, |>>|, |<<|, etc.
5205
5206 *'shortmess'* *'shm'*
5207'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "")
5208 global
5209 {not in Vi}
5210 This option helps to avoid all the |hit-enter| prompts caused by file
5211 messages, for example with CTRL-G, and to avoid some other messages.
5212 It is a list of flags:
5213 flag meaning when present ~
5214 f use "(3 of 5)" instead of "(file 3 of 5)"
5215 i use "[noeol]" instead of "[Incomplete last line]"
5216 l use "999L, 888C" instead of "999 lines, 888 characters"
5217 m use "[+]" instead of "[Modified]"
5218 n use "[New]" instead of "[New File]"
5219 r use "[RO]" instead of "[readonly]"
5220 w use "[w]" instead of "written" for file write message
5221 and "[a]" instead of "appended" for ':w >> file' command
5222 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5223 "[unix format]" and "[mac]" instead of "[mac format]".
5224 a all of the above abbreviations
5225
5226 o overwrite message for writing a file with subsequent message
5227 for reading a file (useful for ":wn" or when 'autowrite' on)
5228 O message for reading a file overwrites any previous message.
5229 Also for quickfix message (e.g., ":cn").
5230 s don't give "search hit BOTTOM, continuing at TOP" or "search
5231 hit TOP, continuing at BOTTOM" messages
5232 t truncate file message at the start if it is too long to fit
5233 on the command-line, "<" will appear in the left most column.
5234 Ignored in Ex mode.
5235 T truncate other messages in the middle if they are too long to
5236 fit on the command line. "..." will appear in the middle.
5237 Ignored in Ex mode.
5238 W don't give "written" or "[w]" when writing a file
5239 A don't give the "ATTENTION" message when an existing swap file
5240 is found.
5241 I don't give the intro message when starting Vim |:intro|.
5242
5243 This gives you the opportunity to avoid that a change between buffers
5244 requires you to hit <Enter>, but still gives as useful a message as
5245 possible for the space available. To get the whole message that you
5246 would have got with 'shm' empty, use ":file!"
5247 Useful values:
5248 shm= No abbreviation of message.
5249 shm=a Abbreviation, but no loss of information.
5250 shm=at Abbreviation, and truncate message when necessary.
5251
5252 NOTE: This option is set to the Vi default value when 'compatible' is
5253 set and to the Vim default value when 'compatible' is reset.
5254
5255 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5256'shortname' 'sn' boolean (default off)
5257 local to buffer
5258 {not in Vi, not in MS-DOS versions}
5259 Filenames are assumed to be 8 characters plus one extension of 3
5260 characters. Multiple dots in file names are not allowed. When this
5261 option is on, dots in file names are replaced with underscores when
5262 adding an extension (".~" or ".swp"). This option is not available
5263 for MS-DOS, because then it would always be on. This option is useful
5264 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5265 or crossdos. When running the Win32 GUI version under Win32s, this
5266 option is always on by default.
5267
5268 *'showbreak'* *'sbr'* *E595*
5269'showbreak' 'sbr' string (default "")
5270 global
5271 {not in Vi}
5272 {not available when compiled without the |+linebreak|
5273 feature}
5274 String to put at the start of lines that have been wrapped. Useful
5275 values are "> " or "+++ ".
5276 Only printable single-cell characters are allowed, excluding <Tab> and
5277 comma (in a future version the comma might be used to separate the
5278 part that is shown at the end and at the start of a line).
5279 The characters are highlighted according to the '@' flag in
5280 'highlight'.
5281 Note that tabs after the showbreak will be displayed differently.
5282 If you want the 'showbreak' to appear in between line numbers, add the
5283 "n" flag to 'cpoptions'.
5284
5285 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5286'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5287 off)
5288 global
5289 {not in Vi}
5290 {not available when compiled without the
5291 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005292 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 terminal is slow.
5294 In Visual mode the size of the selected area is shown:
5295 - When selecting characters within a line, the number of characters.
5296 - When selecting more than one line, the number of lines.
5297 - When selecting a block, the size in screen characters: linesxcolumns.
5298 NOTE: This option is set to the Vi default value when 'compatible' is
5299 set and to the Vim default value when 'compatible' is reset.
5300
5301 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5302'showfulltag' 'sft' boolean (default off)
5303 global
5304 {not in Vi}
5305 When completing a word in insert mode (see |ins-completion|) from the
5306 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005307 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 matched a C function, you can see a template for what arguments are
5309 required (coding style permitting).
5310
5311 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5312'showmatch' 'sm' boolean (default off)
5313 global
5314 When a bracket is inserted, briefly jump to the matching one. The
5315 jump is only done if the match can be seen on the screen. The time to
5316 show the match can be set with 'matchtime'.
5317 A Beep is given if there is no match (no matter if the match can be
5318 seen or not). This option is reset when the 'paste' option is set.
5319 When the 'm' flag is not included in 'cpoptions', typing a character
5320 will immediately move the cursor back to where it belongs.
5321 See the "sm" field in 'guicursor' for setting the cursor shape and
5322 blinking when showing the match.
5323 The 'matchpairs' option can be used to specify the characters to show
5324 matches for. 'rightleft' and 'revins' are used to look for opposite
5325 matches.
5326 Note: For the use of the short form parental guidance is advised.
5327
5328 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5329'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5330 global
5331 If in Insert, Replace or Visual mode put a message on the last line.
5332 Use the 'M' flag in 'highlight' to set the type of highlighting for
5333 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005334 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 doesn't mean XIM is really active, especially when 'imactivatekey' is
5336 not set.
5337 NOTE: This option is set to the Vi default value when 'compatible' is
5338 set and to the Vim default value when 'compatible' is reset.
5339
5340 *'sidescroll'* *'ss'*
5341'sidescroll' 'ss' number (default 0)
5342 global
5343 {not in Vi}
5344 The minimal number of columns to scroll horizontally. Used only when
5345 the 'wrap' option is off and the cursor is moved off of the screen.
5346 When it is zero the cursor will be put in the middle of the screen.
5347 When using a slow terminal set it to a large number or 0. When using
5348 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5349 commands.
5350
5351 *'sidescrolloff'* *'siso'*
5352'sidescrolloff' 'siso' number (default 0)
5353 global
5354 {not in Vi}
5355 The minimal number of screen columns to keep to the left and to the
5356 right of the cursor if 'nowrap' is set. Setting this option to a value
5357 greater than 0 while having |'sidescroll'| also at a non-zero value
5358 makes some context visible in the line you are scrolling in
5359 horizontally (except at the end and beginning of the line). Setting
5360 this option to a large value (like 999) has the effect of keeping the
5361 cursor horizontally centered in the window, as long as one does not
5362 come too close to the beginning or end of the line.
5363 NOTE: This option is set to 0 when 'compatible' is set.
5364
5365 Example: Try this together with 'sidescroll' and 'listchars' as
5366 in the following example to never allow the cursor to move
5367 onto the "extends" character:
5368
5369 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5370 :set sidescrolloff=1
5371
5372
5373 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5374'smartcase' 'scs' boolean (default off)
5375 global
5376 {not in Vi}
5377 Override the 'ignorecase' option if the search pattern contains upper
5378 case characters. Only used when the search pattern is typed and
5379 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005380 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5382 recalling the search pattern from history and hitting <Enter>.
5383 NOTE: This option is reset when 'compatible' is set.
5384
5385 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5386'smartindent' 'si' boolean (default off)
5387 local to buffer
5388 {not in Vi}
5389 {not available when compiled without the
5390 |+smartindent| feature}
5391 Do smart autoindenting when starting a new line. Works for C-like
5392 programs, but can also be used for other languages. 'cindent' does
5393 something like this, works better in most cases, but is more strict,
5394 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5395 'indentexpr' is a more advanced alternative.
5396 Normally 'autoindent' should also be on when using 'smartindent'.
5397 An indent is automatically inserted:
5398 - After a line ending in '{'.
5399 - After a line starting with a keyword from 'cinwords'.
5400 - Before a line starting with '}' (only with the "O" command).
5401 When typing '}' as the first character in a new line, that line is
5402 given the same indent as the matching '{'.
5403 When typing '#' as the first character in a new line, the indent for
5404 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005405 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5407 When using the ">>" command, lines starting with '#' are not shifted
5408 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005409 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 is set smart indenting is disabled.
5411
5412 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5413'smarttab' 'sta' boolean (default off)
5414 global
5415 {not in Vi}
5416 When on, a <Tab> in front of a line inserts blanks according to
5417 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5418 a 'shiftwidth' worth of space at the start of the line.
5419 When off a <Tab> always inserts blanks according to 'tabstop'.
5420 'shiftwidth' is only used for shifting text left or right
5421 |shift-left-right|.
5422 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5423 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005424 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425 NOTE: This option is reset when 'compatible' is set.
5426
5427 *'softtabstop'* *'sts'*
5428'softtabstop' 'sts' number (default 0)
5429 local to buffer
5430 {not in Vi}
5431 Number of spaces that a <Tab> counts for while performing editing
5432 operations, like inserting a <Tab> or using <BS>. It "feels" like
5433 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5434 used. This is useful to keep the 'ts' setting at its standard value
5435 of 8, while being able to edit like it is set to 'sts'. However,
5436 commands like "x" still work on the actual characters.
5437 When 'sts' is zero, this feature is off.
5438 'softtabstop' is set to 0 when the 'paste' option is set.
5439 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5440 spaces is minimized by using <Tab>s.
5441 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5442 set.
5443 NOTE: This option is set to 0 when 'compatible' is set.
5444
5445 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5446'splitbelow' 'sb' boolean (default off)
5447 global
5448 {not in Vi}
5449 {not available when compiled without the +windows
5450 feature}
5451 When on, splitting a window will put the new window below the current
5452 one. |:split|
5453
5454 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5455'splitright' 'spr' boolean (default off)
5456 global
5457 {not in Vi}
5458 {not available when compiled without the +vertsplit
5459 feature}
5460 When on, splitting a window will put the new window right of the
5461 current one. |:vsplit|
5462
5463 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5464'startofline' 'sol' boolean (default on)
5465 global
5466 {not in Vi}
5467 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005468 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005469 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005470 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 with a linewise operator, with "%" with a count and to buffer changing
5472 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5473 only has a line number, e.g., ":25" or ":+".
5474 In case of buffer changing commands the cursor is placed at the column
5475 where it was the last time the buffer was edited.
5476 NOTE: This option is set when 'compatible' is set.
5477
5478 *'statusline'* *'stl'* *E540* *E541* *E542*
5479'statusline' 'stl' string (default empty)
5480 global
5481 {not in Vi}
5482 {not available when compiled without the |+statusline|
5483 feature}
5484 When nonempty, this option determines the content of the status line.
5485 Also see |status-line|.
5486
5487 The option consists of printf style '%' items interspersed with
5488 normal text. Each status line item is of the form:
5489 %-0{minwid}.{maxwid}{item}
5490 All fields except the {item} is optional. A single percent sign can
5491 be given as "%%". Up to 80 items can be specified.
5492
5493 Note that the only effect of 'ruler' when this option is set (and
5494 'laststatus' is 2) is controlling the output of |CTRL-G|.
5495
5496 field meaning ~
5497 - Left justify the item. The default is right justified
5498 when minwid is larger than the length of the item.
5499 0 Leading zeroes in numeric items. Overridden by '-'.
5500 minwid Minimum width of the item, padding as set by '-' & '0'.
5501 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005502 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 on the left for text items. Numeric items will be
5504 shifted down to maxwid-2 digits followed by '>'number
5505 where number is the amount of missing digits, much like
5506 an exponential notation.
5507 item A one letter code as described below.
5508
5509 Following is a description of the possible statusline items. The
5510 second character in "item" is the type:
5511 N for number
5512 S for string
5513 F for flags as described below
5514 - not applicable
5515
5516 item meaning ~
5517 f S Path to the file in the buffer, relative to current directory.
5518 F S Full path to the file in the buffer.
5519 t S File name (tail) of file in the buffer.
5520 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5521 M F Modified flag, text is ",+" or ",-".
5522 r F Readonly flag, text is " [RO]".
5523 R F Readonly flag, text is ",RO".
5524 h F Help buffer flag, text is " [help]".
5525 H F Help buffer flag, text is ",HLP".
5526 w F Preview window flag, text is " [Preview]".
5527 W F Preview window flag, text is ",PRV".
5528 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5529 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5530 {not available when compiled without |+autocmd| feature}
5531 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5532 being used: "<keymap>"
5533 n N Buffer number.
5534 b N Value of byte under cursor.
5535 B N As above, in hexadecimal.
5536 o N Byte number in file of byte under cursor, first byte is 1.
5537 Mnemonic: Offset from start of file (with one added)
5538 {not available when compiled without |+byte_offset| feature}
5539 O N As above, in hexadecimal.
5540 N N Printer page number. (Only works in the 'printheader' option.)
5541 l N Line number.
5542 L N Number of lines in buffer.
5543 c N Column number.
5544 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005545 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005546 p N Percentage through file in lines as in |CTRL-G|.
5547 P S Percentage through file of displayed window. This is like the
5548 percentage described for 'ruler'. Always 3 in length.
5549 a S Argument list status as in default title. ({current} of {max})
5550 Empty if the argument file count is zero or one.
5551 { NF Evaluate expression between '{' and '}' and substitute result.
5552 ( - Start of item group. Can be used for setting the width and
5553 alignment of a section. Must be followed by %) somewhere.
5554 ) - End of item group. No width fields allowed.
5555 < - Where to truncate line if too long. Default is at the start.
5556 No width fields allowed.
5557 = - Separation point between left and right aligned items.
5558 No width fields allowed.
5559 * - Set highlight group to User{N}, where {N} is taken from the
5560 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5561 The difference between User{N} and StatusLine will be applied
5562 to StatusLineNC for the statusline of non-current windows.
5563 The number N must be between 1 and 9. See |hl-User1..9|
5564
5565 Display of flags are controlled by the following heuristic:
5566 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005567 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 with a space it is assumed that it wants to separate itself from
5569 anything but other flags. That is: A leading comma is removed if the
5570 preceding character stems from plaintext. A leading space is removed
5571 if the preceding character stems from another active flag. This will
5572 make a nice display when flags are used like in the examples below.
5573
5574 When all items in a group becomes an empty string (ie. flags that are
5575 not set) and a minwid is not set for the group, the whole group will
5576 become empty. This will make a group like the following disappear
5577 completely from the statusline when none of the flags are set. >
5578 :set statusline=...%(\ [%M%R%H]%)...
5579<
5580 Beware that an expression is evaluated each and every time the status
5581 line is displayed. The current buffer and current window will be set
5582 temporarily to that of the window (and buffer) whose statusline is
5583 currently being drawn. The expression will evaluate in this context.
5584 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5585 real current buffer. The expression is evaluated in the |sandbox|.
5586
5587 If the statusline is not updated when you want it (e.g., after setting
5588 a variable that's used in an expression), you can force an update by
5589 setting an option without changing its value. Example: >
5590 :let &ro = &ro
5591
5592< A result of all digits is regarded a number for display purposes.
5593 Otherwise the result is taken as flag text and applied to the rules
5594 described above.
5595
5596 Watch out for errors in expressions. They may render Vim unusable !
5597 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5598 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5599
5600 Examples:
5601 Emulate standard status line with 'ruler' set >
5602 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5603< Similar, but add ASCII value of char under the cursor (like "ga") >
5604 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5605< Display byte count and byte value, modified flag in red. >
5606 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5607 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5608< Display a ,GZ flag if a compressed file is loaded >
5609 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5610< In the |:autocmd|'s: >
5611 :let b:gzflag = 1
5612< And: >
5613 :unlet b:gzflag
5614< And define this function: >
5615 :function VarExists(var, val)
5616 : if exists(a:var) | return a:val | else | return '' | endif
5617 :endfunction
5618<
5619 *'suffixes'* *'su'*
5620'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5621 global
5622 {not in Vi}
5623 Files with these suffixes get a lower priority when multiple files
5624 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005625 suffixes. Spaces after the comma are ignored. A dot is also seen as
5626 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 separator, precede it with a backslash (see |option-backslash| about
5628 including spaces and backslashes).
5629 See 'wildignore' for completely ignoring files.
5630 The use of |:set+=| and |:set-=| is preferred when adding or removing
5631 suffixes from the list. This avoids problems when a future version
5632 uses another default.
5633
5634 *'suffixesadd'* *'sua'*
5635'suffixesadd' 'sua' string (default "")
5636 local to buffer
5637 {not in Vi}
5638 {not available when compiled without the
5639 |+file_in_path| feature}
5640 Comma separated list of suffixes, which are used when searching for a
5641 file for the "gf", "[I", etc. commands. Example: >
5642 :set suffixesadd=.java
5643<
5644 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5645'swapfile' 'swf' boolean (default on)
5646 local to buffer
5647 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005648 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005649 swapfile is not wanted for a specific buffer. For example, with
5650 confidential information that even root must not be able to access.
5651 Careful: All text will be in memory:
5652 - Don't use this for big files.
5653 - Recovery will be impossible!
5654 A swapfile will only be present when |'updatecount'| is non-zero and
5655 'swapfile' is set.
5656 When 'swapfile' is reset, the swap file for the current buffer is
5657 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5658 non-zero, a swap file is immediately created.
5659 Also see |swap-file| and |'swapsync'|.
5660
5661 This option is used together with 'bufhidden' and 'buftype' to
5662 specify special kinds of buffers. See |special-buffers|.
5663
5664 *'swapsync'* *'sws'*
5665'swapsync' 'sws' string (default "fsync")
5666 global
5667 {not in Vi}
5668 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005669 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005670 When this option is empty parts of the swap file may be in memory and
5671 not written to disk. When the system crashes you may lose more work.
5672 On Unix the system does a sync now and then without Vim asking for it,
5673 so the disadvantage of setting this option off is small. On some
5674 systems the swap file will not be written at all. For a unix system
5675 setting it to "sync" will use the sync() call instead of the default
5676 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005677 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005678
5679 *'switchbuf'* *'swb'*
5680'switchbuf' 'swb' string (default "")
5681 global
5682 {not in Vi}
5683 This option controls the behavior when switching between buffers.
5684 Possible values (comma separated list):
5685 useopen If included, jump to the first open window that
5686 contains the specified buffer (if there is one).
5687 Otherwise: Do not examine other windows.
5688 This setting is checked with |quickfix| commands, when
5689 jumping to errors (":cc", ":cn", "cp", etc.). It is
5690 also used in all buffer related split commands, for
5691 example ":sbuffer", ":sbnext", or ":sbrewind".
5692 split If included, split the current window before loading
5693 a buffer. Otherwise: do not split, use current window.
5694 Supported in |quickfix| commands that display errors.
5695
5696 *'syntax'* *'syn'*
5697'syntax' 'syn' string (default empty)
5698 local to buffer
5699 {not in Vi}
5700 {not available when compiled without the |+syntax|
5701 feature}
5702 When this option is set, the syntax with this name is loaded, unless
5703 syntax highlighting has been switched off with ":syntax off".
5704 Otherwise this option does not always reflect the current syntax (the
5705 b:current_syntax variable does).
5706 This option is most useful in a modeline, for a file which syntax is
5707 not automatically recognized. Example, for in an IDL file: >
5708 /* vim: set syntax=idl : */
5709< To switch off syntax highlighting for the current file, use: >
5710 :set syntax=OFF
5711< To switch syntax highlighting on according to the current value of the
5712 'filetype' option: >
5713 :set syntax=ON
5714< What actually happens when setting the 'syntax' option is that the
5715 Syntax autocommand event is triggered with the value as argument.
5716 This option is not copied to another buffer, independent of the 's' or
5717 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005718 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719
5720 *'tabstop'* *'ts'*
5721'tabstop' 'ts' number (default 8)
5722 local to buffer
5723 Number of spaces that a <Tab> in the file counts for. Also see
5724 |:retab| command, and 'softtabstop' option.
5725
5726 Note: Setting 'tabstop' to any other value than 8 can make your file
5727 appear wrong in many places (e.g., when printing it).
5728
5729 There are four main ways to use tabs in Vim:
5730 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5731 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5732 will use a mix of tabs and spaces, but typing Tab and BS will
5733 behave like a tab appears every 4 (or 3) characters.
5734 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5735 'expandtab'. This way you will always insert spaces. The
5736 formatting will never be messed up when 'tabstop' is changed.
5737 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005738 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 works when using Vim to edit the file.
5740 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5741 'noexpandtab'. This should then work (for initial indents only)
5742 for any tabstop setting that people use. It might be nice to have
5743 tabs after the first non-blank inserted as spaces if you do this
5744 though. Otherwise aligned comments will be wrong when 'tabstop' is
5745 changed.
5746
5747 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5748'tagbsearch' 'tbs' boolean (default on)
5749 global
5750 {not in Vi}
5751 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005752 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005753 searching makes searching for a tag a LOT faster, but a linear search
5754 will find more tags if the tags file wasn't properly sorted.
5755 Vim normally assumes that your tags files are sorted, or indicate that
5756 they are not sorted. Only when this is not the case does the
5757 'tagbsearch' option need to be switched off.
5758
5759 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005760 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 certain files, or retry all files with a linear search. When
5762 'tagbsearch' is off, only a linear search is done.
5763
5764 Linear searching is done anyway, for one file, when Vim finds a line
5765 at the start of the file indicating that it's not sorted: >
5766 !_TAG_FILE_SORTED 0 /some command/
5767< [The whitespace before and after the '0' must be a single <Tab>]
5768
5769 When a binary search was done and no match was found in any of the
5770 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5771 instead of a normal tag name, a retry is done with a linear search.
5772 Tags in unsorted tags files, and matches with different case will only
5773 be found in the retry.
5774
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005775 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005776 linear search can be avoided for the 'ignorecase' case. Use a value
5777 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5778 case-fold sorted with the -f switch to "sort" in most unices, as in
5779 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5780 5.3 or higher the -f or --fold-case-sort switch can be used for this
5781 as well. Note that case must be folded to uppercase for this to work.
5782
5783 When 'tagbsearch' is off, tags searching is slower when a full match
5784 exists, but faster when no full match exists. Tags in unsorted tags
5785 files may only be found with 'tagbsearch' off.
5786 When the tags file is not sorted, or sorted in a wrong way (not on
5787 ASCII byte value), 'tagbsearch' should be off, or the line given above
5788 must be included in the tags file.
5789 This option doesn't affect commands that find all matching tags (e.g.,
5790 command-line completion and ":help").
5791 {Vi: always uses binary search in some versions}
5792
5793 *'taglength'* *'tl'*
5794'taglength' 'tl' number (default 0)
5795 global
5796 If non-zero, tags are significant up to this number of characters.
5797
5798 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5799'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5800 global
5801 {not in Vi}
5802 If on and using a tag file in another directory, file names in that
5803 tag file are relative to the directory where the tag file is.
5804 NOTE: This option is set to the Vi default value when 'compatible' is
5805 set and to the Vim default value when 'compatible' is reset.
5806
5807 *'tags'* *'tag'* *E433*
5808'tags' 'tag' string (default "./tags,tags", when compiled with
5809 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5810 global or local to buffer |global-local|
5811 Filenames for the tag command, separated by spaces or commas. To
5812 include a space or comma in a file name, precede it with a backslash
5813 (see |option-backslash| about including spaces and backslashes).
5814 When a file name starts with "./", the '.' is replaced with the path
5815 of the current file. But only when the 'd' flag is not included in
5816 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5817 |tags-option|.
5818 "*", "**" and other wildcards can be used to search for tags files in
5819 a directory tree. See |file-searching|. {not available when compiled
5820 without the |+path_extra| feature}
5821 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5822 files are also supported. They are automatically recognized. The
5823 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5824 differences are ignored (MS-Windows). |emacs-tags|
5825 The use of |:set+=| and |:set-=| is preferred when adding or removing
5826 file names from the list. This avoids problems when a future version
5827 uses another default.
5828 {Vi: default is "tags /usr/lib/tags"}
5829
5830 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5831'tagstack' 'tgst' boolean (default on)
5832 global
5833 {not in all versions of Vi}
5834 When on, the |tagstack| is used normally. When off, a ":tag" or
5835 ":tselect" command with an argument will not push the tag onto the
5836 tagstack. A following ":tag" without an argument, a ":pop" command or
5837 any other command that uses the tagstack will use the unmodified
5838 tagstack, but does change the pointer to the active entry.
5839 Resetting this option is useful when using a ":tag" command in a
5840 mapping which should not change the tagstack.
5841
5842 *'term'* *E529* *E530* *E531*
5843'term' string (default is $TERM, if that fails:
5844 in the GUI: "builtin_gui"
5845 on Amiga: "amiga"
5846 on BeOS: "beos-ansi"
5847 on Mac: "mac-ansi"
5848 on MiNT: "vt52"
5849 on MS-DOS: "pcterm"
5850 on OS/2: "os2ansi"
5851 on Unix: "ansi"
5852 on VMS: "ansi"
5853 on Win 32: "win32")
5854 global
5855 Name of the terminal. Used for choosing the terminal control
5856 characters. Environment variables are expanded |:set_env|.
5857 For example: >
5858 :set term=$TERM
5859< See |termcap|.
5860
5861 *'termbidi'* *'tbidi'*
5862 *'notermbidi'* *'notbidi'*
5863'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5864 global
5865 {not in Vi}
5866 {only available when compiled with the |+arabic|
5867 feature}
5868 The terminal is in charge of Bi-directionality of text (as specified
5869 by Unicode). The terminal is also expected to do the required shaping
5870 that some languages (such as Arabic) require.
5871 Setting this option implies that 'rightleft' will not be set when
5872 'arabic' is set and the value of 'arabicshape' will be ignored.
5873 Note that setting 'termbidi' has the immediate effect that
5874 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5875 This option is reset when the GUI is started.
5876 For further details see |arabic.txt|.
5877
5878 *'termencoding'* *'tenc'*
5879'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
5880 Macintosh GUI: "macroman")
5881 global
5882 {only available when compiled with the |+multi_byte|
5883 feature}
5884 {not in Vi}
5885 Encoding used for the terminal. This specifies what character
5886 encoding the keyboard produces and the display will understand. For
5887 the GUI it only applies to the keyboard ('encoding' is used for the
5888 display).
5889 In the Win32 console version the default value is the console codepage
5890 when it differs from the ANSI codepage.
5891 *E617*
5892 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
5893 successfully initialized, 'termencoding' is forcibly set to "utf-8".
5894 Any attempts to set a different value will be rejected, and an error
5895 message is shown.
5896 For the Win32 GUI 'termencoding' is not used for typed characters,
5897 because the Win32 system always passes Unicode characters.
5898 When empty, the same encoding is used as for the 'encoding' option.
5899 This is the normal value.
5900 Not all combinations for 'termencoding' and 'encoding' are valid. See
5901 |encoding-table|.
5902 The value for this option must be supported by internal conversions or
5903 iconv(). When this is not possible no conversion will be done and you
5904 will probably experience problems with non-ASCII characters.
5905 Example: You are working with the locale set to euc-jp (Japanese) and
5906 want to edit a UTF-8 file: >
5907 :let &termencoding = &encoding
5908 :set encoding=utf-8
5909< You need to do this when your system has no locale support for UTF-8.
5910
5911 *'terse'* *'noterse'*
5912'terse' boolean (default off)
5913 global
5914 When set: Add 's' flag to 'shortmess' option (this makes the message
5915 for a search that hits the start or end of the file not being
5916 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
5917 shortens a lot of messages}
5918
5919 *'textauto'* *'ta'* *'notextauto'* *'nota'*
5920'textauto' 'ta' boolean (Vim default: on, Vi default: off)
5921 global
5922 {not in Vi}
5923 This option is obsolete. Use 'fileformats'.
5924 For backwards compatibility, when 'textauto' is set, 'fileformats' is
5925 set to the default value for the current system. When 'textauto' is
5926 reset, 'fileformats' is made empty.
5927 NOTE: This option is set to the Vi default value when 'compatible' is
5928 set and to the Vim default value when 'compatible' is reset.
5929
5930 *'textmode'* *'tx'* *'notextmode'* *'notx'*
5931'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
5932 others: default off)
5933 local to buffer
5934 {not in Vi}
5935 This option is obsolete. Use 'fileformat'.
5936 For backwards compatibility, when 'textmode' is set, 'fileformat' is
5937 set to "dos". When 'textmode' is reset, 'fileformat' is set to
5938 "unix".
5939
5940 *'textwidth'* *'tw'*
5941'textwidth' 'tw' number (default 0)
5942 local to buffer
5943 {not in Vi}
5944 Maximum width of text that is being inserted. A longer line will be
5945 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005946 this. 'textwidth' is set to 0 when the 'paste' option is set. When
5947 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 'formatoptions' and |ins-textwidth|.
5949 NOTE: This option is set to 0 when 'compatible' is set.
5950
5951 *'thesaurus'* *'tsr'*
5952'thesaurus' 'tsr' string (default "")
5953 global or local to buffer |global-local|
5954 {not in Vi}
5955 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005956 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005957 the file should contain words with similar meaning, separated by
5958 non-keyword characters (white space is preferred). Maximum line
5959 length is 510 bytes.
5960 To obtain a file to be used here, check out the wordlist FAQ at
5961 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005962 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 after a comma are ignored, otherwise spaces are included in the file
5964 name. See |option-backslash| about using backslashes.
5965 The use of |:set+=| and |:set-=| is preferred when adding or removing
5966 directories from the list. This avoids problems when a future version
5967 uses another default.
5968 Backticks cannot be used in this option for security reasons.
5969
5970 *'tildeop'* *'top'* *'notildeop'* *'notop'*
5971'tildeop' 'top' boolean (default off)
5972 global
5973 {not in Vi}
5974 When on: The tilde command "~" behaves like an operator.
5975 NOTE: This option is reset when 'compatible' is set.
5976
5977 *'timeout'* *'to'* *'notimeout'* *'noto'*
5978'timeout' 'to' boolean (default on)
5979 global
5980 *'ttimeout'* *'nottimeout'*
5981'ttimeout' boolean (default off)
5982 global
5983 {not in Vi}
5984 These two options together determine the behavior when part of a
5985 mapped key sequence or keyboard code has been received:
5986
5987 'timeout' 'ttimeout' action ~
5988 off off do not time out
5989 on on or off time out on :mappings and key codes
5990 off on time out on key codes
5991
5992 If both options are off, Vim will wait until either the complete
5993 mapping or key sequence has been received, or it is clear that there
5994 is no mapping or key sequence for the received characters. For
5995 example: if you have mapped "vl" and Vim has received 'v', the next
5996 character is needed to see if the 'v' is followed by an 'l'.
5997 When one of the options is on, Vim will wait for about 1 second for
5998 the next character to arrive. After that the already received
5999 characters are interpreted as single characters. The waiting time can
6000 be changed with the 'timeoutlen' option.
6001 On slow terminals or very busy systems timing out may cause
6002 malfunctioning cursor keys. If both options are off, Vim waits
6003 forever after an entered <Esc> if there are key codes that start
6004 with <Esc>. You will have to type <Esc> twice. If you do not have
6005 problems with key codes, but would like to have :mapped key
6006 sequences not timing out in 1 second, set the 'ttimeout' option and
6007 reset the 'timeout' option.
6008
6009 NOTE: 'ttimeout' is reset when 'compatible' is set.
6010
6011 *'timeoutlen'* *'tm'*
6012'timeoutlen' 'tm' number (default 1000)
6013 global
6014 {not in all versions of Vi}
6015 *'ttimeoutlen'* *'ttm'*
6016'ttimeoutlen' 'ttm' number (default -1)
6017 global
6018 {not in Vi}
6019 The time in milliseconds that is waited for a key code or mapped key
6020 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6021 when part of a command has been typed.
6022 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6023 different timeout value for key codes is desired set 'ttimeoutlen' to
6024 a non-negative number.
6025
6026 ttimeoutlen mapping delay key code delay ~
6027 < 0 'timeoutlen' 'timeoutlen'
6028 >= 0 'timeoutlen' 'ttimeoutlen'
6029
6030 The timeout only happens when the 'timeout' and 'ttimeout' options
6031 tell so. A useful setting would be >
6032 :set timeout timeoutlen=3000 ttimeoutlen=100
6033< (time out on mapping after three seconds, time out on key codes after
6034 a tenth of a second).
6035
6036 *'title'* *'notitle'*
6037'title' boolean (default off, on when title can be restored)
6038 global
6039 {not in Vi}
6040 {not available when compiled without the |+title|
6041 feature}
6042 When on, the title of the window will be set to the value of
6043 'titlestring' (if it is not empty), or to:
6044 filename [+=-] (path) - VIM
6045 Where:
6046 filename the name of the file being edited
6047 - indicates the file cannot be modified, 'ma' off
6048 + indicates the file was modified
6049 = indicates the file is read-only
6050 =+ indicates the file is read-only and modified
6051 (path) is the path of the file being edited
6052 - VIM the server name |v:servername| or "VIM"
6053 Only works if the terminal supports setting window titles
6054 (currently Amiga console, Win32 console, all GUI versions and
6055 terminals with a non- empty 't_ts' option - these are Unix xterm and
6056 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6057 *X11*
6058 When Vim was compiled with HAVE_X11 defined, the original title will
6059 be restored if possible. The output of ":version" will include "+X11"
6060 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6061 works for the icon name |'icon'|.
6062 But: When Vim was started with the |-X| argument, restoring the title
6063 will not work (except in the GUI).
6064 If the title cannot be restored, it is set to the value of 'titleold'.
6065 You might want to restore the title outside of Vim then.
6066 When using an xterm from a remote machine you can use this command:
6067 rsh machine_name xterm -display $DISPLAY &
6068 then the WINDOWID environment variable should be inherited and the
6069 title of the window should change back to what it should be after
6070 exiting Vim.
6071
6072 *'titlelen'*
6073'titlelen' number (default 85)
6074 global
6075 {not in Vi}
6076 {not available when compiled without the |+title|
6077 feature}
6078 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006079 title. When the title is longer, only the end of the path name is
6080 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 Using a percentage makes this adapt to the width of the window. But
6082 it won't work perfectly, because the actual number of characters
6083 available also depends on the font used and other things in the title
6084 bar. When 'titlelen' is zero the full path is used. Otherwise,
6085 values from 1 to 30000 percent can be used.
6086 'titlelen' is also used for the 'titlestring' option.
6087
6088 *'titleold'*
6089'titleold' string (default "Thanks for flying Vim")
6090 global
6091 {not in Vi}
6092 {only available when compiled with the |+title|
6093 feature}
6094 This option will be used for the window title when exiting Vim if the
6095 original title cannot be restored. Only happens if 'title' is on or
6096 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006097 This option cannot be set from a |modeline| or in the |sandbox|, for
6098 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 *'titlestring'*
6100'titlestring' string (default "")
6101 global
6102 {not in Vi}
6103 {not available when compiled without the |+title|
6104 feature}
6105 When this option is not empty, it will be used for the title of the
6106 window. This happens only when the 'title' option is on.
6107 Only works if the terminal supports setting window titles (currently
6108 Amiga console, Win32 console, all GUI versions and terminals with a
6109 non-empty 't_ts' option).
6110 When Vim was compiled with HAVE_X11 defined, the original title will
6111 be restored if possible |X11|.
6112 When this option contains printf-style '%' items, they will be
6113 expanded according to the rules used for 'statusline'.
6114 Example: >
6115 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6116 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6117< The value of 'titlelen' is used to align items in the middle or right
6118 of the available space.
6119 Some people prefer to have the file name first: >
6120 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6121< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006122 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 separating space only when needed.
6124 NOTE: Use of special characters in 'titlestring' may cause the display
6125 to be garbled (e.g., when it contains a CR or NL character).
6126 {not available when compiled without the |+statusline| feature}
6127
6128 *'toolbar'* *'tb'*
6129'toolbar' 'tb' string (default "icons,tooltips")
6130 global
6131 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6132 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006133 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 possible values are:
6135 icons Toolbar buttons are shown with icons.
6136 text Toolbar buttons shown with text.
6137 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006138 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 tooltips Tooltips are active for toolbar buttons.
6140 Tooltips refer to the popup help text which appears after the mouse
6141 cursor is placed over a toolbar button for a brief moment.
6142
6143 If you want the toolbar to be shown with icons as well as text, do the
6144 following: >
6145 :set tb=icons,text
6146< Motif and Athena cannot display icons and text at the same time. They
6147 will show icons if both are requested.
6148
6149 If none of the strings specified in 'toolbar' are valid or if
6150 'toolbar' is empty, this option is ignored. If you want to disable
6151 the toolbar, you need to set the 'guioptions' option. For example: >
6152 :set guioptions-=T
6153< Also see |gui-toolbar|.
6154
6155 *'toolbariconsize'* *'tbis'*
6156'toolbariconsize' 'tbis' string (default "small")
6157 global
6158 {not in Vi}
6159 {only in the GTK+ 2 GUI}
6160 Controls the size of toolbar icons. The possible values are:
6161 tiny Use tiny toolbar icons.
6162 small Use small toolbar icons (default).
6163 medium Use medium-sized toolbar icons.
6164 large Use large toolbar icons.
6165 The exact dimensions in pixels of the various icon sizes depend on
6166 the current theme. Common dimensions are large=32x32, medium=24x24,
6167 small=20x20 and tiny=16x16.
6168
6169 If 'toolbariconsize' is empty, the global default size as determined
6170 by user preferences or the current theme is used.
6171
6172 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6173'ttybuiltin' 'tbi' boolean (default on)
6174 global
6175 {not in Vi}
6176 When on, the builtin termcaps are searched before the external ones.
6177 When off the builtin termcaps are searched after the external ones.
6178 When this option is changed, you should set the 'term' option next for
6179 the change to take effect, for example: >
6180 :set notbi term=$TERM
6181< See also |termcap|.
6182 Rationale: The default for this option is "on", because the builtin
6183 termcap entries are generally better (many systems contain faulty
6184 xterm entries...).
6185
6186 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6187'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6188 sun-cmd, screen, rxvt, dtterm or
6189 iris-ansi; also on when running Vim in
6190 a DOS console)
6191 global
6192 {not in Vi}
6193 Indicates a fast terminal connection. More characters will be sent to
6194 the screen for redrawing, instead of using insert/delete line
6195 commands. Improves smoothness of redrawing when there are multiple
6196 windows and the terminal does not support a scrolling region.
6197 Also enables the extra writing of characters at the end of each screen
6198 line for lines that wrap. This helps when using copy/paste with the
6199 mouse in an xterm and other terminals.
6200
6201 *'ttymouse'* *'ttym'*
6202'ttymouse' 'ttym' string (default depends on 'term')
6203 global
6204 {not in Vi}
6205 {only in Unix and VMS, doesn't work in the GUI; not
6206 available when compiled without |+mouse|}
6207 Name of the terminal type for which mouse codes are to be recognized.
6208 Currently these three strings are valid:
6209 *xterm-mouse*
6210 xterm xterm-like mouse handling. The mouse generates
6211 "<Esc>[Mscr", where "scr" is three bytes:
6212 "s" = button state
6213 "c" = column plus 33
6214 "r" = row plus 33
6215 xterm2 Works like "xterm", but with the xterm reporting the
6216 mouse position while the mouse is dragged. This works
6217 much faster and more precise. Your xterm must at
6218 least at patchlevel 88 / XFree 3.3.3 for this to
6219 work. See below for how Vim detects this
6220 automatically.
6221 *netterm-mouse*
6222 netterm NetTerm mouse handling. The mouse generates
6223 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6224 for the row and column.
6225 *dec-mouse*
6226 dec DEC terminal mouse handling. The mouse generates a
6227 rather complex sequence, starting with "<Esc>[".
6228 *jsbterm-mouse*
6229 jsbterm JSB term mouse handling.
6230 *pterm-mouse*
6231 pterm QNX pterm mouse handling.
6232
6233 The mouse handling must be enabled at compile time |+mouse_xterm|
6234 |+mouse_dec| |+mouse_netterm|.
6235 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6236 recognized, if enabled at compile time. DEC terminal mouse codes
6237 are recognized if enabled at compile time, and 'ttymouse' is not
6238 "xterm" (because the xterm and dec mouse codes conflict).
6239 This option is automatically set to "xterm", when the 'term' option is
6240 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6241 or "xterm2" already. The main use of this option is to set it to
6242 "xterm", when the terminal name doesn't start with "xterm", but it can
6243 handle xterm mouse codes.
6244 The "xterm2" value will be set if the xterm version is reported to be
6245 95 of higher. This only works when compiled with the |+termresponse|
6246 feature and if |t_RV| is set to the escape sequence to request the
6247 xterm version number. Otherwise "xterm2" must be set explicitly.
6248 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6249 t_RV to an empty string: >
6250 :set t_RV=
6251<
6252 *'ttyscroll'* *'tsl'*
6253'ttyscroll' 'tsl' number (default 999)
6254 global
6255 Maximum number of lines to scroll the screen. If there are more lines
6256 to scroll the window is redrawn. For terminals where scrolling is
6257 very slow and redrawing is not slow this can be set to a small number,
6258 e.g., 3, to speed up displaying.
6259
6260 *'ttytype'* *'tty'*
6261'ttytype' 'tty' string (default from $TERM)
6262 global
6263 Alias for 'term', see above.
6264
6265 *'undolevels'* *'ul'*
6266'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6267 Win32 and OS/2)
6268 global
6269 {not in Vi}
6270 Maximum number of changes that can be undone. Since undo information
6271 is kept in memory, higher numbers will cause more memory to be used
6272 (nevertheless, a single change can use an unlimited amount of memory).
6273 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6274 itself: >
6275 set ul=0
6276< But you can also get Vi compatibility by including the 'u' flag in
6277 'cpoptions', and still be able to use CTRL-R to repeat undo.
6278 Set to a negative number for no undo at all: >
6279 set ul=-1
6280< This helps when you run out of memory for a single change.
6281 Also see |undo-two-ways|.
6282
6283 *'updatecount'* *'uc'*
6284'updatecount' 'uc' number (default: 200)
6285 global
6286 {not in Vi}
6287 After typing this many characters the swap file will be written to
6288 disk. When zero, no swap file will be created at all (see chapter on
6289 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6290 Vim with the "-n" option, see |startup|. When editing in readonly
6291 mode this option will be initialized to 10000.
6292 The swapfile can be disabled per buffer with |'swapfile'|.
6293 When 'updatecount' is set from zero to non-zero, swap files are
6294 created for all buffers that have 'swapfile' set. When 'updatecount'
6295 is set to zero, existing swap files are not deleted.
6296 Also see |'swapsync'|.
6297 This option has no meaning in buffers where |'buftype'| is "nofile"
6298 or "nowrite".
6299
6300 *'updatetime'* *'ut'*
6301'updatetime' 'ut' number (default 4000)
6302 global
6303 {not in Vi}
6304 If this many milliseconds nothing is typed the swap file will be
6305 written to disk (see |crash-recovery|). Also used for the
6306 |CursorHold| autocommand event.
6307
6308 *'verbose'* *'vbs'*
6309'verbose' 'vbs' number (default 0)
6310 global
6311 {not in Vi, although some versions have a boolean
6312 verbose option}
6313 When bigger than zero, Vim will give messages about what it is doing.
6314 Currently, these messages are given:
6315 >= 1 When the viminfo file is read or written.
6316 >= 2 When a file is ":source"'ed.
6317 >= 5 Every searched tags file.
6318 >= 8 Files for which a group of autocommands is executed.
6319 >= 9 Every executed autocommand.
6320 >= 12 Every executed function.
6321 >= 13 When an exception is thrown, caught, finished, or discarded.
6322 >= 14 Anything pending in a ":finally" clause.
6323 >= 15 Every executed Ex command (truncated at 200 characters).
6324
6325 This option can also be set with the "-V" argument. See |-V|.
6326 This option is also set by the |:verbose| command.
6327
6328 *'viewdir'* *'vdir'*
6329'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6330 "$VIM/vimfiles/view",
6331 for Unix: "~/.vim/view",
6332 for Macintosh: "$VIM:vimfiles:view"
6333 for VMS: "sys$login:vimfiles/view"
6334 for RiscOS: "Choices:vimfiles/view")
6335 global
6336 {not in Vi}
6337 {not available when compiled without the +mksession
6338 feature}
6339 Name of the directory where to store files for |:mkview|.
6340 This option cannot be set from a |modeline| or in the |sandbox|, for
6341 security reasons.
6342
6343 *'viewoptions'* *'vop'*
6344'viewoptions' 'vop' string (default: "folds,options,cursor")
6345 global
6346 {not in Vi}
6347 {not available when compiled without the +mksession
6348 feature}
6349 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006350 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 word save and restore ~
6352 cursor cursor position in file and in window
6353 folds manually created folds, opened/closed folds and local
6354 fold options
6355 options options and mappings local to a window or buffer (not
6356 global values for local options)
6357 slash backslashes in file names replaced with forward
6358 slashes
6359 unix with Unix end-of-line format (single <NL>), even when
6360 on Windows or DOS
6361
6362 "slash" and "unix" are useful on Windows when sharing view files
6363 with Unix. The Unix version of Vim cannot source dos format scripts,
6364 but the Windows version of Vim can source unix format scripts.
6365
6366 *'viminfo'* *'vi'* *E526* *E527* *E528*
6367'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6368 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6369 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6370 for others: '20,<50,s10,h)
6371 global
6372 {not in Vi}
6373 {not available when compiled without the |+viminfo|
6374 feature}
6375 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006376 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 separated list of parameters, each consisting of a single character
6378 identifying the particular parameter, followed by a number or string
6379 which specifies the value of that parameter. If a particular
6380 character is left out, then the default value is used for that
6381 parameter. The following is a list of the identifying characters and
6382 the effect of their value.
6383 CHAR VALUE ~
6384 ! When included, save and restore global variables that start
6385 with an uppercase letter, and don't contain a lowercase
6386 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
6387 and "_K_L_M" are not.
6388 " Maximum number of lines saved for each register. Old name of
6389 the '<' item, with the disadvantage that you need to put a
6390 backslash before the ", otherwise it will be recognized as the
6391 start of a comment!
6392 % When included, save and restore the buffer list. If Vim is
6393 started with a file name argument, the buffer list is not
6394 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006395 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 without a file name and buffers for help files are not written
6397 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006398 When followed by a number, the number specifies the maximum
6399 number of buffers that are stored. Without a number all
6400 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006401 ' Maximum number of previously edited files for which the marks
6402 are remembered. This parameter must always be included when
6403 'viminfo' is non-empty.
6404 Including this item also means that the |jumplist| and the
6405 |changelist| are stored in the viminfo file.
6406 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006407 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006408 patterns are also saved. When not included, the value of
6409 'history' is used.
6410 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006411 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 < Maximum number of lines saved for each register. If zero then
6413 registers are not saved. When not included, all lines are
6414 saved. '"' is the old name for this item.
6415 Also see the 's' item below: limit specified in Kbyte.
6416 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006417 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 c When included, convert the text in the viminfo file from the
6419 'encoding' used when writing the file to the current
6420 'encoding'. See |viminfo-encoding|.
6421 f Whether file marks need to be stored. If zero, file marks ('0
6422 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006423 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 cursor position (when exiting or when doing ":wviminfo").
6425 h Disable the effect of 'hlsearch' when loading the viminfo
6426 file. When not included, it depends on whether ":nohlsearch"
6427 has been used since the last search command.
6428 n Name of the viminfo file. The name must immediately follow
6429 the 'n'. Must be the last one! If the "-i" argument was
6430 given when starting Vim, that file name overrides the one
6431 given here with 'viminfo'. Environment variables are expanded
6432 when opening the file, not when setting the option.
6433 r Removable media. The argument is a string (up to the next
6434 ','). This parameter can be given several times. Each
6435 specifies the start of a path for which no marks will be
6436 stored. This is to avoid removable media. For MS-DOS you
6437 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6438 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6439 ignored. Maximum length of each 'r' argument is 50
6440 characters.
6441 s Maximum size of an item in Kbyte. If zero then registers are
6442 not saved. Currently only applies to registers. The default
6443 "s10" will exclude registers with more than 10 Kbyte of text.
6444 Also see the '<' item above: line count limit.
6445
6446 Example: >
6447 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6448<
6449 '50 Marks will be remembered for the last 50 files you
6450 edited.
6451 <1000 Contents of registers (up to 1000 lines each) will be
6452 remembered.
6453 s100 Registers with more than 100 Kbyte text are skipped.
6454 :0 Command-line history will not be saved.
6455 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6456 no / Since '/' is not specified, the default will be used,
6457 that is, save all of the search history, and also the
6458 previous search and substitute patterns.
6459 no % The buffer list will not be saved nor read back.
6460 no h 'hlsearch' highlighting will be restored.
6461
6462 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6463 load the contents of the file, this is not done automatically.
6464
6465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'virtualedit'* *'ve'*
6469'virtualedit' 've' string (default "")
6470 global
6471 {not in Vi}
6472 {not available when compiled without the
6473 |+virtualedit| feature}
6474 A comma separated list of these words:
6475 block Allow virtual editing in Visual block mode.
6476 insert Allow virtual editing in Insert mode.
6477 all Allow virtual editing in all modes.
6478 Virtual editing means that the cursor can be positioned where there is
6479 no actual character. This can be halfway into a Tab or beyond the end
6480 of the line. Useful for selecting a rectangle in Visual mode and
6481 editing a table.
6482
6483 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6484'visualbell' 'vb' boolean (default off)
6485 global
6486 {not in Vi}
6487 Use visual bell instead of beeping. The terminal code to display the
6488 visual bell is given with 't_vb'. When no beep or flash is wanted,
6489 use ":set vb t_vb=".
6490 Note: When the GUI starts, 't_vb' is reset to its default value. You
6491 might want to set it again in your |gvimrc|.
6492 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6493 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6494 where 40 is the time in msec.
6495 Does not work on the Amiga, you always get a screen flash.
6496 Also see 'errorbells'.
6497
6498 *'warn'* *'nowarn'*
6499'warn' boolean (default on)
6500 global
6501 Give a warning message when a shell command is used while the buffer
6502 has been changed.
6503
6504 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6505'weirdinvert' 'wiv' boolean (default off)
6506 global
6507 {not in Vi}
6508 This option has the same effect as the 't_xs' termcap option.
6509 It is provided for backwards compatibility with version 4.x.
6510 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6511 vice versa. Has no effect when the GUI is running.
6512
6513 *'whichwrap'* *'ww'*
6514'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6515 global
6516 {not in Vi}
6517 Allow specified keys that move the cursor left/right to move to the
6518 previous/next line when the cursor is on the first/last character in
6519 the line. Concatenate characters to allow this for these keys:
6520 char key mode ~
6521 b <BS> Normal and Visual
6522 s <Space> Normal and Visual
6523 h "h" Normal and Visual
6524 l "l" Normal and Visual
6525 < <Left> Normal and Visual
6526 > <Right> Normal and Visual
6527 ~ "~" Normal
6528 [ <Left> Insert and Replace
6529 ] <Right> Insert and Replace
6530 For example: >
6531 :set ww=<,>,[,]
6532< allows wrap only when cursor keys are used.
6533 When the movement keys are used in combination with a delete or change
6534 operator, the <EOL> also counts for a character. This makes "3h"
6535 different from "3dh" when the cursor crosses the end of a line. This
6536 is also true for "x" and "X", because they do the same as "dl" and
6537 "dh". If you use this, you may also want to use the mapping
6538 ":map <BS> X" to make backspace delete the character in front of the
6539 cursor.
6540 When 'l' is included, you get a side effect: "yl" on an empty line
6541 will include the <EOL>, so that "p" will insert a new line.
6542 NOTE: This option is set to the Vi default value when 'compatible' is
6543 set and to the Vim default value when 'compatible' is reset.
6544
6545 *'wildchar'* *'wc'*
6546'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6547 global
6548 {not in Vi}
6549 Character you have to type to start wildcard expansion in the
6550 command-line, as specified with 'wildmode'.
6551 The character is not recognized when used inside a macro. See
6552 'wildcharm' for that.
6553 Although 'wc' is a number option, you can set it to a special key: >
6554 :set wc=<Esc>
6555< NOTE: This option is set to the Vi default value when 'compatible' is
6556 set and to the Vim default value when 'compatible' is reset.
6557
6558 *'wildcharm'* *'wcm'*
6559'wildcharm' 'wcm' number (default: none (0))
6560 global
6561 {not in Vi}
6562 'wildcharm' works exactly like 'wildchar', except that it is
6563 recognized when used inside a macro. You can find "spare" command-line
6564 keys suitable for this option by looking at |ex-edit-index|. Normally
6565 you'll never actually type 'wildcharm', just use it in mappings that
6566 automatically invoke completion mode, e.g.: >
6567 :set wcm=<C-Z>
6568 :cmap ss so $vim/sessions/*.vim<C-Z>
6569< Then after typing :ss you can use CTRL-P & CTRL-N.
6570
6571 *'wildignore'* *'wig'*
6572'wildignore' 'wig' string (default "")
6573 global
6574 {not in Vi}
6575 {not available when compiled without the |+wildignore|
6576 feature}
6577 A list of file patterns. A file that matches with one of these
6578 patterns is ignored when completing file or directory names.
6579 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6580 Also see 'suffixes'.
6581 Example: >
6582 :set wildignore=*.o,*.obj
6583< The use of |:set+=| and |:set-=| is preferred when adding or removing
6584 a pattern from the list. This avoids problems when a future version
6585 uses another default.
6586
6587 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6588'wildmenu' 'wmnu' boolean (default off)
6589 global
6590 {not in Vi}
6591 {not available if compiled without the |+wildmenu|
6592 feature}
6593 When 'wildmenu' is on, command-line completion operates in an enhanced
6594 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6595 the possible matches are shown just above the command line, with the
6596 first match highlighted (overwriting the status line, if there is
6597 one). Keys that show the previous/next match, such as <Tab> or
6598 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6599 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6600 specified. "longest" and "list" do not start "wildmenu" mode.
6601 If there are more matches than can fit in the line, a ">" is shown on
6602 the right and/or a "<" is shown on the left. The status line scrolls
6603 as needed.
6604 The "wildmenu" mode is abandoned when a key is hit that is not used
6605 for selecting a completion.
6606 While the "wildmenu" is active the following keys have special
6607 meanings:
6608
6609 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6610 <Down> - in filename/menu name completion: move into a
6611 subdirectory or submenu.
6612 <CR> - in menu completion, when the cursor is just after a
6613 dot: move into a submenu.
6614 <Up> - in filename/menu name completion: move up into
6615 parent directory or parent menu.
6616
6617 This makes the menus accessible from the console |console-menus|.
6618
6619 If you prefer the <Left> and <Right> keys to move the cursor instead
6620 of selecting a different match, use this: >
6621 :cnoremap <Left> <Space><BS><Left>
6622 :cnoremap <Right> <Space><BS><Right>
6623<
6624 The "WildMenu" highlighting is used for displaying the current match
6625 |hl-WildMenu|.
6626
6627 *'wildmode'* *'wim'*
6628'wildmode' 'wim' string (Vim default: "full")
6629 global
6630 {not in Vi}
6631 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006632 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 part specifies what to do for each consecutive use of 'wildchar. The
6634 first part specifies the behavior for the first use of 'wildchar',
6635 The second part for the second use, etc.
6636 These are the possible values for each part:
6637 "" Complete only the first match.
6638 "full" Complete the next full match. After the last match,
6639 the original string is used and then the first match
6640 again.
6641 "longest" Complete till longest common string. If this doesn't
6642 result in a longer string, use the next part.
6643 "longest:full" Like "longest", but also start 'wildmenu' if it is
6644 enabled.
6645 "list" When more than one match, list all matches.
6646 "list:full" When more than one match, list all matches and
6647 complete first match.
6648 "list:longest" When more than one match, list all matches and
6649 complete till longest common string.
6650 When there is only a single match, it is fully completed in all cases.
6651
6652 Examples: >
6653 :set wildmode=full
6654< Complete first full match, next match, etc. (the default) >
6655 :set wildmode=longest,full
6656< Complete longest common string, then each full match >
6657 :set wildmode=list:full
6658< List all matches and complete each full match >
6659 :set wildmode=list,full
6660< List all matches without completing, then each full match >
6661 :set wildmode=longest,list
6662< Complete longest common string, then list alternatives.
6663
6664 *'winaltkeys'* *'wak'*
6665'winaltkeys' 'wak' string (default "menu")
6666 global
6667 {not in Vi}
6668 {only used in Win32, Motif, GTK and Photon GUI}
6669 Some GUI versions allow the access to menu entries by using the ALT
6670 key in combination with a character that appears underlined in the
6671 menu. This conflicts with the use of the ALT key for mappings and
6672 entering special characters. This option tells what to do:
6673 no Don't use ALT keys for menus. ALT key combinations can be
6674 mapped, but there is no automatic handling. This can then be
6675 done with the |:simalt| command.
6676 yes ALT key handling is done by the windowing system. ALT key
6677 combinations cannot be mapped.
6678 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 keys can be mapped.
6681 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6682 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006683 This option is not used for <F10>; on Win32 and with GTK <F10> will
6684 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685
6686 *'winheight'* *'wh'* *E591*
6687'winheight' 'wh' number (default 1)
6688 global
6689 {not in Vi}
6690 {not available when compiled without the +windows
6691 feature}
6692 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006693 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 current window is smaller, its size is increased, at the cost of the
6695 height of other windows. Set it to 999 to make the current window
6696 always fill the screen (although this has the drawback that ":all"
6697 will create only two windows). Set it to a small number for normal
6698 editing.
6699 Minimum value is 1.
6700 The height is not adjusted after one of the commands to change the
6701 height of the current window.
6702 'winheight' applies to the current window. Use 'winminheight' to set
6703 the minimal height for other windows.
6704
6705 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6706'winfixheight' 'wfh' boolean (default off)
6707 local to window
6708 {not in Vi}
6709 {not available when compiled without the +windows
6710 feature}
6711 Keep the window height when windows are opened or closed and
6712 'equalalways' is set. Set by default for the |preview-window| and
6713 |quickfix-window|.
6714 The height may be changed anyway when running out of room.
6715
6716 *'winminheight'* *'wmh'*
6717'winminheight' 'wmh' number (default 1)
6718 global
6719 {not in Vi}
6720 {not available when compiled without the +windows
6721 feature}
6722 The minimal height of a window, when it's not the current window.
6723 This is a hard minimum, windows will never become smaller.
6724 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6725 status bar) if necessary. They will return to at least one line when
6726 they become active (since the cursor has to have somewhere to go.)
6727 Use 'winheight' to set the minimal height of the current window.
6728 This option is only checked when making a window smaller. Don't use a
6729 large number, it will cause errors when opening more than a few
6730 windows. A value of 0 to 3 is reasonable.
6731
6732 *'winminwidth'* *'wmw'*
6733'winminwidth' 'wmw' number (default 1)
6734 global
6735 {not in Vi}
6736 {not available when compiled without the +vertsplit
6737 feature}
6738 The minimal width of a window, when it's not the current window.
6739 This is a hard minimum, windows will never become smaller.
6740 When set to zero, windows may be "squashed" to zero columns (i.e. just
6741 a vertical separator) if necessary. They will return to at least one
6742 line when they become active (since the cursor has to have somewhere
6743 to go.)
6744 Use 'winwidth' to set the minimal width of the current window.
6745 This option is only checked when making a window smaller. Don't use a
6746 large number, it will cause errors when opening more than a few
6747 windows. A value of 0 to 12 is reasonable.
6748
6749 *'winwidth'* *'wiw'* *E592*
6750'winwidth' 'wiw' number (default 20)
6751 global
6752 {not in Vi}
6753 {not available when compiled without the +vertsplit
6754 feature}
6755 Minimal number of columns for the current window. This is not a hard
6756 minimum, Vim will use fewer columns if there is not enough room. If
6757 the current window is smaller, its size is increased, at the cost of
6758 the width of other windows. Set it to 999 to make the current window
6759 always fill the screen. Set it to a small number for normal editing.
6760 The width is not adjusted after one of the commands to change the
6761 width of the current window.
6762 'winwidth' applies to the current window. Use 'winminwidth' to set
6763 the minimal width for other windows.
6764
6765 *'wrap'* *'nowrap'*
6766'wrap' boolean (default on)
6767 local to window
6768 {not in Vi}
6769 This option changes how text is displayed. It doesn't change the text
6770 in the buffer, see 'textwidth' for that.
6771 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006772 displaying continues on the next line. When off lines will not wrap
6773 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 moved to a part that is not shown, the screen will scroll
6775 horizontally.
6776 The line will be broken in the middle of a word if necessary. See
6777 'linebreak' to get the break at a word boundary.
6778 To make scrolling horizontally a bit more useful, try this: >
6779 :set sidescroll=5
6780 :set listchars+=precedes:<,extends:>
6781< See 'sidescroll', 'listchars' and |wrap-off|.
6782
6783 *'wrapmargin'* *'wm'*
6784'wrapmargin' 'wm' number (default 0)
6785 local to buffer
6786 Number of characters from the right window border where wrapping
6787 starts. When typing text beyond this limit, an <EOL> will be inserted
6788 and inserting continues on the next line.
6789 Options that add a margin, such as 'number' and 'foldcolumn', cause
6790 the text width to be further reduced. This is Vi compatible.
6791 When 'textwidth' is non-zero, this option is not used.
6792 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6793 and less usefully}
6794
6795 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6796'wrapscan' 'ws' boolean (default on) *E384* *E385*
6797 global
6798 Searches wrap around the end of the file.
6799
6800 *'write'* *'nowrite'*
6801'write' boolean (default on)
6802 global
6803 {not in Vi}
6804 Allows writing files. When not set, writing a file is not allowed.
6805 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006806 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 argument. Filtering text is still possible, even though this requires
6808 writing a temporary file.
6809
6810 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6811'writeany' 'wa' boolean (default off)
6812 global
6813 Allows writing to any file with no need for "!" override.
6814
6815 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6816'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6817 otherwise)
6818 global
6819 {not in Vi}
6820 Make a backup before overwriting a file. The backup is removed after
6821 the file was successfully written, unless the 'backup' option is
6822 also on. Reset this option if your file system is almost full. See
6823 |backup-table| for another explanation.
6824 When the 'backupskip' pattern matches, a backup is not made anyway.
6825 NOTE: This option is set to the default value when 'compatible' is
6826 set.
6827
6828 *'writedelay'* *'wd'*
6829'writedelay' 'wd' number (default 0)
6830 global
6831 {not in Vi}
6832 The number of microseconds to wait for each character sent to the
6833 screen. When non-zero, characters are sent to the terminal one by
6834 one. For MS-DOS pcterm this does not work. For debugging purposes.
6835
6836 vim:tw=78:ts=8:ft=help:norl: