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