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