blob: e8b4a9d1554591d91be2deef314cae9dab978d60 [file] [log] [blame]
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Feb 21
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
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001099 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1100 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 This option is used together with 'buftype' and 'swapfile' to specify
1102 special kinds of buffers. See |special-buffers|.
1103
1104 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1105'buflisted' 'bl' boolean (default: on)
1106 local to buffer
1107 {not in Vi}
1108 When this option is set, the buffer shows up in the buffer list. If
1109 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1110 This option is reset by Vim for buffers that are only used to remember
1111 a file name or marks. Vim sets it when starting to edit a buffer.
1112 But not when moving to a buffer with ":buffer".
1113
1114 *'buftype'* *'bt'* *E382*
1115'buftype' 'bt' string (default: "")
1116 local to buffer
1117 {not in Vi}
1118 {not available when compiled without the |+quickfix|
1119 feature}
1120 The value of this option specifies the type of a buffer:
1121 <empty> normal buffer
1122 nofile buffer which is not related to a file and will not be
1123 written
1124 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001125 acwrite buffer which will always be written with BufWriteCmd
1126 autocommands. {not available when compiled without the
1127 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 quickfix quickfix buffer, contains list of errors |:cwindow|
1129 help help buffer (you are not supposed to set this
1130 manually)
1131
1132 This option is used together with 'bufhidden' and 'swapfile' to
1133 specify special kinds of buffers. See |special-buffers|.
1134
1135 Be careful with changing this option, it can have many side effects!
1136
1137 A "quickfix" buffer is only used for the error list. This value is
1138 set by the |:cwindow| command and you are not supposed to change it.
1139
1140 "nofile" and "nowrite" buffers are similar:
1141 both: The buffer is not to be written to disk, ":w" doesn't
1142 work (":w filename" does work though).
1143 both: The buffer is never considered to be |'modified'|.
1144 There is no warning when the changes will be lost, for
1145 example when you quit Vim.
1146 both: A swap file is only created when using too much memory
1147 (when 'swapfile' has been reset there is never a swap
1148 file).
1149 nofile only: The buffer name is fixed, it is not handled like a
1150 file name. It is not modified in response to a |:cd|
1151 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001152 *E676*
1153 "acwrite" implies that the buffer name is not related to a file, like
1154 "nofile", but it will be written. Thus, in contrast to "nofile" and
1155 "nowrite", ":w" does work and a modified buffer can't be abandoned
1156 without saving. For writing there must be matching |BufWriteCmd|,
1157 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158
1159 *'casemap'* *'cmp'*
1160'casemap' 'cmp' string (default: "internal,keepascii")
1161 global
1162 {not in Vi}
1163 Specifies details about changing the case of letters. It may contain
1164 these words, separated by a comma:
1165 internal Use internal case mapping functions, the current
1166 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001167 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 "internal" is omitted, the towupper() and towlower()
1169 system library functions are used when available.
1170 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1171 case mapping, the current locale is not effective.
1172 This probably only matters for Turkish.
1173
1174 *'cdpath'* *'cd'* *E344* *E346*
1175'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1176 global
1177 {not in Vi}
1178 {not available when compiled without the
1179 |+file_in_path| feature}
1180 This is a list of directories which will be searched when using the
1181 |:cd| and |:lcd| commands, provided that the directory being searched
1182 for has a relative path (not starting with "/", "./" or "../").
1183 The 'cdpath' option's value has the same form and semantics as
1184 |'path'|. Also see |file-searching|.
1185 The default value is taken from $CDPATH, with a "," prepended to look
1186 in the current directory first.
1187 If the default value taken from $CDPATH is not what you want, include
1188 a modified version of the following command in your vimrc file to
1189 override it: >
1190 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1191< This option cannot be set from a |modeline| or in the |sandbox|, for
1192 security reasons.
1193 (parts of 'cdpath' can be passed to the shell to expand file names).
1194
1195 *'cedit'*
1196'cedit' string (Vi default: "", Vim default: CTRL-F)
1197 global
1198 {not in Vi}
1199 {not available when compiled without the |+vertsplit|
1200 feature}
1201 The key used in Command-line Mode to open the command-line window.
1202 The default is CTRL-F when 'compatible' is off.
1203 Only non-printable keys are allowed.
1204 The key can be specified as a single character, but it is difficult to
1205 type. The preferred way is to use the <> notation. Examples: >
1206 :set cedit=<C-Y>
1207 :set cedit=<Esc>
1208< |Nvi| also has this option, but it only uses the first character.
1209 See |cmdwin|.
1210
1211 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1212'charconvert' 'ccv' string (default "")
1213 global
1214 {only available when compiled with the |+multi_byte|
1215 feature and the |+eval| feature}
1216 {not in Vi}
1217 An expression that is used for character encoding conversion. It is
1218 evaluated when a file that is to be read or has been written has a
1219 different encoding from what is desired.
1220 'charconvert' is not used when the internal iconv() function is
1221 supported and is able to do the conversion. Using iconv() is
1222 preferred, because it is much faster.
1223 'charconvert' is not used when reading stdin |--|, because there is no
1224 file to convert from. You will have to save the text in a file first.
1225 The expression must return zero or an empty string for success,
1226 non-zero for failure.
1227 The possible encoding names encountered are in 'encoding'.
1228 Additionally, names given in 'fileencodings' and 'fileencoding' are
1229 used.
1230 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1231 is done internally by Vim, 'charconvert' is not used for this.
1232 'charconvert' is also used to convert the viminfo file, if the 'c'
1233 flag is present in 'viminfo'. Also used for Unicode conversion.
1234 Example: >
1235 set charconvert=CharConvert()
1236 fun CharConvert()
1237 system("recode "
1238 \ . v:charconvert_from . ".." . v:charconvert_to
1239 \ . " <" . v:fname_in . " >" v:fname_out)
1240 return v:shell_error
1241 endfun
1242< The related Vim variables are:
1243 v:charconvert_from name of the current encoding
1244 v:charconvert_to name of the desired encoding
1245 v:fname_in name of the input file
1246 v:fname_out name of the output file
1247 Note that v:fname_in and v:fname_out will never be the same.
1248 Note that v:charconvert_from and v:charconvert_to may be different
1249 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1250 Encryption is not done by Vim when using 'charconvert'. If you want
1251 to encrypt the file after conversion, 'charconvert' should take care
1252 of this.
1253 This option cannot be set from a |modeline| or in the |sandbox|, for
1254 security reasons.
1255
1256 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1257'cindent' 'cin' boolean (default off)
1258 local to buffer
1259 {not in Vi}
1260 {not available when compiled without the |+cindent|
1261 feature}
1262 Enables automatic C program indenting See 'cinkeys' to set the keys
1263 that trigger reindenting in insert mode and 'cinoptions' to set your
1264 preferred indent style.
1265 If 'indentexpr' is not empty, it overrules 'cindent'.
1266 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1267 the "=" operator indents using this algorithm rather than calling an
1268 external program.
1269 See |C-indenting|.
1270 When you don't like the way 'cindent' works, try the 'smartindent'
1271 option or 'indentexpr'.
1272 This option is not used when 'paste' is set.
1273 NOTE: This option is reset when 'compatible' is set.
1274
1275 *'cinkeys'* *'cink'*
1276'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1277 local to buffer
1278 {not in Vi}
1279 {not available when compiled without the |+cindent|
1280 feature}
1281 A list of keys that, when typed in Insert mode, cause reindenting of
1282 the current line. Only used if 'cindent' is on and 'indentexpr' is
1283 empty.
1284 For the format of this option see |cinkeys-format|.
1285 See |C-indenting|.
1286
1287 *'cinoptions'* *'cino'*
1288'cinoptions' 'cino' string (default "")
1289 local to buffer
1290 {not in Vi}
1291 {not available when compiled without the |+cindent|
1292 feature}
1293 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1294 program. See |cinoptions-values| for the values of this option, and
1295 |C-indenting| for info on C indenting in general.
1296
1297
1298 *'cinwords'* *'cinw'*
1299'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1300 local to buffer
1301 {not in Vi}
1302 {not available when compiled without both the
1303 |+cindent| and the |+smartindent| features}
1304 These keywords start an extra indent in the next line when
1305 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1306 an appropriate place (inside {}).
1307 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1308 matter, include the keyword both the uppercase and lowercase:
1309 "if,If,IF".
1310
1311 *'clipboard'* *'cb'*
1312'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1313 for X-windows, "" otherwise)
1314 global
1315 {not in Vi}
1316 {only in GUI versions or when the |+xterm_clipboard|
1317 feature is included}
1318 This option is a list of comma separated names.
1319 These names are recognized:
1320
1321 unnamed When included, Vim will use the clipboard register '*'
1322 for all yank, delete, change and put operations which
1323 would normally go to the unnamed register. When a
1324 register is explicitly specified, it will always be
1325 used regardless of whether "unnamed" is in 'clipboard'
1326 or not. The clipboard register can always be
1327 explicitly accessed using the "* notation. Also see
1328 |gui-clipboard|.
1329
1330 autoselect Works like the 'a' flag in 'guioptions': If present,
1331 then whenever Visual mode is started, or the Visual
1332 area extended, Vim tries to become the owner of the
1333 windowing system's global selection or put the
1334 selected text on the clipboard used by the selection
1335 register "*. See |guioptions_a| and |quotestar| for
1336 details. When the GUI is active, the 'a' flag in
1337 'guioptions' is used, when the GUI is not active, this
1338 "autoselect" flag is used.
1339 Also applies to the modeless selection.
1340
1341 autoselectml Like "autoselect", but for the modeless selection
1342 only. Compare to the 'A' flag in 'guioptions'.
1343
1344 exclude:{pattern}
1345 Defines a pattern that is matched against the name of
1346 the terminal 'term'. If there is a match, no
1347 connection will be made to the X server. This is
1348 useful in this situation:
1349 - Running Vim in a console.
1350 - $DISPLAY is set to start applications on another
1351 display.
1352 - You do not want to connect to the X server in the
1353 console, but do want this in a terminal emulator.
1354 To never connect to the X server use: >
1355 exclude:.*
1356< This has the same effect as using the |-X| argument.
1357 Note that when there is no connection to the X server
1358 the window title won't be restored and the clipboard
1359 cannot be accessed.
1360 The value of 'magic' is ignored, {pattern} is
1361 interpreted as if 'magic' was on.
1362 The rest of the option value will be used for
1363 {pattern}, this must be the last entry.
1364
1365 *'cmdheight'* *'ch'*
1366'cmdheight' 'ch' number (default 1)
1367 global
1368 {not in Vi}
1369 Number of screen lines to use for the command-line. Helps avoiding
1370 |hit-enter| prompts.
1371
1372 *'cmdwinheight'* *'cwh'*
1373'cmdwinheight' 'cwh' number (default 7)
1374 global
1375 {not in Vi}
1376 {not available when compiled without the |+vertsplit|
1377 feature}
1378 Number of screen lines to use for the command-line window. |cmdwin|
1379
1380 *'columns'* *'co'* *E594*
1381'columns' 'co' number (default 80 or terminal width)
1382 global
1383 {not in Vi}
1384 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001385 initialization and does not have to be set by hand. Also see
1386 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 When Vim is running in the GUI or in a resizable window, setting this
1388 option will cause the window size to be changed. When you only want
1389 to use the size for the GUI, put the command in your |gvimrc| file.
1390 When you set this option and Vim is unable to change the physical
1391 number of columns of the display, the display may be messed up.
1392
1393 *'comments'* *'com'* *E524* *E525*
1394'comments' 'com' string (default
1395 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+comments|
1399 feature}
1400 A comma separated list of strings that can start a comment line. See
1401 |format-comments|. See |option-backslash| about using backslashes to
1402 insert a space.
1403
1404 *'commentstring'* *'cms'* *E537*
1405'commentstring' 'cms' string (default "/*%s*/")
1406 local to buffer
1407 {not in Vi}
1408 {not available when compiled without the |+folding|
1409 feature}
1410 A template for a comment. The "%s" in the value is replaced with the
1411 comment text. Currently only used to add markers for folding, see
1412 |fold-marker|.
1413
1414 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1415'compatible' 'cp' boolean (default on, off when a .vimrc file is found)
1416 global
1417 {not in Vi}
1418 This option has the effect of making Vim either more Vi-compatible, or
1419 make Vim behave in a more useful way.
1420 This is a special kind of option, because when it's set or reset,
1421 other options are also changed as a side effect. CAREFUL: Setting or
1422 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001423 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 set this option in your vimrc file, you should probably put it at the
1425 very start.
1426 By default this option is on and the Vi defaults are used for the
1427 options. This default was chosen for those people who want to use Vim
1428 just like Vi, and don't even (want to) know about the 'compatible'
1429 option.
1430 When a ".vimrc" file is found while Vim is starting up, this option is
1431 switched off, and all options that have not been modified will be set
1432 to the Vim defaults. Effectively, this means that when a ".vimrc"
1433 file exists, Vim will use the Vim defaults, otherwise it will use the
1434 Vi defaults. (Note: This doesn't happen for the system-wide vimrc
Bram Moolenaar7c626922005-02-07 22:01:03 +00001435 file). Also see |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 You can also set this option with the "-C" argument, and reset it with
1437 "-N". See |-C| and |-N|.
1438 Switching this option off makes the Vim defaults be used for options
1439 that have a different Vi and Vim default value. See the options
1440 marked with a '+' below. Other options are not modified.
1441 At the moment this option is set, several other options will be set
1442 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001443 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 editing.
1445 See also 'cpoptions'.
1446
1447 option + set value effect ~
1448
1449 'allowrevins' off no CTRL-_ command
1450 'backupcopy' Unix: "yes" backup file is a copy
1451 others: "auto" copy or rename backup file
1452 'backspace' "" normal backspace
1453 'backup' off no backup file
1454 'cindent' off no C code indentation
1455 'cedit' + "" no key to open the |cmdwin|
1456 'cpoptions' + (all flags) Vi-compatible flags
1457 'cscopetag' off don't use cscope for ":tag"
1458 'cscopetagorder' 0 see |cscopetagorder|
1459 'cscopeverbose' off see |cscopeverbose|
1460 'digraph' off no digraphs
1461 'esckeys' + off no <Esc>-keys in Insert mode
1462 'expandtab' off tabs not expanded to spaces
1463 'fileformats' + "" no automatic file format detection,
1464 "dos,unix" except for DOS, Windows and OS/2
1465 'formatoptions' + "vt" Vi compatible formatting
1466 'gdefault' off no default 'g' flag for ":s"
1467 'history' + 0 no commandline history
1468 'hkmap' off no Hebrew keyboard mapping
1469 'hkmapp' off no phonetic Hebrew keyboard mapping
1470 'hlsearch' off no highlighting of search matches
1471 'incsearch' off no incremental searching
1472 'indentexpr' "" no indenting by expression
1473 'insertmode' off do not start in Insert mode
1474 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1475 characters and '_'
1476 'joinspaces' on insert 2 spaces after period
1477 'modeline' + off no modelines
1478 'more' + off no pauses in listings
1479 'revins' off no reverse insert
1480 'ruler' off no ruler
1481 'scrolljump' 1 no jump scroll
1482 'scrolloff' 0 no scroll offset
1483 'shiftround' off indent not rounded to shiftwidth
1484 'shortmess' + "" no shortening of messages
1485 'showcmd' + off command characters not shown
1486 'showmode' + off current mode not shown
1487 'smartcase' off no automatic ignore case switch
1488 'smartindent' off no smart indentation
1489 'smarttab' off no smart tab size
1490 'softtabstop' 0 tabs are always 'tabstop' positions
1491 'startofline' on goto startofline with some commands
1492 'tagrelative' + off tag file names are not relative
1493 'textauto' + off no automatic textmode detection
1494 'textwidth' 0 no automatic line wrap
1495 'tildeop' off tilde is not an operator
1496 'ttimeout' off no terminal timeout
1497 'whichwrap' + "" left-right movements don't wrap
1498 'wildchar' + CTRL-E only when the current value is <Tab>
1499 use CTRL-E for cmdline completion
1500 'writebackup' on or off depends on +writebackup feature
1501
1502 *'complete'* *'cpt'* *E535*
1503'complete' 'cpt' string (default: ".,w,b,u,t,i")
1504 local to buffer
1505 {not in Vi}
1506 This option specifies how keyword completion |ins-completion| works
1507 when CTRL-P or CTRL-N are used. It is also used for whole-line
1508 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1509 and the places to scan. It is a comma separated list of flags:
1510 . scan the current buffer ('wrapscan' is ignored)
1511 w scan buffers from other windows
1512 b scan other loaded buffers that are in the buffer list
1513 u scan the unloaded buffers that are in the buffer list
1514 U scan the buffers that are not in the buffer list
1515 k scan the files given with the 'dictionary' option
1516 k{dict} scan the file {dict}. Several "k" flags can be given,
1517 patterns are valid too. For example: >
1518 :set cpt=k/usr/dict/*,k~/spanish
1519< s scan the files given with the 'thesaurus' option
1520 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1521 are valid too.
1522 i scan current and included files
1523 d scan current and included files for defined name or macro
1524 |i_CTRL-X_CTRL-D|
1525 ] tag completion
1526 t same as "]"
1527
1528 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1529 not executed, this may lead to unexpected completions from some files
1530 (gzipped files for example). Unloaded buffers are not scanned for
1531 whole-line completion.
1532
1533 The default is ".,w,b,u,t,i", which means to scan:
1534 1. the current buffer
1535 2. buffers in other windows
1536 3. other loaded buffers
1537 4. unloaded buffers
1538 5. tags
1539 6. included files
1540
1541 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1542 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1543 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1544
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001545 *'completefunc'* *'cfu'*
1546'completefunc' 'cfu' string (default: empty)
1547 local to buffer
1548 {not in Vi}
1549 This option specifies a completion function to be used for CTRL-X
1550 CTRL-X. The function will be invoked with four arguments:
1551 a:line the text of the current line
1552 a:base the text with which matches should match
1553 a:col column in a:line where the cursor is, first column is
1554 zero
1555 a:findstart either 1 or 0
1556 When the a:findstart argument is 1, the function must return the
1557 column of where the completion starts. It must be a number between
1558 zero and "a:col". This involves looking at the characters in a:line
1559 before column a:col and include those characters that could be part of
1560 the completed item.
1561 When the a:findstart argument is 0 the function must return a string
1562 with the matching words, separated by newlines. When there are no
1563 matches return an empty string.
1564 An example that completes the names of the months: >
1565 fun! CompleteMonths(line, base, col, findstart)
1566 if a:findstart
1567 " locate start column of word
1568 let start = a:col
1569 while start > 0 && a:line[start - 1] =~ '\a'
1570 let start = start - 1
1571 endwhile
1572 return start
1573 else
1574 " find months matching with "a:base"
1575 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1576 if a:base != ''
1577 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1578 endif
1579 let res = substitute(res, ' \+', "\n", 'g')
1580 return res
1581 endif
1582 endfun
1583 set completefunc=CompleteMonths
1584< Note that a substitute() function is used to reduce the list of
1585 possible values and remove the ones that don't match the base. The
1586 part before the "\|" matches the base, the part after it is used
1587 when there is no match. The "\2" in the replacement is empty if the
1588 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001589
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1591'confirm' 'cf' boolean (default off)
1592 global
1593 {not in Vi}
1594 When 'confirm' is on, certain operations that would normally
1595 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1596 instead raise a |dialog| asking if you wish to save the current
1597 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1598 If 'confirm' is off you can still activate confirmation for one
1599 command only (this is most useful in mappings) with the |:confirm|
1600 command.
1601 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1602
1603 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1604'conskey' 'consk' boolean (default off)
1605 global
1606 {not in Vi} {only for MS-DOS}
1607 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001608 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 three methods of console input are available:
1610 'conskey' 'bioskey' action ~
1611 on on or off direct console input
1612 off on BIOS
1613 off off STDIN
1614
1615 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1616'copyindent' 'ci' boolean (default off)
1617 local to buffer
1618 {not in Vi}
1619 Copy the structure of the existing lines indent when autoindenting a
1620 new line. Normally the new indent is reconstructed by a series of
1621 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1622 in which case only spaces are used). Enabling this option makes the
1623 new line copy whatever characters were used for indenting on the
1624 existing line. If the new indent is greater than on the existing
1625 line, the remaining space is filled in the normal manner.
1626 NOTE: 'copyindent' is reset when 'compatible' is set.
1627 Also see 'preserveindent'.
1628
1629 *'cpoptions'* *'cpo'*
1630'cpoptions' 'cpo' string (Vim default: "aABceFs",
1631 Vi default: all flags)
1632 global
1633 {not in Vi}
1634 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001635 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 not being vi-compatible is mostly or sometimes preferred.
1637 'cpoptions' stands for "compatible-options".
1638 Commas can be added for readability.
1639 To avoid problems with flags that are added in the future, use the
1640 "+=" and "-=" feature of ":set" |add-option-flags|.
1641 NOTE: This option is set to the Vi default value when 'compatible' is
1642 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001643 NOTE: This option is set to the POSIX default value at startup when
1644 the Vi default value would be used and the $VIM_POSIX environment
1645 variable exists |posix|. This means tries to behave like the POSIX
1646 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647
1648 contains behavior ~
1649 *cpo-a*
1650 a When included, a ":read" command with a file name
1651 argument will set the alternate file name for the
1652 current window.
1653 *cpo-A*
1654 A When included, a ":write" command with a file name
1655 argument will set the alternate file name for the
1656 current window.
1657 *cpo-b*
1658 b "\|" in a ":map" command is recognized as the end of
1659 the map command. The '\' is included in the mapping,
1660 the text after the '|' is interpreted as the next
1661 command. Use a CTRL-V instead of a backslash to
1662 include the '|' in the mapping. Applies to all
1663 mapping, abbreviation, menu and autocmd commands.
1664 See also |map_bar|.
1665 *cpo-B*
1666 B A backslash has no special meaning in mappings,
1667 abbreviations and the "to" part of the menu commands.
1668 Remove this flag to be able to use a backslash like a
1669 CTRL-V. For example, the command ":map X \<Esc>"
1670 results in X being mapped to:
1671 'B' included: "\^[" (^[ is a real <Esc>)
1672 'B' excluded: "<Esc>" (5 characters)
1673 ('<' excluded in both cases)
1674 *cpo-c*
1675 c Searching continues at the end of any match at the
1676 cursor position, but not further than the start of the
1677 next line. When not present searching continues
1678 one character from the cursor position. With 'c'
1679 "abababababab" only gets three matches when repeating
1680 "/abab", without 'c' there are five matches.
1681 *cpo-C*
1682 C Do not concatenate sourced lines that start with a
1683 backslash. See |line-continuation|.
1684 *cpo-d*
1685 d Using "./" in the 'tags' option doesn't mean to use
1686 the tags file relative to the current file, but the
1687 tags file in the current directory.
1688 *cpo-D*
1689 D Can't use CTRL-K to enter a digraph after Normal mode
1690 commands with a character argument, like |r|, |f| and
1691 |t|.
1692 *cpo-e*
1693 e When executing a register with ":@r", always add a
1694 <CR> to the last line, also when the register is not
1695 linewise. If this flag is not present, the register
1696 is not linewise and the last line does not end in a
1697 <CR>, then the last line is put on the command-line
1698 and can be edited before hitting <CR>.
1699 *cpo-E*
1700 E It is an error when using "y", "d", "c", "g~", "gu" or
1701 "gU" on an Empty region. The operators only work when
1702 at least one character is to be operate on. Example:
1703 This makes "y0" fail in the first column.
1704 *cpo-f*
1705 f When included, a ":read" command with a file name
1706 argument will set the file name for the current buffer,
1707 if the current buffer doesn't have a file name yet.
1708 *cpo-F*
1709 F When included, a ":write" command with a file name
1710 argument will set the file name for the current
1711 buffer, if the current buffer doesn't have a file name
1712 yet.
1713 *cpo-g*
1714 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001715 *cpo-H*
1716 H When using "I" on a line with only blanks, insert
1717 before the last blank. Without this flag insert after
1718 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 *cpo-i*
1720 i When included, interrupting the reading of a file will
1721 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001722 *cpo-I*
1723 I When moving the cursor up or down just after inserting
1724 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 *cpo-j*
1726 j When joining lines, only add two spaces after a '.',
1727 not after '!' or '?'. Also see 'joinspaces'.
1728 *cpo-J*
1729 J A |sentence| has to be followed by two spaces after
1730 the '.', '!' or '?'. A <Tab> is not recognized as
1731 white space.
1732 *cpo-k*
1733 k Disable the recognition of raw key codes in
1734 mappings, abbreviations, and the "to" part of menu
1735 commands. For example, if <Key> sends ^[OA (where ^[
1736 is <Esc>), the command ":map X ^[OA" results in X
1737 being mapped to:
1738 'k' included: "^[OA" (3 characters)
1739 'k' excluded: "<Key>" (one key code)
1740 Also see the '<' flag below.
1741 *cpo-K*
1742 K Don't wait for a key code to complete when it is
1743 halfway a mapping. This breaks mapping <F1><F1> when
1744 only part of the second <F1> has been read. It
1745 enables cancelling the mapping by typing <F1><Esc>.
1746 *cpo-l*
1747 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001748 literally, only "\]", "\^", "\-" and "\\" are special.
1749 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1751 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001752 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 *cpo-L*
1754 L When the 'list' option is set, 'wrapmargin',
1755 'textwidth', 'softtabstop' and Virtual Replace mode
1756 (see |gR|) count a <Tab> as two characters, instead of
1757 the normal behavior of a <Tab>.
1758 *cpo-m*
1759 m When included, a showmatch will always wait half a
1760 second. When not included, a showmatch will wait half
1761 a second or until a character is typed. |'showmatch'|
1762 *cpo-M*
1763 M When excluded, "%" matching will take backslashes into
1764 account. Thus in "( \( )" and "\( ( \)" the outer
1765 parenthesis match. When included "%" ignores
1766 backslashes, which is Vi compatible.
1767 *cpo-n*
1768 n When included, the column used for 'number' will also
1769 be used for text of wrapped lines.
1770 *cpo-o*
1771 o Line offset to search command is not remembered for
1772 next search.
1773 *cpo-O*
1774 O Don't complain if a file is being overwritten, even
1775 when it didn't exist when editing it. This is a
1776 protection against a file unexpectedly created by
1777 someone else. Vi didn't complain about this.
1778 *cpo-p*
1779 p Vi compatible Lisp indenting. When not present, a
1780 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001781 *cpo-q*
1782 q When joining multiple lines leave the cursor at the
1783 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 *cpo-r*
1785 r Redo ("." command) uses "/" to repeat a search
1786 command, instead of the actually used search string.
1787 *cpo-R*
1788 R Remove marks from filtered lines. Without this flag
1789 marks are kept like |:keepmarks| was used.
1790 *cpo-s*
1791 s Set buffer options when entering the buffer for the
1792 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001793 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 set when the buffer is created.
1795 *cpo-S*
1796 S Set buffer options always when entering a buffer
1797 (except 'readonly', 'fileformat', 'filetype' and
1798 'syntax'). This is the (most) Vi compatible setting.
1799 The options are set to the values in the current
1800 buffer. When you change an option and go to another
1801 buffer, the value is copied. Effectively makes the
1802 buffer options global to all buffers.
1803
1804 's' 'S' copy buffer options
1805 no no when buffer created
1806 yes no when buffer first entered (default)
1807 X yes each time when buffer entered (vi comp.)
1808 *cpo-t*
1809 t Search pattern for the tag command is remembered for
1810 "n" command. Otherwise Vim only puts the pattern in
1811 the history for search pattern, but doesn't change the
1812 last used search pattern.
1813 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001814 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 *cpo-v*
1816 v Backspaced characters remain visible on the screen in
1817 Insert mode. Without this flag the characters are
1818 erased from the screen right away. With this flag the
1819 screen newly typed text overwrites backspaced
1820 characters.
1821 *cpo-w*
1822 w When using "cw" on a blank character, only change one
1823 character and not all blanks until the start of the
1824 next word.
1825 *cpo-W*
1826 W Don't overwrite a readonly file. When omitted, ":w!"
1827 overwrites a readonly file, if possible.
1828 *cpo-x*
1829 x <Esc> on the command-line executes the command-line.
1830 The default in Vim is to abandon the command-line,
1831 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001832 *cpo-X*
1833 X When using a count with "R" the replaced text is
1834 deleted only once. Also when repeating "R" with "."
1835 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 *cpo-y*
1837 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001838 *cpo-Z*
1839 Z When using "w!" while the 'readonly' option is set,
1840 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 *cpo-!*
1842 ! When redoing a filter command, use the last used
1843 external command, whatever it was. Otherwise the last
1844 used -filter- command is used.
1845 *cpo-$*
1846 $ When making a change to one line, don't redisplay the
1847 line, but put a '$' at the end of the changed text.
1848 The changed text will be overwritten when you type the
1849 new text. The line is redisplayed if you type any
1850 command that moves the cursor from the insertion
1851 point.
1852 *cpo-%*
1853 % Vi-compatible matching is done for the "%" command.
1854 Does not recognize "#if", "#endif", etc.
1855 Does not recognize "/*" and "*/".
1856 Parens inside single and double quotes are also
1857 counted, causing a string that contains a paren to
1858 disturb the matching. For example, in a line like
1859 "if (strcmp("foo(", s))" the first paren does not
1860 match the last one. When this flag is not included,
1861 parens inside single and double quotes are treated
1862 specially. When matching a paren outside of quotes,
1863 everything inside quotes is ignored. When matching a
1864 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001865 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001866 This flag is also used for other features, such as
1867 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001868 *cpo--*
1869 - When included, a vertical movement command fails when
1870 it would above the first line or below the last line.
1871 Without it the cursor moves to the first or last line,
1872 unless it already was in that line.
1873 Applies to the commands "-", "k", CTRL-P, "+", "j",
1874 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001875 *cpo-+*
1876 + When included, a ":write file" command will reset the
1877 'modified' flag of the buffer, even though the buffer
1878 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001879 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 * Use ":*" in the same way as ":@". When not included,
1881 ":*" is an alias for ":'<,'>", select the Visual area.
1882 *cpo-<*
1883 < Disable the recognition of special key codes in |<>|
1884 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001885 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 ":map X <Tab>" results in X being mapped to:
1887 '<' included: "<Tab>" (5 characters)
1888 '<' excluded: "^I" (^I is a real <Tab>)
1889 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001890 *cpo->*
1891 > When appending to a register, put a line break before
1892 the appended text.
1893
1894 POSIX flags. These are not included in the Vi default value, except
1895 when $VIM_POSIX was set on startup. |posix|
1896
1897 contains behavior ~
1898 *cpo-#*
1899 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001900 *cpo-&*
1901 & When ":preserve" was used keep the swap file when
1902 exiting normally while this buffer is still loaded.
1903 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001904 *cpo-\*
1905 \ Backslash in a [] range in a search pattern is taken
1906 literally, only "\]" is special See |/[]|
1907 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1908 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1909 Also see |cpo-\|.
1910 *cpo-/*
1911 / When "%" is used as the replacement string in a |:s|
1912 command, use the previous replacement string. |:s%|
1913 *cpo-{*
1914 { The |{| and |}| commands also stop at a "{" character
1915 at the start of a line.
1916 *cpo-.*
1917 . The ":chdir" and ":cd" commands fail if the current
1918 buffer is modified, unless ! is used. Vim doesn't
1919 need this, since it remembers the full path of an
1920 opened file.
1921 *cpo-bar*
1922 | The value of the $LINES and $COLUMNS environment
1923 variables overrule the terminal size values obtained
1924 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001925
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926
1927 *'cscopepathcomp'* *'cspc'*
1928'cscopepathcomp' 'cspc' number (default 0)
1929 global
1930 {not available when compiled without the |+cscope|
1931 feature}
1932 {not in Vi}
1933 Determines how many components of the path to show in a list of tags.
1934 See |cscopepathcomp|.
1935
1936 *'cscopeprg'* *'csprg'*
1937'cscopeprg' 'csprg' string (default "cscope")
1938 global
1939 {not available when compiled without the |+cscope|
1940 feature}
1941 {not in Vi}
1942 Specifies the command to execute cscope. See |cscopeprg|.
1943 This option cannot be set from a |modeline| or in the |sandbox|, for
1944 security reasons.
1945
1946 *'cscopequickfix'* *'csqf'*
1947'cscopequickfix' 'csqf' string (default "")
1948 global
1949 {not available when compiled without the |+cscope|
1950 or |+quickfix| features}
1951 {not in Vi}
1952 Specifies whether to use quickfix window to show cscope results.
1953 See |cscopequickfix|.
1954
1955 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1956'cscopetag' 'cst' boolean (default off)
1957 global
1958 {not available when compiled without the |+cscope|
1959 feature}
1960 {not in Vi}
1961 Use cscope for tag commands. See |cscope-options|.
1962 NOTE: This option is reset when 'compatible' is set.
1963
1964 *'cscopetagorder'* *'csto'*
1965'cscopetagorder' 'csto' number (default 0)
1966 global
1967 {not available when compiled without the |+cscope|
1968 feature}
1969 {not in Vi}
1970 Determines the order in which ":cstag" performs a search. See
1971 |cscopetagorder|.
1972 NOTE: This option is set to 0 when 'compatible' is set.
1973
1974 *'cscopeverbose'* *'csverb'*
1975 *'nocscopeverbose'* *'nocsverb'*
1976'cscopeverbose' 'csverb' boolean (default off)
1977 global
1978 {not available when compiled without the |+cscope|
1979 feature}
1980 {not in Vi}
1981 Give messages when adding a cscope database. See |cscopeverbose|.
1982 NOTE: This option is reset when 'compatible' is set.
1983
1984 *'debug'*
1985'debug' string (default "")
1986 global
1987 {not in Vi}
1988 When set to "msg", error messages that would otherwise be omitted will
1989 be given anyway. This is useful when debugging 'foldexpr' or
1990 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001991 When set to "beep", a message will be given when otherwise only a beep
1992 would be produced.
1993 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994
1995 *'define'* *'def'*
1996'define' 'def' string (default "^\s*#\s*define")
1997 global or local to buffer |global-local|
1998 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001999 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 pattern, just like for the "/" command. This option is used for the
2001 commands like "[i" and "[d" |include-search|. The 'isident' option is
2002 used to recognize the defined name after the match:
2003 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2004 See |option-backslash| about inserting backslashes to include a space
2005 or backslash.
2006 The default value is for C programs. For C++ this value would be
2007 useful, to include const type declarations: >
2008 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2009< When using the ":set" command, you need to double the backslashes!
2010
2011 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2012'delcombine' 'deco' boolean (default off)
2013 global
2014 {not in Vi}
2015 {only available when compiled with the |+multi_byte|
2016 feature}
2017 If editing Unicode and this option is set, backspace and Normal mode
2018 "x" delete each combining character on its own. When it is off (the
2019 default) the character along with its combining characters are
2020 deleted.
2021 Note: When 'delcombine' is set "xx" may work different from "2x"!
2022
2023 This is useful for Arabic, Hebrew and many other languages where one
2024 may have combining characters overtop of base characters, and want
2025 to remove only the combining ones.
2026
2027 *'dictionary'* *'dict'*
2028'dictionary' 'dict' string (default "")
2029 global or local to buffer |global-local|
2030 {not in Vi}
2031 List of file names, separated by commas, that are used to lookup words
2032 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2033 contain a list of words. This can be one word per line, or several
2034 words per line, separated by non-keyword characters (white space is
2035 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002036 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 after a comma are ignored, otherwise spaces are included in the file
2038 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002039 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 Where to find a list of words?
2041 - On FreeBSD, there is the file "/usr/share/dict/words".
2042 - In the Simtel archive, look in the "msdos/linguist" directory.
2043 - In "miscfiles" of the GNU collection.
2044 The use of |:set+=| and |:set-=| is preferred when adding or removing
2045 directories from the list. This avoids problems when a future version
2046 uses another default.
2047 Backticks cannot be used in this option for security reasons.
2048
2049 *'diff'* *'nodiff'*
2050'diff' boolean (default off)
2051 local to window
2052 {not in Vi}
2053 {not available when compiled without the |+diff|
2054 feature}
2055 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002056 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057
2058 *'dex'* *'diffexpr'*
2059'diffexpr' 'dex' string (default "")
2060 global
2061 {not in Vi}
2062 {not available when compiled without the |+diff|
2063 feature}
2064 Expression which is evaluated to obtain an ed-style diff file from two
2065 versions of a file. See |diff-diffexpr|.
2066 This option cannot be set from a |modeline| or in the |sandbox|, for
2067 security reasons.
2068
2069 *'dip'* *'diffopt'*
2070'diffopt' 'dip' string (default "filler")
2071 global
2072 {not in Vi}
2073 {not available when compiled without the |+diff|
2074 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002075 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 All are optional. Items must be separated by a comma.
2077
2078 filler Show filler lines, to keep the text
2079 synchronized with a window that has inserted
2080 lines at the same position. Mostly useful
2081 when windows are side-by-side and 'scrollbind'
2082 is set.
2083
2084 context:{n} Use a context of {n} lines between a change
2085 and a fold that contains unchanged lines.
2086 When omitted a context of six lines is used.
2087 See |fold-diff|.
2088
2089 icase Ignore changes in case of text. "a" and "A"
2090 are considered the same. Adds the "-i" flag
2091 to the "diff" command if 'diffexpr' is empty.
2092
2093 iwhite Ignore changes in amount of white space. Adds
2094 the "-b" flag to the "diff" command if
2095 'diffexpr' is empty. Check the documentation
2096 of the "diff" command for what this does
2097 exactly. It should ignore adding trailing
2098 white space, but not leading white space.
2099
2100 Examples: >
2101
2102 :set diffopt=filler,context:4
2103 :set diffopt=
2104 :set diffopt=filler
2105<
2106 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2107'digraph' 'dg' boolean (default off)
2108 global
2109 {not in Vi}
2110 {not available when compiled without the |+digraphs|
2111 feature}
2112 Enable the entering of digraphs in Insert mode with {char1} <BS>
2113 {char2}. See |digraphs|.
2114 NOTE: This option is reset when 'compatible' is set.
2115
2116 *'directory'* *'dir'*
2117'directory' 'dir' string (default for Amiga: ".,t:",
2118 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2119 for Unix: ".,~/tmp,/var/tmp,/tmp")
2120 global
2121 List of directory names for the swap file, separated with commas.
2122 - The swap file will be created in the first directory where this is
2123 possible.
2124 - Empty means that no swap file will be used (recovery is
2125 impossible!).
2126 - A directory "." means to put the swap file in the same directory as
2127 the edited file. On Unix, a dot is prepended to the file name, so
2128 it doesn't show in a directory listing. On MS-Windows the "hidden"
2129 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002130 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002131 put the swap file relative to where the edited file is. The leading
2132 "." is replaced with the path name of the edited file.
2133 - For Unix and Win32, if a directory ends in two path separators, the
2134 swap file name will be built from the complete path to the file
2135 with all path separators substituted to percent '%' signs. This will
2136 ensure file name uniqueness in the preserve directory.
2137 - Spaces after the comma are ignored, other spaces are considered part
2138 of the directory name. To have a space at the start of a directory
2139 name, precede it with a backslash.
2140 - To include a comma in a directory name precede it with a backslash.
2141 - A directory name may end in an ':' or '/'.
2142 - Environment variables are expanded |:set_env|.
2143 - Careful with '\' characters, type one before a space, type two to
2144 get one in the option (see |option-backslash|), for example: >
2145 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2146< - For backwards compatibility with Vim version 3.0 a '>' at the start
2147 of the option is removed.
2148 Using "." first in the list is recommended. This means that editing
2149 the same file twice will result in a warning. Using "/tmp" on Unix is
2150 discouraged: When the system crashes you lose the swap file.
2151 "/var/tmp" is often not cleared when rebooting, thus is a better
2152 choice than "/tmp". But it can contain a lot of files, your swap
2153 files get lost in the crowd. That is why a "tmp" directory in your
2154 home directory is tried first.
2155 The use of |:set+=| and |:set-=| is preferred when adding or removing
2156 directories from the list. This avoids problems when a future version
2157 uses another default.
2158 This option cannot be set from a |modeline| or in the |sandbox|, for
2159 security reasons.
2160 {Vi: directory to put temp file in, defaults to "/tmp"}
2161
2162 *'display'* *'dy'*
2163'display' 'dy' string (default "")
2164 global
2165 {not in Vi}
2166 Change the way text is displayed. This is comma separated list of
2167 flags:
2168 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002169 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 last line that doesn't fit is replaced with "@" lines.
2171 uhex Show unprintable characters hexadecimal as <xx>
2172 instead of using ^C and ~C.
2173
2174 *'eadirection'* *'ead'*
2175'eadirection' 'ead' string (default "both")
2176 global
2177 {not in Vi}
2178 {not available when compiled without the +vertsplit
2179 feature}
2180 Tells when the 'equalalways' option applies:
2181 ver vertically, width of windows is not affected
2182 hor horizontally, height of windows is not affected
2183 both width and height of windows is affected
2184
2185 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2186'edcompatible' 'ed' boolean (default off)
2187 global
2188 Makes the 'g' and 'c' flags of the ":substitute" command to be
2189 toggled each time the flag is given. See |complex-change|. See
2190 also 'gdefault' option.
2191 Switching this option on is discouraged!
2192
2193 *'encoding'* *'enc'* *E543*
2194'encoding' 'enc' string (default: "latin1" or value from $LANG)
2195 global
2196 {only available when compiled with the |+multi_byte|
2197 feature}
2198 {not in Vi}
2199 Sets the character encoding used inside Vim. It applies to text in
2200 the buffers, registers, Strings in expressions, text stored in the
2201 viminfo file, etc. It sets the kind of characters which Vim can work
2202 with. See |encoding-names| for the possible values.
2203
2204 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002205 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 It should normally be kept at its default value, or set when Vim
2207 starts up. See |multibyte|.
2208
2209 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2210 "utf-8". Although care has been taken to allow different values of
2211 'encoding', "utf-8" is the natural choice for the environment and
2212 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002213 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 versions, and to avoid changing the encoding of newly created files
2215 without your knowledge (in case 'fileencodings' is empty).
2216
2217 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002218 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 iconv() or as specified with 'charconvert'.
2220
2221 Normally 'encoding' will be equal to your current locale. This will
2222 be the default if Vim recognizes your environment settings. If
2223 'encoding' is not set to the current locale, 'termencoding' must be
2224 set to convert typed and displayed text. See |encoding-table|.
2225
2226 When you set this option, it fires the |EncodingChanged| autocommand
2227 event so that you can set up fonts if necessary.
2228
2229 When the option is set, the value is converted to lowercase. Thus
2230 you can set it with uppercase values too. Underscores are translated
2231 to '-' signs.
2232 When the encoding is recognized, it is changed to the standard name.
2233 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2234 "iso-8859-2" and "utf8" becomes "utf-8".
2235
2236 Note: "latin1" is also used when the encoding could not be detected.
2237 This only works when editing files in the same encoding! When the
2238 actual character set is not latin1, make sure 'fileencoding' and
2239 'fileencodings' are empty. When conversion is needed, switch to using
2240 utf-8.
2241
2242 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2243 You don't notice this while editing, but it does matter for the
2244 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2245 setting 'encoding' to one of these values instead of utf-8 only has
2246 effect for encoding used for files when 'fileencoding' is empty.
2247
2248 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2249 not set yet, the default for 'fileencodings' is changed.
2250
2251 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2252'endofline' 'eol' boolean (default on)
2253 local to buffer
2254 {not in Vi}
2255 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002256 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 option is automatically set when starting to edit a new file, unless
2258 the file does not have an <EOL> for the last line in the file, in
2259 which case it is reset. Normally you don't have to set or reset this
2260 option. When 'binary' is off the value is not used when writing the
2261 file. When 'binary' is on it is used to remember the presence of a
2262 <EOL> for the last line in the file, so that when you write the file
2263 the situation from the original file can be kept. But you can change
2264 it if you want to.
2265
2266 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2267'equalalways' 'ea' boolean (default on)
2268 global
2269 {not in Vi}
2270 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002271 splitting or closing a window. This also happens the moment the
2272 option is switched on. When off, splitting a window will reduce the
2273 size of the current window and leave the other windows the same. When
2274 closing a window the extra lines are given to the window next to it
2275 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 When mixing vertically and horizontally split windows, a minimal size
2277 is computed and some windows may be larger if there is room. The
2278 'eadirection' option tells in which direction the size is affected.
2279 Changing the height of a window can be avoided by setting
2280 'winfixheight'.
2281
2282 *'equalprg'* *'ep'*
2283'equalprg' 'ep' string (default "")
2284 global or local to buffer |global-local|
2285 {not in Vi}
2286 External program to use for "=" command. When this option is empty
2287 the internal formatting functions are used ('lisp', 'cindent' or
2288 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002289 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290 about including spaces and backslashes.
2291 This option cannot be set from a |modeline| or in the |sandbox|, for
2292 security reasons.
2293
2294 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2295'errorbells' 'eb' boolean (default off)
2296 global
2297 Ring the bell (beep or screen flash) for error messages. This only
2298 makes a difference for error messages, the bell will be used always
2299 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002300 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 screen flash or do nothing.
2302
2303 *'errorfile'* *'ef'*
2304'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2305 others: "errors.err")
2306 global
2307 {not in Vi}
2308 {not available when compiled without the |+quickfix|
2309 feature}
2310 Name of the errorfile for the QuickFix mode (see |:cf|).
2311 When the "-q" command-line argument is used, 'errorfile' is set to the
2312 following argument. See |-q|.
2313 NOT used for the ":make" command. See 'makeef' for that.
2314 Environment variables are expanded |:set_env|.
2315 See |option-backslash| about including spaces and backslashes.
2316 This option cannot be set from a |modeline| or in the |sandbox|, for
2317 security reasons.
2318
2319 *'errorformat'* *'efm'*
2320'errorformat' 'efm' string (default is very long)
2321 global or local to buffer |global-local|
2322 {not in Vi}
2323 {not available when compiled without the |+quickfix|
2324 feature}
2325 Scanf-like description of the format for the lines in the error file
2326 (see |errorformat|).
2327
2328 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2329'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2330 global
2331 {not in Vi}
2332 Function keys that start with an <Esc> are recognized in Insert
2333 mode. When this option is off, the cursor and function keys cannot be
2334 used in Insert mode if they start with an <Esc>. The advantage of
2335 this is that the single <Esc> is recognized immediately, instead of
2336 after one second. Instead of resetting this option, you might want to
2337 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2338 when 'esckeys' is off, you can still map anything, but the cursor keys
2339 won't work by default.
2340 NOTE: This option is set to the Vi default value when 'compatible' is
2341 set and to the Vim default value when 'compatible' is reset.
2342
2343 *'eventignore'* *'ei'*
2344'eventignore' 'ei' string (default "")
2345 global
2346 {not in Vi}
2347 {not available when compiled without the |+autocmd|
2348 feature}
2349 A list of autocommand event names, which are to be ignored.
2350 When set to "all", all autocommand events are ignored, autocommands
2351 will not be executed.
2352 Otherwise this is a comma separated list of event names. Example: >
2353 :set ei=WinEnter,WinLeave
2354<
2355 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2356'expandtab' 'et' boolean (default off)
2357 local to buffer
2358 {not in Vi}
2359 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002360 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2362 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2363 NOTE: This option is reset when 'compatible' is set.
2364
2365 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2366'exrc' 'ex' boolean (default off)
2367 global
2368 {not in Vi}
2369 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2370 directory. If you switch this option on you should also consider
2371 setting the 'secure' option (see |initialization|). Using a local
2372 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2373 also see |.vimrc| and |gui-init|.
2374 This option cannot be set from a |modeline| or in the |sandbox|, for
2375 security reasons.
2376
2377 *'fileencoding'* *'fenc'* *E213*
2378'fileencoding' 'fenc' string (default: "")
2379 local to buffer
2380 {only available when compiled with the |+multi_byte|
2381 feature}
2382 {not in Vi}
2383 Sets the character encoding for the file of this buffer.
2384 When 'fileencoding' is different from 'encoding', conversion will be
2385 done when reading and writing the file.
2386 When 'fileencoding' is empty, the same value as 'encoding' will be
2387 used (no conversion when reading or writing a file).
2388 WARNING: Conversion can cause loss of information! When
2389 'encoding' is "utf-8" conversion is most likely done in a way
2390 that the reverse conversion results in the same text. When
2391 'encoding' is not "utf-8" some characters may be lost!
2392 See 'encoding' for the possible values. Additionally, values may be
2393 specified that can be handled by the converter, see
2394 |mbyte-conversion|.
2395 When reading a file 'fileencoding' will be set from 'fileencodings'.
2396 To read a file in a certain encoding it won't work by setting
2397 'fileencoding', use the |++enc| argument.
2398 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2399 When the option is set, the value is converted to lowercase. Thus
2400 you can set it with uppercase values too. '_' characters are
2401 replaced with '-'. If a name is recognized from the list for
2402 'encoding', it is replaced by the standard name. For example
2403 "ISO8859-2" becomes "iso-8859-2".
2404 When this option is set, after starting to edit a file, the 'modified'
2405 option is set, because the file would be different when written.
2406 If you do this in a modeline, you might want to set 'nomodified' to
2407 avoid this.
2408 This option can not be changed when 'modifiable' is off.
2409
2410 *'fe'*
2411 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002412 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413 old short name was 'fe', which is no longer used.
2414
2415 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002416'fileencodings' 'fencs' string (default: "ucs-bom",
2417 "ucs-bom,utf-8,default,latin1" when
2418 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 global
2420 {only available when compiled with the |+multi_byte|
2421 feature}
2422 {not in Vi}
2423 This is a list of character encodings considered when starting to edit
2424 an existing file. When a file is read, Vim tries to use the first
2425 mentioned character encoding. If an error is detected, the next one
2426 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002427 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 an empty string, which means the value of 'encoding' is used.
2429 WARNING: Conversion can cause loss of information! When
2430 'encoding' is "utf-8" (or one of the other Unicode variants)
2431 conversion is most likely done in a way that the reverse
2432 conversion results in the same text. When 'encoding' is not
2433 "utf-8" special characters may be lost!
2434 For an empty file or a file with only ASCII characters most encodings
2435 will work and the first entry of 'fileencodings' will be used (except
2436 "ucs-bom", which requires the BOM to be present). If you prefer
2437 another encoding use an BufReadPost autocommand event to test if your
2438 preferred encoding is to be used. Example: >
2439 au BufReadPost * if search('\S', 'w') == 0 |
2440 \ set fenc=iso-2022-jp | endif
2441< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2442 non-blank characters.
2443 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2444 is always empty then. This means that a non-existing file may get a
2445 different encoding than an empty file.
2446 The special value "ucs-bom" can be used to check for a Unicode BOM
2447 (Byte Order Mark) at the start of the file. It must not be preceded
2448 by "utf-8" or another Unicode encoding for this to work properly.
2449 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2450 because Vim cannot detect an error, thus the encoding is always
2451 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002452 The special value "default" can be used for the encoding from the
2453 environment. This is the default value for 'encoding'. It is useful
2454 when 'encoding' is set to "utf-8" and your environment uses a
2455 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 WRONG VALUES: WHAT'S WRONG:
2457 latin1,utf-8 "latin1" will always be used
2458 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2459 file
2460 cp1250,latin1 "cp1250" will always be used
2461 If 'fileencodings' is empty, 'fileencoding' is not modified.
2462 See 'fileencoding' for the possible values.
2463 Setting this option does not have an effect until the next time a file
2464 is read.
2465
2466 *'fileformat'* *'ff'*
2467'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2468 Unix default: "unix",
2469 Macintosh default: "mac")
2470 local to buffer
2471 {not in Vi}
2472 This gives the <EOL> of the current buffer, which is used for
2473 reading/writing the buffer from/to a file:
2474 dos <CR> <NL>
2475 unix <NL>
2476 mac <CR>
2477 When "dos" is used, CTRL-Z at the end of a file is ignored.
2478 See |file-formats| and |file-read|.
2479 For the character encoding of the file see 'fileencoding'.
2480 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2481 works like it was set to "unix'.
2482 This option is set automatically when starting to edit a file and
2483 'fileformats' is not empty and 'binary' is off.
2484 When this option is set, after starting to edit a file, the 'modified'
2485 option is set, because the file would be different when written.
2486 This option can not be changed when 'modifiable' is off.
2487 For backwards compatibility: When this option is set to "dos",
2488 'textmode' is set, otherwise 'textmode' is reset.
2489
2490 *'fileformats'* *'ffs'*
2491'fileformats' 'ffs' string (default:
2492 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2493 Vim Unix: "unix,dos",
2494 Vim Mac: "mac,unix,dos",
2495 Vi Cygwin: "unix,dos",
2496 Vi others: "")
2497 global
2498 {not in Vi}
2499 This gives the end-of-line (<EOL>) formats that will be tried when
2500 starting to edit a new buffer and when reading a file into an existing
2501 buffer:
2502 - When empty, the format defined with 'fileformat' will be used
2503 always. It is not set automatically.
2504 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002505 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 'fileformats' name will be used when a file is read into an existing
2507 buffer, no matter what 'fileformat' for that buffer is set to.
2508 - When more than one name is present, separated by commas, automatic
2509 <EOL> detection will be done when reading a file. When starting to
2510 edit a file, a check is done for the <EOL>:
2511 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2512 'fileformat' is set to "dos".
2513 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002514 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 preceding <CR>, "unix" is preferred over "dos".
2516 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2517 This means that "mac" is only chosen when "unix" is not present,
2518 or when no <NL> is found in the file, and when "dos" is not
2519 present, or no <CR><NL> is present in the file.
2520 Also if "unix" was first chosen, but the first <CR> is before
2521 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2522 the file, then 'fileformat' is set to "mac".
2523 4. If 'fileformat' is still not set, the first name from
2524 'fileformats' is used.
2525 When reading a file into an existing buffer, the same is done, but
2526 this happens like 'fileformat' has been set appropriately for that
2527 file only, the option is not changed.
2528 When 'binary' is set, the value of 'fileformats' is not used.
2529
2530 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2531 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2532 done:
2533 - When 'fileformats' is empty, there is no automatic detection. Dos
2534 format will be used.
2535 - When 'fileformats' is set to one or more names, automatic detection
2536 is done. This is based on the first <NL> in the file: If there is a
2537 <CR> in front of it, Dos format is used, otherwise Unix format is
2538 used.
2539 Also see |file-formats|.
2540 For backwards compatibility: When this option is set to an empty
2541 string or one format (no comma is included), 'textauto' is reset,
2542 otherwise 'textauto' is set.
2543 NOTE: This option is set to the Vi default value when 'compatible' is
2544 set and to the Vim default value when 'compatible' is reset.
2545
2546 *'filetype'* *'ft'*
2547'filetype' 'ft' string (default: "")
2548 local to buffer
2549 {not in Vi}
2550 {not available when compiled without the |+autocmd|
2551 feature}
2552 When this option is set, the FileType autocommand event is triggered.
2553 All autocommands that match with the value of this option will be
2554 executed. Thus the value of 'filetype' is used in place of the file
2555 name.
2556 Otherwise this option does not always reflect the current file type.
2557 This option is normally set when the file type is detected. To enable
2558 this use the ":filetype on" command. |:filetype|
2559 Setting this option to a different value is most useful in a modeline,
2560 for a file for which the file type is not automatically recognized.
2561 Example, for in an IDL file: >
2562 /* vim: set filetype=idl : */
2563< |FileType| |filetypes|
2564 Do not confuse this option with 'osfiletype', which is for the file
2565 type that is actually stored with the file.
2566 This option is not copied to another buffer, independent of the 's' or
2567 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002568 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'fillchars'* *'fcs'*
2571'fillchars' 'fcs' string (default "vert:|,fold:-")
2572 global
2573 {not in Vi}
2574 {not available when compiled without the |+windows|
2575 and |+folding| features}
2576 Characters to fill the statuslines and vertical separators.
2577 It is a comma separated list of items:
2578
2579 item default Used for ~
2580 stl:c ' ' or '^' statusline of the current window
2581 stlnc:c ' ' or '-' statusline of the non-current windows
2582 vert:c '|' vertical separators |:vsplit|
2583 fold:c '-' filling 'foldtext'
2584 diff:c '-' deleted lines of the 'diff' option
2585
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 "stlnc" the space will be used when there is highlighting, '^' or '-'
2588 otherwise.
2589
2590 Example: >
2591 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2592< This is similar to the default, except that these characters will also
2593 be used when there is highlighting.
2594
2595 The highlighting used for these items:
2596 item highlight group ~
2597 stl:c StatusLine |hl-StatusLine|
2598 stlnc:c StatusLineNC |hl-StatusLineNC|
2599 vert:c VertSplit |hl-VertSplit|
2600 fold:c Folded |hl-Folded|
2601 diff:c DiffDelete |hl-DiffDelete|
2602
2603 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2604'fkmap' 'fk' boolean (default off) *E198*
2605 global
2606 {not in Vi}
2607 {only available when compiled with the |+rightleft|
2608 feature}
2609 When on, the keyboard is mapped for the Farsi character set.
2610 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002611 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612
2613 *'foldclose'* *'fcl'*
2614'foldclose' 'fcl' string (default "")
2615 global
2616 {not in Vi}
2617 {not available when compiled without the |+folding|
2618 feature}
2619 When set to "all", a fold is closed when the cursor isn't in it and
2620 its level is higher than 'foldlevel'. Useful if you want folds to
2621 automatically close when moving out of them.
2622
2623 *'foldcolumn'* *'fdc'*
2624'foldcolumn' 'fdc' number (default 0)
2625 local to window
2626 {not in Vi}
2627 {not available when compiled without the |+folding|
2628 feature}
2629 When non-zero, a column with the specified width is shown at the side
2630 of the window which indicates open and closed folds. The maximum
2631 value is 12.
2632 See |folding|.
2633
2634 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2635'foldenable' 'fen' boolean (default on)
2636 local to window
2637 {not in Vi}
2638 {not available when compiled without the |+folding|
2639 feature}
2640 When off, all folds are open. This option can be used to quickly
2641 switch between showing all text unfolded and viewing the text with
2642 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002643 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 'foldenable' is off.
2645 This option is set by commands that create a new fold or close a fold.
2646 See |folding|.
2647
2648 *'foldexpr'* *'fde'*
2649'foldexpr' 'fde' string (default: "0")
2650 local to window
2651 {not in Vi}
2652 {not available when compiled without the |+folding|
2653 or |+eval| feature}
2654 The expression used for when 'foldmethod' is "expr". It is evaluated
2655 for each line to obtain its fold level. See |fold-expr|. Also see
2656 |eval-sandbox|.
2657
2658 *'foldignore'* *'fdi'*
2659'foldignore' 'fdi' string (default: "#")
2660 local to window
2661 {not in Vi}
2662 {not available when compiled without the |+folding|
2663 feature}
2664 Used only when 'foldmethod' is "indent". Lines starting with
2665 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002666 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 The default "#" works well for C programs. See |fold-indent|.
2668
2669 *'foldlevel'* *'fdl'*
2670'foldlevel' 'fdl' number (default: 0)
2671 local to window
2672 {not in Vi}
2673 {not available when compiled without the |+folding|
2674 feature}
2675 Sets the fold level: Folds with a higher level will be closed.
2676 Setting this option to zero will close all folds. Higher numbers will
2677 close fewer folds.
2678 This option is set by commands like |zm|, |zM| and |zR|.
2679 See |fold-foldlevel|.
2680
2681 *'foldlevelstart'* *'fdls'*
2682'foldlevelstart' 'fdls' number (default: -1)
2683 global
2684 {not in Vi}
2685 {not available when compiled without the |+folding|
2686 feature}
2687 Sets 'foldlevel' when starting to edit another buffer in a window.
2688 Useful to always start editing with all folds closed (value zero),
2689 some folds closed (one) or no folds closed (99).
2690 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002691 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 ignores this option and closes all folds.
2693 It is also done before BufReadPre autocommands, to allow an autocmd to
2694 overrule the 'foldlevel' value for specific files.
2695 When the value is negative, it is not used.
2696
2697 *'foldmarker'* *'fmr'* *E536*
2698'foldmarker' 'fmr' string (default: "{{{,}}}")
2699 local to window
2700 {not in Vi}
2701 {not available when compiled without the |+folding|
2702 feature}
2703 The start and end marker used when 'foldmethod' is "marker". There
2704 must be one comma, which separates the start and end marker. The
2705 marker is a literal string (a regular expression would be too slow).
2706 See |fold-marker|.
2707
2708 *'foldmethod'* *'fdm'*
2709'foldmethod' 'fdm' string (default: "manual")
2710 local to window
2711 {not in Vi}
2712 {not available when compiled without the |+folding|
2713 feature}
2714 The kind of folding used for the current window. Possible values:
2715 |fold-manual| manual Folds are created manually.
2716 |fold-indent| indent Lines with equal indent form a fold.
2717 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2718 |fold-marker| marker Markers are used to specify folds.
2719 |fold-syntax| syntax Syntax highlighting items specify folds.
2720 |fold-diff| diff Fold text that is not changed.
2721
2722 *'foldminlines'* *'fml'*
2723'foldminlines' 'fml' number (default: 1)
2724 local to window
2725 {not in Vi}
2726 {not available when compiled without the |+folding|
2727 feature}
2728 Sets the minimum number of screen lines for a fold to be displayed
2729 closed. Also for manually closed folds.
2730 Note that this only has an effect of what is displayed. After using
2731 "zc" to close a fold, which is displayed open because it's smaller
2732 than 'foldminlines', a following "zc" may close a containing fold.
2733
2734 *'foldnestmax'* *'fdn'*
2735'foldnestmax' 'fdn' number (default: 20)
2736 local to window
2737 {not in Vi}
2738 {not available when compiled without the |+folding|
2739 feature}
2740 Sets the maximum nesting of folds for the "indent" and "syntax"
2741 methods. This avoids that too many folds will be created. Using more
2742 than 20 doesn't work, because the internal limit is 20.
2743
2744 *'foldopen'* *'fdo'*
2745'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2746 search,tag,undo")
2747 global
2748 {not in Vi}
2749 {not available when compiled without the |+folding|
2750 feature}
2751 Specifies for which type of commands folds will be opened, if the
2752 command moves the cursor into a closed fold. It is a comma separated
2753 list of items.
2754 item commands ~
2755 all any
2756 block "(", "{", "[[", "[{", etc.
2757 hor horizontal movements: "l", "w", "fx", etc.
2758 insert any command in Insert mode
2759 jump far jumps: "G", "gg", etc.
2760 mark jumping to a mark: "'m", CTRL-O, etc.
2761 percent "%"
2762 quickfix ":cn", ":crew", ":make", etc.
2763 search search for a pattern: "/", "n", "*", "gd", etc.
2764 (not for a search pattern in a ":" command)
2765 tag jumping to a tag: ":ta", CTRL-T, etc.
2766 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002767 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 the |zv| command to the mapping to get the same effect.
2769 When a movement command is used for an operator (e.g., "dl" or "y%")
2770 this option is not used. This means the operator will include the
2771 whole closed fold.
2772 Note that vertical movements are not here, because it would make it
2773 very difficult to move onto a closed fold.
2774 In insert mode the folds containing the cursor will always be open
2775 when text is inserted.
2776 To close folds you can re-apply 'foldlevel' with the |zx| command or
2777 set the 'foldclose' option to "all".
2778
2779 *'foldtext'* *'fdt'*
2780'foldtext' 'fdt' string (default: "foldtext()")
2781 local to window
2782 {not in Vi}
2783 {not available when compiled without the |+folding|
2784 feature}
2785 An expression which is used to specify the text displayed for a closed
2786 fold. See |fold-foldtext|.
2787
2788 *'formatoptions'* *'fo'*
2789'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2790 local to buffer
2791 {not in Vi}
2792 This is a sequence of letters which describes how automatic
2793 formatting is to be done. See |fo-table|. When the 'paste' option is
2794 on, no formatting is done (like 'formatoptions' is empty). Commas can
2795 be inserted for readability.
2796 To avoid problems with flags that are added in the future, use the
2797 "+=" and "-=" feature of ":set" |add-option-flags|.
2798 NOTE: This option is set to the Vi default value when 'compatible' is
2799 set and to the Vim default value when 'compatible' is reset.
2800
Bram Moolenaar86b68352004-12-27 21:59:20 +00002801 *'formatlistpat'* *'flp'*
2802'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2803 local to buffer
2804 {not in Vi}
2805 A pattern that is used to recognize a list header. This is used for
2806 the "n" flag in 'formatoptions'.
2807 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002808 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002809 while still checking more characters. There must be a character
2810 following the pattern, when it matches the whole line it is handled
2811 like there is no match.
2812 The default recognizes a number, followed by an optional punctuation
2813 character and white space.
2814
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 *'formatprg'* *'fp'*
2816'formatprg' 'fp' string (default "")
2817 global
2818 {not in Vi}
2819 The name of an external program that will be used to format the lines
2820 selected with the "gq" command. The program must take the input on
2821 stdin and produce the output on stdout. The Unix program "fmt" is
2822 such a program. If this option is an empty string, the internal
2823 format function will be used |C-indenting|. Environment variables are
2824 expanded |:set_env|. See |option-backslash| about including spaces
2825 and backslashes.
2826 This option cannot be set from a |modeline| or in the |sandbox|, for
2827 security reasons.
2828
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002829 *'fsync'* *'fs'*
2830'fsync' 'fs' boolean (default on)
2831 global
2832 {not in Vi}
2833 When on, the library function fsync() will be called after writing a
2834 file. This will flush a file to disk, ensuring that it is safely
2835 written even on filesystems which do metadata-only journaling. This
2836 will force the harddrive to spin up on Linux systems running in laptop
2837 mode, so it may be undesirable in some situations. Be warned that
2838 turning this off increases the chances of data loss after a crash. On
2839 systems without an fsync() implementation, this variable is always
2840 off.
2841 Also see 'swapsync' for controlling fsync() on swap files.
2842
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2844'gdefault' 'gd' boolean (default off)
2845 global
2846 {not in Vi}
2847 When on, the ":substitute" flag 'g' is default on. This means that
2848 all matches in a line are substituted instead of one. When a 'g' flag
2849 is given to a ":substitute" command, this will toggle the substitution
2850 of all or one match. See |complex-change|.
2851
2852 command 'gdefault' on 'gdefault' off ~
2853 :s/// subst. all subst. one
2854 :s///g subst. one subst. all
2855 :s///gg subst. all subst. one
2856
2857 NOTE: This option is reset when 'compatible' is set.
2858
2859 *'grepformat'* *'gfm'*
2860'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2861 global
2862 {not in Vi}
2863 Format to recognize for the ":grep" command output.
2864 This is a scanf-like string that uses the same format as the
2865 'errorformat' option: see |errorformat|.
2866
2867 *'grepprg'* *'gp'*
2868'grepprg' 'gp' string (default "grep -n ",
2869 Unix: "grep -n $* /dev/null",
2870 Win32: "findstr /n" or "grep -n",
2871 VMS: "SEARCH/NUMBERS ")
2872 global or local to buffer |global-local|
2873 {not in Vi}
Bram Moolenaar7c626922005-02-07 22:01:03 +00002874 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 and '#' characters, which are expanded like when used in a command-
2876 line. The placeholder "$*" is allowed to specify where the arguments
2877 will be included. Environment variables are expanded |:set_env|. See
2878 |option-backslash| about including spaces and backslashes.
2879 When your "grep" accepts the "-H" argument, use this to make ":grep"
2880 also work well with a single file: >
2881 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002882< Special value: When 'grepprg' is set to "internal" the |:grep| command
2883 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002884 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 apply equally to 'grepprg'.
2886 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2887 otherwise it's "grep -n".
2888 This option cannot be set from a |modeline| or in the |sandbox|, for
2889 security reasons.
2890
2891 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2892'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2893 ve:ver35-Cursor,
2894 o:hor50-Cursor,
2895 i-ci:ver25-Cursor/lCursor,
2896 r-cr:hor20-Cursor/lCursor,
2897 sm:block-Cursor
2898 -blinkwait175-blinkoff150-blinkon175",
2899 for MS-DOS and Win32 console:
2900 "n-v-c:block,o:hor50,i-ci:hor15,
2901 r-cr:hor30,sm:block")
2902 global
2903 {not in Vi}
2904 {only available when compiled with GUI enabled, and
2905 for MS-DOS and Win32 console}
2906 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002907 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 the height of the cursor can be changed. This can be done by
2909 specifying a block cursor, or a percentage for a vertical or
2910 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002911 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002913 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 mode-list and an argument-list:
2915 mode-list:argument-list,mode-list:argument-list,..
2916 The mode-list is a dash separated list of these modes:
2917 n Normal mode
2918 v Visual mode
2919 ve Visual mode with 'selection' "exclusive" (same as 'v',
2920 if not specified)
2921 o Operator-pending mode
2922 i Insert mode
2923 r Replace mode
2924 c Command-line Normal (append) mode
2925 ci Command-line Insert mode
2926 cr Command-line Replace mode
2927 sm showmatch in Insert mode
2928 a all modes
2929 The argument-list is a dash separated list of these arguments:
2930 hor{N} horizontal bar, {N} percent of the character height
2931 ver{N} vertical bar, {N} percent of the character width
2932 block block cursor, fills the whole character
2933 [only one of the above three should be present]
2934 blinkwait{N} *cursor-blinking*
2935 blinkon{N}
2936 blinkoff{N}
2937 blink times for cursor: blinkwait is the delay before
2938 the cursor starts blinking, blinkon is the time that
2939 the cursor is shown and blinkoff is the time that the
2940 cursor is not shown. The times are in msec. When one
2941 of the numbers is zero, there is no blinking. The
2942 default is: "blinkwait700-blinkon400-blinkoff250".
2943 These numbers are used for a missing entry. This
2944 means that blinking is enabled by default. To switch
2945 blinking off you can use "blinkon0". The cursor only
2946 blinks when Vim is waiting for input, not while
2947 executing a command.
2948 To make the cursor blink in an xterm, see
2949 |xterm-blink|.
2950 {group-name}
2951 a highlight group name, that sets the color and font
2952 for the cursor
2953 {group-name}/{group-name}
2954 Two highlight group names, the first is used when
2955 no language mappings are used, the other when they
2956 are. |language-mapping|
2957
2958 Examples of parts:
2959 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2960 block cursor with colors from the "nCursor"
2961 highlight group
2962 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2963 In Insert and Command-line Insert mode, use a
2964 30% vertical bar cursor with colors from the
2965 "iCursor" highlight group. Blink a bit
2966 faster.
2967
2968 The 'a' mode is different. It will set the given argument-list for
2969 all modes. It does not reset anything to defaults. This can be used
2970 to do a common setting for all modes. For example, to switch off
2971 blinking: "a:blinkon0"
2972
2973 Examples of cursor highlighting: >
2974 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2975 :highlight Cursor gui=NONE guifg=bg guibg=fg
2976<
2977 *'guifont'* *'gfn'*
2978 *E235* *E596* *E610* *E611*
2979'guifont' 'gfn' string (default "")
2980 global
2981 {not in Vi}
2982 {only available when compiled with GUI enabled}
2983 This is a list of fonts which will be used for the GUI version of Vim.
2984 In its simplest form the value is just one font name. When
2985 the font cannot be found you will get an error message. To try other
2986 font names a list can be specified, font names separated with commas.
2987 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002990
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 Spaces after a comma are ignored. To include a comma in a font name
2992 precede it with a backslash. Setting an option requires an extra
2993 backslash before a space and a backslash. See also
2994 |option-backslash|. For example: >
2995 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002996< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002998
2999 If none of the fonts can be loaded, Vim will keep the current setting.
3000 If an empty font list is given, Vim will try using other resource
3001 settings (for X, it will use the Vim.font resource), and finally it
3002 will try some builtin default which should always be there ("7x13" in
3003 the case of X). The font names given should be "normal" fonts. Vim
3004 will try to find the related bold and italic fonts.
3005
3006 For Win32, GTK and Photon only: >
3007 :set guifont=*
3008< will bring up a font requester, where you can pick the font you want.
3009
3010 The font name depends on the GUI used. See |setting-guifont| for a
3011 way to set 'guifont' for various systems.
3012
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 For the GTK+ 2 GUI the font name looks like this: >
3014 :set guifont=Andale\ Mono\ 11
3015< That's all. XLFDs are no longer accepted.
3016 *E236*
3017 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003018 width). An exception is GTK 2: all fonts are accepted, but
3019 mono-spaced fonts look best.
3020
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 To preview a font on X11, you might be able to use the "xfontsel"
3022 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003023
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 For the Win32 GUI *E244* *E245*
3025 - takes these options in the font name:
3026 hXX - height is XX (points, can be floating-point)
3027 wXX - width is XX (points, can be floating-point)
3028 b - bold
3029 i - italic
3030 u - underline
3031 s - strikeout
3032 cXX - character set XX. valid charsets are: ANSI, ARABIC,
3033 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3034 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3035 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003036 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037
3038 Use a ':' to separate the options.
3039 - A '_' can be used in the place of a space, so you don't need to use
3040 backslashes to escape the spaces.
3041 - Examples: >
3042 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3043 :set guifont=Andale_Mono:h7.5:w4.5
3044< See also |font-sizes|.
3045
3046 *'guifontset'* *'gfs'*
3047 *E250* *E252* *E234* *E597* *E598*
3048'guifontset' 'gfs' string (default "")
3049 global
3050 {not in Vi}
3051 {only available when compiled with GUI enabled and
3052 with the |+xfontset| feature}
3053 {not available in the GTK+ 2 GUI}
3054 When not empty, specifies two (or more) fonts to be used. The first
3055 one for normal English, the second one for your special language. See
3056 |xfontset|.
3057 Setting this option also means that all font names will be handled as
3058 a fontset name. Also the ones used for the "font" argument of the
3059 |:highlight| command.
3060 The fonts must match with the current locale. If fonts for the
3061 character sets that the current locale uses are not included, setting
3062 'guifontset' will fail.
3063 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3064 the comma-separated names are alternative names, one of which will be
3065 used. In 'guifontset' the whole string is one fontset name,
3066 including the commas. It is not possible to specify alternative
3067 fontset names.
3068 This example works on many X11 systems: >
3069 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3070<
3071 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3072'guifontwide' 'gfw' string (default "")
3073 global
3074 {not in Vi}
3075 {only available when compiled with GUI enabled}
3076 When not empty, specifies a comma-separated list of fonts to be used
3077 for double-width characters. The first font that can be loaded is
3078 used.
3079 Note: The size of these fonts must be exactly twice as wide as the one
3080 specified with 'guifont' and the same height.
3081
3082 All GUI versions but GTK+ 2:
3083
3084 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3085 'guifontset' is empty or invalid.
3086 When 'guifont' is set and a valid font is found in it and
3087 'guifontwide' is empty Vim will attempt to find a matching
3088 double-width font and set 'guifontwide' to it.
3089
3090 GTK+ 2 GUI only: *guifontwide_gtk2*
3091
3092 If set and valid, 'guifontwide' is always used for double width
3093 characters, even if 'encoding' is not set to "utf-8".
3094 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003095 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 font for characters not available in 'guifont'. Thus you do not need
3097 to set 'guifontwide' at all unless you want to override the choice
3098 made by Pango/Xft.
3099
3100 *'guiheadroom'* *'ghr'*
3101'guiheadroom' 'ghr' number (default 50)
3102 global
3103 {not in Vi} {only for GTK and X11 GUI}
3104 The number of pixels subtracted from the screen height when fitting
3105 the GUI window on the screen. Set this before the GUI is started,
3106 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 lines will be left for window decorations and other items on the
3109 screen. Set it to a negative value to allow windows taller than the
3110 screen.
3111
3112 *'guioptions'* *'go'*
3113'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
3114 "agimrLtT" (GTK, Motif and Athena)
3115 global
3116 {not in Vi}
3117 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003118 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 sequence of letters which describes what components and options of the
3120 GUI should be used.
3121 To avoid problems with flags that are added in the future, use the
3122 "+=" and "-=" feature of ":set" |add-option-flags|.
3123
3124 Valid letters are as follows:
3125 *guioptions_a*
3126 'a' Autoselect: If present, then whenever VISUAL mode is started,
3127 or the Visual area extended, Vim tries to become the owner of
3128 the windowing system's global selection. This means that the
3129 Visually highlighted text is available for pasting into other
3130 applications as well as into Vim itself. When the Visual mode
3131 ends, possibly due to an operation on the text, or when an
3132 application wants to paste the selection, the highlighted text
3133 is automatically yanked into the "* selection register.
3134 Thus the selection is still available for pasting into other
3135 applications after the VISUAL mode has ended.
3136 If not present, then Vim won't become the owner of the
3137 windowing system's global selection unless explicitly told to
3138 by a yank or delete operation for the "* register.
3139 The same applies to the modeless selection.
3140
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003141 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142 applies to the modeless selection.
3143
3144 'guioptions' autoselect Visual autoselect modeless ~
3145 "" - -
3146 "a" yes yes
3147 "A" - yes
3148 "aA" yes yes
3149
3150 'c' Use console dialogs instead of popup dialogs for simple
3151 choices.
3152
3153 'f' Foreground: Don't use fork() to detach the GUI from the shell
3154 where it was started. Use this for programs that wait for the
3155 editor to finish (e.g., an e-mail program). Alternatively you
3156 can use "gvim -f" or ":gui -f" to start the GUI in the
3157 foreground. |gui-fork|
3158 Note: Set this option in the vimrc file. The forking may have
3159 happened already when the gvimrc file is read.
3160
3161 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3162 corner of the window. It's black&white on non-GTK, because of
3163 limitations of X11. For a color icon, see |X11-icon|.
3164
3165 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003166 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 that this flag must be added in the .vimrc file, before
3168 switching on syntax or filetype recognition (when the .gvimrc
3169 file is sourced the system menu has already been loaded; the
3170 ":syntax on" and ":filetype on" commands load the menu too).
3171 'g' Grey menu items: Make menu items that are not active grey. If
3172 'g' is not included inactive menu items are not shown at all.
3173 Exception: Athena will always use grey menu items.
3174
3175 't' Include tearoff menu items. Currently only works for Win32,
3176 GTK+, and Motif 1.2 GUI.
3177 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3178 Athena GUIs.
3179
3180 'r' Right-hand scrollbar is always present.
3181 'R' Right-hand scrollbar is present when there is a vertically
3182 split window.
3183 'l' Left-hand scrollbar is always present.
3184 'L' Left-hand scrollbar is present when there is a vertically
3185 split window.
3186 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3187 the longest visible line, or on the cursor line if the 'h'
3188 flag is included. |gui-horiz-scroll|
3189 'h' Limit horizontal scrollbar size to the length of the cursor
3190 line. Reduces computations. |gui-horiz-scroll|
3191
3192 And yes, you may even have scrollbars on the left AND the right if
3193 you really want to :-). See |gui-scrollbars| for more information.
3194
3195 'v' Use a vertical button layout for dialogs. When not included,
3196 a horizontal layout is preferred, but when it doesn't fit a
3197 vertical layout is used anyway.
3198 'p' Use Pointer callbacks for X11 GUI. This is required for some
3199 window managers. If the cursor is not blinking or hollow at
3200 the right moment, try adding this flag. This must be done
3201 before starting the GUI. Set it in your gvimrc. Adding or
3202 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003203 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204
3205 *'guipty'* *'noguipty'*
3206'guipty' boolean (default on)
3207 global
3208 {not in Vi}
3209 {only available when compiled with GUI enabled}
3210 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3211 I/O to/from shell commands. See |gui-pty|.
3212
3213 *'helpfile'* *'hf'*
3214'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3215 (others) "$VIMRUNTIME/doc/help.txt")
3216 global
3217 {not in Vi}
3218 Name of the main help file. All distributed help files should be
3219 placed together in one directory. Additionally, all "doc" directories
3220 in 'runtimepath' will be used.
3221 Environment variables are expanded |:set_env|. For example:
3222 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003223 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 spaces and backslashes.
3225 This option cannot be set from a |modeline| or in the |sandbox|, for
3226 security reasons.
3227
3228 *'helpheight'* *'hh'*
3229'helpheight' 'hh' number (default 20)
3230 global
3231 {not in Vi}
3232 {not available when compiled without the +windows
3233 feature}
3234 Minimal initial height of the help window when it is opened with the
3235 ":help" command. The initial height of the help window is half of the
3236 current window, or (when the 'ea' option is on) the same as other
3237 windows. When the height is less than 'helpheight', the height is
3238 set to 'helpheight'. Set to zero to disable.
3239
3240 *'helplang'* *'hlg'*
3241'helplang' 'hlg' string (default: messages language or empty)
3242 global
3243 {only available when compiled with the |+multi_lang|
3244 feature}
3245 {not in Vi}
3246 Comma separated list of languages. Vim will use the first language
3247 for which the desired help can be found. The English help will always
3248 be used as a last resort. You can add "en" to prefer English over
3249 another language, but that will only find tags that exist in that
3250 language and not in the English help.
3251 Example: >
3252 :set helplang=de,it
3253< This will first search German, then Italian and finally English help
3254 files.
3255 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3256 try to find the tag in the current language before using this option.
3257 See |help-translated|.
3258
3259 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3260'hidden' 'hid' boolean (default off)
3261 global
3262 {not in Vi}
3263 When off a buffer is unloaded when it is |abandon|ed. When on a
3264 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3265 displayed in another window, it does not become hidden, of course.
3266 The commands that move through the buffer list sometimes make a buffer
3267 hidden although the 'hidden' option is off: When the buffer is
3268 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003269 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003270 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 This option is set for one command with ":hide {command}" |:hide|.
3272 WARNING: It's easy to forget that you have changes in hidden buffers.
3273 Think twice when using ":q!" or ":qa!".
3274
3275 *'highlight'* *'hl'*
3276'highlight' 'hl' string (default (as a single string):
3277 "8:SpecialKey,@:NonText,d:Directory,
3278 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3279 M:ModeMsg,n:LineNr,r:Question,
3280 s:StatusLine,S:StatusLineNC,c:VertSplit
3281 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3282 f:Folded,F:FoldColumn,A:DiffAdd,
3283 C:DiffChange,D:DiffDelete,T:DiffText,
3284 >:SignColumn")
3285 global
3286 {not in Vi}
3287 This option can be used to set highlighting mode for various
3288 occasions. It is a comma separated list of character pairs. The
3289 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3292 |hl-NonText| @ '~' and '@' at the end of the window and
3293 characters from 'showbreak'
3294 |hl-Directory| d directories in CTRL-D listing and other special
3295 things in listings
3296 |hl-ErrorMsg| e error messages
3297 h (obsolete, ignored)
3298 |hl-IncSearch| i 'incsearch' highlighting
3299 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3300 |hl-MoreMsg| m |more-prompt|
3301 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3302 |hl-LineNr| n line number for ":number" and ":#" commands
3303 |hl-Question| r |hit-enter| prompt and yes/no questions
3304 |hl-StatusLine| s status line of current window |status-line|
3305 |hl-StatusLineNC| S status lines of not-current windows
3306 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3307 |hl-VertSplit| c column used to separate vertically split windows
3308 |hl-Visual| v Visual mode
3309 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3310 Selection" Only X11 Gui's |gui-x11| and
3311 |xterm-clipboard|.
3312 |hl-WarningMsg| w warning messages
3313 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3314 |hl-Folded| f line used for closed folds
3315 |hl-FoldColumn| F 'foldcolumn'
3316 |hl-SignColumn| > column used for |signs|
3317
3318 The display modes are:
3319 r reverse (termcap entry "mr" and "me")
3320 i italic (termcap entry "ZH" and "ZR")
3321 b bold (termcap entry "md" and "me")
3322 s standout (termcap entry "so" and "se")
3323 u underline (termcap entry "us" and "ue")
3324 n no highlighting
3325 - no highlighting
3326 : use a highlight group
3327 The default is used for occasions that are not included.
3328 If you want to change what the display modes do, see |dos-colors|
3329 for an example.
3330 When using the ':' display mode, this must be followed by the name of
3331 a highlight group. A highlight group can be used to define any type
3332 of highlighting, including using color. See |:highlight| on how to
3333 define one. The default uses a different group for each occasion.
3334 See |highlight-default| for the default highlight groups.
3335
3336 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3337'hlsearch' 'hls' boolean (default off)
3338 global
3339 {not in Vi}
3340 {not available when compiled without the
3341 |+extra_search| feature}
3342 When there is a previous search pattern, highlight all its matches.
3343 The type of highlighting used can be set with the 'l' occasion in the
3344 'highlight' option. This uses the "Search" highlight group by
3345 default. Note that only the matching text is highlighted, any offsets
3346 are not applied.
3347 See also: 'incsearch' and |:match|.
3348 When you get bored looking at the highlighted matches, you can turn it
3349 off with |:nohlsearch|. As soon as you use a search command, the
3350 highlighting comes back.
3351 When the search pattern can match an end-of-line, Vim will try to
3352 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003353 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 line below a closed fold. A match in a previous line which is not
3355 drawn may not continue in an newly drawn line.
3356 NOTE: This option is reset when 'compatible' is set.
3357
3358 *'history'* *'hi'*
3359'history' 'hi' number (Vim default: 20, Vi default: 0)
3360 global
3361 {not in Vi}
3362 A history of ":" commands, and a history of previous search patterns
3363 are remembered. This option decides how many entries may be stored in
3364 each of these histories (see |cmdline-editing|).
3365 NOTE: This option is set to the Vi default value when 'compatible' is
3366 set and to the Vim default value when 'compatible' is reset.
3367
3368 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3369'hkmap' 'hk' boolean (default off)
3370 global
3371 {not in Vi}
3372 {only available when compiled with the |+rightleft|
3373 feature}
3374 When on, the keyboard is mapped for the Hebrew character set.
3375 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3376 toggle this option. See |rileft.txt|.
3377 NOTE: This option is reset when 'compatible' is set.
3378
3379 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3380'hkmapp' 'hkp' boolean (default off)
3381 global
3382 {not in Vi}
3383 {only available when compiled with the |+rightleft|
3384 feature}
3385 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3386 This is useful if you have a non-Hebrew keyboard.
3387 See |rileft.txt|.
3388 NOTE: This option is reset when 'compatible' is set.
3389
3390 *'icon'* *'noicon'*
3391'icon' boolean (default off, on when title can be restored)
3392 global
3393 {not in Vi}
3394 {not available when compiled without the |+title|
3395 feature}
3396 When on, the icon text of the window will be set to the value of
3397 'iconstring' (if it is not empty), or to the name of the file
3398 currently being edited. Only the last part of the name is used.
3399 Overridden by the 'iconstring' option.
3400 Only works if the terminal supports setting window icons (currently
3401 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3402 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3403 builtin termcap).
3404 When Vim was compiled with HAVE_X11 defined, the original icon will be
3405 restored if possible |X11|. See |X11-icon| for changing the icon on
3406 X11.
3407
3408 *'iconstring'*
3409'iconstring' string (default "")
3410 global
3411 {not in Vi}
3412 {not available when compiled without the |+title|
3413 feature}
3414 When this option is not empty, it will be used for the icon text of
3415 the window. This happens only when the 'icon' option is on.
3416 Only works if the terminal supports setting window icon text
3417 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3418 Does not work for MS Windows.
3419 When Vim was compiled with HAVE_X11 defined, the original icon will be
3420 restored if possible |X11|.
3421 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003422 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423 'titlestring' for example settings.
3424 {not available when compiled without the |+statusline| feature}
3425
3426 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3427'ignorecase' 'ic' boolean (default off)
3428 global
3429 Ignore case in search patterns. Also used when searching in the tags
3430 file.
3431 Also see 'smartcase'.
3432 Can be overruled by using "\c" or "\C" in the pattern, see
3433 |/ignorecase|.
3434
3435 *'imactivatekey'* *'imak'*
3436'imactivatekey' 'imak' string (default "")
3437 global
3438 {not in Vi}
3439 {only available when compiled with |+xim| and
3440 |+GUI_GTK|}
3441 Specifies the key that your Input Method in X-Windows uses for
3442 activation. When this is specified correctly, vim can fully control
3443 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3444 You can't use this option to change the activation key, the option
3445 tells Vim what the key is.
3446 Format:
3447 [MODIFIER_FLAG-]KEY_STRING
3448
3449 These characters can be used for MODIFIER_FLAG (case is ignored):
3450 S Shift key
3451 L Lock key
3452 C Control key
3453 1 Mod1 key
3454 2 Mod2 key
3455 3 Mod3 key
3456 4 Mod4 key
3457 5 Mod5 key
3458 Combinations are allowed, for example "S-C-space" or "SC-space" are
3459 both shift+ctrl+space.
3460 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3461
3462 Example: >
3463 :set imactivatekey=S-space
3464< "S-space" means shift+space. This is the activation key for kinput2 +
3465 canna (Japanese), and ami (Korean).
3466
3467 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3468'imcmdline' 'imc' boolean (default off)
3469 global
3470 {not in Vi}
3471 {only available when compiled with the |+xim|
3472 |+multi_byte_ime| or |global-ime| feature}
3473 When set the Input Method is always on when starting to edit a command
3474 line, unless entering a search pattern (see 'imsearch' for that).
3475 Setting this option is useful when your input method allows entering
3476 English characters directly, e.g., when it's used to type accented
3477 characters with dead keys.
3478
3479 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3480'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3481 global
3482 {not in Vi}
3483 {only available when compiled with the |+xim|
3484 |+multi_byte_ime| or |global-ime| feature}
3485 When set the Input Method is never used. This is useful to disable
3486 the IM when it doesn't work properly.
3487 Currently this option is on by default for SGI/IRIX machines. This
3488 may change in later releases.
3489
3490 *'iminsert'* *'imi'*
3491'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3492 local to buffer
3493 {not in Vi}
3494 Specifies whether :lmap or an Input Method (IM) is to be used in
3495 Insert mode. Valid values:
3496 0 :lmap is off and IM is off
3497 1 :lmap is ON and IM is off
3498 2 :lmap is off and IM is ON
3499 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3500 or |global-ime|.
3501 To always reset the option to zero when leaving Insert mode with <Esc>
3502 this can be used: >
3503 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3504< This makes :lmap and IM turn off automatically when leaving Insert
3505 mode.
3506 Note that this option changes when using CTRL-^ in Insert mode
3507 |i_CTRL-^|.
3508 The value is set to 1 when setting 'keymap' to a valid keymap name.
3509 It is also used for the argument of commands like "r" and "f".
3510 The value 0 may not work correctly with Athena and Motif with some XIM
3511 methods. Use 'imdisable' to disable XIM then.
3512
3513 *'imsearch'* *'ims'*
3514'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3515 local to buffer
3516 {not in Vi}
3517 Specifies whether :lmap or an Input Method (IM) is to be used when
3518 entering a search pattern. Valid values:
3519 -1 the value of 'iminsert' is used, makes it look like
3520 'iminsert' is also used when typing a search pattern
3521 0 :lmap is off and IM is off
3522 1 :lmap is ON and IM is off
3523 2 :lmap is off and IM is ON
3524 Note that this option changes when using CTRL-^ in Command-line mode
3525 |c_CTRL-^|.
3526 The value is set to 1 when it is not -1 and setting the 'keymap'
3527 option to a valid keymap name.
3528 The value 0 may not work correctly with Athena and Motif with some XIM
3529 methods. Use 'imdisable' to disable XIM then.
3530
3531 *'include'* *'inc'*
3532'include' 'inc' string (default "^\s*#\s*include")
3533 global or local to buffer |global-local|
3534 {not in Vi}
3535 {not available when compiled without the
3536 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003537 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 pattern, just like for the "/" command (See |pattern|). The default
3539 value is for C programs. This option is used for the commands "[i",
3540 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3541 name that comes after the matched pattern. See |option-backslash|
3542 about including spaces and backslashes.
3543
3544 *'includeexpr'* *'inex'*
3545'includeexpr' 'inex' string (default "")
3546 local to buffer
3547 {not in Vi}
3548 {not available when compiled without the
3549 |+find_in_path| or |+eval| feature}
3550 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003551 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 :set includeexpr=substitute(v:fname,'\\.','/','g')
3553< The "v:fname" variable will be set to the file name that was detected.
3554 Evaluated in the |sandbox|.
3555 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003556 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 Also used for |<cfile>|.
3558
3559 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3560'incsearch' 'is' boolean (default off)
3561 global
3562 {not in Vi}
3563 {not available when compiled without the
3564 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003565 While typing a search command, show where the pattern, as it was typed
3566 so far, matches. The matched string is highlighted. If the pattern
3567 is invalid or not found, nothing is shown. The screen will be updated
3568 often, this is only useful on fast terminals.
3569 Note that the match will be shown, but the cursor will return to its
3570 original position when no match is found and when pressing <Esc>. You
3571 still need to finish the search command with <Enter> to move the
3572 cursor to the match.
3573 The highlighting can be set with the 'i' flag in 'highlight'.
3574 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 NOTE: This option is reset when 'compatible' is set.
3576
3577 *'indentexpr'* *'inde'*
3578'indentexpr' 'inde' string (default "")
3579 local to buffer
3580 {not in Vi}
3581 {not available when compiled without the |+cindent|
3582 or |+eval| features}
3583 Expression which is evaluated to obtain the proper indent for a line.
3584 It is used when a new line is created, for the |=| operator and
3585 in Insert mode as specified with the 'indentkeys' option.
3586 When this option is not empty, it overrules the 'cindent' and
3587 'smartindent' indenting.
3588 When 'paste' is set this option is not used for indenting.
3589 The expression is evaluated with |v:lnum| set to the line number for
3590 which the indent is to be computed. The cursor is also as this line
3591 when the expression is evaluated (but it may be moved around).
3592 The expression must return the number of spaces worth of indent. It
3593 can return "-1" to keep the current indent (this means 'autoindent' is
3594 used for the indent).
3595 Functions useful for computing the indent are |indent()|, |cindent()|
3596 and |lispindent()|.
3597 The evaluation of the expression must not have side effects! It must
3598 not change the text, jump to another window, etc. Afterwards the
3599 cursor position is always restored, thus the cursor may be moved.
3600 Normally this option would be set to call a function: >
3601 :set indentexpr=GetMyIndent()
3602< Error messages will be suppressed, unless the 'debug' option contains
3603 "msg".
3604 See |indent-expression|. Also see |eval-sandbox|.
3605 NOTE: This option is made empty when 'compatible' is set.
3606
3607 *'indentkeys'* *'indk'*
3608'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3609 local to buffer
3610 {not in Vi}
3611 {not available when compiled without the |+cindent|
3612 feature}
3613 A list of keys that, when typed in Insert mode, cause reindenting of
3614 the current line. Only happens if 'indentexpr' isn't empty.
3615 The format is identical to 'cinkeys', see |indentkeys-format|.
3616 See |C-indenting| and |indent-expression|.
3617
3618 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3619'infercase' 'inf' boolean (default off)
3620 local to buffer
3621 {not in Vi}
3622 When doing keyword completion in insert mode |ins-completion|, and
3623 'ignorecase' is also on, the case of the match is adjusted. If the
3624 typed text contains a lowercase letter where the match has an upper
3625 case letter, the completed part is made lowercase. If the typed text
3626 has no lowercase letters and the match has a lowercase letter where
3627 the typed text has an uppercase letter, and there is a letter before
3628 it, the completed part is made uppercase.
3629
3630 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3631'insertmode' 'im' boolean (default off)
3632 global
3633 {not in Vi}
3634 Makes Vim work in a way that Insert mode is the default mode. Useful
3635 if you want to use Vim as a modeless editor. Used for |evim|.
3636 These Insert mode commands will be useful:
3637 - Use the cursor keys to move around.
3638 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3639 this is a mapping, it is executed as if 'insertmode' was off.
3640 Normal mode remains active until the mapping is finished.
3641 *i_CTRL-L*
3642 - Use CTRL-L to execute a number of Normal mode commands, then use
3643 <Esc> to get back to Insert mode.
3644
3645 These items change when 'insertmode' is set:
3646 - when starting to edit of a file, Vim goes to Insert mode.
3647 - <Esc> in Insert mode is a no-op and beeps.
3648 - <Esc> in Normal mode makes Vim go to Insert mode.
3649 - CTRL-L in Insert mode is a command, it is not inserted.
3650 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3651 However, when <Esc> is used inside a mapping, it behaves like
3652 'insertmode' was not set. This was done to be able to use the same
3653 mappings with 'insertmode' set or not set.
3654 When executing commands with |:normal| 'insertmode' is not used.
3655
3656 NOTE: This option is reset when 'compatible' is set.
3657
3658 *'isfname'* *'isf'*
3659'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3660 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3661 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3662 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3663 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3664 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3665 global
3666 {not in Vi}
3667 The characters specified by this option are included in file names and
3668 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003669 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 Multi-byte characters 256 and above are always included, only the
3671 characters up to 255 are specified with this option.
3672 For UTF-8 the characters 0xa0 to 0xff are included as well.
3673
3674 Note that on systems using a backslash as path separator, Vim tries to
3675 do its best to make it work as you would expect. That is a bit
3676 tricky, since Vi originally used the backslash to escape special
3677 characters. Vim will not remove a backslash in front of a normal file
3678 name character on these systems, but it will on Unix and alikes. The
3679 '&' and '^' are not included by default, because these are special for
3680 cmd.exe.
3681
3682 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003683 Each part can be a single character number or a range. A range is two
3684 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 decimal number between 0 and 255 or the ASCII character itself (does
3686 not work for digits). Example:
3687 "_,-,128-140,#-43" (include '_' and '-' and the range
3688 128 to 140 and '#' to 43)
3689 If a part starts with '^', the following character number or range
3690 will be excluded from the option. The option is interpreted from left
3691 to right. Put the excluded character after the range where it is
3692 included. To include '^' itself use it as the last character of the
3693 option or the end of a range. Example:
3694 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3695 If the character is '@', all characters where isalpha() returns TRUE
3696 are included. Normally these are the characters a to z and A to Z,
3697 plus accented characters. To include '@' itself use "@-@". Examples:
3698 "@,^a-z" All alphabetic characters, excluding lower
3699 case letters.
3700 "a-z,A-Z,@-@" All letters plus the '@' character.
3701 A comma can be included by using it where a character number is
3702 expected. Example:
3703 "48-57,,,_" Digits, comma and underscore.
3704 A comma can be excluded by prepending a '^'. Example:
3705 " -~,^,,9" All characters from space to '~', excluding
3706 comma, plus <Tab>.
3707 See |option-backslash| about including spaces and backslashes.
3708
3709 *'isident'* *'isi'*
3710'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3711 "@,48-57,_,128-167,224-235"
3712 otherwise: "@,48-57,_,192-255")
3713 global
3714 {not in Vi}
3715 The characters given by this option are included in identifiers.
3716 Identifiers are used in recognizing environment variables and after a
3717 match of the 'define' option. It is also used for "\i" in a
3718 |pattern|. See 'isfname' for a description of the format of this
3719 option.
3720 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003721 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003722 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3723
3724 *'iskeyword'* *'isk'*
3725'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3726 "@,48-57,_,128-167,224-235"
3727 otherwise: "@,48-57,_,192-255"
3728 Vi default: "@,48-57,_")
3729 local to buffer
3730 {not in Vi}
3731 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003732 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 'isfname' for a description of the format of this option. For C
3734 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3735 For a help file it is set to all non-blank printable characters except
3736 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3737 command).
3738 When the 'lisp' option is on the '-' character is always included.
3739 NOTE: This option is set to the Vi default value when 'compatible' is
3740 set and to the Vim default value when 'compatible' is reset.
3741
3742 *'isprint'* *'isp'*
3743'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3744 "@,~-255"; otherwise: "@,161-255")
3745 global
3746 {not in Vi}
3747 The characters given by this option are displayed directly on the
3748 screen. It is also used for "\p" in a |pattern|. The characters from
3749 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3750 even when they are not included in 'isprint' or excluded. See
3751 'isfname' for a description of the format of this option.
3752
3753 Non-printable characters are displayed with two characters:
3754 0 - 31 "^@" - "^_"
3755 32 - 126 always single characters
3756 127 "^?"
3757 128 - 159 "~@" - "~_"
3758 160 - 254 "| " - "|~"
3759 255 "~?"
3760 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3761 displayed as <xx>, with the hexadecimal value of the byte.
3762 When 'display' contains "uhex" all unprintable characters are
3763 displayed as <xx>.
3764 The NonText highlighting will be used for unprintable characters.
3765 |hl-NonText|
3766
3767 Multi-byte characters 256 and above are always included, only the
3768 characters up to 255 are specified with this option. When a character
3769 is printable but it is not available in the current font, a
3770 replacement character will be shown.
3771 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3772 There is no option to specify these characters.
3773
3774 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3775'joinspaces' 'js' boolean (default on)
3776 global
3777 {not in Vi}
3778 Insert two spaces after a '.', '?' and '!' with a join command.
3779 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3780 Otherwise only one space is inserted.
3781 NOTE: This option is set when 'compatible' is set.
3782
3783 *'key'*
3784'key' string (default "")
3785 local to buffer
3786 {not in Vi}
3787 The key that is used for encrypting and decrypting the current buffer.
3788 See |encryption|.
3789 Careful: Do not set the key value by hand, someone might see the typed
3790 key. Use the |:X| command. But you can make 'key' empty: >
3791 :set key=
3792< It is not possible to get the value of this option with ":set key" or
3793 "echo &key". This is to avoid showing it to someone who shouldn't
3794 know. It also means you cannot see it yourself once you have set it,
3795 be careful not to make a typing error!
3796
3797 *'keymap'* *'kmp'* *E544*
3798'keymap' 'kmp' string (default "")
3799 local to buffer
3800 {not in Vi}
3801 {only available when compiled with the |+keymap|
3802 feature}
3803 Name of a keyboard mapping. See |mbyte-keymap|.
3804 Setting this option to a valid keymap name has the side effect of
3805 setting 'iminsert' to one, so that the keymap becomes effective.
3806 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003807 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808
3809 *'keymodel'* *'km'*
3810'keymodel' 'km' string (default "")
3811 global
3812 {not in Vi}
3813 List of comma separated words, which enable special things that keys
3814 can do. These values can be used:
3815 startsel Using a shifted special key starts selection (either
3816 Select mode or Visual mode, depending on "key" being
3817 present in 'selectmode').
3818 stopsel Using a not-shifted special key stops selection.
3819 Special keys in this context are the cursor keys, <End>, <Home>,
3820 <PageUp> and <PageDown>.
3821 The 'keymodel' option is set by the |:behave| command.
3822
3823 *'keywordprg'* *'kp'*
3824'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3825 OS/2: "view /", VMS: "help")
3826 global or local to buffer |global-local|
3827 {not in Vi}
3828 Program to use for the |K| command. Environment variables are
3829 expanded |:set_env|. ":help" may be used to access the Vim internal
3830 help. (Note that previously setting the global option to the empty
3831 value did this, which is now deprecated.)
3832 When "man" is used, Vim will automatically translate a count for the
3833 "K" command to a section number. Also for "man -s", in which case the
3834 "-s" is removed when there is no count.
3835 See |option-backslash| about including spaces and backslashes.
3836 Example: >
3837 :set keywordprg=man\ -s
3838< This option cannot be set from a |modeline| or in the |sandbox|, for
3839 security reasons.
3840
3841 *'langmap'* *'lmap'* *E357* *E358*
3842'langmap' 'lmap' string (default "")
3843 global
3844 {not in Vi}
3845 {only available when compiled with the |+langmap|
3846 feature}
3847 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003848 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 inserted directly. When in command mode the 'langmap' option takes
3850 care of translating these special characters to the original meaning
3851 of the key. This means you don't have to change the keyboard mode to
3852 be able to execute Normal mode commands.
3853 This is the opposite of the 'keymap' option, where characters are
3854 mapped in Insert mode.
3855 This only works for 8-bit characters. The value of 'langmap' may be
3856 specified with multi-byte characters (e.g., UTF-8), but only the lower
3857 8 bits of each character will be used.
3858
3859 Example (for Greek): *greek* >
3860 :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
3861< Example (exchanges meaning of z and y for commands): >
3862 :set langmap=zy,yz,ZY,YZ
3863<
3864 The 'langmap' option is a list of parts, separated with commas. Each
3865 part can be in one of two forms:
3866 1. A list of pairs. Each pair is a "from" character immediately
3867 followed by the "to" character. Examples: "aA", "aAbBcC".
3868 2. A list of "from" characters, a semi-colon and a list of "to"
3869 characters. Example: "abc;ABC"
3870 Example: "aA,fgh;FGH,cCdDeE"
3871 Special characters need to be preceded with a backslash. These are
3872 ";", ',' and backslash itself.
3873
3874 This will allow you to activate vim actions without having to switch
3875 back and forth between the languages. Your language characters will
3876 be understood as normal vim English characters (according to the
3877 langmap mappings) in the following cases:
3878 o Normal/Visual mode (commands, buffer/register names, user mappings)
3879 o Insert/Replace Mode: Register names after CTRL-R
3880 o Insert/Replace Mode: Mappings
3881 Characters entered in Command-line mode will NOT be affected by
3882 this option. Note that this option can be changed at any time
3883 allowing to switch between mappings for different languages/encodings.
3884 Use a mapping to avoid having to type it each time!
3885
3886 *'langmenu'* *'lm'*
3887'langmenu' 'lm' string (default "")
3888 global
3889 {not in Vi}
3890 {only available when compiled with the |+menu| and
3891 |+multi_lang| features}
3892 Language to use for menu translation. Tells which file is loaded
3893 from the "lang" directory in 'runtimepath': >
3894 "lang/menu_" . &langmenu . ".vim"
3895< (without the spaces). For example, to always use the Dutch menus, no
3896 matter what $LANG is set to: >
3897 :set langmenu=nl_NL.ISO_8859-1
3898< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003899 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 If your $LANG is set to a non-English language but you do want to use
3901 the English menus: >
3902 :set langmenu=none
3903< This option must be set before loading menus, switching on filetype
3904 detection or syntax highlighting. Once the menus are defined setting
3905 this option has no effect. But you could do this: >
3906 :source $VIMRUNTIME/delmenu.vim
3907 :set langmenu=de_DE.ISO_8859-1
3908 :source $VIMRUNTIME/menu.vim
3909< Warning: This deletes all menus that you defined yourself!
3910
3911 *'laststatus'* *'ls'*
3912'laststatus' 'ls' number (default 1)
3913 global
3914 {not in Vi}
3915 The value of this option influences when the last window will have a
3916 status line:
3917 0: never
3918 1: only if there are at least two windows
3919 2: always
3920 The screen looks nicer with a status line if you have several
3921 windows, but it takes another screen line. |status-line|
3922
3923 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3924'lazyredraw' 'lz' boolean (default off)
3925 global
3926 {not in Vi}
3927 When this option is set, the screen will not be redrawn while
3928 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003929 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 update use |:redraw|.
3931
3932 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3933'linebreak' 'lbr' boolean (default off)
3934 local to window
3935 {not in Vi}
3936 {not available when compiled without the |+linebreak|
3937 feature}
3938 If on Vim will wrap long lines at a character in 'breakat' rather
3939 than at the last character that fits on the screen. Unlike
3940 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3941 it only affects the way the file is displayed, not its contents. The
3942 value of 'showbreak' is used to put in front of wrapped lines.
3943 This option is not used when the 'wrap' option is off or 'list' is on.
3944 Note that <Tab> characters after an <EOL> are mostly not displayed
3945 with the right amount of white space.
3946
3947 *'lines'* *E593*
3948'lines' number (default 24 or terminal height)
3949 global
3950 Number of lines of the Vim window.
3951 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00003952 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 When Vim is running in the GUI or in a resizable window, setting this
3954 option will cause the window size to be changed. When you only want
3955 to use the size for the GUI, put the command in your |gvimrc| file.
3956 Vim limits the number of lines to what fits on the screen. You can
3957 use this command to get the tallest window possible: >
3958 :set lines=999
3959< If you get less lines than expected, check the 'guiheadroom' option.
3960 When you set this option and Vim is unable to change the physical
3961 number of lines of the display, the display may be messed up.
3962
3963 *'linespace'* *'lsp'*
3964'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3965 global
3966 {not in Vi}
3967 {only in the GUI}
3968 Number of pixel lines inserted between characters. Useful if the font
3969 uses the full character cell height, making lines touch each other.
3970 When non-zero there is room for underlining.
3971
3972 *'lisp'* *'nolisp'*
3973'lisp' boolean (default off)
3974 local to buffer
3975 {not available when compiled without the |+lispindent|
3976 feature}
3977 Lisp mode: When <Enter> is typed in insert mode set the indent for
3978 the next line to Lisp standards (well, sort of). Also happens with
3979 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3980 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3981 better. Also see 'lispwords'.
3982 The '-' character is included in keyword characters. Redefines the
3983 "=" operator to use this same indentation algorithm rather than
3984 calling an external program if 'equalprg' is empty.
3985 This option is not used when 'paste' is set.
3986 {Vi: Does it a little bit differently}
3987
3988 *'lispwords'* *'lw'*
3989'lispwords' 'lw' string (default is very long)
3990 global
3991 {not in Vi}
3992 {not available when compiled without the |+lispindent|
3993 feature}
3994 Comma separated list of words that influence the Lisp indenting.
3995 |'lisp'|
3996
3997 *'list'* *'nolist'*
3998'list' boolean (default off)
3999 local to window
4000 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4001 see the difference between tabs and spaces and for trailing blanks.
4002 Note that this will also affect formatting (set with 'textwidth' or
4003 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4004 changing the way tabs are displayed.
4005
4006 *'listchars'* *'lcs'*
4007'listchars' 'lcs' string (default "eol:$")
4008 global
4009 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004010 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 settings.
4012 eol:c Character to show at the end of each line. When
4013 omitted, there is no extra character at the end of the
4014 line.
4015 tab:xy Two characters to be used to show a Tab. The first
4016 char is used once. The second char is repeated to
4017 fill the space that the Tab normally occupies.
4018 "tab:>-" will show a Tab that takes four spaces as
4019 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004020 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004021 trailing spaces are blank.
4022 extends:c Character to show in the last column, when 'wrap' is
4023 off and the line continues beyond the right of the
4024 screen.
4025 precedes:c Character to show in the first column, when 'wrap'
4026 is off and there is text preceding the character
4027 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004028 nbsp:c Character to show for a non-breakable space (character
4029 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004031 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 be used when 'encoding' is "utf-8", otherwise only printable
4033 characters are allowed.
4034
4035 Examples: >
4036 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004037 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 :set lcs=extends:>,precedes:<
4039< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004040 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041
4042 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4043'loadplugins' 'lpl' boolean (default on)
4044 global
4045 {not in Vi}
4046 When on the plugin scripts are loaded when starting up |load-plugins|.
4047 This option can be reset in your |vimrc| file to disable the loading
4048 of plugins.
4049 Note that using the "-u NONE" and "--noplugin" command line arguments
4050 reset this option. |-u| |--noplugin|
4051
4052 *'magic'* *'nomagic'*
4053'magic' boolean (default on)
4054 global
4055 Changes the special characters that can be used in search patterns.
4056 See |pattern|.
4057 NOTE: To avoid portability problems with using patterns, always keep
4058 this option at the default "on". Only switch it off when working with
4059 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004060 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061
4062 *'makeef'* *'mef'*
4063'makeef' 'mef' string (default: "")
4064 global
4065 {not in Vi}
4066 {not available when compiled without the |+quickfix|
4067 feature}
4068 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4069 and the |:grep| command.
4070 When it is empty, an internally generated temp file will be used.
4071 When "##" is included, it is replaced by a number to make the name
4072 unique. This makes sure that the ":make" command doesn't overwrite an
4073 existing file.
4074 NOT used for the ":cf" command. See 'errorfile' for that.
4075 Environment variables are expanded |:set_env|.
4076 See |option-backslash| about including spaces and backslashes.
4077 This option cannot be set from a |modeline| or in the |sandbox|, for
4078 security reasons.
4079
4080 *'makeprg'* *'mp'*
4081'makeprg' 'mp' string (default "make", VMS: "MMS")
4082 global or local to buffer |global-local|
4083 {not in Vi}
4084 Program to use for the ":make" command. See |:make_makeprg|. This
4085 option may contain '%' and '#' characters, which are expanded like
4086 when used in a command-line. Environment variables are expanded
4087 |:set_env|. See |option-backslash| about including spaces and
4088 backslashes. Note that a '|' must be escaped twice: once for ":set"
4089 and once for the interpretation of a command. When you use a filter
4090 called "myfilter" do it like this: >
4091 :set makeprg=gmake\ \\\|\ myfilter
4092< The placeholder "$*" can be given (even multiple times) to specify
4093 where the arguments will be included, for example: >
4094 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4095< This option cannot be set from a |modeline| or in the |sandbox|, for
4096 security reasons.
4097
4098 *'matchpairs'* *'mps'*
4099'matchpairs' 'mps' string (default "(:),{:},[:]")
4100 local to buffer
4101 {not in Vi}
4102 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 must be different. The characters must be separated by a colon. The
4105 pairs must be separated by a comma. Example for including '<' and '>'
4106 (HTML): >
4107 :set mps+=<:>
4108
4109< A more exotic example, to jump between the '=' and ';' in an
4110 assignment, useful for languages like C and Java: >
4111 :au FileType c,cpp,java set mps+==:;
4112
4113< For a more advanced way of using "%", see the matchit.vim plugin in
4114 the $VIMRUNTIME/macros directory. |add-local-help|
4115
4116 *'matchtime'* *'mat'*
4117'matchtime' 'mat' number (default 5)
4118 global
4119 {not in Vi}{in Nvi}
4120 Tenths of a second to show the matching paren, when 'showmatch' is
4121 set. Note that this is not in milliseconds, like other options that
4122 set a time. This is to be compatible with Nvi.
4123
4124 *'maxfuncdepth'* *'mfd'*
4125'maxfuncdepth' 'mfd' number (default 100)
4126 global
4127 {not in Vi}
4128 Maximum depth of function calls for user functions. This normally
4129 catches endless recursion. When using a recursive function with
4130 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4131 more memory, there is the danger of failing when memory is exhausted.
4132 See also |:function|.
4133
4134 *'maxmapdepth'* *'mmd'* *E223*
4135'maxmapdepth' 'mmd' number (default 1000)
4136 global
4137 {not in Vi}
4138 Maximum number of times a mapping is done without resulting in a
4139 character to be used. This normally catches endless mappings, like
4140 ":map x y" with ":map y x". It still does not catch ":map g wg",
4141 because the 'w' is used before the next mapping is done. See also
4142 |key-mapping|.
4143
4144 *'maxmem'* *'mm'*
4145'maxmem' 'mm' number (default between 256 to 5120 (system
4146 dependent) or half the amount of memory
4147 available)
4148 global
4149 {not in Vi}
4150 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4151 limit is reached allocating extra memory for a buffer will cause
4152 other memory to be freed. Maximum value 2000000. Use this to work
4153 without a limit. Also see 'maxmemtot'.
4154
4155 *'maxmemtot'* *'mmt'*
4156'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4157 dependent) or half the amount of memory
4158 available)
4159 global
4160 {not in Vi}
4161 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004162 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 'maxmem'.
4164
4165 *'menuitems'* *'mis'*
4166'menuitems' 'mis' number (default 25)
4167 global
4168 {not in Vi}
4169 {not available when compiled without the |+menu|
4170 feature}
4171 Maximum number of items to use in a menu. Used for menus that are
4172 generated from a list of items, e.g., the Buffers menu. Changing this
4173 option has no direct effect, the menu must be refreshed first.
4174
4175 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4176'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4177 local to buffer
4178 *'modelines'* *'mls'*
4179'modelines' 'mls' number (default 5)
4180 global
4181 {not in Vi}
4182 If 'modeline' is on 'modelines' gives the number of lines that is
4183 checked for set commands. If 'modeline' is off or 'modelines' is zero
4184 no lines are checked. See |modeline|.
4185 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4186 set and to the Vim default value when 'compatible' is reset.
4187
4188 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4189'modifiable' 'ma' boolean (default on)
4190 local to buffer
4191 {not in Vi} *E21*
4192 When off the buffer contents cannot be changed. The 'fileformat' and
4193 'fileencoding' options also can't be changed.
4194 Can be reset with the |-M| command line argument.
4195
4196 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4197'modified' 'mod' boolean (default off)
4198 local to buffer
4199 {not in Vi}
4200 When on, the buffer is considered to be modified. This option is set
4201 when:
4202 1. A change was made to the text since it was last written. Using the
4203 |undo| command to go back to the original text will reset the
4204 option. But undoing changes that were made before writing the
4205 buffer will set the option again, since the text is different from
4206 when it was written.
4207 2. 'fileformat' or 'fileencoding' is different from its original
4208 value. The original value is set when the buffer is read or
4209 written. A ":set nomodified" command also resets the original
4210 values to the current values and the 'modified' option will be
4211 reset.
4212 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4213 will be ignored.
4214
4215 *'more'* *'nomore'*
4216'more' boolean (Vim default: on, Vi default: off)
4217 global
4218 {not in Vi}
4219 When on, listings pause when the whole screen is filled. You will get
4220 the |more-prompt|. When this option is off there are no pauses, the
4221 listing continues until finished.
4222 NOTE: This option is set to the Vi default value when 'compatible' is
4223 set and to the Vim default value when 'compatible' is reset.
4224
4225 *'mouse'* *E538*
4226'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4227 global
4228 {not in Vi}
4229 Enable the use of the mouse. Only works for certain terminals
4230 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4231 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4232 The mouse can be enabled for different modes:
4233 n Normal mode
4234 v Visual mode
4235 i Insert mode
4236 c Command-line mode
4237 h all previous modes when editing a help file
4238 a all previous modes
4239 r for |hit-enter| and |more-prompt| prompt
4240 A auto-select in Visual mode
4241 Normally you would enable the mouse in all four modes with: >
4242 :set mouse=a
4243< When the mouse is not enabled, the GUI will still use the mouse for
4244 modeless selection. This doesn't move the text cursor.
4245
4246 See |mouse-using|. Also see |'clipboard'|.
4247
4248 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004249 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 the mouse buttons can still be used by keeping the shift key pressed.
4251 Also see the 'clipboard' option.
4252
4253 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4254'mousefocus' 'mousef' boolean (default off)
4255 global
4256 {not in Vi}
4257 {only works in the GUI}
4258 The window that the mouse pointer is on is automatically activated.
4259 When changing the window layout or window focus in another way, the
4260 mouse pointer is moved to the window with keyboard focus. Off is the
4261 default because it makes using the pull down menus a little goofy, as
4262 a pointer transit may activate a window unintentionally.
4263
4264 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4265'mousehide' 'mh' boolean (default on)
4266 global
4267 {not in Vi}
4268 {only works in the GUI}
4269 When on, the mouse pointer is hidden when characters are typed.
4270 The mouse pointer is restored when the mouse is moved.
4271
4272 *'mousemodel'* *'mousem'*
4273'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4274 global
4275 {not in Vi}
4276 Sets the model to use for the mouse. The name mostly specifies what
4277 the right mouse button is used for:
4278 extend Right mouse button extends a selection. This works
4279 like in an xterm.
4280 popup Right mouse button pops up a menu. The shifted left
4281 mouse button extends a selection. This works like
4282 with Microsoft Windows
4283 popup_setpos Like "popup", but the cursor will be moved to the
4284 position where the mouse was clicked, and thus the
4285 selected operation will act upon the clicked object.
4286 If clicking inside a selection, that selection will
4287 be acted upon, ie. no cursor move. This implies of
4288 course, that right clicking outside a selection will
4289 end Visual mode.
4290 Overview of what button does what for each model:
4291 mouse extend popup(_setpos) ~
4292 left click place cursor place cursor
4293 left drag start selection start selection
4294 shift-left search word extend selection
4295 right click extend selection popup menu (place cursor)
4296 right drag extend selection -
4297 middle click paste paste
4298
4299 In the "popup" model the right mouse button produces a pop-up menu.
4300 You need to define this first, see |popup-menu|.
4301
4302 Note that you can further refine the meaning of buttons with mappings.
4303 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4304 selection (because that's handled in the GUI code directly).
4305
4306 The 'mousemodel' option is set by the |:behave| command.
4307
4308 *'mouseshape'* *'mouses'* *E547*
4309'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4310 m:no,ml:up-arrow,v:rightup-arrow"
4311 global
4312 {not in Vi}
4313 {only available when compiled with the |+mouseshape|
4314 feature}
4315 This option tells Vim what the mouse pointer should look like in
4316 different modes. The option is a comma separated list of parts, much
4317 like used for 'guicursor'. Each part consist of a mode/location-list
4318 and an argument-list:
4319 mode-list:shape,mode-list:shape,..
4320 The mode-list is a dash separated list of these modes/locations:
4321 In a normal window: ~
4322 n Normal mode
4323 v Visual mode
4324 ve Visual mode with 'selection' "exclusive" (same as 'v',
4325 if not specified)
4326 o Operator-pending mode
4327 i Insert mode
4328 r Replace mode
4329
4330 Others: ~
4331 c appending to the command-line
4332 ci inserting in the command-line
4333 cr replacing in the command-line
4334 m at the 'Hit ENTER' or 'More' prompts
4335 ml idem, but cursor in the last line
4336 e any mode, pointer below last window
4337 s any mode, pointer on a status line
4338 sd any mode, while dragging a status line
4339 vs any mode, pointer on a vertical separator line
4340 vd any mode, while dragging a vertical separator line
4341 a everywhere
4342
4343 The shape is one of the following:
4344 avail name looks like ~
4345 w x arrow Normal mouse pointer
4346 w x blank no pointer at all (use with care!)
4347 w x beam I-beam
4348 w x updown up-down sizing arrows
4349 w x leftright left-right sizing arrows
4350 w x busy The system's usual busy pointer
4351 w x no The system's usual 'no input' pointer
4352 x udsizing indicates up-down resizing
4353 x lrsizing indicates left-right resizing
4354 x crosshair like a big thin +
4355 x hand1 black hand
4356 x hand2 white hand
4357 x pencil what you write with
4358 x question big ?
4359 x rightup-arrow arrow pointing right-up
4360 w x up-arrow arrow pointing up
4361 x <number> any X11 pointer number (see X11/cursorfont.h)
4362
4363 The "avail" column contains a 'w' if the shape is available for Win32,
4364 x for X11.
4365 Any modes not specified or shapes not available use the normal mouse
4366 pointer.
4367
4368 Example: >
4369 :set mouseshape=s:udsizing,m:no
4370< will make the mouse turn to a sizing arrow over the status lines and
4371 indicate no input when the hit-enter prompt is displayed (since
4372 clicking the mouse has no effect in this state.)
4373
4374 *'mousetime'* *'mouset'*
4375'mousetime' 'mouset' number (default 500)
4376 global
4377 {not in Vi}
4378 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4379 time in msec between two mouse clicks for the second click to be
4380 recognized as a multi click.
4381
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004382 *'mzquantum'* *'mzq'*
4383'mzquantum' 'mzq' number (default 100)
4384 global
4385 {not in Vi}
4386 {not available when compiled without the |+mzscheme|
4387 feature}
4388 The number of milliseconds between polls for MzScheme threads.
4389 Negative or zero value means no thread scheduling.
4390
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 *'nrformats'* *'nf'*
4392'nrformats' 'nf' string (default "octal,hex")
4393 local to buffer
4394 {not in Vi}
4395 This defines what bases Vim will consider for numbers when using the
4396 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4397 respectively; see |CTRL-A| for more info on these commands.
4398 alpha if included, single alphabetical characters will be
4399 incremented or decremented. This is useful for a list with a
4400 letter index a), b), etc.
4401 octal if included, numbers that start with a zero will be considered
4402 to be octal. Example: Using CTRL-A on "007" results in "010".
4403 hex if included, numbers starting with "0x" or "0X" will be
4404 considered to be hexadecimal. Example: Using CTRL-X on
4405 "0x100" results in "0x0ff".
4406 Numbers which simply begin with a digit in the range 1-9 are always
4407 considered decimal. This also happens for numbers that are not
4408 recognized as octal or hex.
4409
4410 *'number'* *'nu'* *'nonumber'* *'nonu'*
4411'number' 'nu' boolean (default off)
4412 local to window
4413 Print the line number in front of each line. When the 'n' option is
4414 excluded from 'cpoptions' a wrapped line will not use the column of
4415 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004416 The 'numberwidth' option can be used to set the room used for the line
4417 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418 When a long, wrapped line doesn't start with the first character, '-'
4419 characters are put before the number.
4420 See |hl-LineNr| for the highlighting used for the number.
4421
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004422 *'numberwidth'* *'nuw'*
4423'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4424 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004425 {not in Vi}
4426 {only available when compiled with the |+linebreak|
4427 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004428 Minimal number of columns to use for the line number. Only relevant
4429 when the 'number' option is set.
4430 Since one space is always between the number and the text, there is
4431 one less character for the number itself.
4432 The value is the minimum width. A bigger width is used when needed to
4433 fit the highest line number in the buffer. Thus with the Vim default
4434 of 4 there is room for a line number up to 999. When the buffer has
4435 1000 lines five columns will be used.
4436 The minimum value is 1, the maximum value is 10.
4437 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4438
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 *'osfiletype'* *'oft'* *E366*
4440'osfiletype' 'oft' string (RISC-OS default: "Text",
4441 others default: "")
4442 local to buffer
4443 {not in Vi}
4444 {only available when compiled with the |+osfiletype|
4445 feature}
4446 Some operating systems store extra information about files besides
4447 name, datestamp and permissions. This option contains the extra
4448 information, the nature of which will vary between systems.
4449 The value of this option is usually set when the file is loaded, and
4450 use to set the file type when file is written.
4451 It can affect the pattern matching of the automatic commands.
4452 |autocmd-osfiletypes|
4453
4454 *'paragraphs'* *'para'*
4455'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4456 global
4457 Specifies the nroff macros that separate paragraphs. These are pairs
4458 of two letters (see |object-motions|).
4459
4460 *'paste'* *'nopaste'*
4461'paste' boolean (default off)
4462 global
4463 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004464 Put Vim in Paste mode. This is useful if you want to cut or copy
4465 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004466 unexpected effects.
4467 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004468 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 knows about pasting and will mostly do the right thing without 'paste'
4470 being set. The same is true for a terminal where Vim handles the
4471 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004472 This option is reset when starting the GUI. Thus if you set it in
4473 your .vimrc it will work in a terminal, but not in the GUI. Setting
4474 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4475 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 When the 'paste' option is switched on (also when it was already on):
4477 - mapping in Insert mode and Command-line mode is disabled
4478 - abbreviations are disabled
4479 - 'textwidth' is set to 0
4480 - 'wrapmargin' is set to 0
4481 - 'autoindent' is reset
4482 - 'smartindent' is reset
4483 - 'softtabstop' is set to 0
4484 - 'revins' is reset
4485 - 'ruler' is reset
4486 - 'showmatch' is reset
4487 - 'formatoptions' is used like it is empty
4488 These options keep their value, but their effect is disabled:
4489 - 'lisp'
4490 - 'indentexpr'
4491 - 'cindent'
4492 NOTE: When you start editing another file while the 'paste' option is
4493 on, settings from the modelines or autocommands may change the
4494 settings again, causing trouble when pasting text. You might want to
4495 set the 'paste' option again.
4496 When the 'paste' option is reset the mentioned options are restored to
4497 the value before the moment 'paste' was switched from off to on.
4498 Resetting 'paste' before ever setting it does not have any effect.
4499 Since mapping doesn't work while 'paste' is active, you need to use
4500 the 'pastetoggle' option to toggle the 'paste' option with some key.
4501
4502 *'pastetoggle'* *'pt'*
4503'pastetoggle' 'pt' string (default "")
4504 global
4505 {not in Vi}
4506 When non-empty, specifies the key sequence that toggles the 'paste'
4507 option. This is like specifying a mapping: >
4508 :map {keys} :set invpaste<CR>
4509< Where {keys} is the value of 'pastetoggle'.
4510 The difference is that it will work even when 'paste' is set.
4511 'pastetoggle' works in Insert mode and Normal mode, but not in
4512 Command-line mode.
4513 Mappings are checked first, thus overrule 'pastetoggle'. However,
4514 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4515 this: >
4516 :map <F10> :set paste<CR>
4517 :map <F11> :set nopaste<CR>
4518 :imap <F10> <C-O>:set paste<CR>
4519 :imap <F11> <nop>
4520 :set pastetoggle=<F11>
4521< This will make <F10> start paste mode and <F11> stop paste mode.
4522 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4523 mode everything is inserted literally, except the 'pastetoggle' key
4524 sequence.
4525
4526 *'pex'* *'patchexpr'*
4527'patchexpr' 'pex' string (default "")
4528 global
4529 {not in Vi}
4530 {not available when compiled without the |+diff|
4531 feature}
4532 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004533 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534
4535 *'patchmode'* *'pm'* *E206*
4536'patchmode' 'pm' string (default "")
4537 global
4538 {not in Vi}
4539 When non-empty the oldest version of a file is kept. This can be used
4540 to keep the original version of a file if you are changing files in a
4541 source distribution. Only the first time that a file is written a
4542 copy of the original file will be kept. The name of the copy is the
4543 name of the original file with the string in the 'patchmode' option
4544 appended. This option should start with a dot. Use a string like
4545 ".org". 'backupdir' must not be empty for this to work (Detail: The
4546 backup file is renamed to the patchmode file after the new file has
4547 been successfully written, that's why it must be possible to write a
4548 backup file). If there was no file to be backed up, an empty file is
4549 created.
4550 When the 'backupskip' pattern matches, a patchmode file is not made.
4551 Using 'patchmode' for compressed files appends the extension at the
4552 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4553 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004554 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555
4556 *'path'* *'pa'* *E343* *E345* *E347*
4557'path' 'pa' string (default on Unix: ".,/usr/include,,"
4558 on OS/2: ".,/emx/include,,"
4559 other systems: ".,,")
4560 global or local to buffer |global-local|
4561 {not in Vi}
4562 This is a list of directories which will be searched when using the
4563 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4564 being searched for has a relative path (not starting with '/'). The
4565 directories in the 'path' option may be relative or absolute.
4566 - Use commas to separate directory names: >
4567 :set path=.,/usr/local/include,/usr/include
4568< - Spaces can also be used to separate directory names (for backwards
4569 compatibility with version 3.0). To have a space in a directory
4570 name, precede it with an extra backslash, and escape the space: >
4571 :set path=.,/dir/with\\\ space
4572< - To include a comma in a directory name precede it with an extra
4573 backslash: >
4574 :set path=.,/dir/with\\,comma
4575< - To search relative to the directory of the current file, use: >
4576 :set path=.
4577< - To search in the current directory use an empty string between two
4578 commas: >
4579 :set path=,,
4580< - A directory name may end in a ':' or '/'.
4581 - Environment variables are expanded |:set_env|.
4582 - When using |netrw.vim| URLs can be used. For example, adding
4583 "http://www.vim.org" will make ":find index.html" work.
4584 - Search upwards and downwards in a directory tree:
4585 1) "*" matches a sequence of characters, e.g.: >
4586 :set path=/usr/include/*
4587< means all subdirectories in /usr/include (but not /usr/include
4588 itself). >
4589 :set path=/usr/*c
4590< matches /usr/doc and /usr/src.
4591 2) "**" matches a subtree, up to 100 directories deep. Example: >
4592 :set path=/home/user_x/src/**
4593< means search in the whole subtree under "/home/usr_x/src".
4594 3) If the path ends with a ';', this path is the startpoint
4595 for upward search.
4596 See |file-searching| for more info and exact syntax.
4597 {not available when compiled without the |+path_extra| feature}
4598 - Careful with '\' characters, type two to get one in the option: >
4599 :set path=.,c:\\include
4600< Or just use '/' instead: >
4601 :set path=.,c:/include
4602< Don't forget "." or files won't even be found in the same directory as
4603 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 it is something like 256 or 1024 characters.
4606 You can check if all the include files are found, using the value of
4607 'path', see |:checkpath|.
4608 The use of |:set+=| and |:set-=| is preferred when adding or removing
4609 directories from the list. This avoids problems when a future version
4610 uses another default. To remove the current directory use: >
4611 :set path-=
4612< To add the current directory use: >
4613 :set path+=
4614< To use an environment variable, you probably need to replace the
4615 separator. Here is an example to append $INCL, in which directory
4616 names are separated with a semi-colon: >
4617 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4618< Replace the ';' with a ':' or whatever separator is used. Note that
4619 this doesn't work when $INCL contains a comma or white space.
4620
4621 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4622'preserveindent' 'pi' boolean (default off)
4623 local to buffer
4624 {not in Vi}
4625 When changing the indent of the current line, preserve as much of the
4626 indent structure as possible. Normally the indent is replaced by a
4627 series of tabs followed by spaces as required (unless |'expandtab'| is
4628 enabled, in which case only spaces are used). Enabling this option
4629 means the indent will preserve as many existing characters as possible
4630 for indenting, and only add additional tabs or spaces as required.
4631 NOTE: When using ">>" multiple times the resulting indent is a mix of
4632 tabs and spaces. You might not like this.
4633 NOTE: 'preserveindent' is reset when 'compatible' is set.
4634 Also see 'copyindent'.
4635 Use |:retab| to clean up white space.
4636
4637 *'previewheight'* *'pvh'*
4638'previewheight' 'pvh' number (default 12)
4639 global
4640 {not in Vi}
4641 {not available when compiled without the |+windows| or
4642 |+quickfix| feature}
4643 Default height for a preview window. Used for |:ptag| and associated
4644 commands. Used for |CTRL-W_}| when no count is given.
4645
4646 *'previewwindow'* *'nopreviewwindow'*
4647 *'pvw'* *'nopvw'* *E590*
4648'previewwindow' 'pvw' boolean (default off)
4649 local to window
4650 {not in Vi}
4651 {not available when compiled without the |+windows| or
4652 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004653 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 set. It's normally not set directly, but by using one of the commands
4655 |:ptag|, |:pedit|, etc.
4656
4657 *'printdevice'* *'pdev'*
4658'printdevice' 'pdev' string (default empty)
4659 global
4660 {not in Vi}
4661 {only available when compiled with the |+printer|
4662 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004663 The name of the printer to be used for |:hardcopy|.
4664 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004665 This option cannot be set from a |modeline| or in the |sandbox|, for
4666 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667
Bram Moolenaar8299df92004-07-10 09:47:34 +00004668 *'printencoding'* *'penc'*
4669'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 global
4671 {not in Vi}
4672 {only available when compiled with the |+printer|
4673 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004674 Sets the character encoding used when printing.
4675 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676
4677 *'printexpr'* *'pexpr'*
4678'printexpr' 'pexpr' String (default: see below)
4679 global
4680 {not in Vi}
4681 {only available when compiled with the |+printer|
4682 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004683 Expression used to print the PostScript produced with |:hardcopy|.
4684 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
Bram Moolenaar8299df92004-07-10 09:47:34 +00004686 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687'printfont' 'pfn' string (default "courier")
4688 global
4689 {not in Vi}
4690 {only available when compiled with the |+printer|
4691 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004692 The name of the font that will be used for |:hardcopy|.
4693 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694
4695 *'printheader'* *'pheader'*
4696'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4697 global
4698 {not in Vi}
4699 {only available when compiled with the |+printer|
4700 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004701 The format of the header produced in |:hardcopy| output.
4702 See |pheader-option|.
4703
4704 *'printmbcharset'* *'pmbcs'*
4705'printmbcharset' 'pmbcs' string (default "")
4706 global
4707 {not in Vi}
4708 {only available when compiled with the |+printer|
4709 and |+multi_byte| features}
4710 The CJK character set to be used for CJK output from |:hardcopy|.
4711 See |pmbcs-option|.
4712
4713 *'printmbfont'* *'pmbfn'*
4714'printmbfont' 'pmbfn' string (default "")
4715 global
4716 {not in Vi}
4717 {only available when compiled with the |+printer|
4718 and |+multi_byte| features}
4719 List of font names to be used for CJK output from |:hardcopy|.
4720 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721
4722 *'printoptions'* *'popt'*
4723'printoptions' 'popt' string (default "")
4724 global
4725 {not in Vi}
4726 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004727 List of items that control the format of the output of |:hardcopy|.
4728 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004730 *'prompt'* *'noprompt'*
4731'prompt' boolean (default on)
4732 global
4733 When on a ":" prompt is used in Ex mode.
4734
Bram Moolenaar677ee682005-01-27 14:41:15 +00004735 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004736'quoteescape' 'qe' string (default "\")
4737 local to buffer
4738 {not in Vi}
4739 The characters that are used to escape quotes in a string. Used for
4740 objects like a', a" and a` |a'|.
4741 When one of the characters in this option is found inside a string,
4742 the following character will be skipped. The default value makes the
4743 text "foo\"bar\\" considered to be one string.
4744
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4746'readonly' 'ro' boolean (default off)
4747 local to buffer
4748 If on, writes fail unless you use a '!'. Protects you from
4749 accidentally overwriting a file. Default on when Vim is started
4750 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004751 When using ":w!" the 'readonly' option is reset for the current
4752 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004754 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755
4756 *'remap'* *'noremap'*
4757'remap' boolean (default on)
4758 global
4759 Allows for mappings to work recursively. If you do not want this for
4760 a single entry, use the :noremap[!] command.
4761
4762 *'report'*
4763'report' number (default 2)
4764 global
4765 Threshold for reporting number of lines changed. When the number of
4766 changed lines is more than 'report' a message will be given for most
4767 ":" commands. If you want it always, set 'report' to 0.
4768 For the ":substitute" command the number of substitutions is used
4769 instead of the number of lines.
4770
4771 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4772'restorescreen' 'rs' boolean (default on)
4773 global
4774 {not in Vi} {only in Windows 95/NT console version}
4775 When set, the screen contents is restored when exiting Vim. This also
4776 happens when executing external commands.
4777
4778 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4779 options in your .vimrc. To disable restoring:
4780 set t_ti= t_te=
4781 To enable restoring (for an xterm):
4782 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4783 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4784
4785 *'revins'* *'ri'* *'norevins'* *'nori'*
4786'revins' 'ri' boolean (default off)
4787 global
4788 {not in Vi}
4789 {only available when compiled with the |+rightleft|
4790 feature}
4791 Inserting characters in Insert mode will work backwards. See "typing
4792 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4793 command in Insert mode, when 'allowrevins' is set.
4794 NOTE: This option is reset when 'compatible' or 'paste' is set.
4795
4796 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4797'rightleft' 'rl' boolean (default off)
4798 local to window
4799 {not in Vi}
4800 {only available when compiled with the |+rightleft|
4801 feature}
4802 When on, display orientation becomes right-to-left, i.e., characters
4803 that are stored in the file appear from the right to the left.
4804 Using this option, it is possible to edit files for languages that
4805 are written from the right to the left such as Hebrew and Arabic.
4806 This option is per window, so it is possible to edit mixed files
4807 simultaneously, or to view the same file in both ways (this is
4808 useful whenever you have a mixed text file with both right-to-left
4809 and left-to-right strings so that both sets are displayed properly
4810 in different windows). Also see |rileft.txt|.
4811
4812 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4813'rightleftcmd' 'rlc' string (default "search")
4814 local to window
4815 {not in Vi}
4816 {only available when compiled with the |+rightleft|
4817 feature}
4818 Each word in this option enables the command line editing to work in
4819 right-to-left mode for a group of commands:
4820
4821 search "/" and "?" commands
4822
4823 This is useful for languages such as Hebrew, Arabic and Farsi.
4824 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4825
4826 *'ruler'* *'ru'* *'noruler'* *'noru'*
4827'ruler' 'ru' boolean (default off)
4828 global
4829 {not in Vi}
4830 {not available when compiled without the
4831 |+cmdline_info| feature}
4832 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004833 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 text in the file is shown on the far right:
4835 Top first line is visible
4836 Bot last line is visible
4837 All first and last line are visible
4838 45% relative position in the file
4839 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004840 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 ruler is shown there. Otherwise it is shown in the last line of the
4842 screen. If the statusline is given by 'statusline' (ie. not empty),
4843 this option takes precedence over 'ruler' and 'rulerformat'
4844 If the number of characters displayed is different from the number of
4845 bytes in the text (e.g., for a TAB or a multi-byte character), both
4846 the text column (byte number) and the screen column are shown,
4847 separated with a dash.
4848 For an empty line "0-1" is shown.
4849 For an empty buffer the line number will also be zero: "0,0-1".
4850 This option is reset when the 'paste' option is set.
4851 If you don't want to see the ruler all the time but want to know where
4852 you are, use "g CTRL-G" |g_CTRL-G|.
4853 NOTE: This option is reset when 'compatible' is set.
4854
4855 *'rulerformat'* *'ruf'*
4856'rulerformat' 'ruf' string (default empty)
4857 global
4858 {not in Vi}
4859 {not available when compiled without the |+statusline|
4860 feature}
4861 When this option is not empty, it determines the content of the ruler
4862 string, as displayed for the 'ruler' option.
4863 The format of this option, is like that of 'statusline'.
4864 The default ruler width is 17 characters. To make the ruler 15
4865 characters wide, put "%15(" at the start and "%)" at the end.
4866 Example: >
4867 :set rulerformat=%15(%c%V\ %p%%%)
4868<
4869 *'runtimepath'* *'rtp'* *vimfiles*
4870'runtimepath' 'rtp' string (default:
4871 Unix: "$HOME/.vim,
4872 $VIM/vimfiles,
4873 $VIMRUNTIME,
4874 $VIM/vimfiles/after,
4875 $HOME/.vim/after"
4876 Amiga: "home:vimfiles,
4877 $VIM/vimfiles,
4878 $VIMRUNTIME,
4879 $VIM/vimfiles/after,
4880 home:vimfiles/after"
4881 PC, OS/2: "$HOME/vimfiles,
4882 $VIM/vimfiles,
4883 $VIMRUNTIME,
4884 $VIM/vimfiles/after,
4885 $HOME/vimfiles/after"
4886 Macintosh: "$VIM:vimfiles,
4887 $VIMRUNTIME,
4888 $VIM:vimfiles:after"
4889 RISC-OS: "Choices:vimfiles,
4890 $VIMRUNTIME,
4891 Choices:vimfiles/after"
4892 VMS: "sys$login:vimfiles,
4893 $VIM/vimfiles,
4894 $VIMRUNTIME,
4895 $VIM/vimfiles/after,
4896 sys$login:vimfiles/after"
4897 global
4898 {not in Vi}
4899 This is a list of directories which will be searched for runtime
4900 files:
4901 filetype.vim filetypes by file name |new-filetype|
4902 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004903 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 colors/ color scheme files |:colorscheme|
4905 compiler/ compiler files |:compiler|
4906 doc/ documentation |write-local-help|
4907 ftplugin/ filetype plugins |write-filetype-plugin|
4908 indent/ indent scripts |indent-expression|
4909 keymap/ key mapping files |mbyte-keymap|
4910 lang/ menu translations |:menutrans|
4911 menu.vim GUI menus |menu.vim|
4912 plugin/ plugin scripts |write-plugin|
4913 print/ files for printing |postscript-print-encoding|
4914 syntax/ syntax files |mysyntaxfile|
4915 tutor/ files for vimtutor |tutor|
4916
4917 And any other file searched for with the |:runtime| command.
4918
4919 The defaults for most systems are setup to search five locations:
4920 1. In your home directory, for your personal preferences.
4921 2. In a system-wide Vim directory, for preferences from the system
4922 administrator.
4923 3. In $VIMRUNTIME, for files distributed with Vim.
4924 *after-directory*
4925 4. In the "after" directory in the system-wide Vim directory. This is
4926 for the system administrator to overrule or add to the distributed
4927 defaults (rarely needed)
4928 5. In the "after" directory in your home directory. This is for
4929 personal preferences to overrule or add to the distributed defaults
4930 or system-wide settings (rarely needed).
4931
4932 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4933 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004934 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 wildcards.
4936 See |:runtime|.
4937 Example: >
4938 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4939< This will use the directory "~/vimruntime" first (containing your
4940 personal Vim runtime files), then "/mygroup/vim" (shared between a
4941 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4942 files).
4943 You probably should always include $VIMRUNTIME somewhere, to use the
4944 distributed runtime files. You can put a directory before $VIMRUNTIME
4945 to find files which replace a distributed runtime files. You can put
4946 a directory after $VIMRUNTIME to find files which add to distributed
4947 runtime files.
4948 This option cannot be set from a |modeline| or in the |sandbox|, for
4949 security reasons.
4950
4951 *'scroll'* *'scr'*
4952'scroll' 'scr' number (default: half the window height)
4953 local to window
4954 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4955 set to half the number of lines in the window when the window size
4956 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004957 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4959 the number of screen lines instead of file lines, makes a difference
4960 when lines wrap}
4961
4962 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4963'scrollbind' 'scb' boolean (default off)
4964 local to window
4965 {not in Vi}
4966 {not available when compiled without the |+scrollbind|
4967 feature}
4968 See also |scroll-binding|. When this option is set, the current
4969 window scrolls as other scrollbind windows (windows that also have
4970 this option set) scroll. This option is useful for viewing the
4971 differences between two versions of a file, see 'diff'.
4972 See |'scrollopt'| for options that determine how this option should be
4973 interpreted.
4974 This option is mostly reset when splitting a window to edit another
4975 file. This means that ":split | edit file" results in two windows
4976 with scroll-binding, but ":split file" does not.
4977
4978 *'scrolljump'* *'sj'*
4979'scrolljump' 'sj' number (default 1)
4980 global
4981 {not in Vi}
4982 Minimal number of lines to scroll when the cursor gets off the
4983 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4984 CTRL-D). Useful if your terminal scrolls very slowly.
4985 NOTE: This option is set to 1 when 'compatible' is set.
4986
4987 *'scrolloff'* *'so'*
4988'scrolloff' 'so' number (default 0)
4989 global
4990 {not in Vi}
4991 Minimal number of screen lines to keep above and below the cursor.
4992 This will make some context visible around where you are working. If
4993 you set it to a very large value (999) the cursor line will always be
4994 in the middle of the window (except at the start or end of the file or
4995 when long lines wrap).
4996 For scrolling horizontally see 'sidescrolloff'.
4997 NOTE: This option is set to 0 when 'compatible' is set.
4998
4999 *'scrollopt'* *'sbo'*
5000'scrollopt' 'sbo' string (default "ver,jump")
5001 global
5002 {not available when compiled without the |+scrollbind|
5003 feature}
5004 {not in Vi}
5005 This is a comma-separated list of words that specifies how
5006 'scrollbind' windows should behave.
5007 The following words are available:
5008 ver Bind vertical scrolling for 'scrollbind' windows
5009 hor Bind horizontal scrolling for 'scrollbind' windows
5010 jump Applies to the offset between two windows for vertical
5011 scrolling. This offset is the difference in the first
5012 displayed line of the bound windows. When moving
5013 around in a window, another 'scrollbind' window may
5014 reach a position before the start or after the end of
5015 the buffer. The offset is not changed though, when
5016 moving back the 'scrollbind' window will try to scroll
5017 to the desired position when possible.
5018 When now making that window the current one, two
5019 things can be done with the relative offset:
5020 1. When "jump" is not included, the relative offset is
5021 adjusted for the scroll position in the new current
5022 window. When going back to the other window, the
5023 the new relative offset will be used.
5024 2. When "jump" is included, the other windows are
5025 scrolled to keep the same relative offset. When
5026 going back to the other window, it still uses the
5027 same relative offset.
5028 Also see |scroll-binding|.
5029
5030 *'sections'* *'sect'*
5031'sections' 'sect' string (default "SHNHH HUnhsh")
5032 global
5033 Specifies the nroff macros that separate sections. These are pairs of
5034 two letters (See |object-motions|). The default makes a section start
5035 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5036
5037 *'secure'* *'nosecure'* *E523*
5038'secure' boolean (default off)
5039 global
5040 {not in Vi}
5041 When on, ":autocmd", shell and write commands are not allowed in
5042 ".vimrc" and ".exrc" in the current directory and map commands are
5043 displayed. Switch it off only if you know that you will not run into
5044 problems, or when the 'exrc' option is off. On Unix this option is
5045 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005046 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 'secure' at the end of your ~/.vimrc then.
5048 This option cannot be set from a |modeline| or in the |sandbox|, for
5049 security reasons.
5050
5051 *'selection'* *'sel'*
5052'selection' 'sel' string (default "inclusive")
5053 global
5054 {not in Vi}
5055 This option defines the behavior of the selection. It is only used
5056 in Visual and Select mode.
5057 Possible values:
5058 value past line inclusive ~
5059 old no yes
5060 inclusive yes yes
5061 exclusive yes no
5062 "past line" means that the cursor is allowed to be positioned one
5063 character past the line.
5064 "inclusive" means that the last character of the selection is included
5065 in an operation. For example, when "x" is used to delete the
5066 selection.
5067 Note that when "exclusive" is used and selecting from the end
5068 backwards, you cannot include the last character of a line, when
5069 starting in Normal mode and 'virtualedit' empty.
5070
5071 The 'selection' option is set by the |:behave| command.
5072
5073 *'selectmode'* *'slm'*
5074'selectmode' 'slm' string (default "")
5075 global
5076 {not in Vi}
5077 This is a comma separated list of words, which specifies when to start
5078 Select mode instead of Visual mode, when a selection is started.
5079 Possible values:
5080 mouse when using the mouse
5081 key when using shifted special keys
5082 cmd when using "v", "V" or CTRL-V
5083 See |Select-mode|.
5084 The 'selectmode' option is set by the |:behave| command.
5085
5086 *'sessionoptions'* *'ssop'*
5087'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5088 help,options,winsize")
5089 global
5090 {not in Vi}
5091 {not available when compiled without the +mksession
5092 feature}
5093 Changes the effect of the |:mksession| command. It is a comma
5094 separated list of words. Each word enables saving and restoring
5095 something:
5096 word save and restore ~
5097 blank empty windows
5098 buffers hidden and unloaded buffers, not just those in windows
5099 curdir the current directory
5100 folds manually created folds, opened/closed folds and local
5101 fold options
5102 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005103 and contain at least one lowercase letter. Only
5104 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 help the help window
5106 localoptions options and mappings local to a window or buffer (not
5107 global values for local options)
5108 options all options and mappings (also global values for local
5109 options)
5110 resize size of the Vim window: 'lines' and 'columns'
5111 sesdir the directory in which the session file is located
5112 will become the current directory (useful with
5113 projects accessed over a network from different
5114 systems)
5115 slash backslashes in file names replaced with forward
5116 slashes
5117 unix with Unix end-of-line format (single <NL>), even when
5118 on Windows or DOS
5119 winpos position of the whole Vim window
5120 winsize window sizes
5121
5122 Don't include both "curdir" and "sesdir".
5123 When "curdir" nor "sesdir" is included, file names are stored with
5124 absolute paths.
5125 "slash" and "unix" are useful on Windows when sharing session files
5126 with Unix. The Unix version of Vim cannot source dos format scripts,
5127 but the Windows version of Vim can source unix format scripts.
5128
5129 *'shell'* *'sh'* *E91*
5130'shell' 'sh' string (default $SHELL or "sh",
5131 MS-DOS and Win32: "command.com" or
5132 "cmd.exe", OS/2: "cmd")
5133 global
5134 Name of the shell to use for ! and :! commands. When changing the
5135 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5136 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005137 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 See |option-backslash| about including spaces and backslashes.
5139 Environment variables are expanded |:set_env|.
5140 If the name of the shell contains a space, you might need to enclose
5141 it in quotes. Example: >
5142 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5143< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005144 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 "-f" is not inside the quotes, because it is not part of the command
5146 name. And Vim automagically recognizes the backslashes that are path
5147 separators.
5148 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5149 variable to change the way external commands are executed. See the
5150 libc.inf file of DJGPP.
5151 Under MS-Windows, when the executable ends in ".com" it must be
5152 included. Thus setting the shell to "command.com" or "4dos.com"
5153 works, but "command" and "4dos" do not work for all commands (e.g.,
5154 filtering).
5155 For unknown reasons, when using "4dos.com" the current directory is
5156 changed to "C:\". To avoid this set 'shell' like this: >
5157 :set shell=command.com\ /c\ 4dos
5158< This option cannot be set from a |modeline| or in the |sandbox|, for
5159 security reasons.
5160
5161 *'shellcmdflag'* *'shcf'*
5162'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5163 does not contain "sh" somewhere: "/c")
5164 global
5165 {not in Vi}
5166 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5167 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5168 systems, the default is set according to the value of 'shell', to
5169 reduce the need to set this option by the user. It's not used for
5170 OS/2 (EMX figures this out itself). See |option-backslash| about
5171 including spaces and backslashes. See |dos-shell|.
5172 This option cannot be set from a |modeline| or in the |sandbox|, for
5173 security reasons.
5174
5175 *'shellpipe'* *'sp'*
5176'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5177 global
5178 {not in Vi}
5179 {not available when compiled without the |+quickfix|
5180 feature}
5181 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005182 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 including spaces and backslashes.
5184 The name of the temporary file can be represented by "%s" if necessary
5185 (the file name is appended automatically if no %s appears in the value
5186 of this option).
5187 For the Amiga and MS-DOS the default is ">". The output is directly
5188 saved in a file and not echoed to the screen.
5189 For Unix the default it "| tee". The stdout of the compiler is saved
5190 in a file and echoed to the screen. If the 'shell' option is "csh" or
5191 "tcsh" after initializations, the default becomes "|& tee". If the
5192 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5193 "2>&1| tee". This means that stderr is also included.
5194 The initialization of this option is done after reading the ".vimrc"
5195 and the other initializations, so that when the 'shell' option is set
5196 there, the 'shellpipe' option changes automatically, unless it was
5197 explicitly set before.
5198 When 'shellpipe' is set to an empty string, no redirection of the
5199 ":make" output will be done. This is useful if you use a 'makeprg'
5200 that writes to 'makeef' by itself. If you want no piping, but do
5201 want to include the 'makeef', set 'shellpipe' to a single space.
5202 Don't forget to precede the space with a backslash: ":set sp=\ ".
5203 In the future pipes may be used for filtering and this option will
5204 become obsolete (at least for Unix).
5205 This option cannot be set from a |modeline| or in the |sandbox|, for
5206 security reasons.
5207
5208 *'shellquote'* *'shq'*
5209'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5210 contains "sh" somewhere: "\"")
5211 global
5212 {not in Vi}
5213 Quoting character(s), put around the command passed to the shell, for
5214 the "!" and ":!" commands. The redirection is kept outside of the
5215 quoting. See 'shellxquote' to include the redirection. It's
5216 probably not useful to set both options.
5217 This is an empty string by default. Only known to be useful for
5218 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5219 or bash, where it should be "\"". The default is adjusted according
5220 the value of 'shell', to reduce the need to set this option by the
5221 user. See |dos-shell|.
5222 This option cannot be set from a |modeline| or in the |sandbox|, for
5223 security reasons.
5224
5225 *'shellredir'* *'srr'*
5226'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5227 global
5228 {not in Vi}
5229 String to be used to put the output of a filter command in a temporary
5230 file. See also |:!|. See |option-backslash| about including spaces
5231 and backslashes.
5232 The name of the temporary file can be represented by "%s" if necessary
5233 (the file name is appended automatically if no %s appears in the value
5234 of this option).
5235 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5236 or "zsh" during initializations, the default becomes ">&". If the
5237 'shell' option is "sh", "ksh" or "bash" the default becomes
5238 ">%s 2>&1". This means that stderr is also included.
5239 For Win32, the Unix checks are done and additionally "cmd" is checked
5240 for, which makes the default ">%s 2>&1". Also, the same names with
5241 ".exe" appended are checked for.
5242 The initialization of this option is done after reading the ".vimrc"
5243 and the other initializations, so that when the 'shell' option is set
5244 there, the 'shellredir' option changes automatically unless it was
5245 explicitly set before.
5246 In the future pipes may be used for filtering and this option will
5247 become obsolete (at least for Unix).
5248 This option cannot be set from a |modeline| or in the |sandbox|, for
5249 security reasons.
5250
5251 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5252'shellslash' 'ssl' boolean (default off)
5253 global
5254 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5255 When set, a forward slash is used when expanding file names. This is
5256 useful when a Unix-like shell is used instead of command.com or
5257 cmd.exe. Backward slashes can still be typed, but they are changed to
5258 forward slashes by Vim.
5259 Note that setting or resetting this option has no effect for some
5260 existing file names, thus this option needs to be set before opening
5261 any file for best results. This might change in the future.
5262 'shellslash' only works when a backslash can be used as a path
5263 separator. To test if this is so use: >
5264 if exists('+shellslash')
5265<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005266 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5267'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5268 global
5269 {not in Vi}
5270 When on, use temp files for shell commands. When off use a pipe.
5271 When using a pipe is not possible temp files are used anyway.
5272 Currently a pipe is only supported on Unix. You can check it with: >
5273 :if has("filterpipe")
5274< The advantage of using a pipe is that nobody can read the temp file
5275 and the 'shell' command does not need to support redirection.
5276 The advantage of using a temp file is that the file type and encoding
5277 can be detected.
5278 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5279 |FilterWritePost| autocommands event are not triggered when
5280 'shelltemp' is off.
5281
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 *'shelltype'* *'st'*
5283'shelltype' 'st' number (default 0)
5284 global
5285 {not in Vi} {only for the Amiga}
5286 On the Amiga this option influences the way how the commands work
5287 which use a shell.
5288 0 and 1: always use the shell
5289 2 and 3: use the shell only to filter lines
5290 4 and 5: use shell only for ':sh' command
5291 When not using the shell, the command is executed directly.
5292
5293 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5294 1 and 3: use "shell cmd" to start external commands
5295
5296 *'shellxquote'* *'sxq'*
5297'shellxquote' 'sxq' string (default: "";
5298 for Win32, when 'shell' contains "sh"
5299 somewhere: "\""
5300 for Unix, when using system(): "\"")
5301 global
5302 {not in Vi}
5303 Quoting character(s), put around the command passed to the shell, for
5304 the "!" and ":!" commands. Includes the redirection. See
5305 'shellquote' to exclude the redirection. It's probably not useful
5306 to set both options.
5307 This is an empty string by default. Known to be useful for
5308 third-party shells when using the Win32 version, such as the MKS Korn
5309 Shell or bash, where it should be "\"". The default is adjusted
5310 according the value of 'shell', to reduce the need to set this option
5311 by the user. See |dos-shell|.
5312 This option cannot be set from a |modeline| or in the |sandbox|, for
5313 security reasons.
5314
5315 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5316'shiftround' 'sr' boolean (default off)
5317 global
5318 {not in Vi}
5319 Round indent to multiple of 'shiftwidth'. Applies to > and <
5320 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5321 a multiple of 'shiftwidth' (this is Vi compatible).
5322 NOTE: This option is reset when 'compatible' is set.
5323
5324 *'shiftwidth'* *'sw'*
5325'shiftwidth' 'sw' number (default 8)
5326 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005327 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005328 |'cindent'|, |>>|, |<<|, etc.
5329
5330 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005331'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5332 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 global
5334 {not in Vi}
5335 This option helps to avoid all the |hit-enter| prompts caused by file
5336 messages, for example with CTRL-G, and to avoid some other messages.
5337 It is a list of flags:
5338 flag meaning when present ~
5339 f use "(3 of 5)" instead of "(file 3 of 5)"
5340 i use "[noeol]" instead of "[Incomplete last line]"
5341 l use "999L, 888C" instead of "999 lines, 888 characters"
5342 m use "[+]" instead of "[Modified]"
5343 n use "[New]" instead of "[New File]"
5344 r use "[RO]" instead of "[readonly]"
5345 w use "[w]" instead of "written" for file write message
5346 and "[a]" instead of "appended" for ':w >> file' command
5347 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5348 "[unix format]" and "[mac]" instead of "[mac format]".
5349 a all of the above abbreviations
5350
5351 o overwrite message for writing a file with subsequent message
5352 for reading a file (useful for ":wn" or when 'autowrite' on)
5353 O message for reading a file overwrites any previous message.
5354 Also for quickfix message (e.g., ":cn").
5355 s don't give "search hit BOTTOM, continuing at TOP" or "search
5356 hit TOP, continuing at BOTTOM" messages
5357 t truncate file message at the start if it is too long to fit
5358 on the command-line, "<" will appear in the left most column.
5359 Ignored in Ex mode.
5360 T truncate other messages in the middle if they are too long to
5361 fit on the command line. "..." will appear in the middle.
5362 Ignored in Ex mode.
5363 W don't give "written" or "[w]" when writing a file
5364 A don't give the "ATTENTION" message when an existing swap file
5365 is found.
5366 I don't give the intro message when starting Vim |:intro|.
5367
5368 This gives you the opportunity to avoid that a change between buffers
5369 requires you to hit <Enter>, but still gives as useful a message as
5370 possible for the space available. To get the whole message that you
5371 would have got with 'shm' empty, use ":file!"
5372 Useful values:
5373 shm= No abbreviation of message.
5374 shm=a Abbreviation, but no loss of information.
5375 shm=at Abbreviation, and truncate message when necessary.
5376
5377 NOTE: This option is set to the Vi default value when 'compatible' is
5378 set and to the Vim default value when 'compatible' is reset.
5379
5380 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5381'shortname' 'sn' boolean (default off)
5382 local to buffer
5383 {not in Vi, not in MS-DOS versions}
5384 Filenames are assumed to be 8 characters plus one extension of 3
5385 characters. Multiple dots in file names are not allowed. When this
5386 option is on, dots in file names are replaced with underscores when
5387 adding an extension (".~" or ".swp"). This option is not available
5388 for MS-DOS, because then it would always be on. This option is useful
5389 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5390 or crossdos. When running the Win32 GUI version under Win32s, this
5391 option is always on by default.
5392
5393 *'showbreak'* *'sbr'* *E595*
5394'showbreak' 'sbr' string (default "")
5395 global
5396 {not in Vi}
5397 {not available when compiled without the |+linebreak|
5398 feature}
5399 String to put at the start of lines that have been wrapped. Useful
5400 values are "> " or "+++ ".
5401 Only printable single-cell characters are allowed, excluding <Tab> and
5402 comma (in a future version the comma might be used to separate the
5403 part that is shown at the end and at the start of a line).
5404 The characters are highlighted according to the '@' flag in
5405 'highlight'.
5406 Note that tabs after the showbreak will be displayed differently.
5407 If you want the 'showbreak' to appear in between line numbers, add the
5408 "n" flag to 'cpoptions'.
5409
5410 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5411'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5412 off)
5413 global
5414 {not in Vi}
5415 {not available when compiled without the
5416 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005417 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005418 terminal is slow.
5419 In Visual mode the size of the selected area is shown:
5420 - When selecting characters within a line, the number of characters.
5421 - When selecting more than one line, the number of lines.
5422 - When selecting a block, the size in screen characters: linesxcolumns.
5423 NOTE: This option is set to the Vi default value when 'compatible' is
5424 set and to the Vim default value when 'compatible' is reset.
5425
5426 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5427'showfulltag' 'sft' boolean (default off)
5428 global
5429 {not in Vi}
5430 When completing a word in insert mode (see |ins-completion|) from the
5431 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005432 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005433 matched a C function, you can see a template for what arguments are
5434 required (coding style permitting).
5435
5436 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5437'showmatch' 'sm' boolean (default off)
5438 global
5439 When a bracket is inserted, briefly jump to the matching one. The
5440 jump is only done if the match can be seen on the screen. The time to
5441 show the match can be set with 'matchtime'.
5442 A Beep is given if there is no match (no matter if the match can be
5443 seen or not). This option is reset when the 'paste' option is set.
5444 When the 'm' flag is not included in 'cpoptions', typing a character
5445 will immediately move the cursor back to where it belongs.
5446 See the "sm" field in 'guicursor' for setting the cursor shape and
5447 blinking when showing the match.
5448 The 'matchpairs' option can be used to specify the characters to show
5449 matches for. 'rightleft' and 'revins' are used to look for opposite
5450 matches.
5451 Note: For the use of the short form parental guidance is advised.
5452
5453 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5454'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5455 global
5456 If in Insert, Replace or Visual mode put a message on the last line.
5457 Use the 'M' flag in 'highlight' to set the type of highlighting for
5458 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005459 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005460 doesn't mean XIM is really active, especially when 'imactivatekey' is
5461 not set.
5462 NOTE: This option is set to the Vi default value when 'compatible' is
5463 set and to the Vim default value when 'compatible' is reset.
5464
5465 *'sidescroll'* *'ss'*
5466'sidescroll' 'ss' number (default 0)
5467 global
5468 {not in Vi}
5469 The minimal number of columns to scroll horizontally. Used only when
5470 the 'wrap' option is off and the cursor is moved off of the screen.
5471 When it is zero the cursor will be put in the middle of the screen.
5472 When using a slow terminal set it to a large number or 0. When using
5473 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5474 commands.
5475
5476 *'sidescrolloff'* *'siso'*
5477'sidescrolloff' 'siso' number (default 0)
5478 global
5479 {not in Vi}
5480 The minimal number of screen columns to keep to the left and to the
5481 right of the cursor if 'nowrap' is set. Setting this option to a value
5482 greater than 0 while having |'sidescroll'| also at a non-zero value
5483 makes some context visible in the line you are scrolling in
5484 horizontally (except at the end and beginning of the line). Setting
5485 this option to a large value (like 999) has the effect of keeping the
5486 cursor horizontally centered in the window, as long as one does not
5487 come too close to the beginning or end of the line.
5488 NOTE: This option is set to 0 when 'compatible' is set.
5489
5490 Example: Try this together with 'sidescroll' and 'listchars' as
5491 in the following example to never allow the cursor to move
5492 onto the "extends" character:
5493
5494 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5495 :set sidescrolloff=1
5496
5497
5498 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5499'smartcase' 'scs' boolean (default off)
5500 global
5501 {not in Vi}
5502 Override the 'ignorecase' option if the search pattern contains upper
5503 case characters. Only used when the search pattern is typed and
5504 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005505 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5507 recalling the search pattern from history and hitting <Enter>.
5508 NOTE: This option is reset when 'compatible' is set.
5509
5510 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5511'smartindent' 'si' boolean (default off)
5512 local to buffer
5513 {not in Vi}
5514 {not available when compiled without the
5515 |+smartindent| feature}
5516 Do smart autoindenting when starting a new line. Works for C-like
5517 programs, but can also be used for other languages. 'cindent' does
5518 something like this, works better in most cases, but is more strict,
5519 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5520 'indentexpr' is a more advanced alternative.
5521 Normally 'autoindent' should also be on when using 'smartindent'.
5522 An indent is automatically inserted:
5523 - After a line ending in '{'.
5524 - After a line starting with a keyword from 'cinwords'.
5525 - Before a line starting with '}' (only with the "O" command).
5526 When typing '}' as the first character in a new line, that line is
5527 given the same indent as the matching '{'.
5528 When typing '#' as the first character in a new line, the indent for
5529 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005530 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5532 When using the ">>" command, lines starting with '#' are not shifted
5533 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005534 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005535 is set smart indenting is disabled.
5536
5537 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5538'smarttab' 'sta' boolean (default off)
5539 global
5540 {not in Vi}
5541 When on, a <Tab> in front of a line inserts blanks according to
5542 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5543 a 'shiftwidth' worth of space at the start of the line.
5544 When off a <Tab> always inserts blanks according to 'tabstop'.
5545 'shiftwidth' is only used for shifting text left or right
5546 |shift-left-right|.
5547 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5548 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005549 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005550 NOTE: This option is reset when 'compatible' is set.
5551
5552 *'softtabstop'* *'sts'*
5553'softtabstop' 'sts' number (default 0)
5554 local to buffer
5555 {not in Vi}
5556 Number of spaces that a <Tab> counts for while performing editing
5557 operations, like inserting a <Tab> or using <BS>. It "feels" like
5558 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5559 used. This is useful to keep the 'ts' setting at its standard value
5560 of 8, while being able to edit like it is set to 'sts'. However,
5561 commands like "x" still work on the actual characters.
5562 When 'sts' is zero, this feature is off.
5563 'softtabstop' is set to 0 when the 'paste' option is set.
5564 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5565 spaces is minimized by using <Tab>s.
5566 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5567 set.
5568 NOTE: This option is set to 0 when 'compatible' is set.
5569
5570 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5571'splitbelow' 'sb' boolean (default off)
5572 global
5573 {not in Vi}
5574 {not available when compiled without the +windows
5575 feature}
5576 When on, splitting a window will put the new window below the current
5577 one. |:split|
5578
5579 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5580'splitright' 'spr' boolean (default off)
5581 global
5582 {not in Vi}
5583 {not available when compiled without the +vertsplit
5584 feature}
5585 When on, splitting a window will put the new window right of the
5586 current one. |:vsplit|
5587
5588 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5589'startofline' 'sol' boolean (default on)
5590 global
5591 {not in Vi}
5592 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005593 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005594 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005595 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596 with a linewise operator, with "%" with a count and to buffer changing
5597 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5598 only has a line number, e.g., ":25" or ":+".
5599 In case of buffer changing commands the cursor is placed at the column
5600 where it was the last time the buffer was edited.
5601 NOTE: This option is set when 'compatible' is set.
5602
5603 *'statusline'* *'stl'* *E540* *E541* *E542*
5604'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005605 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 {not in Vi}
5607 {not available when compiled without the |+statusline|
5608 feature}
5609 When nonempty, this option determines the content of the status line.
5610 Also see |status-line|.
5611
5612 The option consists of printf style '%' items interspersed with
5613 normal text. Each status line item is of the form:
5614 %-0{minwid}.{maxwid}{item}
5615 All fields except the {item} is optional. A single percent sign can
5616 be given as "%%". Up to 80 items can be specified.
5617
5618 Note that the only effect of 'ruler' when this option is set (and
5619 'laststatus' is 2) is controlling the output of |CTRL-G|.
5620
5621 field meaning ~
5622 - Left justify the item. The default is right justified
5623 when minwid is larger than the length of the item.
5624 0 Leading zeroes in numeric items. Overridden by '-'.
5625 minwid Minimum width of the item, padding as set by '-' & '0'.
5626 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005627 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 on the left for text items. Numeric items will be
5629 shifted down to maxwid-2 digits followed by '>'number
5630 where number is the amount of missing digits, much like
5631 an exponential notation.
5632 item A one letter code as described below.
5633
5634 Following is a description of the possible statusline items. The
5635 second character in "item" is the type:
5636 N for number
5637 S for string
5638 F for flags as described below
5639 - not applicable
5640
5641 item meaning ~
5642 f S Path to the file in the buffer, relative to current directory.
5643 F S Full path to the file in the buffer.
5644 t S File name (tail) of file in the buffer.
5645 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5646 M F Modified flag, text is ",+" or ",-".
5647 r F Readonly flag, text is " [RO]".
5648 R F Readonly flag, text is ",RO".
5649 h F Help buffer flag, text is " [help]".
5650 H F Help buffer flag, text is ",HLP".
5651 w F Preview window flag, text is " [Preview]".
5652 W F Preview window flag, text is ",PRV".
5653 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5654 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5655 {not available when compiled without |+autocmd| feature}
5656 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5657 being used: "<keymap>"
5658 n N Buffer number.
5659 b N Value of byte under cursor.
5660 B N As above, in hexadecimal.
5661 o N Byte number in file of byte under cursor, first byte is 1.
5662 Mnemonic: Offset from start of file (with one added)
5663 {not available when compiled without |+byte_offset| feature}
5664 O N As above, in hexadecimal.
5665 N N Printer page number. (Only works in the 'printheader' option.)
5666 l N Line number.
5667 L N Number of lines in buffer.
5668 c N Column number.
5669 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005670 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005671 p N Percentage through file in lines as in |CTRL-G|.
5672 P S Percentage through file of displayed window. This is like the
5673 percentage described for 'ruler'. Always 3 in length.
5674 a S Argument list status as in default title. ({current} of {max})
5675 Empty if the argument file count is zero or one.
5676 { NF Evaluate expression between '{' and '}' and substitute result.
5677 ( - Start of item group. Can be used for setting the width and
5678 alignment of a section. Must be followed by %) somewhere.
5679 ) - End of item group. No width fields allowed.
5680 < - Where to truncate line if too long. Default is at the start.
5681 No width fields allowed.
5682 = - Separation point between left and right aligned items.
5683 No width fields allowed.
5684 * - Set highlight group to User{N}, where {N} is taken from the
5685 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5686 The difference between User{N} and StatusLine will be applied
5687 to StatusLineNC for the statusline of non-current windows.
5688 The number N must be between 1 and 9. See |hl-User1..9|
5689
5690 Display of flags are controlled by the following heuristic:
5691 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005692 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 with a space it is assumed that it wants to separate itself from
5694 anything but other flags. That is: A leading comma is removed if the
5695 preceding character stems from plaintext. A leading space is removed
5696 if the preceding character stems from another active flag. This will
5697 make a nice display when flags are used like in the examples below.
5698
5699 When all items in a group becomes an empty string (ie. flags that are
5700 not set) and a minwid is not set for the group, the whole group will
5701 become empty. This will make a group like the following disappear
5702 completely from the statusline when none of the flags are set. >
5703 :set statusline=...%(\ [%M%R%H]%)...
5704<
5705 Beware that an expression is evaluated each and every time the status
5706 line is displayed. The current buffer and current window will be set
5707 temporarily to that of the window (and buffer) whose statusline is
5708 currently being drawn. The expression will evaluate in this context.
5709 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5710 real current buffer. The expression is evaluated in the |sandbox|.
5711
5712 If the statusline is not updated when you want it (e.g., after setting
5713 a variable that's used in an expression), you can force an update by
5714 setting an option without changing its value. Example: >
5715 :let &ro = &ro
5716
5717< A result of all digits is regarded a number for display purposes.
5718 Otherwise the result is taken as flag text and applied to the rules
5719 described above.
5720
5721 Watch out for errors in expressions. They may render Vim unusable !
5722 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5723 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5724
5725 Examples:
5726 Emulate standard status line with 'ruler' set >
5727 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5728< Similar, but add ASCII value of char under the cursor (like "ga") >
5729 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5730< Display byte count and byte value, modified flag in red. >
5731 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5732 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5733< Display a ,GZ flag if a compressed file is loaded >
5734 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5735< In the |:autocmd|'s: >
5736 :let b:gzflag = 1
5737< And: >
5738 :unlet b:gzflag
5739< And define this function: >
5740 :function VarExists(var, val)
5741 : if exists(a:var) | return a:val | else | return '' | endif
5742 :endfunction
5743<
5744 *'suffixes'* *'su'*
5745'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5746 global
5747 {not in Vi}
5748 Files with these suffixes get a lower priority when multiple files
5749 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005750 suffixes. Spaces after the comma are ignored. A dot is also seen as
5751 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752 separator, precede it with a backslash (see |option-backslash| about
5753 including spaces and backslashes).
5754 See 'wildignore' for completely ignoring files.
5755 The use of |:set+=| and |:set-=| is preferred when adding or removing
5756 suffixes from the list. This avoids problems when a future version
5757 uses another default.
5758
5759 *'suffixesadd'* *'sua'*
5760'suffixesadd' 'sua' string (default "")
5761 local to buffer
5762 {not in Vi}
5763 {not available when compiled without the
5764 |+file_in_path| feature}
5765 Comma separated list of suffixes, which are used when searching for a
5766 file for the "gf", "[I", etc. commands. Example: >
5767 :set suffixesadd=.java
5768<
5769 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5770'swapfile' 'swf' boolean (default on)
5771 local to buffer
5772 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005773 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 swapfile is not wanted for a specific buffer. For example, with
5775 confidential information that even root must not be able to access.
5776 Careful: All text will be in memory:
5777 - Don't use this for big files.
5778 - Recovery will be impossible!
5779 A swapfile will only be present when |'updatecount'| is non-zero and
5780 'swapfile' is set.
5781 When 'swapfile' is reset, the swap file for the current buffer is
5782 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5783 non-zero, a swap file is immediately created.
5784 Also see |swap-file| and |'swapsync'|.
5785
5786 This option is used together with 'bufhidden' and 'buftype' to
5787 specify special kinds of buffers. See |special-buffers|.
5788
5789 *'swapsync'* *'sws'*
5790'swapsync' 'sws' string (default "fsync")
5791 global
5792 {not in Vi}
5793 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005794 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 When this option is empty parts of the swap file may be in memory and
5796 not written to disk. When the system crashes you may lose more work.
5797 On Unix the system does a sync now and then without Vim asking for it,
5798 so the disadvantage of setting this option off is small. On some
5799 systems the swap file will not be written at all. For a unix system
5800 setting it to "sync" will use the sync() call instead of the default
5801 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005802 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803
5804 *'switchbuf'* *'swb'*
5805'switchbuf' 'swb' string (default "")
5806 global
5807 {not in Vi}
5808 This option controls the behavior when switching between buffers.
5809 Possible values (comma separated list):
5810 useopen If included, jump to the first open window that
5811 contains the specified buffer (if there is one).
5812 Otherwise: Do not examine other windows.
5813 This setting is checked with |quickfix| commands, when
5814 jumping to errors (":cc", ":cn", "cp", etc.). It is
5815 also used in all buffer related split commands, for
5816 example ":sbuffer", ":sbnext", or ":sbrewind".
5817 split If included, split the current window before loading
5818 a buffer. Otherwise: do not split, use current window.
5819 Supported in |quickfix| commands that display errors.
5820
5821 *'syntax'* *'syn'*
5822'syntax' 'syn' string (default empty)
5823 local to buffer
5824 {not in Vi}
5825 {not available when compiled without the |+syntax|
5826 feature}
5827 When this option is set, the syntax with this name is loaded, unless
5828 syntax highlighting has been switched off with ":syntax off".
5829 Otherwise this option does not always reflect the current syntax (the
5830 b:current_syntax variable does).
5831 This option is most useful in a modeline, for a file which syntax is
5832 not automatically recognized. Example, for in an IDL file: >
5833 /* vim: set syntax=idl : */
5834< To switch off syntax highlighting for the current file, use: >
5835 :set syntax=OFF
5836< To switch syntax highlighting on according to the current value of the
5837 'filetype' option: >
5838 :set syntax=ON
5839< What actually happens when setting the 'syntax' option is that the
5840 Syntax autocommand event is triggered with the value as argument.
5841 This option is not copied to another buffer, independent of the 's' or
5842 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005843 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005844
5845 *'tabstop'* *'ts'*
5846'tabstop' 'ts' number (default 8)
5847 local to buffer
5848 Number of spaces that a <Tab> in the file counts for. Also see
5849 |:retab| command, and 'softtabstop' option.
5850
5851 Note: Setting 'tabstop' to any other value than 8 can make your file
5852 appear wrong in many places (e.g., when printing it).
5853
5854 There are four main ways to use tabs in Vim:
5855 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5856 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5857 will use a mix of tabs and spaces, but typing Tab and BS will
5858 behave like a tab appears every 4 (or 3) characters.
5859 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5860 'expandtab'. This way you will always insert spaces. The
5861 formatting will never be messed up when 'tabstop' is changed.
5862 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005863 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 works when using Vim to edit the file.
5865 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5866 'noexpandtab'. This should then work (for initial indents only)
5867 for any tabstop setting that people use. It might be nice to have
5868 tabs after the first non-blank inserted as spaces if you do this
5869 though. Otherwise aligned comments will be wrong when 'tabstop' is
5870 changed.
5871
5872 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5873'tagbsearch' 'tbs' boolean (default on)
5874 global
5875 {not in Vi}
5876 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 searching makes searching for a tag a LOT faster, but a linear search
5879 will find more tags if the tags file wasn't properly sorted.
5880 Vim normally assumes that your tags files are sorted, or indicate that
5881 they are not sorted. Only when this is not the case does the
5882 'tagbsearch' option need to be switched off.
5883
5884 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005885 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 certain files, or retry all files with a linear search. When
5887 'tagbsearch' is off, only a linear search is done.
5888
5889 Linear searching is done anyway, for one file, when Vim finds a line
5890 at the start of the file indicating that it's not sorted: >
5891 !_TAG_FILE_SORTED 0 /some command/
5892< [The whitespace before and after the '0' must be a single <Tab>]
5893
5894 When a binary search was done and no match was found in any of the
5895 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5896 instead of a normal tag name, a retry is done with a linear search.
5897 Tags in unsorted tags files, and matches with different case will only
5898 be found in the retry.
5899
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005900 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005901 linear search can be avoided for the 'ignorecase' case. Use a value
5902 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5903 case-fold sorted with the -f switch to "sort" in most unices, as in
5904 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5905 5.3 or higher the -f or --fold-case-sort switch can be used for this
5906 as well. Note that case must be folded to uppercase for this to work.
5907
5908 When 'tagbsearch' is off, tags searching is slower when a full match
5909 exists, but faster when no full match exists. Tags in unsorted tags
5910 files may only be found with 'tagbsearch' off.
5911 When the tags file is not sorted, or sorted in a wrong way (not on
5912 ASCII byte value), 'tagbsearch' should be off, or the line given above
5913 must be included in the tags file.
5914 This option doesn't affect commands that find all matching tags (e.g.,
5915 command-line completion and ":help").
5916 {Vi: always uses binary search in some versions}
5917
5918 *'taglength'* *'tl'*
5919'taglength' 'tl' number (default 0)
5920 global
5921 If non-zero, tags are significant up to this number of characters.
5922
5923 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5924'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5925 global
5926 {not in Vi}
5927 If on and using a tag file in another directory, file names in that
5928 tag file are relative to the directory where the tag file is.
5929 NOTE: This option is set to the Vi default value when 'compatible' is
5930 set and to the Vim default value when 'compatible' is reset.
5931
5932 *'tags'* *'tag'* *E433*
5933'tags' 'tag' string (default "./tags,tags", when compiled with
5934 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5935 global or local to buffer |global-local|
5936 Filenames for the tag command, separated by spaces or commas. To
5937 include a space or comma in a file name, precede it with a backslash
5938 (see |option-backslash| about including spaces and backslashes).
5939 When a file name starts with "./", the '.' is replaced with the path
5940 of the current file. But only when the 'd' flag is not included in
5941 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5942 |tags-option|.
5943 "*", "**" and other wildcards can be used to search for tags files in
5944 a directory tree. See |file-searching|. {not available when compiled
5945 without the |+path_extra| feature}
5946 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5947 files are also supported. They are automatically recognized. The
5948 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5949 differences are ignored (MS-Windows). |emacs-tags|
5950 The use of |:set+=| and |:set-=| is preferred when adding or removing
5951 file names from the list. This avoids problems when a future version
5952 uses another default.
5953 {Vi: default is "tags /usr/lib/tags"}
5954
5955 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5956'tagstack' 'tgst' boolean (default on)
5957 global
5958 {not in all versions of Vi}
5959 When on, the |tagstack| is used normally. When off, a ":tag" or
5960 ":tselect" command with an argument will not push the tag onto the
5961 tagstack. A following ":tag" without an argument, a ":pop" command or
5962 any other command that uses the tagstack will use the unmodified
5963 tagstack, but does change the pointer to the active entry.
5964 Resetting this option is useful when using a ":tag" command in a
5965 mapping which should not change the tagstack.
5966
5967 *'term'* *E529* *E530* *E531*
5968'term' string (default is $TERM, if that fails:
5969 in the GUI: "builtin_gui"
5970 on Amiga: "amiga"
5971 on BeOS: "beos-ansi"
5972 on Mac: "mac-ansi"
5973 on MiNT: "vt52"
5974 on MS-DOS: "pcterm"
5975 on OS/2: "os2ansi"
5976 on Unix: "ansi"
5977 on VMS: "ansi"
5978 on Win 32: "win32")
5979 global
5980 Name of the terminal. Used for choosing the terminal control
5981 characters. Environment variables are expanded |:set_env|.
5982 For example: >
5983 :set term=$TERM
5984< See |termcap|.
5985
5986 *'termbidi'* *'tbidi'*
5987 *'notermbidi'* *'notbidi'*
5988'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5989 global
5990 {not in Vi}
5991 {only available when compiled with the |+arabic|
5992 feature}
5993 The terminal is in charge of Bi-directionality of text (as specified
5994 by Unicode). The terminal is also expected to do the required shaping
5995 that some languages (such as Arabic) require.
5996 Setting this option implies that 'rightleft' will not be set when
5997 'arabic' is set and the value of 'arabicshape' will be ignored.
5998 Note that setting 'termbidi' has the immediate effect that
5999 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6000 This option is reset when the GUI is started.
6001 For further details see |arabic.txt|.
6002
6003 *'termencoding'* *'tenc'*
6004'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6005 Macintosh GUI: "macroman")
6006 global
6007 {only available when compiled with the |+multi_byte|
6008 feature}
6009 {not in Vi}
6010 Encoding used for the terminal. This specifies what character
6011 encoding the keyboard produces and the display will understand. For
6012 the GUI it only applies to the keyboard ('encoding' is used for the
6013 display).
6014 In the Win32 console version the default value is the console codepage
6015 when it differs from the ANSI codepage.
6016 *E617*
6017 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6018 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6019 Any attempts to set a different value will be rejected, and an error
6020 message is shown.
6021 For the Win32 GUI 'termencoding' is not used for typed characters,
6022 because the Win32 system always passes Unicode characters.
6023 When empty, the same encoding is used as for the 'encoding' option.
6024 This is the normal value.
6025 Not all combinations for 'termencoding' and 'encoding' are valid. See
6026 |encoding-table|.
6027 The value for this option must be supported by internal conversions or
6028 iconv(). When this is not possible no conversion will be done and you
6029 will probably experience problems with non-ASCII characters.
6030 Example: You are working with the locale set to euc-jp (Japanese) and
6031 want to edit a UTF-8 file: >
6032 :let &termencoding = &encoding
6033 :set encoding=utf-8
6034< You need to do this when your system has no locale support for UTF-8.
6035
6036 *'terse'* *'noterse'*
6037'terse' boolean (default off)
6038 global
6039 When set: Add 's' flag to 'shortmess' option (this makes the message
6040 for a search that hits the start or end of the file not being
6041 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6042 shortens a lot of messages}
6043
6044 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6045'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6046 global
6047 {not in Vi}
6048 This option is obsolete. Use 'fileformats'.
6049 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6050 set to the default value for the current system. When 'textauto' is
6051 reset, 'fileformats' is made empty.
6052 NOTE: This option is set to the Vi default value when 'compatible' is
6053 set and to the Vim default value when 'compatible' is reset.
6054
6055 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6056'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6057 others: default off)
6058 local to buffer
6059 {not in Vi}
6060 This option is obsolete. Use 'fileformat'.
6061 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6062 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6063 "unix".
6064
6065 *'textwidth'* *'tw'*
6066'textwidth' 'tw' number (default 0)
6067 local to buffer
6068 {not in Vi}
6069 Maximum width of text that is being inserted. A longer line will be
6070 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006071 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6072 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 'formatoptions' and |ins-textwidth|.
6074 NOTE: This option is set to 0 when 'compatible' is set.
6075
6076 *'thesaurus'* *'tsr'*
6077'thesaurus' 'tsr' string (default "")
6078 global or local to buffer |global-local|
6079 {not in Vi}
6080 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006081 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 the file should contain words with similar meaning, separated by
6083 non-keyword characters (white space is preferred). Maximum line
6084 length is 510 bytes.
6085 To obtain a file to be used here, check out the wordlist FAQ at
6086 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006087 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006088 after a comma are ignored, otherwise spaces are included in the file
6089 name. See |option-backslash| about using backslashes.
6090 The use of |:set+=| and |:set-=| is preferred when adding or removing
6091 directories from the list. This avoids problems when a future version
6092 uses another default.
6093 Backticks cannot be used in this option for security reasons.
6094
6095 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6096'tildeop' 'top' boolean (default off)
6097 global
6098 {not in Vi}
6099 When on: The tilde command "~" behaves like an operator.
6100 NOTE: This option is reset when 'compatible' is set.
6101
6102 *'timeout'* *'to'* *'notimeout'* *'noto'*
6103'timeout' 'to' boolean (default on)
6104 global
6105 *'ttimeout'* *'nottimeout'*
6106'ttimeout' boolean (default off)
6107 global
6108 {not in Vi}
6109 These two options together determine the behavior when part of a
6110 mapped key sequence or keyboard code has been received:
6111
6112 'timeout' 'ttimeout' action ~
6113 off off do not time out
6114 on on or off time out on :mappings and key codes
6115 off on time out on key codes
6116
6117 If both options are off, Vim will wait until either the complete
6118 mapping or key sequence has been received, or it is clear that there
6119 is no mapping or key sequence for the received characters. For
6120 example: if you have mapped "vl" and Vim has received 'v', the next
6121 character is needed to see if the 'v' is followed by an 'l'.
6122 When one of the options is on, Vim will wait for about 1 second for
6123 the next character to arrive. After that the already received
6124 characters are interpreted as single characters. The waiting time can
6125 be changed with the 'timeoutlen' option.
6126 On slow terminals or very busy systems timing out may cause
6127 malfunctioning cursor keys. If both options are off, Vim waits
6128 forever after an entered <Esc> if there are key codes that start
6129 with <Esc>. You will have to type <Esc> twice. If you do not have
6130 problems with key codes, but would like to have :mapped key
6131 sequences not timing out in 1 second, set the 'ttimeout' option and
6132 reset the 'timeout' option.
6133
6134 NOTE: 'ttimeout' is reset when 'compatible' is set.
6135
6136 *'timeoutlen'* *'tm'*
6137'timeoutlen' 'tm' number (default 1000)
6138 global
6139 {not in all versions of Vi}
6140 *'ttimeoutlen'* *'ttm'*
6141'ttimeoutlen' 'ttm' number (default -1)
6142 global
6143 {not in Vi}
6144 The time in milliseconds that is waited for a key code or mapped key
6145 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6146 when part of a command has been typed.
6147 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6148 different timeout value for key codes is desired set 'ttimeoutlen' to
6149 a non-negative number.
6150
6151 ttimeoutlen mapping delay key code delay ~
6152 < 0 'timeoutlen' 'timeoutlen'
6153 >= 0 'timeoutlen' 'ttimeoutlen'
6154
6155 The timeout only happens when the 'timeout' and 'ttimeout' options
6156 tell so. A useful setting would be >
6157 :set timeout timeoutlen=3000 ttimeoutlen=100
6158< (time out on mapping after three seconds, time out on key codes after
6159 a tenth of a second).
6160
6161 *'title'* *'notitle'*
6162'title' boolean (default off, on when title can be restored)
6163 global
6164 {not in Vi}
6165 {not available when compiled without the |+title|
6166 feature}
6167 When on, the title of the window will be set to the value of
6168 'titlestring' (if it is not empty), or to:
6169 filename [+=-] (path) - VIM
6170 Where:
6171 filename the name of the file being edited
6172 - indicates the file cannot be modified, 'ma' off
6173 + indicates the file was modified
6174 = indicates the file is read-only
6175 =+ indicates the file is read-only and modified
6176 (path) is the path of the file being edited
6177 - VIM the server name |v:servername| or "VIM"
6178 Only works if the terminal supports setting window titles
6179 (currently Amiga console, Win32 console, all GUI versions and
6180 terminals with a non- empty 't_ts' option - these are Unix xterm and
6181 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6182 *X11*
6183 When Vim was compiled with HAVE_X11 defined, the original title will
6184 be restored if possible. The output of ":version" will include "+X11"
6185 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6186 works for the icon name |'icon'|.
6187 But: When Vim was started with the |-X| argument, restoring the title
6188 will not work (except in the GUI).
6189 If the title cannot be restored, it is set to the value of 'titleold'.
6190 You might want to restore the title outside of Vim then.
6191 When using an xterm from a remote machine you can use this command:
6192 rsh machine_name xterm -display $DISPLAY &
6193 then the WINDOWID environment variable should be inherited and the
6194 title of the window should change back to what it should be after
6195 exiting Vim.
6196
6197 *'titlelen'*
6198'titlelen' number (default 85)
6199 global
6200 {not in Vi}
6201 {not available when compiled without the |+title|
6202 feature}
6203 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006204 title. When the title is longer, only the end of the path name is
6205 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006206 Using a percentage makes this adapt to the width of the window. But
6207 it won't work perfectly, because the actual number of characters
6208 available also depends on the font used and other things in the title
6209 bar. When 'titlelen' is zero the full path is used. Otherwise,
6210 values from 1 to 30000 percent can be used.
6211 'titlelen' is also used for the 'titlestring' option.
6212
6213 *'titleold'*
6214'titleold' string (default "Thanks for flying Vim")
6215 global
6216 {not in Vi}
6217 {only available when compiled with the |+title|
6218 feature}
6219 This option will be used for the window title when exiting Vim if the
6220 original title cannot be restored. Only happens if 'title' is on or
6221 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006222 This option cannot be set from a |modeline| or in the |sandbox|, for
6223 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006224 *'titlestring'*
6225'titlestring' string (default "")
6226 global
6227 {not in Vi}
6228 {not available when compiled without the |+title|
6229 feature}
6230 When this option is not empty, it will be used for the title of the
6231 window. This happens only when the 'title' option is on.
6232 Only works if the terminal supports setting window titles (currently
6233 Amiga console, Win32 console, all GUI versions and terminals with a
6234 non-empty 't_ts' option).
6235 When Vim was compiled with HAVE_X11 defined, the original title will
6236 be restored if possible |X11|.
6237 When this option contains printf-style '%' items, they will be
6238 expanded according to the rules used for 'statusline'.
6239 Example: >
6240 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6241 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6242< The value of 'titlelen' is used to align items in the middle or right
6243 of the available space.
6244 Some people prefer to have the file name first: >
6245 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6246< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006247 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 separating space only when needed.
6249 NOTE: Use of special characters in 'titlestring' may cause the display
6250 to be garbled (e.g., when it contains a CR or NL character).
6251 {not available when compiled without the |+statusline| feature}
6252
6253 *'toolbar'* *'tb'*
6254'toolbar' 'tb' string (default "icons,tooltips")
6255 global
6256 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6257 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006258 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 possible values are:
6260 icons Toolbar buttons are shown with icons.
6261 text Toolbar buttons shown with text.
6262 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006263 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006264 tooltips Tooltips are active for toolbar buttons.
6265 Tooltips refer to the popup help text which appears after the mouse
6266 cursor is placed over a toolbar button for a brief moment.
6267
6268 If you want the toolbar to be shown with icons as well as text, do the
6269 following: >
6270 :set tb=icons,text
6271< Motif and Athena cannot display icons and text at the same time. They
6272 will show icons if both are requested.
6273
6274 If none of the strings specified in 'toolbar' are valid or if
6275 'toolbar' is empty, this option is ignored. If you want to disable
6276 the toolbar, you need to set the 'guioptions' option. For example: >
6277 :set guioptions-=T
6278< Also see |gui-toolbar|.
6279
6280 *'toolbariconsize'* *'tbis'*
6281'toolbariconsize' 'tbis' string (default "small")
6282 global
6283 {not in Vi}
6284 {only in the GTK+ 2 GUI}
6285 Controls the size of toolbar icons. The possible values are:
6286 tiny Use tiny toolbar icons.
6287 small Use small toolbar icons (default).
6288 medium Use medium-sized toolbar icons.
6289 large Use large toolbar icons.
6290 The exact dimensions in pixels of the various icon sizes depend on
6291 the current theme. Common dimensions are large=32x32, medium=24x24,
6292 small=20x20 and tiny=16x16.
6293
6294 If 'toolbariconsize' is empty, the global default size as determined
6295 by user preferences or the current theme is used.
6296
6297 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6298'ttybuiltin' 'tbi' boolean (default on)
6299 global
6300 {not in Vi}
6301 When on, the builtin termcaps are searched before the external ones.
6302 When off the builtin termcaps are searched after the external ones.
6303 When this option is changed, you should set the 'term' option next for
6304 the change to take effect, for example: >
6305 :set notbi term=$TERM
6306< See also |termcap|.
6307 Rationale: The default for this option is "on", because the builtin
6308 termcap entries are generally better (many systems contain faulty
6309 xterm entries...).
6310
6311 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6312'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6313 sun-cmd, screen, rxvt, dtterm or
6314 iris-ansi; also on when running Vim in
6315 a DOS console)
6316 global
6317 {not in Vi}
6318 Indicates a fast terminal connection. More characters will be sent to
6319 the screen for redrawing, instead of using insert/delete line
6320 commands. Improves smoothness of redrawing when there are multiple
6321 windows and the terminal does not support a scrolling region.
6322 Also enables the extra writing of characters at the end of each screen
6323 line for lines that wrap. This helps when using copy/paste with the
6324 mouse in an xterm and other terminals.
6325
6326 *'ttymouse'* *'ttym'*
6327'ttymouse' 'ttym' string (default depends on 'term')
6328 global
6329 {not in Vi}
6330 {only in Unix and VMS, doesn't work in the GUI; not
6331 available when compiled without |+mouse|}
6332 Name of the terminal type for which mouse codes are to be recognized.
6333 Currently these three strings are valid:
6334 *xterm-mouse*
6335 xterm xterm-like mouse handling. The mouse generates
6336 "<Esc>[Mscr", where "scr" is three bytes:
6337 "s" = button state
6338 "c" = column plus 33
6339 "r" = row plus 33
6340 xterm2 Works like "xterm", but with the xterm reporting the
6341 mouse position while the mouse is dragged. This works
6342 much faster and more precise. Your xterm must at
6343 least at patchlevel 88 / XFree 3.3.3 for this to
6344 work. See below for how Vim detects this
6345 automatically.
6346 *netterm-mouse*
6347 netterm NetTerm mouse handling. The mouse generates
6348 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6349 for the row and column.
6350 *dec-mouse*
6351 dec DEC terminal mouse handling. The mouse generates a
6352 rather complex sequence, starting with "<Esc>[".
6353 *jsbterm-mouse*
6354 jsbterm JSB term mouse handling.
6355 *pterm-mouse*
6356 pterm QNX pterm mouse handling.
6357
6358 The mouse handling must be enabled at compile time |+mouse_xterm|
6359 |+mouse_dec| |+mouse_netterm|.
6360 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6361 recognized, if enabled at compile time. DEC terminal mouse codes
6362 are recognized if enabled at compile time, and 'ttymouse' is not
6363 "xterm" (because the xterm and dec mouse codes conflict).
6364 This option is automatically set to "xterm", when the 'term' option is
6365 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6366 or "xterm2" already. The main use of this option is to set it to
6367 "xterm", when the terminal name doesn't start with "xterm", but it can
6368 handle xterm mouse codes.
6369 The "xterm2" value will be set if the xterm version is reported to be
6370 95 of higher. This only works when compiled with the |+termresponse|
6371 feature and if |t_RV| is set to the escape sequence to request the
6372 xterm version number. Otherwise "xterm2" must be set explicitly.
6373 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6374 t_RV to an empty string: >
6375 :set t_RV=
6376<
6377 *'ttyscroll'* *'tsl'*
6378'ttyscroll' 'tsl' number (default 999)
6379 global
6380 Maximum number of lines to scroll the screen. If there are more lines
6381 to scroll the window is redrawn. For terminals where scrolling is
6382 very slow and redrawing is not slow this can be set to a small number,
6383 e.g., 3, to speed up displaying.
6384
6385 *'ttytype'* *'tty'*
6386'ttytype' 'tty' string (default from $TERM)
6387 global
6388 Alias for 'term', see above.
6389
6390 *'undolevels'* *'ul'*
6391'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6392 Win32 and OS/2)
6393 global
6394 {not in Vi}
6395 Maximum number of changes that can be undone. Since undo information
6396 is kept in memory, higher numbers will cause more memory to be used
6397 (nevertheless, a single change can use an unlimited amount of memory).
6398 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6399 itself: >
6400 set ul=0
6401< But you can also get Vi compatibility by including the 'u' flag in
6402 'cpoptions', and still be able to use CTRL-R to repeat undo.
6403 Set to a negative number for no undo at all: >
6404 set ul=-1
6405< This helps when you run out of memory for a single change.
6406 Also see |undo-two-ways|.
6407
6408 *'updatecount'* *'uc'*
6409'updatecount' 'uc' number (default: 200)
6410 global
6411 {not in Vi}
6412 After typing this many characters the swap file will be written to
6413 disk. When zero, no swap file will be created at all (see chapter on
6414 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6415 Vim with the "-n" option, see |startup|. When editing in readonly
6416 mode this option will be initialized to 10000.
6417 The swapfile can be disabled per buffer with |'swapfile'|.
6418 When 'updatecount' is set from zero to non-zero, swap files are
6419 created for all buffers that have 'swapfile' set. When 'updatecount'
6420 is set to zero, existing swap files are not deleted.
6421 Also see |'swapsync'|.
6422 This option has no meaning in buffers where |'buftype'| is "nofile"
6423 or "nowrite".
6424
6425 *'updatetime'* *'ut'*
6426'updatetime' 'ut' number (default 4000)
6427 global
6428 {not in Vi}
6429 If this many milliseconds nothing is typed the swap file will be
6430 written to disk (see |crash-recovery|). Also used for the
6431 |CursorHold| autocommand event.
6432
6433 *'verbose'* *'vbs'*
6434'verbose' 'vbs' number (default 0)
6435 global
6436 {not in Vi, although some versions have a boolean
6437 verbose option}
6438 When bigger than zero, Vim will give messages about what it is doing.
6439 Currently, these messages are given:
6440 >= 1 When the viminfo file is read or written.
6441 >= 2 When a file is ":source"'ed.
6442 >= 5 Every searched tags file.
6443 >= 8 Files for which a group of autocommands is executed.
6444 >= 9 Every executed autocommand.
6445 >= 12 Every executed function.
6446 >= 13 When an exception is thrown, caught, finished, or discarded.
6447 >= 14 Anything pending in a ":finally" clause.
6448 >= 15 Every executed Ex command (truncated at 200 characters).
6449
6450 This option can also be set with the "-V" argument. See |-V|.
6451 This option is also set by the |:verbose| command.
6452
6453 *'viewdir'* *'vdir'*
6454'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6455 "$VIM/vimfiles/view",
6456 for Unix: "~/.vim/view",
6457 for Macintosh: "$VIM:vimfiles:view"
6458 for VMS: "sys$login:vimfiles/view"
6459 for RiscOS: "Choices:vimfiles/view")
6460 global
6461 {not in Vi}
6462 {not available when compiled without the +mksession
6463 feature}
6464 Name of the directory where to store files for |:mkview|.
6465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'viewoptions'* *'vop'*
6469'viewoptions' 'vop' string (default: "folds,options,cursor")
6470 global
6471 {not in Vi}
6472 {not available when compiled without the +mksession
6473 feature}
6474 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006475 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 word save and restore ~
6477 cursor cursor position in file and in window
6478 folds manually created folds, opened/closed folds and local
6479 fold options
6480 options options and mappings local to a window or buffer (not
6481 global values for local options)
6482 slash backslashes in file names replaced with forward
6483 slashes
6484 unix with Unix end-of-line format (single <NL>), even when
6485 on Windows or DOS
6486
6487 "slash" and "unix" are useful on Windows when sharing view files
6488 with Unix. The Unix version of Vim cannot source dos format scripts,
6489 but the Windows version of Vim can source unix format scripts.
6490
6491 *'viminfo'* *'vi'* *E526* *E527* *E528*
6492'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6493 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6494 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6495 for others: '20,<50,s10,h)
6496 global
6497 {not in Vi}
6498 {not available when compiled without the |+viminfo|
6499 feature}
6500 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006501 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 separated list of parameters, each consisting of a single character
6503 identifying the particular parameter, followed by a number or string
6504 which specifies the value of that parameter. If a particular
6505 character is left out, then the default value is used for that
6506 parameter. The following is a list of the identifying characters and
6507 the effect of their value.
6508 CHAR VALUE ~
6509 ! When included, save and restore global variables that start
6510 with an uppercase letter, and don't contain a lowercase
6511 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006512 and "_K_L_M" are not. Only String and Number types are
6513 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 " Maximum number of lines saved for each register. Old name of
6515 the '<' item, with the disadvantage that you need to put a
6516 backslash before the ", otherwise it will be recognized as the
6517 start of a comment!
6518 % When included, save and restore the buffer list. If Vim is
6519 started with a file name argument, the buffer list is not
6520 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006521 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 without a file name and buffers for help files are not written
6523 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006524 When followed by a number, the number specifies the maximum
6525 number of buffers that are stored. Without a number all
6526 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 ' Maximum number of previously edited files for which the marks
6528 are remembered. This parameter must always be included when
6529 'viminfo' is non-empty.
6530 Including this item also means that the |jumplist| and the
6531 |changelist| are stored in the viminfo file.
6532 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006533 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 patterns are also saved. When not included, the value of
6535 'history' is used.
6536 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006537 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 < Maximum number of lines saved for each register. If zero then
6539 registers are not saved. When not included, all lines are
6540 saved. '"' is the old name for this item.
6541 Also see the 's' item below: limit specified in Kbyte.
6542 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006543 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 c When included, convert the text in the viminfo file from the
6545 'encoding' used when writing the file to the current
6546 'encoding'. See |viminfo-encoding|.
6547 f Whether file marks need to be stored. If zero, file marks ('0
6548 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006549 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 cursor position (when exiting or when doing ":wviminfo").
6551 h Disable the effect of 'hlsearch' when loading the viminfo
6552 file. When not included, it depends on whether ":nohlsearch"
6553 has been used since the last search command.
6554 n Name of the viminfo file. The name must immediately follow
6555 the 'n'. Must be the last one! If the "-i" argument was
6556 given when starting Vim, that file name overrides the one
6557 given here with 'viminfo'. Environment variables are expanded
6558 when opening the file, not when setting the option.
6559 r Removable media. The argument is a string (up to the next
6560 ','). This parameter can be given several times. Each
6561 specifies the start of a path for which no marks will be
6562 stored. This is to avoid removable media. For MS-DOS you
6563 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6564 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6565 ignored. Maximum length of each 'r' argument is 50
6566 characters.
6567 s Maximum size of an item in Kbyte. If zero then registers are
6568 not saved. Currently only applies to registers. The default
6569 "s10" will exclude registers with more than 10 Kbyte of text.
6570 Also see the '<' item above: line count limit.
6571
6572 Example: >
6573 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6574<
6575 '50 Marks will be remembered for the last 50 files you
6576 edited.
6577 <1000 Contents of registers (up to 1000 lines each) will be
6578 remembered.
6579 s100 Registers with more than 100 Kbyte text are skipped.
6580 :0 Command-line history will not be saved.
6581 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6582 no / Since '/' is not specified, the default will be used,
6583 that is, save all of the search history, and also the
6584 previous search and substitute patterns.
6585 no % The buffer list will not be saved nor read back.
6586 no h 'hlsearch' highlighting will be restored.
6587
6588 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6589 load the contents of the file, this is not done automatically.
6590
6591 This option cannot be set from a |modeline| or in the |sandbox|, for
6592 security reasons.
6593
6594 *'virtualedit'* *'ve'*
6595'virtualedit' 've' string (default "")
6596 global
6597 {not in Vi}
6598 {not available when compiled without the
6599 |+virtualedit| feature}
6600 A comma separated list of these words:
6601 block Allow virtual editing in Visual block mode.
6602 insert Allow virtual editing in Insert mode.
6603 all Allow virtual editing in all modes.
6604 Virtual editing means that the cursor can be positioned where there is
6605 no actual character. This can be halfway into a Tab or beyond the end
6606 of the line. Useful for selecting a rectangle in Visual mode and
6607 editing a table.
6608
6609 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6610'visualbell' 'vb' boolean (default off)
6611 global
6612 {not in Vi}
6613 Use visual bell instead of beeping. The terminal code to display the
6614 visual bell is given with 't_vb'. When no beep or flash is wanted,
6615 use ":set vb t_vb=".
6616 Note: When the GUI starts, 't_vb' is reset to its default value. You
6617 might want to set it again in your |gvimrc|.
6618 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6619 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6620 where 40 is the time in msec.
6621 Does not work on the Amiga, you always get a screen flash.
6622 Also see 'errorbells'.
6623
6624 *'warn'* *'nowarn'*
6625'warn' boolean (default on)
6626 global
6627 Give a warning message when a shell command is used while the buffer
6628 has been changed.
6629
6630 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6631'weirdinvert' 'wiv' boolean (default off)
6632 global
6633 {not in Vi}
6634 This option has the same effect as the 't_xs' termcap option.
6635 It is provided for backwards compatibility with version 4.x.
6636 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6637 vice versa. Has no effect when the GUI is running.
6638
6639 *'whichwrap'* *'ww'*
6640'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6641 global
6642 {not in Vi}
6643 Allow specified keys that move the cursor left/right to move to the
6644 previous/next line when the cursor is on the first/last character in
6645 the line. Concatenate characters to allow this for these keys:
6646 char key mode ~
6647 b <BS> Normal and Visual
6648 s <Space> Normal and Visual
6649 h "h" Normal and Visual
6650 l "l" Normal and Visual
6651 < <Left> Normal and Visual
6652 > <Right> Normal and Visual
6653 ~ "~" Normal
6654 [ <Left> Insert and Replace
6655 ] <Right> Insert and Replace
6656 For example: >
6657 :set ww=<,>,[,]
6658< allows wrap only when cursor keys are used.
6659 When the movement keys are used in combination with a delete or change
6660 operator, the <EOL> also counts for a character. This makes "3h"
6661 different from "3dh" when the cursor crosses the end of a line. This
6662 is also true for "x" and "X", because they do the same as "dl" and
6663 "dh". If you use this, you may also want to use the mapping
6664 ":map <BS> X" to make backspace delete the character in front of the
6665 cursor.
6666 When 'l' is included, you get a side effect: "yl" on an empty line
6667 will include the <EOL>, so that "p" will insert a new line.
6668 NOTE: This option is set to the Vi default value when 'compatible' is
6669 set and to the Vim default value when 'compatible' is reset.
6670
6671 *'wildchar'* *'wc'*
6672'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6673 global
6674 {not in Vi}
6675 Character you have to type to start wildcard expansion in the
6676 command-line, as specified with 'wildmode'.
6677 The character is not recognized when used inside a macro. See
6678 'wildcharm' for that.
6679 Although 'wc' is a number option, you can set it to a special key: >
6680 :set wc=<Esc>
6681< NOTE: This option is set to the Vi default value when 'compatible' is
6682 set and to the Vim default value when 'compatible' is reset.
6683
6684 *'wildcharm'* *'wcm'*
6685'wildcharm' 'wcm' number (default: none (0))
6686 global
6687 {not in Vi}
6688 'wildcharm' works exactly like 'wildchar', except that it is
6689 recognized when used inside a macro. You can find "spare" command-line
6690 keys suitable for this option by looking at |ex-edit-index|. Normally
6691 you'll never actually type 'wildcharm', just use it in mappings that
6692 automatically invoke completion mode, e.g.: >
6693 :set wcm=<C-Z>
6694 :cmap ss so $vim/sessions/*.vim<C-Z>
6695< Then after typing :ss you can use CTRL-P & CTRL-N.
6696
6697 *'wildignore'* *'wig'*
6698'wildignore' 'wig' string (default "")
6699 global
6700 {not in Vi}
6701 {not available when compiled without the |+wildignore|
6702 feature}
6703 A list of file patterns. A file that matches with one of these
6704 patterns is ignored when completing file or directory names.
6705 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6706 Also see 'suffixes'.
6707 Example: >
6708 :set wildignore=*.o,*.obj
6709< The use of |:set+=| and |:set-=| is preferred when adding or removing
6710 a pattern from the list. This avoids problems when a future version
6711 uses another default.
6712
6713 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6714'wildmenu' 'wmnu' boolean (default off)
6715 global
6716 {not in Vi}
6717 {not available if compiled without the |+wildmenu|
6718 feature}
6719 When 'wildmenu' is on, command-line completion operates in an enhanced
6720 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6721 the possible matches are shown just above the command line, with the
6722 first match highlighted (overwriting the status line, if there is
6723 one). Keys that show the previous/next match, such as <Tab> or
6724 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6725 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6726 specified. "longest" and "list" do not start "wildmenu" mode.
6727 If there are more matches than can fit in the line, a ">" is shown on
6728 the right and/or a "<" is shown on the left. The status line scrolls
6729 as needed.
6730 The "wildmenu" mode is abandoned when a key is hit that is not used
6731 for selecting a completion.
6732 While the "wildmenu" is active the following keys have special
6733 meanings:
6734
6735 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6736 <Down> - in filename/menu name completion: move into a
6737 subdirectory or submenu.
6738 <CR> - in menu completion, when the cursor is just after a
6739 dot: move into a submenu.
6740 <Up> - in filename/menu name completion: move up into
6741 parent directory or parent menu.
6742
6743 This makes the menus accessible from the console |console-menus|.
6744
6745 If you prefer the <Left> and <Right> keys to move the cursor instead
6746 of selecting a different match, use this: >
6747 :cnoremap <Left> <Space><BS><Left>
6748 :cnoremap <Right> <Space><BS><Right>
6749<
6750 The "WildMenu" highlighting is used for displaying the current match
6751 |hl-WildMenu|.
6752
6753 *'wildmode'* *'wim'*
6754'wildmode' 'wim' string (Vim default: "full")
6755 global
6756 {not in Vi}
6757 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006758 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 part specifies what to do for each consecutive use of 'wildchar. The
6760 first part specifies the behavior for the first use of 'wildchar',
6761 The second part for the second use, etc.
6762 These are the possible values for each part:
6763 "" Complete only the first match.
6764 "full" Complete the next full match. After the last match,
6765 the original string is used and then the first match
6766 again.
6767 "longest" Complete till longest common string. If this doesn't
6768 result in a longer string, use the next part.
6769 "longest:full" Like "longest", but also start 'wildmenu' if it is
6770 enabled.
6771 "list" When more than one match, list all matches.
6772 "list:full" When more than one match, list all matches and
6773 complete first match.
6774 "list:longest" When more than one match, list all matches and
6775 complete till longest common string.
6776 When there is only a single match, it is fully completed in all cases.
6777
6778 Examples: >
6779 :set wildmode=full
6780< Complete first full match, next match, etc. (the default) >
6781 :set wildmode=longest,full
6782< Complete longest common string, then each full match >
6783 :set wildmode=list:full
6784< List all matches and complete each full match >
6785 :set wildmode=list,full
6786< List all matches without completing, then each full match >
6787 :set wildmode=longest,list
6788< Complete longest common string, then list alternatives.
6789
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006790 *'wildoptions'* *'wop'*
6791'wildoptions' 'wop' string (default "")
6792 global
6793 {not in Vi}
6794 {not available when compiled without the |+wildignore|
6795 feature}
6796 A list of words that change how command line completion is done.
6797 Currently only one word is allowed:
6798 tagfile When using CTRL-D to list matching tags, the kind of
6799 tag and the file of the tag is listed. Only one match
6800 is displayed per line. Often used tag kinds are:
6801 d #define
6802 f function
6803 Also see |cmdline-completion|.
6804
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 *'winaltkeys'* *'wak'*
6806'winaltkeys' 'wak' string (default "menu")
6807 global
6808 {not in Vi}
6809 {only used in Win32, Motif, GTK and Photon GUI}
6810 Some GUI versions allow the access to menu entries by using the ALT
6811 key in combination with a character that appears underlined in the
6812 menu. This conflicts with the use of the ALT key for mappings and
6813 entering special characters. This option tells what to do:
6814 no Don't use ALT keys for menus. ALT key combinations can be
6815 mapped, but there is no automatic handling. This can then be
6816 done with the |:simalt| command.
6817 yes ALT key handling is done by the windowing system. ALT key
6818 combinations cannot be mapped.
6819 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006820 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 keys can be mapped.
6822 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6823 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006824 This option is not used for <F10>; on Win32 and with GTK <F10> will
6825 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006827 *'window'* *'wi'*
6828'window' 'wi' number (default screen height - 1)
6829 global
6830 Window height. Do not confuse this with the height of the Vim window,
6831 use 'lines' for that.
6832 Used for |CTRL-F| and |CTRL-B| when the value is smaller than 'lines'
6833 minus one. The screen will scroll 'window' minus two lines, with a
6834 minimum of one.
6835 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
6836 in a much smarter way, taking care of wrapping lines.
6837 When resizing the Vim window, the value is smaller than 1 or more than
6838 or equal to 'lines' it will be set to 'lines' minus 1.
6839 {Vi also uses the option to specify the number of displayed lines}
6840
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 *'winheight'* *'wh'* *E591*
6842'winheight' 'wh' number (default 1)
6843 global
6844 {not in Vi}
6845 {not available when compiled without the +windows
6846 feature}
6847 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006848 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 current window is smaller, its size is increased, at the cost of the
6850 height of other windows. Set it to 999 to make the current window
6851 always fill the screen (although this has the drawback that ":all"
6852 will create only two windows). Set it to a small number for normal
6853 editing.
6854 Minimum value is 1.
6855 The height is not adjusted after one of the commands to change the
6856 height of the current window.
6857 'winheight' applies to the current window. Use 'winminheight' to set
6858 the minimal height for other windows.
6859
6860 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6861'winfixheight' 'wfh' boolean (default off)
6862 local to window
6863 {not in Vi}
6864 {not available when compiled without the +windows
6865 feature}
6866 Keep the window height when windows are opened or closed and
6867 'equalalways' is set. Set by default for the |preview-window| and
6868 |quickfix-window|.
6869 The height may be changed anyway when running out of room.
6870
6871 *'winminheight'* *'wmh'*
6872'winminheight' 'wmh' number (default 1)
6873 global
6874 {not in Vi}
6875 {not available when compiled without the +windows
6876 feature}
6877 The minimal height of a window, when it's not the current window.
6878 This is a hard minimum, windows will never become smaller.
6879 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6880 status bar) if necessary. They will return to at least one line when
6881 they become active (since the cursor has to have somewhere to go.)
6882 Use 'winheight' to set the minimal height of the current window.
6883 This option is only checked when making a window smaller. Don't use a
6884 large number, it will cause errors when opening more than a few
6885 windows. A value of 0 to 3 is reasonable.
6886
6887 *'winminwidth'* *'wmw'*
6888'winminwidth' 'wmw' number (default 1)
6889 global
6890 {not in Vi}
6891 {not available when compiled without the +vertsplit
6892 feature}
6893 The minimal width of a window, when it's not the current window.
6894 This is a hard minimum, windows will never become smaller.
6895 When set to zero, windows may be "squashed" to zero columns (i.e. just
6896 a vertical separator) if necessary. They will return to at least one
6897 line when they become active (since the cursor has to have somewhere
6898 to go.)
6899 Use 'winwidth' to set the minimal width of the current window.
6900 This option is only checked when making a window smaller. Don't use a
6901 large number, it will cause errors when opening more than a few
6902 windows. A value of 0 to 12 is reasonable.
6903
6904 *'winwidth'* *'wiw'* *E592*
6905'winwidth' 'wiw' number (default 20)
6906 global
6907 {not in Vi}
6908 {not available when compiled without the +vertsplit
6909 feature}
6910 Minimal number of columns for the current window. This is not a hard
6911 minimum, Vim will use fewer columns if there is not enough room. If
6912 the current window is smaller, its size is increased, at the cost of
6913 the width of other windows. Set it to 999 to make the current window
6914 always fill the screen. Set it to a small number for normal editing.
6915 The width is not adjusted after one of the commands to change the
6916 width of the current window.
6917 'winwidth' applies to the current window. Use 'winminwidth' to set
6918 the minimal width for other windows.
6919
6920 *'wrap'* *'nowrap'*
6921'wrap' boolean (default on)
6922 local to window
6923 {not in Vi}
6924 This option changes how text is displayed. It doesn't change the text
6925 in the buffer, see 'textwidth' for that.
6926 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006927 displaying continues on the next line. When off lines will not wrap
6928 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 moved to a part that is not shown, the screen will scroll
6930 horizontally.
6931 The line will be broken in the middle of a word if necessary. See
6932 'linebreak' to get the break at a word boundary.
6933 To make scrolling horizontally a bit more useful, try this: >
6934 :set sidescroll=5
6935 :set listchars+=precedes:<,extends:>
6936< See 'sidescroll', 'listchars' and |wrap-off|.
6937
6938 *'wrapmargin'* *'wm'*
6939'wrapmargin' 'wm' number (default 0)
6940 local to buffer
6941 Number of characters from the right window border where wrapping
6942 starts. When typing text beyond this limit, an <EOL> will be inserted
6943 and inserting continues on the next line.
6944 Options that add a margin, such as 'number' and 'foldcolumn', cause
6945 the text width to be further reduced. This is Vi compatible.
6946 When 'textwidth' is non-zero, this option is not used.
6947 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6948 and less usefully}
6949
6950 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6951'wrapscan' 'ws' boolean (default on) *E384* *E385*
6952 global
6953 Searches wrap around the end of the file.
6954
6955 *'write'* *'nowrite'*
6956'write' boolean (default on)
6957 global
6958 {not in Vi}
6959 Allows writing files. When not set, writing a file is not allowed.
6960 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006961 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 argument. Filtering text is still possible, even though this requires
6963 writing a temporary file.
6964
6965 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6966'writeany' 'wa' boolean (default off)
6967 global
6968 Allows writing to any file with no need for "!" override.
6969
6970 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6971'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6972 otherwise)
6973 global
6974 {not in Vi}
6975 Make a backup before overwriting a file. The backup is removed after
6976 the file was successfully written, unless the 'backup' option is
6977 also on. Reset this option if your file system is almost full. See
6978 |backup-table| for another explanation.
6979 When the 'backupskip' pattern matches, a backup is not made anyway.
6980 NOTE: This option is set to the default value when 'compatible' is
6981 set.
6982
6983 *'writedelay'* *'wd'*
6984'writedelay' 'wd' number (default 0)
6985 global
6986 {not in Vi}
6987 The number of microseconds to wait for each character sent to the
6988 screen. When non-zero, characters are sent to the terminal one by
6989 one. For MS-DOS pcterm this does not work. For debugging purposes.
6990
6991 vim:tw=78:ts=8:ft=help:norl: